drasil-gool-0.1.1.0: A framework for code and document generation for scientific software - GOOL SubPackage
Safe HaskellSafe-Inferred
LanguageHaskell2010

GOOL.Drasil

Description

re-export smart constructors for external code writing

Documentation

type Label = String Source #

type GSProgram a = GS (a (Program a)) Source #

type SFile a = FS (a (File a)) Source #

type MSBody a = MS (a (Body a)) Source #

type MSBlock a = MS (a (Block a)) Source #

type VSType a = VS (a (Type a)) Source #

type SVariable a = VS (a (Variable a)) Source #

type SValue a = VS (a (Value a)) Source #

type VSFunction a = VS (a (Function a)) Source #

type MSStatement a = MS (a (Statement a)) Source #

type MSParameter a = MS (a (Parameter a)) Source #

type SMethod a = MS (a (Method a)) Source #

type CSStateVar a = CS (a (StateVar a)) Source #

type SClass a = CS (a (Class a)) Source #

type FSModule a = FS (a (Module a)) Source #

type NamedArgs r = [(SVariable r, SValue r)] Source #

type Initializers r = [(SVariable r, SValue r)] Source #

class (ProgramSym r, VectorType r, VectorDecl r, VectorThunk r, VectorExpression r, ThunkAssign r, AssignStatement r, DeclStatement r, IOStatement r, StringStatement r, FuncAppStatement r, CommentStatement r, ControlStatement r, InternalList r, Argument r, Literal r, MathConstant r, VariableValue r, CommandLineArgs r, NumericExpression r, BooleanExpression r, Comparison r, ValueExpression r, InternalValueExp r, GetSet r, List r, StatePattern r, ObserverPattern r, StrategyPattern r, TypeElim r, VariableElim r) => OOProg r Source #

class FileSym r => ProgramSym r where Source #

Associated Types

type Program r Source #

Methods

prog :: Label -> Label -> [SFile r] -> GSProgram r Source #

class ModuleSym r => FileSym r where Source #

Associated Types

type File r Source #

Methods

fileDoc :: FSModule r -> SFile r Source #

docMod :: String -> [String] -> String -> SFile r -> SFile r Source #

class PermanenceSym r where Source #

Associated Types

type Permanence r Source #

Methods

static :: r (Permanence r) Source #

dynamic :: r (Permanence r) Source #

class BlockSym r => BodySym r where Source #

Associated Types

type Body r Source #

Methods

body :: [MSBlock r] -> MSBody r Source #

addComments :: Label -> MSBody r -> MSBody r Source #

bodyStatements :: BodySym r => [MSStatement r] -> MSBody r Source #

oneLiner :: BodySym r => MSStatement r -> MSBody r Source #

class StatementSym r => BlockSym r where Source #

Associated Types

type Block r Source #

Methods

block :: [MSStatement r] -> MSBlock r Source #

class TypeSym r where Source #

Associated Types

type Type r Source #

Methods

bool :: VSType r Source #

int :: VSType r Source #

float :: VSType r Source #

double :: VSType r Source #

char :: VSType r Source #

string :: VSType r Source #

infile :: VSType r Source #

outfile :: VSType r Source #

listType :: VSType r -> VSType r Source #

arrayType :: VSType r -> VSType r Source #

listInnerType :: VSType r -> VSType r Source #

obj :: ClassName -> VSType r Source #

funcType :: [VSType r] -> VSType r -> VSType r Source #

void :: VSType r Source #

class TypeSym r => TypeElim r where Source #

Methods

getType :: r (Type r) -> CodeType Source #

getTypeString :: r (Type r) -> String Source #

class ThunkSym r Source #

Associated Types

type Thunk (r :: Type -> Type) Source #

class TypeSym r => VectorType r where Source #

Methods

vecType :: VSType r -> VSType r Source #

class (VariableSym r, StatementSym r) => VectorDecl r where Source #

Methods

vecDec :: Integer -> SVariable r -> MSStatement r Source #

vecDecDef :: SVariable r -> [SValue r] -> MSStatement r Source #

class (VariableSym r, ThunkSym r) => VectorThunk r where Source #

Methods

vecThunk :: SVariable r -> VSThunk r Source #

class (ThunkSym r, ValueSym r) => VectorExpression r where Source #

Methods

vecScale :: SValue r -> VSThunk r -> VSThunk r Source #

vecAdd :: VSThunk r -> VSThunk r -> VSThunk r Source #

vecIndex :: SValue r -> VSThunk r -> SValue r Source #

vecDot :: VSThunk r -> VSThunk r -> VSThunk r Source #

class (VariableSym r, ThunkSym r, StatementSym r) => ThunkAssign r where Source #

Methods

thunkAssign :: SVariable r -> VSThunk r -> MSStatement r Source #

class ValueSym r => StatementSym r where Source #

Associated Types

type Statement r Source #

Methods

valStmt :: SValue r -> MSStatement r Source #

multi :: [MSStatement r] -> MSStatement r Source #

class (VariableSym r, StatementSym r) => AssignStatement r where Source #

Methods

(&-=) :: SVariable r -> SValue r -> MSStatement r infixl 1 Source #

(&+=) :: SVariable r -> SValue r -> MSStatement r infixl 1 Source #

(&++) :: SVariable r -> MSStatement r infixl 8 Source #

(&--) :: SVariable r -> MSStatement r infixl 8 Source #

assign :: SVariable r -> SValue r -> MSStatement r Source #

(&=) :: AssignStatement r => SVariable r -> SValue r -> MSStatement r infixr 1 Source #

assignToListIndex :: (StatementSym r, VariableValue r, List r) => SVariable r -> SValue r -> SValue r -> MSStatement r Source #

class (VariableSym r, StatementSym r) => DeclStatement r where Source #

Methods

varDec :: SVariable r -> MSStatement r Source #

varDecDef :: SVariable r -> SValue r -> MSStatement r Source #

listDec :: Integer -> SVariable r -> MSStatement r Source #

listDecDef :: SVariable r -> [SValue r] -> MSStatement r Source #

arrayDec :: Integer -> SVariable r -> MSStatement r Source #

arrayDecDef :: SVariable r -> [SValue r] -> MSStatement r Source #

objDecDef :: SVariable r -> SValue r -> MSStatement r Source #

objDecNew :: SVariable r -> [SValue r] -> MSStatement r Source #

extObjDecNew :: Library -> SVariable r -> [SValue r] -> MSStatement r Source #

constDecDef :: SVariable r -> SValue r -> MSStatement r Source #

funcDecDef :: SVariable r -> [SVariable r] -> MSBody r -> MSStatement r Source #

objDecNewNoParams :: DeclStatement r => SVariable r -> MSStatement r Source #

extObjDecNewNoParams :: DeclStatement r => Library -> SVariable r -> MSStatement r Source #

class (VariableSym r, StatementSym r) => IOStatement r where Source #

Methods

print :: SValue r -> MSStatement r Source #

printLn :: SValue r -> MSStatement r Source #

printStr :: String -> MSStatement r Source #

printStrLn :: String -> MSStatement r Source #

printFile :: SValue r -> SValue r -> MSStatement r Source #

printFileLn :: SValue r -> SValue r -> MSStatement r Source #

printFileStr :: SValue r -> String -> MSStatement r Source #

printFileStrLn :: SValue r -> String -> MSStatement r Source #

getInput :: SVariable r -> MSStatement r Source #

discardInput :: MSStatement r Source #

getFileInput :: SValue r -> SVariable r -> MSStatement r Source #

discardFileInput :: SValue r -> MSStatement r Source #

openFileR :: SVariable r -> SValue r -> MSStatement r Source #

openFileW :: SVariable r -> SValue r -> MSStatement r Source #

openFileA :: SVariable r -> SValue r -> MSStatement r Source #

closeFile :: SValue r -> MSStatement r Source #

getFileInputLine :: SValue r -> SVariable r -> MSStatement r Source #

discardFileLine :: SValue r -> MSStatement r Source #

getFileInputAll :: SValue r -> SVariable r -> MSStatement r Source #

class (VariableSym r, StatementSym r) => StringStatement r where Source #

Methods

stringSplit :: Char -> SVariable r -> SValue r -> MSStatement r Source #

stringListVals :: [SVariable r] -> SValue r -> MSStatement r Source #

stringListLists :: [SVariable r] -> SValue r -> MSStatement r Source #

class (VariableSym r, StatementSym r) => FuncAppStatement r where Source #

Methods

inOutCall :: InOutCall r Source #

selfInOutCall :: InOutCall r Source #

extInOutCall :: Library -> InOutCall r Source #

class StatementSym r => CommentStatement r where Source #

Methods

comment :: Comment -> MSStatement r Source #

initState :: (DeclStatement r, Literal r) => Label -> Label -> MSStatement r Source #

changeState :: (AssignStatement r, Literal r) => Label -> Label -> MSStatement r Source #

initObserverList :: DeclStatement r => VSType r -> [SValue r] -> MSStatement r Source #

addObserver :: (StatementSym r, VariableValue r, List r) => SValue r -> MSStatement r Source #

class (BodySym r, VariableSym r) => ControlStatement r where Source #

Methods

break :: MSStatement r Source #

continue :: MSStatement r Source #

returnStmt :: SValue r -> MSStatement r Source #

throw :: Label -> MSStatement r Source #

ifCond :: [(SValue r, MSBody r)] -> MSBody r -> MSStatement r Source #

switch :: SValue r -> [(SValue r, MSBody r)] -> MSBody r -> MSStatement r Source #

ifExists :: SValue r -> MSBody r -> MSBody r -> MSStatement r Source #

for :: MSStatement r -> SValue r -> MSStatement r -> MSBody r -> MSStatement r Source #

forRange :: SVariable r -> SValue r -> SValue r -> SValue r -> MSBody r -> MSStatement r Source #

forEach :: SVariable r -> SValue r -> MSBody r -> MSStatement r Source #

while :: SValue r -> MSBody r -> MSStatement r Source #

tryCatch :: MSBody r -> MSBody r -> MSStatement r Source #

ifNoElse :: ControlStatement r => [(SValue r, MSBody r)] -> MSStatement r Source #

switchAsIf :: (ControlStatement r, Comparison r) => SValue r -> [(SValue r, MSBody r)] -> MSBody r -> MSStatement r Source #

class TypeSym r => VariableSym r where Source #

Associated Types

type Variable r Source #

Methods

var :: Label -> VSType r -> SVariable r Source #

staticVar :: Label -> VSType r -> SVariable r Source #

constant :: Label -> VSType r -> SVariable r Source #

extVar :: Library -> Label -> VSType r -> SVariable r Source #

self :: SVariable r Source #

classVar :: VSType r -> SVariable r -> SVariable r Source #

extClassVar :: VSType r -> SVariable r -> SVariable r Source #

objVar :: SVariable r -> SVariable r -> SVariable r Source #

objVarSelf :: SVariable r -> SVariable r Source #

arrayElem :: Integer -> SVariable r -> SVariable r Source #

class VariableSym r => VariableElim r where Source #

Methods

variableName :: r (Variable r) -> String Source #

variableType :: r (Variable r) -> r (Type r) Source #

($->) :: VariableSym r => SVariable r -> SVariable r -> SVariable r infixl 9 Source #

listOf :: VariableSym r => Label -> VSType r -> SVariable r Source #

listVar :: VariableSym r => Label -> VSType r -> SVariable r Source #

class TypeSym r => ValueSym r where Source #

Associated Types

type Value r Source #

Methods

valueType :: r (Value r) -> r (Type r) Source #

class ValueSym r => Argument r where Source #

Methods

pointerArg :: SValue r -> SValue r Source #

class ValueSym r => Literal r where Source #

Methods

litTrue :: SValue r Source #

litFalse :: SValue r Source #

litChar :: Char -> SValue r Source #

litDouble :: Double -> SValue r Source #

litFloat :: Float -> SValue r Source #

litInt :: Integer -> SValue r Source #

litString :: String -> SValue r Source #

litArray :: VSType r -> [SValue r] -> SValue r Source #

litList :: VSType r -> [SValue r] -> SValue r Source #

class ValueSym r => MathConstant r where Source #

Methods

pi :: SValue r Source #

class (VariableSym r, ValueSym r) => VariableValue r where Source #

Methods

valueOf :: SVariable r -> SValue r Source #

class ValueSym r => CommandLineArgs r where Source #

Methods

arg :: Integer -> SValue r Source #

argsList :: SValue r Source #

argExists :: Integer -> SValue r Source #

class ValueSym r => NumericExpression r where Source #

Methods

(#~) :: SValue r -> SValue r infixl 8 Source #

(#/^) :: SValue r -> SValue r infixl 7 Source #

(#|) :: SValue r -> SValue r infixl 7 Source #

(#+) :: SValue r -> SValue r -> SValue r infixl 5 Source #

(#-) :: SValue r -> SValue r -> SValue r infixl 5 Source #

(#*) :: SValue r -> SValue r -> SValue r infixl 6 Source #

(#/) :: SValue r -> SValue r -> SValue r infixl 6 Source #

(#%) :: SValue r -> SValue r -> SValue r infixl 6 Source #

(#^) :: SValue r -> SValue r -> SValue r infixl 7 Source #

log :: SValue r -> SValue r Source #

ln :: SValue r -> SValue r Source #

exp :: SValue r -> SValue r Source #

sin :: SValue r -> SValue r Source #

cos :: SValue r -> SValue r Source #

tan :: SValue r -> SValue r Source #

csc :: SValue r -> SValue r Source #

sec :: SValue r -> SValue r Source #

cot :: SValue r -> SValue r Source #

arcsin :: SValue r -> SValue r Source #

arccos :: SValue r -> SValue r Source #

arctan :: SValue r -> SValue r Source #

floor :: SValue r -> SValue r Source #

ceil :: SValue r -> SValue r Source #

class ValueSym r => BooleanExpression r where Source #

Methods

(?!) :: SValue r -> SValue r infixr 6 Source #

(?&&) :: SValue r -> SValue r -> SValue r infixl 2 Source #

(?||) :: SValue r -> SValue r -> SValue r infixl 1 Source #

class ValueSym r => Comparison r where Source #

Methods

(?<) :: SValue r -> SValue r -> SValue r infixl 4 Source #

(?<=) :: SValue r -> SValue r -> SValue r infixl 4 Source #

(?>) :: SValue r -> SValue r -> SValue r infixl 4 Source #

(?>=) :: SValue r -> SValue r -> SValue r infixl 4 Source #

(?==) :: SValue r -> SValue r -> SValue r infixl 3 Source #

(?!=) :: SValue r -> SValue r -> SValue r infixl 3 Source #

class (VariableSym r, ValueSym r) => ValueExpression r where Source #

Methods

inlineIf :: SValue r -> SValue r -> SValue r -> SValue r Source #

funcAppMixedArgs :: MixedCall r Source #

selfFuncAppMixedArgs :: MixedCall r Source #

extFuncAppMixedArgs :: Library -> MixedCall r Source #

libFuncAppMixedArgs :: Library -> MixedCall r Source #

newObjMixedArgs :: MixedCtorCall r Source #

extNewObjMixedArgs :: Library -> MixedCtorCall r Source #

libNewObjMixedArgs :: Library -> MixedCtorCall r Source #

lambda :: [SVariable r] -> SValue r -> SValue r Source #

notNull :: SValue r -> SValue r Source #

funcApp :: ValueExpression r => PosCall r Source #

funcAppNamedArgs :: ValueExpression r => Label -> VSType r -> NamedArgs r -> SValue r Source #

selfFuncApp :: ValueExpression r => PosCall r Source #

extFuncApp :: ValueExpression r => Library -> PosCall r Source #

libFuncApp :: ValueExpression r => Library -> PosCall r Source #

newObj :: ValueExpression r => PosCtorCall r Source #

extNewObj :: ValueExpression r => Library -> PosCtorCall r Source #

libNewObj :: ValueExpression r => Library -> PosCtorCall r Source #

exists :: ValueExpression r => SValue r -> SValue r Source #

objMethodCallMixedArgs :: InternalValueExp r => VSType r -> SValue r -> Label -> [SValue r] -> NamedArgs r -> SValue r Source #

class ValueSym r => FunctionSym r where Source #

Associated Types

type Function r Source #

Methods

func :: Label -> VSType r -> [SValue r] -> VSFunction r Source #

objAccess :: SValue r -> VSFunction r -> SValue r Source #

($.) :: FunctionSym r => SValue r -> VSFunction r -> SValue r infixl 9 Source #

selfAccess :: (VariableValue r, FunctionSym r) => VSFunction r -> SValue r Source #

class (ValueSym r, VariableSym r) => GetSet r where Source #

Methods

get :: SValue r -> SVariable r -> SValue r Source #

set :: SValue r -> SVariable r -> SValue r -> SValue r Source #

class ValueSym r => List r where Source #

Methods

listSize :: SValue r -> SValue r Source #

listAdd :: SValue r -> SValue r -> SValue r -> SValue r Source #

listAppend :: SValue r -> SValue r -> SValue r Source #

listAccess :: SValue r -> SValue r -> SValue r Source #

listSet :: SValue r -> SValue r -> SValue r -> SValue r Source #

indexOf :: SValue r -> SValue r -> SValue r Source #

listSlice :: InternalList r => SVariable r -> SValue r -> Maybe (SValue r) -> Maybe (SValue r) -> Maybe (SValue r) -> MSBlock r Source #

listIndexExists :: (List r, Comparison r) => SValue r -> SValue r -> SValue r Source #

at :: List r => SValue r -> SValue r -> SValue r Source #

class BodySym r => StatePattern r where Source #

Methods

checkState :: Label -> [(SValue r, MSBody r)] -> MSBody r -> MSStatement r Source #

class (StatementSym r, FunctionSym r) => ObserverPattern r where Source #

Methods

notifyObservers :: VSFunction r -> VSType r -> MSStatement r Source #

class (BodySym r, VariableSym r) => StrategyPattern r where Source #

Methods

runStrategy :: Label -> [(Label, MSBody r)] -> Maybe (SValue r) -> Maybe (SVariable r) -> MSBlock r Source #

class ScopeSym r where Source #

Associated Types

type Scope r Source #

Methods

private :: r (Scope r) Source #

public :: r (Scope r) Source #

class VariableSym r => ParameterSym r where Source #

Associated Types

type Parameter r Source #

Methods

param :: SVariable r -> MSParameter r Source #

pointerParam :: SVariable r -> MSParameter r Source #

class (BodySym r, ParameterSym r, ScopeSym r, PermanenceSym r) => MethodSym r where Source #

Associated Types

type Method r Source #

Methods

method :: Label -> r (Scope r) -> r (Permanence r) -> VSType r -> [MSParameter r] -> MSBody r -> SMethod r Source #

getMethod :: SVariable r -> SMethod r Source #

setMethod :: SVariable r -> SMethod r Source #

constructor :: [MSParameter r] -> Initializers r -> MSBody r -> SMethod r Source #

docMain :: MSBody r -> SMethod r Source #

function :: Label -> r (Scope r) -> VSType r -> [MSParameter r] -> MSBody r -> SMethod r Source #

mainFunction :: MSBody r -> SMethod r Source #

docFunc :: String -> [String] -> Maybe String -> SMethod r -> SMethod r Source #

inOutMethod :: Label -> r (Scope r) -> r (Permanence r) -> InOutFunc r Source #

docInOutMethod :: Label -> r (Scope r) -> r (Permanence r) -> DocInOutFunc r Source #

inOutFunc :: Label -> r (Scope r) -> InOutFunc r Source #

docInOutFunc :: Label -> r (Scope r) -> DocInOutFunc r Source #

privMethod :: MethodSym r => Label -> VSType r -> [MSParameter r] -> MSBody r -> SMethod r Source #

pubMethod :: MethodSym r => Label -> VSType r -> [MSParameter r] -> MSBody r -> SMethod r Source #

initializer :: MethodSym r => [MSParameter r] -> Initializers r -> SMethod r Source #

nonInitConstructor :: MethodSym r => [MSParameter r] -> MSBody r -> SMethod r Source #

class (ScopeSym r, PermanenceSym r, VariableSym r) => StateVarSym r where Source #

Associated Types

type StateVar r Source #

Methods

stateVar :: r (Scope r) -> r (Permanence r) -> SVariable r -> CSStateVar r Source #

stateVarDef :: r (Scope r) -> r (Permanence r) -> SVariable r -> SValue r -> CSStateVar r Source #

constVar :: r (Scope r) -> SVariable r -> SValue r -> CSStateVar r Source #

privDVar :: StateVarSym r => SVariable r -> CSStateVar r Source #

pubDVar :: StateVarSym r => SVariable r -> CSStateVar r Source #

pubSVar :: StateVarSym r => SVariable r -> CSStateVar r Source #

class (MethodSym r, StateVarSym r) => ClassSym r where Source #

Associated Types

type Class r Source #

Methods

buildClass :: Maybe Label -> [CSStateVar r] -> [SMethod r] -> SClass r Source #

extraClass :: Label -> Maybe Label -> [CSStateVar r] -> [SMethod r] -> SClass r Source #

implementingClass :: Label -> [Label] -> [CSStateVar r] -> [SMethod r] -> SClass r Source #

docClass :: String -> SClass r -> SClass r Source #

class ClassSym r => ModuleSym r where Source #

Associated Types

type Module r Source #

Methods

buildModule :: Label -> [Label] -> [SMethod r] -> [SClass r] -> FSModule r Source #

convType :: TypeSym r => CodeType -> VSType r Source #

data ProgData Source #

data FileData Source #

data ModData Source #

data ScopeTag Source #

Constructors

Pub 
Priv 

Instances

Instances details
Eq ScopeTag Source # 
Instance details

Defined in GOOL.Drasil.AST

Methods

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

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

data CodeType Source #

Constructors

Boolean 
Integer 
Float 
Double 
Char 
String 
InFile 
OutFile 
List CodeType 
Array CodeType 
Object ClassName 
Func [CodeType] CodeType 
Void 

Instances

Instances details
Show CodeType Source # 
Instance details

Defined in GOOL.Drasil.CodeType

Methods

showsPrec :: Int -> CodeType -> ShowS #

show :: CodeType -> String #

showList :: [CodeType] -> ShowS #

Eq CodeType Source # 
Instance details

Defined in GOOL.Drasil.CodeType

Methods

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

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

data GOOLState Source #

Constructors

GS 

Fields

lensMStoVS :: Lens' MethodState ValueState Source #

headers :: Lens' GOOLState [FilePath] Source #

sources :: Lens' GOOLState [FilePath] Source #

mainMod :: Lens' GOOLState (Maybe FilePath) Source #

initialState :: GOOLState Source #

onStateValue :: (a -> b) -> State s a -> State s b Source #

onCodeList :: Monad m => ([a] -> b) -> [m a] -> m b Source #

unCI :: CodeInfo a -> a Source #

unPC :: PythonCode a -> a Source #

unJC :: JavaCode a -> a Source #

unCSC :: CSharpCode a -> a Source #

unCPPC :: CppCode CppSrcCode CppHdrCode a -> a Source #

unSC :: SwiftCode a -> a Source #

pyName :: String Source #

pyVersion :: String Source #

jName :: String Source #

jVersion :: String Source #

csName :: String Source #

csVersion :: String Source #

cppName :: String Source #

cppVersion :: String Source #

swiftName :: String Source #

swiftVersion :: String Source #