Safe Haskell	Safe-Inferred
Language	Haskell2010

Drasil.Code.CodeVar

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 :: DefinedQuantityDict
- kind :: VarOrFunc
}
qc :: Lens' CodeChunk DefinedQuantityDict
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
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 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 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 DefinedQuantityDict and the kind of code (variable or function).

Constructors

CodeC
Fields _qc :: DefinedQuantityDict kind :: VarOrFunc

Instances

Instances details

HasUID CodeChunk Source #	Finds the `UID` of the `DefinedQuantityDict` used to make the `CodeChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods uid :: Getter CodeChunk UID Source #
Idea CodeChunk Source #	Finds the idea contained in the `DefinedQuantityDict` used to make the `CodeChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods getA :: CodeChunk -> Maybe String Source #
NamedIdea CodeChunk Source #	Finds the term (`NP`) of the `DefinedQuantityDict` used to make the `CodeChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods term :: Lens' CodeChunk NP Source #
MayHaveUnit CodeChunk Source #	Finds the units of the `DefinedQuantityDict` used to make the `CodeChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods getUnit :: CodeChunk -> Maybe UnitDefn Source #
ConceptDomain CodeChunk Source #
Instance details Defined in Drasil.Code.CodeVar Methods cdom :: CodeChunk -> [UID] Source #
Definition CodeChunk Source #	Finds the Definition contained in the `DefinedQuantityDict` used to make the CodeChunk
Instance details Defined in Drasil.Code.CodeVar Methods defn :: Lens' CodeChunk Sentence Source #
Quantity CodeChunk Source #	`CodeChunk`s have a `Quantity`.
Instance details Defined in Drasil.Code.CodeVar
HasSpace CodeChunk Source #	Finds the `Space` of the `DefinedQuantityDict` used to make the `CodeChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods typ :: Getter CodeChunk Space Source #
HasSymbol CodeChunk Source #	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 Source #
Eq CodeChunk Source #	Equal if `UID`s are equal.
Instance details Defined in Drasil.Code.CodeVar Methods (==) :: CodeChunk -> CodeChunk -> Bool # (/=) :: CodeChunk -> CodeChunk -> Bool #

qc :: Lens' CodeChunk DefinedQuantityDict 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

HasUID CodeVarChunk Source #	Finds the `UID` of the `CodeChunk` used to make the `CodeVarChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods uid :: Getter CodeVarChunk UID Source #
Idea CodeVarChunk Source #	Finds the idea contained in the `CodeChunk` used to make the `CodeVarChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods getA :: CodeVarChunk -> Maybe String Source #
NamedIdea CodeVarChunk Source #	Finds the term (`NP`) of the `CodeChunk` used to make the `CodeVarChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods term :: Lens' CodeVarChunk NP Source #
MayHaveUnit CodeVarChunk Source #	Finds the units of the `CodeChunk` used to make the `CodeVarChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods getUnit :: CodeVarChunk -> Maybe UnitDefn Source #
ConceptDomain CodeVarChunk Source #
Instance details Defined in Drasil.Code.CodeVar Methods cdom :: CodeVarChunk -> [UID] Source #
Definition CodeVarChunk Source #
Instance details Defined in Drasil.Code.CodeVar Methods defn :: Lens' CodeVarChunk Sentence Source #
Quantity CodeVarChunk Source #	`CodeVarChunk`s have a `Quantity`.
Instance details Defined in Drasil.Code.CodeVar
HasSpace CodeVarChunk Source #	Finds the `Space` of the `CodeChunk` used to make the `CodeVarChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods typ :: Getter CodeVarChunk Space Source #
HasSymbol CodeVarChunk Source #	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 Source #
Eq CodeVarChunk Source #	Equal if `UID`s are equal.
Instance details Defined in Drasil.Code.CodeVar Methods (==) :: CodeVarChunk -> CodeVarChunk -> Bool # (/=) :: CodeVarChunk -> CodeVarChunk -> Bool #

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

Callable CodeFuncChunk Source #	Functions are Callable.
Instance details Defined in Drasil.Code.CodeVar
HasUID CodeFuncChunk Source #	Finds the `UID` of the `CodeChunk` used to make the `CodeFuncChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods uid :: Getter CodeFuncChunk UID Source #
Idea CodeFuncChunk Source #	Finds the idea contained in the `CodeChunk` used to make the `CodeFuncChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods getA :: CodeFuncChunk -> Maybe String Source #
NamedIdea CodeFuncChunk Source #	Finds the term (`NP`) of the `CodeChunk` used to make the `CodeFuncChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods term :: Lens' CodeFuncChunk NP Source #
MayHaveUnit CodeFuncChunk Source #	Finds the units of the `CodeChunk` used to make the `CodeFuncChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods getUnit :: CodeFuncChunk -> Maybe UnitDefn Source #
ConceptDomain CodeFuncChunk Source #	Finds the ConceptDomain of the `CodeChunk` used to make the `CodeFuncChunk`
Instance details Defined in Drasil.Code.CodeVar Methods cdom :: CodeFuncChunk -> [UID] Source #
Definition CodeFuncChunk Source #	Finds the Definition of the `CodeChunk` used to make the `CodeFuncChunk`
Instance details Defined in Drasil.Code.CodeVar Methods defn :: Lens' CodeFuncChunk Sentence Source #
Quantity CodeFuncChunk Source #	`CodeFuncChunk`s have a `Quantity`.
Instance details Defined in Drasil.Code.CodeVar
HasSpace CodeFuncChunk Source #	Finds the `Space` of the `CodeChunk` used to make the `CodeFuncChunk`.
Instance details Defined in Drasil.Code.CodeVar Methods typ :: Getter CodeFuncChunk Space Source #
HasSymbol CodeFuncChunk Source #	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 Source #
Eq CodeFuncChunk Source #	Equal if `UID`s are equal.
Instance details Defined in Drasil.Code.CodeVar Methods (==) :: CodeFuncChunk -> CodeFuncChunk -> Bool # (/=) :: CodeFuncChunk -> CodeFuncChunk -> Bool #

ccf :: Iso' CodeFuncChunk CodeChunk Source #

listToArray :: CodeVarChunk -> CodeVarChunk Source #