Safe Haskell	Safe-Inferred
Language	Haskell2010

Drasil.GOOL.LanguageRenderer.CommonPseudoOO

Description

Implementations defined here are valid in some, but not all, language renderers

Synopsis

int :: CommonRenderSym r => VSType r
constructor :: OORenderSym r => Label -> [MSParameter r] -> Initializers r -> MSBody r -> SMethod r
doxFunc :: CommonRenderSym r => String -> [String] -> Maybe String -> SMethod r -> SMethod r
doxClass :: OORenderSym r => String -> SClass r -> SClass r
doxMod :: OORenderSym r => String -> String -> [String] -> String -> SFile r -> SFile r
docMod' :: OORenderSym r => String -> String -> [String] -> String -> SFile r -> SFile r
modDoc' :: ModuleDocRenderer
functionDoc :: FuncDocRenderer
extVar :: CommonRenderSym r => Label -> Label -> VSType r -> SVariable r
classVar :: CommonRenderSym r => (Doc -> Doc -> Doc) -> VSType r -> SVariable r -> SVariable r
objVarSelf :: OORenderSym r => SVariable r -> SVariable r
indexOf :: OORenderSym r => Label -> SValue r -> SValue r -> SValue r
contains :: OORenderSym r => Label -> SValue r -> SValue r -> SValue r
containsInt :: OORenderSym r => Label -> Label -> SValue r -> SValue r -> SValue r
listAddFunc :: OORenderSym r => Label -> SValue r -> SValue r -> VSFunction r
discardFileLine :: OORenderSym r => Label -> SValue r -> MSStatement r
intClass :: (OORenderSym r, Monad r) => (Label -> Doc -> Doc -> Doc -> Doc -> Doc) -> Label -> r (Visibility r) -> r ParentSpec -> [CSStateVar r] -> [SMethod r] -> [SMethod r] -> CS (r Doc)
funcType :: CommonRenderSym r => [VSType r] -> VSType r -> VSType r
buildModule :: OORenderSym r => Label -> FS Doc -> FS Doc -> FS Doc -> [SMethod r] -> [SClass r] -> FSModule r
arrayType :: CommonRenderSym r => VSType r -> VSType r
pi :: CommonRenderSym r => SValue r
printSt :: CommonRenderSym r => SValue r -> SValue r -> MSStatement r
arrayDec :: CommonRenderSym r => SValue r -> SVariable r -> r (Scope r) -> MSStatement r
arrayDecDef :: CommonRenderSym r => SVariable r -> r (Scope r) -> [SValue r] -> MSStatement r
openFileA :: CommonRenderSym r => (SValue r -> VSType r -> SValue r -> SValue r) -> SVariable r -> SValue r -> MSStatement r
forEach :: CommonRenderSym r => Doc -> Doc -> Doc -> Doc -> SVariable r -> SValue r -> MSBody r -> MSStatement r
forEach' :: CommonRenderSym r => (r (Variable r) -> r (Value r) -> r (Body r) -> Doc) -> SVariable r -> SValue r -> MSBody r -> MSStatement r
docMain :: OORenderSym r => MSBody r -> SMethod r
mainFunction :: OORenderSym r => VSType r -> Label -> MSBody r -> SMethod r
buildModule' :: OORenderSym r => Label -> (String -> r (Import r)) -> [Label] -> [SMethod r] -> [SClass r] -> FSModule r
call' :: CommonRenderSym r => String -> Maybe Library -> Maybe Doc -> MixedCall r
listSizeFunc :: OORenderSym r => VSFunction r
listAccessFunc' :: OORenderSym r => Label -> VSType r -> SValue r -> VSFunction r
string :: CommonRenderSym r => VSType r
constDecDef :: CommonRenderSym r => SVariable r -> r (Scope r) -> SValue r -> MSStatement r
docInOutFunc :: CommonRenderSym r => ([SVariable r] -> [SVariable r] -> [SVariable r] -> MSBody r -> SMethod r) -> String -> [(String, SVariable r)] -> [(String, SVariable r)] -> [(String, SVariable r)] -> MSBody r -> SMethod r
bindingError :: String -> String
extFuncAppMixedArgs :: CommonRenderSym r => Library -> MixedCall r
notNull :: CommonRenderSym r => String -> SValue r -> SValue r
listDecDef :: CommonRenderSym r => SVariable r -> r (Scope r) -> [SValue r] -> MSStatement r
destructorError :: String -> String
stateVarDef :: (OORenderSym r, Monad r) => r (Visibility r) -> r (Permanence r) -> SVariable r -> SValue r -> CS (r Doc)
constVar :: (CommonRenderSym r, Monad r) => Doc -> r (Visibility r) -> SVariable r -> SValue r -> CS (r Doc)
litArray :: CommonRenderSym r => (Doc -> Doc) -> VSType r -> [SValue r] -> SValue r
litSet :: CommonRenderSym r => (Doc -> Doc) -> (Doc -> Doc) -> VSType r -> [SValue r] -> SValue r
listSetFunc :: CommonRenderSym r => (Doc -> Doc -> Doc) -> SValue r -> SValue r -> SValue r -> VSFunction r
litSetFunc :: CommonRenderSym r => String -> VSType r -> [SValue r] -> SValue r
extraClass :: OORenderSym r => Label -> Maybe Label -> [CSStateVar r] -> [SMethod r] -> [SMethod r] -> SClass r
listAccessFunc :: CommonRenderSym r => VSType r -> SValue r -> VSFunction r
doubleRender :: String
double :: CommonRenderSym r => VSType r
openFileR :: CommonRenderSym r => (SValue r -> VSType r -> SValue r) -> SVariable r -> SValue r -> MSStatement r
openFileW :: CommonRenderSym r => (SValue r -> VSType r -> SValue r -> SValue r) -> SVariable r -> SValue r -> MSStatement r
stateVar :: (OORenderSym r, Monad r) => r (Visibility r) -> r (Permanence r) -> SVariable r -> CS (r Doc)
self :: OORenderSym r => SVariable r
multiAssign :: CommonRenderSym r => (Doc -> Doc) -> [SVariable r] -> [SValue r] -> MSStatement r
multiReturn :: CommonRenderSym r => (Doc -> Doc) -> [SValue r] -> MSStatement r
listDec :: CommonRenderSym r => SVariable r -> r (Scope r) -> MSStatement r
funcDecDef :: OORenderSym r => SVariable r -> r (Scope r) -> [SVariable r] -> MSBody r -> MSStatement r
inOutCall :: CommonRenderSym r => (Label -> VSType r -> [SValue r] -> SValue r) -> Label -> [SValue r] -> [SVariable r] -> [SVariable r] -> MSStatement r
forLoopError :: String -> String
mainBody :: CommonRenderSym r => MSBody r -> SMethod r
inOutFunc :: CommonRenderSym r => (VSType r -> [MSParameter r] -> MSBody r -> SMethod r) -> [SVariable r] -> [SVariable r] -> [SVariable r] -> MSBody r -> SMethod r
docInOutFunc' :: CommonRenderSym r => FuncDocRenderer -> ([SVariable r] -> [SVariable r] -> [SVariable r] -> MSBody r -> SMethod r) -> String -> [(String, SVariable r)] -> [(String, SVariable r)] -> [(String, SVariable r)] -> MSBody r -> SMethod r
boolRender :: String
bool :: CommonRenderSym r => VSType r
floatRender :: String
float :: CommonRenderSym r => VSType r
stringRender' :: String
string' :: CommonRenderSym r => VSType r
inherit :: Monad r => Maybe Label -> r ParentSpec
implements :: Monad r => [Label] -> r ParentSpec
listSize :: CommonRenderSym r => SValue r -> SValue r
setDecDef :: CommonRenderSym r => SVariable r -> r (Scope r) -> [SValue r] -> MSStatement r
setDec :: OORenderSym r => (r (Value r) -> Doc) -> SValue r -> SVariable r -> r (Scope r) -> MSStatement r
listAdd :: CommonRenderSym r => SValue r -> SValue r -> SValue r -> SValue r
listAppend :: CommonRenderSym r => SValue r -> SValue r -> SValue r
intToIndex :: SValue r -> SValue r
indexToInt :: SValue r -> SValue r
intToIndex' :: CommonRenderSym r => SValue r -> SValue r
indexToInt' :: CommonRenderSym r => SValue r -> SValue r
varDecDef :: CommonRenderSym r => SVariable r -> r (Scope r) -> Maybe (SValue r) -> MSStatement r
openFileR' :: CommonRenderSym r => SValue r -> SValue r
openFileW' :: CommonRenderSym r => SValue r -> SValue r
openFileA' :: CommonRenderSym r => SValue r -> SValue r
argExists :: CommonRenderSym r => Integer -> SValue r
global :: Monad r => r ScopeData
setMethodCall :: OORenderSym r => Label -> SValue r -> SValue r -> SValue r

Documentation

int :: CommonRenderSym r => VSType r Source #

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

doxFunc :: CommonRenderSym r => String -> [String] -> Maybe String -> SMethod r -> SMethod r Source #

doxClass :: OORenderSym r => String -> SClass r -> SClass r Source #

doxMod :: OORenderSym r => String -> String -> [String] -> String -> SFile r -> SFile r Source #

docMod' :: OORenderSym r => String -> String -> [String] -> String -> SFile r -> SFile r Source #

modDoc' :: ModuleDocRenderer Source #

Generates Markdown/DocC style module doc comment. Useful for Swift, which follows DocC, Julia, which uses Markdown, and any other language that doesn't have Support for a document generator.

functionDoc :: FuncDocRenderer Source #

Generates Markdown/DocC style function doc comment.

extVar :: CommonRenderSym r => Label -> Label -> VSType r -> SVariable r Source #

classVar :: CommonRenderSym r => (Doc -> Doc -> Doc) -> VSType r -> SVariable r -> SVariable r Source #

objVarSelf :: OORenderSym r => SVariable r -> SVariable r Source #

indexOf :: OORenderSym r => Label -> SValue r -> SValue r -> SValue r Source #

contains :: OORenderSym r => Label -> SValue r -> SValue r -> SValue r Source #

containsInt :: OORenderSym r => Label -> Label -> SValue r -> SValue r -> SValue r Source #

listAddFunc :: OORenderSym r => Label -> SValue r -> SValue r -> VSFunction r Source #

discardFileLine :: OORenderSym r => Label -> SValue r -> MSStatement r Source #

intClass :: (OORenderSym r, Monad r) => (Label -> Doc -> Doc -> Doc -> Doc -> Doc) -> Label -> r (Visibility r) -> r ParentSpec -> [CSStateVar r] -> [SMethod r] -> [SMethod r] -> CS (r Doc) Source #

An internal function for creating a class. Parameters: render function, class name, scope, parent, class variables, constructor(s), methods

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

buildModule :: OORenderSym r => Label -> FS Doc -> FS Doc -> FS Doc -> [SMethod r] -> [SClass r] -> FSModule r Source #

arrayType :: CommonRenderSym r => VSType r -> VSType r Source #

pi :: CommonRenderSym r => SValue r Source #

printSt :: CommonRenderSym r => SValue r -> SValue r -> MSStatement r Source #

arrayDec :: CommonRenderSym r => SValue r -> SVariable r -> r (Scope r) -> MSStatement r Source #

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

openFileA :: CommonRenderSym r => (SValue r -> VSType r -> SValue r -> SValue r) -> SVariable r -> SValue r -> MSStatement r Source #

forEach :: CommonRenderSym r => Doc -> Doc -> Doc -> Doc -> SVariable r -> SValue r -> MSBody r -> MSStatement r Source #

forEach' :: CommonRenderSym r => (r (Variable r) -> r (Value r) -> r (Body r) -> Doc) -> SVariable r -> SValue r -> MSBody r -> MSStatement r Source #

docMain :: OORenderSym r => MSBody r -> SMethod r Source #

mainFunction :: OORenderSym r => VSType r -> Label -> MSBody r -> SMethod r Source #

buildModule' :: OORenderSym r => Label -> (String -> r (Import r)) -> [Label] -> [SMethod r] -> [SClass r] -> FSModule r Source #

Used by the language renderers to build the module. n is the module name inc is the include is is the import statements ms is the class methods cs is the classes

call' :: CommonRenderSym r => String -> Maybe Library -> Maybe Doc -> MixedCall r Source #

First parameter is language name, rest similar to call from RendererClassesCommon

listSizeFunc :: OORenderSym r => VSFunction r Source #

listAccessFunc' :: OORenderSym r => Label -> VSType r -> SValue r -> VSFunction r Source #

string :: CommonRenderSym r => VSType r Source #

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

docInOutFunc :: CommonRenderSym r => ([SVariable r] -> [SVariable r] -> [SVariable r] -> MSBody r -> SMethod r) -> String -> [(String, SVariable r)] -> [(String, SVariable r)] -> [(String, SVariable r)] -> MSBody r -> SMethod r Source #

bindingError :: String -> String Source #

extFuncAppMixedArgs :: CommonRenderSym r => Library -> MixedCall r Source #

notNull :: CommonRenderSym r => String -> SValue r -> SValue r Source #

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

destructorError :: String -> String Source #

stateVarDef :: (OORenderSym r, Monad r) => r (Visibility r) -> r (Permanence r) -> SVariable r -> SValue r -> CS (r Doc) Source #

constVar :: (CommonRenderSym r, Monad r) => Doc -> r (Visibility r) -> SVariable r -> SValue r -> CS (r Doc) Source #

litArray :: CommonRenderSym r => (Doc -> Doc) -> VSType r -> [SValue r] -> SValue r Source #

litSet :: CommonRenderSym r => (Doc -> Doc) -> (Doc -> Doc) -> VSType r -> [SValue r] -> SValue r Source #

listSetFunc :: CommonRenderSym r => (Doc -> Doc -> Doc) -> SValue r -> SValue r -> SValue r -> VSFunction r Source #

litSetFunc :: CommonRenderSym r => String -> VSType r -> [SValue r] -> SValue r Source #

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

listAccessFunc :: CommonRenderSym r => VSType r -> SValue r -> VSFunction r Source #

doubleRender :: String Source #

double :: CommonRenderSym r => VSType r Source #

openFileR :: CommonRenderSym r => (SValue r -> VSType r -> SValue r) -> SVariable r -> SValue r -> MSStatement r Source #

openFileW :: CommonRenderSym r => (SValue r -> VSType r -> SValue r -> SValue r) -> SVariable r -> SValue r -> MSStatement r Source #

stateVar :: (OORenderSym r, Monad r) => r (Visibility r) -> r (Permanence r) -> SVariable r -> CS (r Doc) Source #

self :: OORenderSym r => SVariable r Source #

multiAssign :: CommonRenderSym r => (Doc -> Doc) -> [SVariable r] -> [SValue r] -> MSStatement r Source #

multiReturn :: CommonRenderSym r => (Doc -> Doc) -> [SValue r] -> MSStatement r Source #

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

funcDecDef :: OORenderSym r => SVariable r -> r (Scope r) -> [SVariable r] -> MSBody r -> MSStatement r Source #

inOutCall :: CommonRenderSym r => (Label -> VSType r -> [SValue r] -> SValue r) -> Label -> [SValue r] -> [SVariable r] -> [SVariable r] -> MSStatement r Source #

forLoopError :: String -> String Source #

mainBody :: CommonRenderSym r => MSBody r -> SMethod r Source #

inOutFunc :: CommonRenderSym r => (VSType r -> [MSParameter r] -> MSBody r -> SMethod r) -> [SVariable r] -> [SVariable r] -> [SVariable r] -> MSBody r -> SMethod r Source #

docInOutFunc' :: CommonRenderSym r => FuncDocRenderer -> ([SVariable r] -> [SVariable r] -> [SVariable r] -> MSBody r -> SMethod r) -> String -> [(String, SVariable r)] -> [(String, SVariable r)] -> [(String, SVariable r)] -> MSBody r -> SMethod r Source #

boolRender :: String Source #

bool :: CommonRenderSym r => VSType r Source #

floatRender :: String Source #

float :: CommonRenderSym r => VSType r Source #

stringRender' :: String Source #

string' :: CommonRenderSym r => VSType r Source #

inherit :: Monad r => Maybe Label -> r ParentSpec Source #

implements :: Monad r => [Label] -> r ParentSpec Source #

listSize :: CommonRenderSym r => SValue r -> SValue r Source #

Call to get the size of a list in a language where this is not a method.

setDecDef :: CommonRenderSym r => SVariable r -> r (Scope r) -> [SValue r] -> MSStatement r Source #

setDec :: OORenderSym r => (r (Value r) -> Doc) -> SValue r -> SVariable r -> r (Scope r) -> MSStatement r Source #

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

Call to insert a value into a list in a language where this is not a method.

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

Call to append a value to a list in a language where this is not a method.

intToIndex :: SValue r -> SValue r Source #

Convert an integer to an index in a 0-indexed language Since GOOL is 0-indexed, no adjustments need be made

indexToInt :: SValue r -> SValue r Source #

Convert an index to an integer in a 0-indexed language Since GOOL is 0-indexed, no adjustments need be made

intToIndex' :: CommonRenderSym r => SValue r -> SValue r Source #

Convert an integer to an index in a 1-indexed language Since GOOL is 0-indexed, we need to add 1

indexToInt' :: CommonRenderSym r => SValue r -> SValue r Source #

Convert an index to an integer in a 1-indexed language Since GOOL is 0-indexed, we need to subtract 1

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

For declaring and optionally defining a variable in a language where declaring a variable before defining it is not required. v is the variable to declare, and e is Nothing if we are not defining it, and (Just d) if d is the value we are defining it as.

openFileR' :: CommonRenderSym r => SValue r -> SValue r Source #

openFileW' :: CommonRenderSym r => SValue r -> SValue r Source #

openFileA' :: CommonRenderSym r => SValue r -> SValue r Source #

argExists :: CommonRenderSym r => Integer -> SValue r Source #

global :: Monad r => r ScopeData Source #

setMethodCall :: OORenderSym r => Label -> SValue r -> SValue r -> SValue r Source #