drasil-lang-0.1.60.0: A framework for code and document generation for scientific software - Language SubPackage
Safe HaskellNone
LanguageGHC2024

Drasil.Code.CodeVar

Description

Defines chunk types for use in code generation.

Synopsis

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 #

data VarOrFunc Source #

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

Constructors

Var 
Func 

Instances

Instances details
HasChunkRefs VarOrFunc Source # 
Instance details

Defined in Drasil.Code.CodeVar

Methods

chunkRefs :: VarOrFunc -> Set UID #

Generic VarOrFunc Source # 
Instance details

Defined in Drasil.Code.CodeVar

Associated Types

type Rep VarOrFunc 
Instance details

Defined in Drasil.Code.CodeVar

type Rep VarOrFunc = D1 ('MetaData "VarOrFunc" "Drasil.Code.CodeVar" "drasil-lang-0.1.60.0-1HMwkmtaiHpDlCGzFv9lso" 'False) (C1 ('MetaCons "Var" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Func" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: VarOrFunc -> Rep VarOrFunc x #

to :: Rep VarOrFunc x -> VarOrFunc #

type Rep VarOrFunc Source # 
Instance details

Defined in Drasil.Code.CodeVar

type Rep VarOrFunc = D1 ('MetaData "VarOrFunc" "Drasil.Code.CodeVar" "drasil-lang-0.1.60.0-1HMwkmtaiHpDlCGzFv9lso" 'False) (C1 ('MetaCons "Var" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Func" 'PrefixI 'False) (U1 :: Type -> Type))

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

Instances

Instances details
HasChunkRefs CodeChunk Source # 
Instance details

Defined in Drasil.Code.CodeVar

Methods

chunkRefs :: CodeChunk -> Set UID #

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 #

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 #

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 #

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 #

Generic CodeChunk Source # 
Instance details

Defined in Drasil.Code.CodeVar

Associated Types

type Rep CodeChunk 
Instance details

Defined in Drasil.Code.CodeVar

type Rep CodeChunk = D1 ('MetaData "CodeChunk" "Drasil.Code.CodeVar" "drasil-lang-0.1.60.0-1HMwkmtaiHpDlCGzFv9lso" 'False) (C1 ('MetaCons "CodeC" 'PrefixI 'True) (S1 ('MetaSel ('Just "_qc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DefinedQuantityDict) :*: S1 ('MetaSel ('Just "kind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VarOrFunc)))

Methods

from :: CodeChunk -> Rep CodeChunk x #

to :: Rep CodeChunk x -> CodeChunk #

Eq CodeChunk Source #

Equal if UIDs are equal.

Instance details

Defined in Drasil.Code.CodeVar

Methods

(==) :: CodeChunk -> CodeChunk -> Bool #

(/=) :: CodeChunk -> CodeChunk -> Bool #

type Rep CodeChunk Source # 
Instance details

Defined in Drasil.Code.CodeVar

type Rep CodeChunk = D1 ('MetaData "CodeChunk" "Drasil.Code.CodeVar" "drasil-lang-0.1.60.0-1HMwkmtaiHpDlCGzFv9lso" 'False) (C1 ('MetaCons "CodeC" 'PrefixI 'True) (S1 ('MetaSel ('Just "_qc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DefinedQuantityDict) :*: S1 ('MetaSel ('Just "kind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VarOrFunc)))

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

Instances

Instances details
HasChunkRefs CodeVarChunk Source # 
Instance details

Defined in Drasil.Code.CodeVar

Methods

chunkRefs :: CodeVarChunk -> Set UID #

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 #

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 #

Definition CodeVarChunk Source # 
Instance details

Defined in Drasil.Code.CodeVar

Methods

defn :: Lens' CodeVarChunk Sentence Source #

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 #

Generic CodeVarChunk Source # 
Instance details

Defined in Drasil.Code.CodeVar

Associated Types

type Rep CodeVarChunk 
Instance details

Defined in Drasil.Code.CodeVar

type Rep CodeVarChunk = D1 ('MetaData "CodeVarChunk" "Drasil.Code.CodeVar" "drasil-lang-0.1.60.0-1HMwkmtaiHpDlCGzFv9lso" 'False) (C1 ('MetaCons "CodeVC" 'PrefixI 'True) (S1 ('MetaSel ('Just "_ccv") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CodeChunk) :*: S1 ('MetaSel ('Just "_obv") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CodeChunk))))

Methods

from :: CodeVarChunk -> Rep CodeVarChunk x #

to :: Rep CodeVarChunk x -> CodeVarChunk #

Eq CodeVarChunk Source #

Equal if UIDs are equal.

Instance details

Defined in Drasil.Code.CodeVar

Methods

(==) :: CodeVarChunk -> CodeVarChunk -> Bool #

(/=) :: CodeVarChunk -> CodeVarChunk -> Bool #

type Rep CodeVarChunk Source # 
Instance details

Defined in Drasil.Code.CodeVar

type Rep CodeVarChunk = D1 ('MetaData "CodeVarChunk" "Drasil.Code.CodeVar" "drasil-lang-0.1.60.0-1HMwkmtaiHpDlCGzFv9lso" 'False) (C1 ('MetaCons "CodeVC" 'PrefixI 'True) (S1 ('MetaSel ('Just "_ccv") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CodeChunk) :*: S1 ('MetaSel ('Just "_obv") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CodeChunk))))

ccv :: Lens' CodeVarChunk CodeChunk Source #

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

newtype CodeFuncChunk Source #

Chunk representing a function.

Constructors

CodeFC 

Fields

Instances

Instances details
HasChunkRefs CodeFuncChunk Source # 
Instance details

Defined in Drasil.Code.CodeVar

Methods

chunkRefs :: CodeFuncChunk -> Set UID #

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 #

Callable CodeFuncChunk Source #

Functions are Callable.

Instance details

Defined in Drasil.Code.CodeVar

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 #

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 #

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 #

Generic CodeFuncChunk Source # 
Instance details

Defined in Drasil.Code.CodeVar

Associated Types

type Rep CodeFuncChunk 
Instance details

Defined in Drasil.Code.CodeVar

type Rep CodeFuncChunk = D1 ('MetaData "CodeFuncChunk" "Drasil.Code.CodeVar" "drasil-lang-0.1.60.0-1HMwkmtaiHpDlCGzFv9lso" 'True) (C1 ('MetaCons "CodeFC" 'PrefixI 'True) (S1 ('MetaSel ('Just "_ccf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CodeChunk)))

Methods

from :: CodeFuncChunk -> Rep CodeFuncChunk x #

to :: Rep CodeFuncChunk x -> CodeFuncChunk #

Eq CodeFuncChunk Source #

Equal if UIDs are equal.

Instance details

Defined in Drasil.Code.CodeVar

Methods

(==) :: CodeFuncChunk -> CodeFuncChunk -> Bool #

(/=) :: CodeFuncChunk -> CodeFuncChunk -> Bool #

type Rep CodeFuncChunk Source # 
Instance details

Defined in Drasil.Code.CodeVar

type Rep CodeFuncChunk = D1 ('MetaData "CodeFuncChunk" "Drasil.Code.CodeVar" "drasil-lang-0.1.60.0-1HMwkmtaiHpDlCGzFv9lso" 'True) (C1 ('MetaCons "CodeFC" 'PrefixI 'True) (S1 ('MetaSel ('Just "_ccf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CodeChunk)))

ccf :: Iso' CodeFuncChunk CodeChunk Source #

funcPrefix :: String Source #

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

listToArray :: CodeVarChunk -> CodeVarChunk Source #

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.