Modulelanguage-c-0.9.3Haskell2010

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.

5 types
4 classes
38 values

Packagelanguage-c-0.9.3
Exports47
LanguageHaskell2010
LicenceBSD-3-Clause
SourceTravMonad.hs

Name generation monad

1 declaration

classclass Monad m => MonadName (m :: Type -> Type) where

Methods

genName :: m Name
unique name generation

Instances1MonadName

Monad m => MonadName (TravT s m)Defined in language-c-0.9.3 · Language.C.Analysis.TravMonad

Symbol table monad

1 declaration

classclass Monad m => MonadSymtab (m :: Type -> Type) where

Methods

getDefTable :: m DefTable
return the definition table
withDefTable :: (DefTable -> (a, DefTable)) -> m a
perform an action modifying the definition table

Instances1MonadSymtab

Monad m => MonadSymtab (TravT s m)Defined in language-c-0.9.3 · Language.C.Analysis.TravMonad

Specialized C error-handling monad

1 declaration

classclass Monad m => MonadCError (m :: Type -> Type) where

Methods

throwTravError :: Error e => e -> m a
throw an Error
catchTravError :: m a -> (CError -> m a) -> m a
catch 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.9.3 · Language.C.Analysis.TravMonad

AST traversal monad

1 declaration

classclass (MonadName m, MonadSymtab m, MonadCError m) => MonadTrav (m :: Type -> Type) where

Traversal monad

Methods

handleDecl :: DeclEvent -> m ()
handling declarations and definitions

Instances1MonadTrav

Monad m => MonadTrav (TravT s m)Defined in language-c-0.9.3 · Language.C.Analysis.TravMonad

Handling declarations

9 declarations

valuehandleTagDecl :: (MonadCError m, MonadSymtab m) => TagFwdDecl -> m ()

forward declaration of a tag. Only necessary for name analysis, but otherwise no semantic consequences.

valuehandleTagDef :: MonadTrav m => TagDef -> m ()

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).

valuehandleEnumeratorDef :: (MonadCError m, MonadSymtab m) => Enumerator -> m ()

valuehandleTypeDef :: MonadTrav m => TypeDef -> m ()

valuehandleObjectDef :: MonadTrav m => Bool -> Ident -> ObjDef -> m ()

handle object defintions (maybe tentative)

valuehandleFunDef :: MonadTrav m => Ident -> FunDef -> m ()

handle function definitions

valuehandleVarDecl :: MonadTrav m => Bool -> Decl -> m ()

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

valuehandleParamDecl :: MonadTrav m => ParamDecl -> m ()

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

valuehandleAsmBlock :: MonadTrav m => AsmBlock -> m ()

Symbol table scope modification

6 declarations

valueenterPrototypeScope :: MonadSymtab m => m ()

valueleavePrototypeScope :: MonadSymtab m => m ()

valueenterFunctionScope :: MonadSymtab m => m ()

valueleaveFunctionScope :: MonadSymtab m => m ()

valueenterBlockScope :: MonadSymtab m => m ()

valueleaveBlockScope :: MonadSymtab m => m ()

Symbol table lookup (delegate)

2 declarations

valuelookupTypeDef :: (MonadCError m, MonadSymtab m) => Ident -> m Type

lookup a type definition the 'wrong kind of object' is an internal error here, because the parser should distinguish typeDefs and other objects

valuelookupObject

:: (MonadCError m, MonadSymtab m)
=> Ident
-> m (Maybe IdentDecl)

lookup an object, function or enumerator

Symbol table modification

1 declaration

valuecreateSUERef

:: (MonadCError m, MonadSymtab m)
=> NodeInfo
-> Maybe Ident
-> m SUERef

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

5 declarations

valuehadHardErrors :: [CError] -> Bool

check wheter non-recoverable errors occurred

valuehandleTravError :: MonadCError m => m a -> m (Maybe a)

valuethrowOnLeft :: (MonadCError m, Error e) => Either e a -> m a

raise an error based on an Either argument

valueastError :: MonadCError m => NodeInfo -> String -> m a

raise an error caused by a malformed AST

valuewarn :: (Error e, MonadCError m) => e -> m ()

Trav - default MonadTrav implementation

15 declarations

typetype Trav s a = TravT s Identity a

newtypenewtype TravT s (m :: Type -> Type) a

simple traversal monad, providing user state and callbacks

Instances10MonadTrans, Monad, Functor, Applicative, MonadIO, MonadCError, …

MonadTrans (TravT s)Defined in language-c-0.9.3 · Language.C.Analysis.TravMonad
Monad m => Monad (TravT s m)Defined in language-c-0.9.3 · Language.C.Analysis.TravMonad
Monad f => Functor (TravT s f)Defined in language-c-0.9.3 · Language.C.Analysis.TravMonad
Monad f => Applicative (TravT s f)Defined in language-c-0.9.3 · Language.C.Analysis.TravMonad
MonadIO m => MonadIO (TravT s m)Defined in language-c-0.9.3 · Language.C.Analysis.TravMonad
Monad m => MonadCError (TravT s m)Defined in language-c-0.9.3 · Language.C.Analysis.TravMonad
Monad m => MonadName (TravT s m)Defined in language-c-0.9.3 · Language.C.Analysis.TravMonad
Monad m => MonadSymtab (TravT s m)Defined in language-c-0.9.3 · Language.C.Analysis.TravMonad
Monad m => MonadTrav (TravT s m)Defined in language-c-0.9.3 · Language.C.Analysis.TravMonad
Monad m => MonadState (TravState m s) (TravT s m)Defined in language-c-0.9.3 · Language.C.Analysis.TravMonad

valuerunTravT

:: Monad m
=> s
-> TravT s m a
-> m (Either [CError] (a, TravState m s))

valuerunTravTWithTravState

:: Monad m
=> TravState m s
-> TravT s m a
-> m (Either [CError] (a, TravState m s))

valuerunTrav :: s -> Trav s a -> Either [CError] (a, TravState Identity s)

valuerunTrav_ :: Trav () a -> Either [CError] (a, [CError])

datadata TravState (m :: Type -> Type) s

Instances1MonadState

Monad m => MonadState (TravState m s) (TravT s m)Defined in language-c-0.9.3 · Language.C.Analysis.TravMonad

valueinitTravState :: Monad m => s -> TravState m s

valuewithExtDeclHandler

:: Monad m
=> TravT s m a
-> DeclEvent -> TravT s m ()
-> TravT s m a

valuemodifyUserState :: (s -> s) -> Trav s ()

valueuserState :: TravState m s -> s

valuegetUserState :: Trav s s

datadata TravOptions

Constructors

TravOptions
- language :: CLanguage

valuemodifyOptions :: (TravOptions -> TravOptions) -> Trav s ()

valuetravErrors :: TravState m s -> [CError]

Language options

1 declaration

datadata CLanguage

The variety of the C language to accept. Note: this is not yet enforced.

C89 C99 GNU89 GNU99

Helpers

4 declarations

valuemapMaybeM :: Monad m => Maybe a -> (a -> m b) -> m (Maybe b)

valuemaybeM :: Monad m => Maybe a -> (a -> m ()) -> m ()

valuemapSndM :: Monad m => (b -> m c) -> (a, b) -> m (a, c)

valueconcatMapM :: Monad m => (a -> m [b]) -> [a] -> m [b]