Language.CSPM.Frontend

Frontend contains some reexports from other modules

Documentation

parse :: SourceName -> [Token] -> Either ParseError ModuleFromParser

The parse function parses a List of Token. It returns a ParseError or a Labled Module. The SourceName argument is currently not used.

data ParseError

ParseError data type. This is an instance of Excpetion

Constructors

ParseError

Fields

parseErrorMsg :: String

parseErrorToken :: Token

parseErrorPos :: AlexPosn

Instances

Show ParseError

Typeable ParseError

Exception ParseError

parseFile :: FilePath -> IO ModuleFromParser

Lex and parse a file and return a LModule, throw an exception in case of an error

benchmarkFrontend :: FilePath -> IO (ModuleFromParser, ModuleFromRenaming)

Lex and parse File. | Return the module and print some timing infos

eitherToExc :: Exception a => Either a b -> IO b

eitherToExe returns the Right part of Either or throws the Left part as an dynamic exception.

handleLexError :: (LexError -> IO a) -> IO a -> IO a

Handle a dymanic exception of type LexError.

handleParseError :: (ParseError -> IO a) -> IO a -> IO a

Handle a dymanic exception of type ParseError.

handleRenameError :: (RenameError -> IO a) -> IO a -> IO a

Handle a dymanic exception of type RenameError.

data Token

Instances

Eq Token

Data Token

Ord Token

Show Token

Typeable Token

data LexError

Constructors

LexError

Fields

lexEPos :: !AlexPosn

lexEMsg :: !String

Instances

Show LexError

Typeable LexError

Exception LexError

lexInclude :: String -> IO (Either LexError [Token])

lex a String and process CSP-M include statements.

lexPlain :: String -> Either LexError [Token]

lex a String .

filterIgnoredToken :: [Token] -> [Token]

Remove comments and unneeded newlines.

data Module a

Instances

Typeable1 Module

Eq (Module a)

Data a => Data (Module a)

Ord (Module a)

Show (Module a)

PP (Module a)

type ModuleFromParser = Module FromParser

type ModuleFromRenaming = Module FromRenaming

A module that has gone through renaming

data Labeled t

Constructors

Labeled

Fields

nodeId :: NodeId

srcLoc :: SrcLoc

unLabel :: t

Instances

Typeable1 Labeled

Eq t => Eq (Labeled t)

Data t => Data (Labeled t)

Ord t => Ord (Labeled t)

Show t => Show (Labeled t)

PP x => PP (Labeled x)

castModule :: Module a -> Module b

type Bindings = Map String UniqueIdent

data SrcLoc

Constructors

TokIdPos TokenId

TokIdSpan TokenId TokenId

TokSpan Token Token

TokPos Token

NoLocation

FixedLoc

Fields

fixedStartLine :: !Int

fixedStartCol :: !Int

fixedStartOffset :: !Int

fixedLen :: !Int

fixedEndLine :: !Int

fixedEndCol :: !Int

fixedEndOffset :: !Int

Instances

Eq SrcLoc

Data SrcLoc

Ord SrcLoc

Show SrcLoc

Typeable SrcLoc

renameModule :: ModuleFromParser -> Either RenameError (ModuleFromRenaming, RenameInfo)

renameModule renames a Module. | (also calls mergeFunBinds)

data RenameInfo

Gather all information about an renaming.

Constructors

RenameInfo

Fields

nameSupply :: Int

localBindings :: Bindings

visible :: Bindings

identDefinition :: AstAnnotation UniqueIdent

identUse :: AstAnnotation UniqueIdent

usedNames :: Set String

prologMode :: PrologMode

bindType :: BindType

Instances

Show RenameInfo

getRenaming :: ModuleFromParser -> Either RenameError (Bindings, AstAnnotation UniqueIdent, AstAnnotation UniqueIdent)

getRenaming computes two AstAnnotations. The first one contains all the defining occurences of identifier The second one contains all the using occurences of identitier. getRename returns an RenameError if the Module contains unbound identifiers or illegal redefinitions.

applyRenaming :: (Bindings, AstAnnotation UniqueIdent, AstAnnotation UniqueIdent) -> ModuleFromParser -> ModuleFromRenaming

applyRenaming uses SYB to replace turn every Ident in the Module into to the UIdent version, i.e. set the UniqueIdent. At the same time, we also replace VarPat x with ConstrPat x if x an toplevel constant It is an error if the Module contains occurences of Ident that are not covered by the AstAnnotations.

data RenameError

Constructors

RenameError

Fields

renameErrorMsg :: String

renameErrorLoc :: SrcLoc

Instances

Show RenameError

Typeable RenameError

Exception RenameError

Error RenameError

removeSourceLocations :: Data a => Labeled (Module a) -> Labeled (Module a)

removeSourceLocations sets all locationsInfos to NoLocation

removeParens :: Data a => Labeled (Module a) -> Labeled (Module a)

removeParens removes all occurences of of Parens,i.e. explicit parentheses from the AST

removeModuleTokens :: Labeled (Module a) -> Labeled (Module a)

set the tokenlist in the module datatype to Nothing

unUniqueIdent :: Data a => Labeled (Module a) -> Labeled (Module a)

unUniqueIdent replaces the all UIdent with the Ident of the the new name, thus forgetting | additional information like the bindingside, etc. | Usefull to get a smaller AST.

showAst :: Data a => Labeled a -> String

'a show function that omits the node labeles. | TODO : fix this is very buggy. | this does not work for Compiles pattern / Arrays

computeFreeNames :: Data a => a -> FreeNames

Compute the FreeNames of an Expression. | This function does only work after renaming has been done. | This implementation is inefficient.

setNodeIdsZero :: Data a => Labeled (Module a) -> Labeled (Module a)

Set all NodeIds to zero.

pp :: PP x => x -> Doc

prettyPrintFile :: FilePath -> IO ()

run the pretty printer on a file and write the output to | filename.ast and filename.pretty