Safe Haskell	None
Language	Haskell2010

Language.Drasil.Chunk.CodeBase

Description

Defines chunk types for use in code generation.

Synopsis

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

Documentation

class CodeIdea c where Source #

A CodeIdea must include some code and its name.

Methods

codeName :: c -> String Source #

Name of the idea.

codeChunk :: c -> CodeChunk Source #

Code chunk associated with the idea.

class CodeIdea c => DefiningCodeExpr c where Source #

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

Methods

codeExpr :: Lens' c CodeExpr Source #

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

Convert the program name to an abbreviated String without any special characters.

funcPrefix :: String Source #

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

data VarOrFunc Source #

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

Constructors

Var
Func

data CodeChunk Source #

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

Constructors

CodeC
Fields _qc :: QuantityDict kind :: VarOrFunc

Instances

Instances details

Eq CodeChunk Source #	Equal if `UID`s are equal.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods (==) :: CodeChunk -> CodeChunk -> Bool # (/=) :: CodeChunk -> CodeChunk -> Bool #
Quantity CodeChunk Source #	`CodeChunk`s have a `Quantity`.
Instance details Defined in Language.Drasil.Chunk.CodeBase
NamedIdea CodeChunk Source #	Finds the term (`NP`) of the `QuantityDict` used to make the `CodeChunk`.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods term :: Lens' CodeChunk NP #
MayHaveUnit CodeChunk Source #	Finds the units of the `QuantityDict` used to make the `CodeChunk`.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods getUnit :: CodeChunk -> Maybe UnitDefn #
Idea CodeChunk Source #	Finds the idea contained in the `QuantityDict` used to make the `CodeChunk`.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods getA :: CodeChunk -> Maybe String #
HasSpace CodeChunk Source #	Finds the `Space` of the `QuantityDict` used to make the `CodeChunk`.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods typ :: Lens' CodeChunk Space #
HasSymbol CodeChunk Source #	Finds the `Stage` dependent `Symbol` of the `QuantityDict` used to make the `CodeChunk`.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods symbol :: CodeChunk -> Stage -> Symbol #
HasUID CodeChunk Source #	Finds the `UID` of the `QuantityDict` used to make the `CodeChunk`.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods uid :: Lens' CodeChunk UID #

qc :: Lens' CodeChunk QuantityDict Source #

data CodeVarChunk Source #

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

Eq CodeVarChunk Source #	Equal if `UID`s are equal.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods (==) :: CodeVarChunk -> CodeVarChunk -> Bool # (/=) :: CodeVarChunk -> CodeVarChunk -> Bool #
Quantity CodeVarChunk Source #	`CodeVarChunk`s have a `Quantity`.
Instance details Defined in Language.Drasil.Chunk.CodeBase
NamedIdea CodeVarChunk Source #	Finds the term (`NP`) of the `CodeChunk` used to make the `CodeVarChunk`.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods term :: Lens' CodeVarChunk NP #
MayHaveUnit CodeVarChunk Source #	Finds the units of the `CodeChunk` used to make the `CodeVarChunk`.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods getUnit :: CodeVarChunk -> Maybe UnitDefn #
Idea CodeVarChunk Source #	Finds the idea contained in the `CodeChunk` used to make the `CodeVarChunk`.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods getA :: CodeVarChunk -> Maybe String #
HasSpace CodeVarChunk Source #	Finds the `Space` of the `CodeChunk` used to make the `CodeVarChunk`.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods typ :: Lens' CodeVarChunk Space #
HasSymbol CodeVarChunk Source #	Finds the `Stage` dependent `Symbol` of the `CodeChunk` used to make the `CodeVarChunk`.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods symbol :: CodeVarChunk -> Stage -> Symbol #
HasUID CodeVarChunk Source #	Finds the `UID` of the `CodeChunk` used to make the `CodeVarChunk`.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods uid :: Lens' CodeVarChunk UID #

obv :: Lens' CodeVarChunk (Maybe CodeChunk) Source #

ccv :: Lens' CodeVarChunk CodeChunk Source #

newtype CodeFuncChunk Source #

Chunk representing a function.

Constructors

CodeFC
Fields _ccf :: CodeChunk

Instances

Instances details

Eq CodeFuncChunk Source #	Equal if `UID`s are equal.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods (==) :: CodeFuncChunk -> CodeFuncChunk -> Bool # (/=) :: CodeFuncChunk -> CodeFuncChunk -> Bool #
Quantity CodeFuncChunk Source #	`CodeFuncChunk`s have a `Quantity`.
Instance details Defined in Language.Drasil.Chunk.CodeBase
NamedIdea CodeFuncChunk Source #	Finds the term (`NP`) of the `CodeChunk` used to make the `CodeFuncChunk`.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods term :: Lens' CodeFuncChunk NP #
MayHaveUnit CodeFuncChunk Source #	Finds the units of the `CodeChunk` used to make the `CodeFuncChunk`.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods getUnit :: CodeFuncChunk -> Maybe UnitDefn #
Callable CodeFuncChunk Source #	Functions are Callable.
Instance details Defined in Language.Drasil.Chunk.CodeBase
Idea CodeFuncChunk Source #	Finds the idea contained in the `CodeChunk` used to make the `CodeFuncChunk`.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods getA :: CodeFuncChunk -> Maybe String #
HasSpace CodeFuncChunk Source #	Finds the `Space` of the `CodeChunk` used to make the `CodeFuncChunk`.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods typ :: Lens' CodeFuncChunk Space #
HasSymbol CodeFuncChunk Source #	Finds the `Stage` dependent `Symbol` of the `CodeChunk` used to make the `CodeFuncChunk`.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods symbol :: CodeFuncChunk -> Stage -> Symbol #
HasUID CodeFuncChunk Source #	Finds the `UID` of the `CodeChunk` used to make the `CodeFuncChunk`.
Instance details Defined in Language.Drasil.Chunk.CodeBase Methods uid :: Lens' CodeFuncChunk UID #

ccf :: Iso' CodeFuncChunk CodeChunk Source #

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

Construct a CodeVarChunk from a Quantity.

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

Construct a CodeFuncChunk from a Quantity.

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).

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

Make a CodeVarChunk from a UID in the ChunkDB.

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

Make a CodeFuncChunk from a UID in the ChunkDB.

listToArray :: CodeVarChunk -> CodeVarChunk Source #