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

Drasil.GProc

Description

re-export smart constructors for external code writing

Synopsis

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 FSModule a = FS (a (Module a)) Source #

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

class (VectorType r, VectorDecl r, VectorThunk r, VectorExpression r, ThunkAssign r, AssignStatement r, DeclStatement r, IOStatement r, StringStatement r, FunctionSym 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, List r, Set r, TypeElim r, VariableElim r, MethodSym r, ScopeSym r) => SharedProg r Source #

class (SharedProg r, ProgramSym r) => ProcProg 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 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 #

setType :: VSType r -> VSType r Source #

arrayType :: VSType r -> VSType r Source #

listInnerType :: VSType r -> 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 DeclStatement r => VectorDecl r where Source #

Methods

vecDec :: Integer -> SVariable r -> r (Scope r) -> MSStatement r Source #

vecDecDef :: SVariable r -> r (Scope 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 #

emptyStmt :: 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, ScopeSym r) => DeclStatement r where Source #

Methods

varDec :: SVariable r -> r (Scope r) -> MSStatement r Source #

varDecDef :: SVariable r -> r (Scope r) -> SValue r -> MSStatement r Source #

listDec :: Integer -> SVariable r -> r (Scope r) -> MSStatement r Source #

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

setDec :: SVariable r -> r (Scope r) -> MSStatement r Source #

setDecDef :: SVariable r -> r (Scope r) -> SValue r -> MSStatement r Source #

arrayDec :: Integer -> SVariable r -> r (Scope r) -> MSStatement r Source #

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

constDecDef :: SVariable r -> r (Scope r) -> SValue r -> MSStatement r Source #

funcDecDef :: SVariable r -> r (Scope r) -> [SVariable r] -> MSBody 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 #

extInOutCall :: Library -> InOutCall r Source #

class StatementSym r => CommentStatement r where Source #

Methods

comment :: Comment -> 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 #

String of if-else statements. Arguments: List of predicates and bodies (if this then that), Body for else branch

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 #

assert :: SValue r -> SValue 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 #

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

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

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

class ScopeSym r where Source #

Associated Types

type Scope r Source #

Methods

global :: r (Scope r) Source #

mainFn :: r (Scope r) Source #

local :: r (Scope r) Source #

class VariableSym r => VariableElim r where Source #

Methods

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

variableType :: r (Variable r) -> r (Type r) 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 #

litSet :: 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 #

extFuncAppMixedArgs :: Library -> MixedCall r Source #

libFuncAppMixedArgs :: Library -> MixedCall 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 #

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

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

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

class ValueSym r => FunctionSym r Source #

Associated Types

type Function r Source #

class ValueSym r => List r where Source #

Methods

intToIndex :: SValue r -> SValue r Source #

Does any necessary conversions from GOOL's zero-indexed assumptions to the target language's assumptions

indexToInt :: SValue r -> SValue r Source #

Does any necessary conversions from the target language's indexing assumptions assumptions to GOOL's zero-indexed assumptions

listSize :: SValue r -> SValue r Source #

Finds the size of a list. Arguments are: List

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

Inserts a value into a list. Arguments are: List, Index, Value

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

Appens a value to a list. Arguments are: List, Value

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

Gets the value of an index of a list. Arguments are: List, Index

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

Sets the value of an index of a list. Arguments are: List, Index, Value

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

Finds the index of the first occurrence of a value in a list. Arguments are: List, Value

class ValueSym r => Set r where Source #

Methods

contains :: SValue r -> SValue r -> SValue r Source #

Checks membership Arguments are: Set, Value

setAdd :: SValue r -> SValue r -> SValue r Source #

Inserts a value into a set Arguments are: Set, Value

setRemove :: SValue r -> SValue r -> SValue r Source #

Removes a value from a set Arguments are: Set, Value

setUnion :: SValue r -> SValue r -> SValue r Source #

Removes a value from a set Arguments are: Set, Set

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

Creates a slice of a list and assigns it to a variable. Arguments are: Variable to assign List to read from (optional) Start index inclusive. (if Nothing, then list start if step > 0, list end if step < 0) (optional) End index exclusive. (if Nothing, then list end if step > 0, list start if step > 0) (optional) Step (if Nothing, then defaults to 1)

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

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

class VisibilitySym r where Source #

Associated Types

type Visibility r Source #

Methods

private :: r (Visibility r) Source #

public :: r (Visibility 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, VisibilitySym r) => MethodSym r where Source #

Associated Types

type Method r Source #

Methods

docMain :: MSBody r -> SMethod r Source #

function :: Label -> r (Visibility 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 #

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

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

class MethodSym r => ModuleSym r where Source #

Associated Types

type Module r Source #

Methods

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

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

data ProgData Source #

data FileData Source #

data ModData Source #

data VisibilityTag Source #

Constructors

Pub 
Priv 

Instances

Instances details
Eq VisibilityTag Source # 
Instance details

Defined in Drasil.GOOL.AST

Methods

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

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

data CodeType Source #

Constructors

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

Instances

Instances details
Show CodeType Source # 
Instance details

Defined in Drasil.GOOL.CodeType

Methods

showsPrec :: Int -> CodeType -> ShowS #

show :: CodeType -> String #

showList :: [CodeType] -> ShowS #

Eq CodeType Source # 
Instance details

Defined in Drasil.GOOL.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 :: CodeInfoProc a -> a Source #

unJLC :: JuliaCode a -> a Source #

jlName :: String Source #

jlVersion :: String Source #