Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Drasil.Chunk.Code

Contents

Orphan instances

Description

Defines chunk types for use in code generation.

Synopsis

class CodeIdea c where
- codeName :: c -> String
- codeChunk :: c -> CodeChunk
data CodeChunk = CodeC {
- _qc :: DefinedQuantityDict
- kind :: VarOrFunc
}
data CodeVarChunk = CodeVC {
- _ccv :: CodeChunk
- _obv :: Maybe CodeChunk
}
newtype CodeFuncChunk = CodeFC {
- _ccf :: CodeChunk
}
data VarOrFunc
- = Var
- | Func
obv :: Lens' CodeVarChunk (Maybe CodeChunk)
quantvar :: (Quantity c, MayHaveUnit c, Concept c) => c -> CodeVarChunk
quantfunc :: (Quantity c, MayHaveUnit c, Concept c) => c -> CodeFuncChunk
ccObjVar :: CodeVarChunk -> CodeVarChunk -> CodeVarChunk
codevars :: CodeExpr -> ChunkDB -> [CodeVarChunk]
codevars' :: CodeExpr -> ChunkDB -> [CodeVarChunk]
funcResolve :: ChunkDB -> UID -> CodeFuncChunk
varResolve :: ChunkDB -> UID -> CodeVarChunk
listToArray :: CodeVarChunk -> CodeVarChunk
programName :: CommonIdea c => c -> String
funcPrefix :: String
class CodeIdea c => DefiningCodeExpr c where
- codeExpr :: Lens' c CodeExpr

Documentation

class CodeIdea c where #

A CodeIdea must include some code and its name.

Methods

codeName :: c -> String #

Name of the idea.

codeChunk :: c -> CodeChunk #

Code chunk associated with the idea.

Instances

Instances details

CodeIdea CodeDefinition Source #	Finds the code name of a `CodeDefinition`. `Function` `CodeDefinition`s are named with the function prefix to distinguish them from the corresponding variable version.
Instance details Defined in Language.Drasil.Chunk.CodeDefinition Methods codeName :: CodeDefinition -> String # codeChunk :: CodeDefinition -> CodeChunk #
CodeIdea ParameterChunk Source #	Finds the code name and `CodeChunk` of a `ParameterChunk`.
Instance details Defined in Language.Drasil.Chunk.Parameter Methods codeName :: ParameterChunk -> String # codeChunk :: ParameterChunk -> CodeChunk #
CodeIdea CodeChunk Source #	Finds the code name of a `CodeChunk`.
Instance details Defined in Language.Drasil.Chunk.Code Methods codeName :: CodeChunk -> String # codeChunk :: CodeChunk -> CodeChunk #
CodeIdea CodeFuncChunk Source #	Finds the code name and `CodeChunk` within a `CodeFuncChunk`.
Instance details Defined in Language.Drasil.Chunk.Code Methods codeName :: CodeFuncChunk -> String # codeChunk :: CodeFuncChunk -> CodeChunk #
CodeIdea CodeVarChunk Source #	Finds the code name and `CodeChunk` within a `CodeVarChunk`.
Instance details Defined in Language.Drasil.Chunk.Code Methods codeName :: CodeVarChunk -> String # codeChunk :: CodeVarChunk -> CodeChunk #

data CodeChunk #

Basic chunk representation in the code generation context. Contains a DefinedQuantityDict and the kind of code (variable or function).

Constructors

CodeC
Fields _qc :: DefinedQuantityDict kind :: VarOrFunc

Instances

Instances details

CodeIdea CodeChunk Source #	Finds the code name of a `CodeChunk`.
Instance details Defined in Language.Drasil.Chunk.Code Methods codeName :: CodeChunk -> String # codeChunk :: CodeChunk -> CodeChunk #
HasUID CodeChunk	Finds the `UID` of the `DefinedQuantityDict` used to make the `CodeChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods uid :: Getter CodeChunk UID #
Idea CodeChunk	Finds the idea contained in the `DefinedQuantityDict` used to make the `CodeChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods getA :: CodeChunk -> Maybe String #
NamedIdea CodeChunk	Finds the term (`NP`) of the `DefinedQuantityDict` used to make the `CodeChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods term :: Lens' CodeChunk NP #
MayHaveUnit CodeChunk	Finds the units of the `DefinedQuantityDict` used to make the `CodeChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods getUnit :: CodeChunk -> Maybe UnitDefn #
ConceptDomain CodeChunk
Instance details Defined in Drasil.Code.CodeVar Methods cdom :: CodeChunk -> [UID] #
Definition CodeChunk	Finds the Definition contained in the `DefinedQuantityDict` used to make the CodeChunk
Instance details Defined in Drasil.Code.CodeVar Methods defn :: Lens' CodeChunk Sentence #
Quantity CodeChunk	`CodeChunk`s have a `Quantity`.
Instance details Defined in Drasil.Code.CodeVar
HasSpace CodeChunk	Finds the `Space` of the `DefinedQuantityDict` used to make the `CodeChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods typ :: Getter CodeChunk Space #
HasSymbol CodeChunk	Finds the `Stage` dependent `Symbol` of the `DefinedQuantityDict` used to make the `CodeChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods symbol :: CodeChunk -> Stage -> Symbol #
Eq CodeChunk	Equal if `UID`s are equal.
Instance details Defined in Drasil.Code.CodeVar Methods (==) :: CodeChunk -> CodeChunk -> Bool # (/=) :: CodeChunk -> CodeChunk -> Bool #

data CodeVarChunk #

Chunk representing a variable. The obv field represents the object containing this variable, if it is an object field.

Constructors

CodeVC
Fields _ccv :: CodeChunk _obv :: Maybe CodeChunk

Instances

Instances details

CodeIdea CodeVarChunk Source #	Finds the code name and `CodeChunk` within a `CodeVarChunk`.
Instance details Defined in Language.Drasil.Chunk.Code Methods codeName :: CodeVarChunk -> String # codeChunk :: CodeVarChunk -> CodeChunk #
HasUID CodeVarChunk	Finds the `UID` of the `CodeChunk` used to make the `CodeVarChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods uid :: Getter CodeVarChunk UID #
Idea CodeVarChunk	Finds the idea contained in the `CodeChunk` used to make the `CodeVarChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods getA :: CodeVarChunk -> Maybe String #
NamedIdea CodeVarChunk	Finds the term (`NP`) of the `CodeChunk` used to make the `CodeVarChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods term :: Lens' CodeVarChunk NP #
MayHaveUnit CodeVarChunk	Finds the units of the `CodeChunk` used to make the `CodeVarChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods getUnit :: CodeVarChunk -> Maybe UnitDefn #
ConceptDomain CodeVarChunk
Instance details Defined in Drasil.Code.CodeVar Methods cdom :: CodeVarChunk -> [UID] #
Definition CodeVarChunk
Instance details Defined in Drasil.Code.CodeVar Methods defn :: Lens' CodeVarChunk Sentence #
Quantity CodeVarChunk	`CodeVarChunk`s have a `Quantity`.
Instance details Defined in Drasil.Code.CodeVar
HasSpace CodeVarChunk	Finds the `Space` of the `CodeChunk` used to make the `CodeVarChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods typ :: Getter CodeVarChunk Space #
HasSymbol CodeVarChunk	Finds the `Stage` dependent `Symbol` of the `CodeChunk` used to make the `CodeVarChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods symbol :: CodeVarChunk -> Stage -> Symbol #
Eq CodeVarChunk	Equal if `UID`s are equal.
Instance details Defined in Drasil.Code.CodeVar Methods (==) :: CodeVarChunk -> CodeVarChunk -> Bool # (/=) :: CodeVarChunk -> CodeVarChunk -> Bool #

newtype CodeFuncChunk #

Chunk representing a function.

Constructors

CodeFC
Fields _ccf :: CodeChunk

Instances

Instances details

Callable CodeFuncChunk	Functions are Callable.
Instance details Defined in Drasil.Code.CodeVar
CodeIdea CodeFuncChunk Source #	Finds the code name and `CodeChunk` within a `CodeFuncChunk`.
Instance details Defined in Language.Drasil.Chunk.Code Methods codeName :: CodeFuncChunk -> String # codeChunk :: CodeFuncChunk -> CodeChunk #
HasUID CodeFuncChunk	Finds the `UID` of the `CodeChunk` used to make the `CodeFuncChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods uid :: Getter CodeFuncChunk UID #
Idea CodeFuncChunk	Finds the idea contained in the `CodeChunk` used to make the `CodeFuncChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods getA :: CodeFuncChunk -> Maybe String #
NamedIdea CodeFuncChunk	Finds the term (`NP`) of the `CodeChunk` used to make the `CodeFuncChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods term :: Lens' CodeFuncChunk NP #
MayHaveUnit CodeFuncChunk	Finds the units of the `CodeChunk` used to make the `CodeFuncChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods getUnit :: CodeFuncChunk -> Maybe UnitDefn #
ConceptDomain CodeFuncChunk	Finds the ConceptDomain of the `CodeChunk` used to make the `CodeFuncChunk`
Instance details Defined in Drasil.Code.CodeVar Methods cdom :: CodeFuncChunk -> [UID] #
Definition CodeFuncChunk	Finds the Definition of the `CodeChunk` used to make the `CodeFuncChunk`
Instance details Defined in Drasil.Code.CodeVar Methods defn :: Lens' CodeFuncChunk Sentence #
Quantity CodeFuncChunk	`CodeFuncChunk`s have a `Quantity`.
Instance details Defined in Drasil.Code.CodeVar
HasSpace CodeFuncChunk	Finds the `Space` of the `CodeChunk` used to make the `CodeFuncChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods typ :: Getter CodeFuncChunk Space #
HasSymbol CodeFuncChunk	Finds the `Stage` dependent `Symbol` of the `CodeChunk` used to make the `CodeFuncChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods symbol :: CodeFuncChunk -> Stage -> Symbol #
Eq CodeFuncChunk	Equal if `UID`s are equal.
Instance details Defined in Drasil.Code.CodeVar Methods (==) :: CodeFuncChunk -> CodeFuncChunk -> Bool # (/=) :: CodeFuncChunk -> CodeFuncChunk -> Bool #

data VarOrFunc #

Details if a piece of code is meant to be a variable or a function.

Constructors

Var
Func

obv :: Lens' CodeVarChunk (Maybe CodeChunk) #

quantvar :: (Quantity c, MayHaveUnit c, Concept c) => c -> CodeVarChunk Source #

Construct a CodeVarChunk from a Quantity.

quantfunc :: (Quantity c, MayHaveUnit c, Concept c) => c -> CodeFuncChunk Source #

Construct a CodeFuncChunk from a Quantity.

ccObjVar :: CodeVarChunk -> CodeVarChunk -> CodeVarChunk Source #

Combine an Object-type CodeChunk with another CodeChunk to create a new CodeChunk which represents a field of the first. ex. ccObjVar obj f = obj.f.

codevars :: CodeExpr -> ChunkDB -> [CodeVarChunk] Source #

Get a list of CodeChunks from an equation.

codevars' :: CodeExpr -> ChunkDB -> [CodeVarChunk] Source #

Get a list of CodeChunks from an equation (no functions).

funcResolve :: ChunkDB -> UID -> CodeFuncChunk Source #

Make a CodeFuncChunk from a UID in the ChunkDB.

varResolve :: ChunkDB -> UID -> CodeVarChunk Source #

Make a CodeVarChunk from a UID in the ChunkDB.

listToArray :: CodeVarChunk -> CodeVarChunk #

programName :: CommonIdea c => c -> String #

Convert an abbreviation into one deemed 'code-friendly', removing spaces, and replacing special characters with underscores.

FIXME: This should NOT be treated as a getter, but something we cache local to something that has a 'program name'.

funcPrefix :: String #

Used when a function name needs to be distinguishable from a variable name.

class CodeIdea c => DefiningCodeExpr c where #

A DefiningCodeExpr must have it's underlying chunk defined in the CodeExpr language.

Methods

codeExpr :: Lens' c CodeExpr #

Instances

Instances details

DefiningCodeExpr CodeDefinition Source #	Finds the defining expression of a CodeDefinition.
Instance details Defined in Language.Drasil.Chunk.CodeDefinition Methods codeExpr :: Lens' CodeDefinition CodeExpr #

Orphan instances

CodeIdea CodeChunk Source #	Finds the code name of a `CodeChunk`.
Instance details Methods codeName :: CodeChunk -> String # codeChunk :: CodeChunk -> CodeChunk #
CodeIdea CodeFuncChunk Source #	Finds the code name and `CodeChunk` within a `CodeFuncChunk`.
Instance details Methods codeName :: CodeFuncChunk -> String # codeChunk :: CodeFuncChunk -> CodeChunk #
CodeIdea CodeVarChunk Source #	Finds the code name and `CodeChunk` within a `CodeVarChunk`.
Instance details Methods codeName :: CodeVarChunk -> String # codeChunk :: CodeVarChunk -> CodeChunk #