Modulelanguage-c-0.10.2Haskell2010
Language.C.Analysis.TravMonad
Monad for Traversals of the C AST.
For the traversal, we maintain a symboltable and need MonadError and unique name generation facilities. Furthermore, the user may provide callbacks to handle declarations and definitions.
Contents
- Name generation monad
- Symbol table monad
- Specialized C error-handling monad
- AST traversal monad
- Handling declarations
- Symbol table scope modification
- Symbol table lookup (delegate)
- Symbol table modification
- Additional error handling facilities
- Trav - default MonadTrav implementation
- Language options
- Helpers
Synopsis
- class MonadName
- class MonadSymtab
- class MonadCError
- class MonadTrav
- value handleTagDecl
- value handleTagDef
- value handleEnumeratorDef
- value handleTypeDef
- value handleObjectDef
- value handleFunDef
- value handleVarDecl
- value handleParamDecl
- value handleAsmBlock
- value enterPrototypeScope
- value leavePrototypeScope
- value enterFunctionScope
- value leaveFunctionScope
- value enterBlockScope
- value leaveBlockScope
- value lookupTypeDef
- value lookupObject
- value createSUERef
- value hadHardErrors
- value handleTravError
- value throwOnLeft
- value astError
- value warn
- type Trav
- newtype TravT
- value runTravT
- value runTravTWithTravState
- value runTrav
- value runTrav_
- data TravState
- value initTravState
- value withExtDeclHandler
- value modifyUserState
- value userState
- value getUserState
- data TravOptions
- value modifyOptions
- value travErrors
- data CLanguage
- value mapMaybeM
- value maybeM
- value mapSndM
- value concatMapM
- Packagelanguage-c-0.10.2
- Exports47
- LanguageHaskell2010
- LicenceBSD-3-Clause
- SourceTravMonad.hs
Name generation monad
Symbol table monad
Methods
getDefTable :: m DefTablereturn the definition table
withDefTable :: (DefTable -> (a, DefTable)) -> m aperform an action modifying the definition table
Instances1MonadSymtab
Monad m => MonadSymtab (TravT s m)Defined in language-c-0.10.2 · Language.C.Analysis.TravMonad
Specialized C error-handling monad
Methods
throwTravError :: Error e => e -> m athrow an Error
catchTravError :: m a -> (CError -> m a) -> m acatch an Error (we could implement dynamically-typed catch here)
recordError :: Error e => e -> m ()remember that an Error occurred (without throwing it)
getErrors :: m [CError]return the list of recorded errors
Instances1MonadCError
Monad m => MonadCError (TravT s m)Defined in language-c-0.10.2 · Language.C.Analysis.TravMonad
AST traversal monad
class (MonadName m, MonadSymtab m, MonadCError m) => MonadTrav (m :: Type -> Type) whereTraversal monad
Methods
handleDecl :: DeclEvent -> m ()handling declarations and definitions
Handling declarations
forward declaration of a tag. Only necessary for name analysis, but otherwise no semantic consequences.
define the given composite type or enumeration If there is a declaration visible, overwrite it with the definition. Otherwise, enter a new definition in the current namespace. If there is already a definition present, yield an error (redeclaration).
handle object defintions (maybe tentative)
handle function definitions
handle variable declarations (external object declarations and function prototypes) variable declarations are either function prototypes, or external declarations, and not very interesting on their own. we only put them in the symbol table and call the handle. declarations never override definitions
handle parameter declaration. The interesting part is that parameters can be abstract (if they are part of a type). If they have a name, we enter the name (usually in function prototype or function scope), checking if there are duplicate definitions. FIXME: I think it would be more transparent to handle parameter declarations in a special way
Symbol table scope modification
Symbol table lookup (delegate)
lookup a type definition the 'wrong kind of object' is an internal error here, because the parser should distinguish typeDefs and other objects
lookup an object, function or enumerator
Symbol table modification
create a reference to a struct/union/enum
This currently depends on the fact the structs are tagged with unique names. We could use the name generation of TravMonad as well, which might be the better choice when dealing with autogenerated code.
Additional error handling facilities
check wheter non-recoverable errors occurred
raise an error based on an Either argument
raise an error caused by a malformed AST
Trav - default MonadTrav implementation
simple traversal monad, providing user state and callbacks
Instances10MonadTrans, Monad, Functor, Applicative, MonadIO, MonadCError, …
MonadTrans (TravT s)Defined in language-c-0.10.2 · Language.C.Analysis.TravMonadMonad m => Monad (TravT s m)Defined in language-c-0.10.2 · Language.C.Analysis.TravMonadMonad f => Functor (TravT s f)Defined in language-c-0.10.2 · Language.C.Analysis.TravMonadMonad f => Applicative (TravT s f)Defined in language-c-0.10.2 · Language.C.Analysis.TravMonadMonadIO m => MonadIO (TravT s m)Defined in language-c-0.10.2 · Language.C.Analysis.TravMonadMonad m => MonadCError (TravT s m)Defined in language-c-0.10.2 · Language.C.Analysis.TravMonadMonad m => MonadName (TravT s m)Defined in language-c-0.10.2 · Language.C.Analysis.TravMonadMonad m => MonadSymtab (TravT s m)Defined in language-c-0.10.2 · Language.C.Analysis.TravMonadMonad m => MonadTrav (TravT s m)Defined in language-c-0.10.2 · Language.C.Analysis.TravMonadMonad m => MonadState (TravState m s) (TravT s m)Defined in language-c-0.10.2 · Language.C.Analysis.TravMonad
Instances1MonadState
Monad m => MonadState (TravState m s) (TravT s m)Defined in language-c-0.10.2 · Language.C.Analysis.TravMonad