-- C->Haskell Compiler: traversals of C structure tree -- -- Author : Manuel M. T. Chakravarty -- Created: 16 October 99 -- -- Copyright (c) [1999..2001] Manuel M. T. Chakravarty -- -- This file is free software; you can redistribute it and/or modify -- it under the terms of the GNU General Public License as published by -- the Free Software Foundation; either version 2 of the License, or -- (at your option) any later version. -- -- This file is distributed in the hope that it will be useful, -- but WITHOUT ANY WARRANTY; without even the implied warranty of -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -- GNU General Public License for more details. -- --- DESCRIPTION --------------------------------------------------------------- -- -- This modules provides for traversals of C structure trees. The C -- traversal monad supports traversals that need convenient access to the -- attributes of an attributed C structure tree. The monads state can still -- be extended. -- --- DOCU ---------------------------------------------------------------------- -- -- language: Haskell 98 -- -- Handling of redefined tag values -- -------------------------------- -- -- Structures allow both -- -- struct s {...} ...; -- struct s ...; -- -- and -- -- struct s ...; /* this is called a forward reference */ -- struct s {...} ...; -- -- In contrast enumerations only allow (in ANSI C) -- -- enum e {...} ...; -- enum e ...; -- -- The function `defTag' handles both types and establishes an object -- association from the tag identifier in the empty declaration (ie, the one -- without `{...}') to the actually definition of the structure of -- enumeration. This implies that when looking for the details of a -- structure or enumeration, possibly a chain of references on tag -- identifiers has to be chased. Note that the object association attribute -- is _not_defined_ when the `{...}' part is present in a declaration. -- --- TODO ---------------------------------------------------------------------- -- -- * `extractStruct' doesn't account for forward declarations that have no -- full declaration yet; if `extractStruct' is called on such a declaration, -- we have a user error, but currently an internal error is raised -- module C2HS.C.Trav (CT, readCT, transCT, runCT, throwCTExc, ifCTExc, raiseErrorCTExc, enter, enterObjs, leave, leaveObjs, defObj, findObj, findObjShadow, defTag, findTag, findTagShadow, applyPrefixToNameSpaces, getDefOf, refersToDef, refersToNewDef, getDeclOf, findTypeObjMaybe, findTypeObj, findValueObj, findFunObj, -- -- C structure tree query functions -- isTypedef, simplifyDecl, declrFromDecl, declrNamed, declaredDeclr, initDeclr, declaredName, structMembers, expandDecl, structName, enumName, tagName, isPtrDeclr, isArrDeclr, dropPtrDeclr, isPtrDecl, isArrDecl, isFunDeclr, structFromDecl, funResultAndArgs, chaseDecl, findAndChaseDecl, findAndChaseDeclOrTag, checkForAlias, checkForOneCUName, checkForOneAliasName, lookupEnum, lookupStructUnion, lookupDeclOrTag) where import Data.List (find) import Control.Monad (liftM) import Control.Exception (assert) import Language.C.Data import Language.C.Data.Ident (dumpIdent) import Language.C.Syntax import Data.Attributes import Data.Errors import C2HS.State (CST, readCST, transCST, runCST, raiseError, catchExc, throwExc, Traces(..), putTraceStr) import C2HS.C.Attrs (AttrC(..), enterNewRangeC, enterNewObjRangeC, leaveRangeC, leaveObjRangeC, addDefObjC, lookupDefObjC, lookupDefObjCShadow, addDefTagC, lookupDefTagC, lookupDefTagCShadow, applyPrefix, getDefOfIdentC, setDefOfIdentC, updDefOfIdentC, CObj(..), CTag(..), CDef(..)) -- the C traversal monad -- --------------------- -- | C traversal monad -- type CState s = (AttrC, s) type CT s a = CST (CState s) a -- | read attributed struture tree -- readAttrCCT :: (AttrC -> a) -> CT s a readAttrCCT reader = readCST $ \(ac, _) -> reader ac -- | transform attributed structure tree -- transAttrCCT :: (AttrC -> (AttrC, a)) -> CT s a transAttrCCT trans = transCST $ \(ac, s) -> let (ac', r) = trans ac in ((ac', s), r) -- | access to the user-defined state -- -- | read user-defined state -- readCT :: (s -> a) -> CT s a readCT reader = readCST $ \(_, s) -> reader s -- | transform user-defined state -- transCT :: (s -> (s, a)) -> CT s a transCT trans = transCST $ \(ac, s) -> let (s', r) = trans s in ((ac, s'), r) -- usage of a traversal monad -- -- | execute a traversal monad -- -- * given a traversal monad, an attribute structure tree, and a user -- state, the transformed structure tree and monads result are returned -- runCT :: CT s a -> AttrC -> s -> CST t (AttrC, a) runCT m ac s = runCST m' (ac, s) where m' = do r <- m (ac', _) <- readCST id return (ac', r) -- exception handling -- ------------------ -- | exception identifier -- ctExc :: String ctExc = "ctExc" -- | throw an exception -- throwCTExc :: CT s a throwCTExc = throwExc ctExc "Error during traversal of a C structure tree" -- | catch a `ctExc' -- ifCTExc :: CT s a -> CT s a -> CT s a ifCTExc m handler = m `catchExc` (ctExc, const handler) -- | raise an error followed by throwing a CT exception -- raiseErrorCTExc :: Position -> [String] -> CT s a raiseErrorCTExc pos errs = raiseError pos errs >> throwCTExc -- attribute manipulation -- ---------------------- -- name spaces -- -- | enter a new local range -- enter :: CT s () enter = transAttrCCT $ \ac -> (enterNewRangeC ac, ()) -- | enter a new local range, only for objects -- enterObjs :: CT s () enterObjs = transAttrCCT $ \ac -> (enterNewObjRangeC ac, ()) -- | leave the current local range -- leave :: CT s () leave = transAttrCCT $ \ac -> (leaveRangeC ac, ()) -- | leave the current local range, only for objects -- leaveObjs :: CT s () leaveObjs = transAttrCCT $ \ac -> (leaveObjRangeC ac, ()) -- | enter an object definition into the object name space -- -- * if a definition of the same name was already present, it is returned -- defObj :: Ident -> CObj -> CT s (Maybe CObj) defObj ide obj = do traceCTrav $ "Defining object "++show ide++"...\n" transAttrCCT $ \ac -> addDefObjC ac ide obj -- | find a definition in the object name space -- findObj :: Ident -> CT s (Maybe CObj) findObj ide = readAttrCCT $ \ac -> lookupDefObjC ac ide -- | find a definition in the object name space; if nothing found, try -- whether there is a shadow identifier that matches -- findObjShadow :: Ident -> CT s (Maybe (CObj, Ident)) findObjShadow ide = readAttrCCT $ \ac -> lookupDefObjCShadow ac ide -- | enter a tag definition into the tag name space -- -- * empty definitions of structures get overwritten with complete ones and a -- forward reference is added to their tag identifier; furthermore, both -- structures and enums may be referenced using an empty definition when -- there was a full definition earlier and in this case there is also an -- object association added; otherwise, if a definition of the same name was -- already present, it is returned (see DOCU section) -- -- * it is checked that the first occurence of an enumeration tag is -- accompanied by a full definition of the enumeration -- defTag :: Ident -> CTag -> CT s (Maybe CTag) defTag ide tag = do traceCTrav $ "Defining tag "++show ide++"...\n" otag <- transAttrCCT $ \ac -> addDefTagC ac ide tag case otag of Nothing -> return Nothing -- no collision Just prevTag -> case isRefinedOrUse prevTag tag of Nothing -> return otag Just (fullTag, foreIde) -> do _ <- transAttrCCT $ \ac -> addDefTagC ac ide fullTag foreIde `refersToDef` TagCD fullTag return Nothing -- transparent for env where -- compute whether we have the case of a non-conflicting redefined tag -- definition, and if so, return the full definition and the foreward -- definition's tag identifier -- -- * the first argument contains the _previous_ definition -- -- * in the case of a structure, a foreward definition after a full -- definition is allowed, so we have to handle this case; enumerations -- don't allow foreward definitions -- -- * there may also be multiple foreward definition; if we have two of -- them here, one is arbitrarily selected to take the role of the full -- definition -- isRefinedOrUse (StructUnionCT (CStruct _ (Just ide') Nothing _ _)) tag'@(StructUnionCT (CStruct _ (Just _ ) _ _ _)) = Just (tag', ide') isRefinedOrUse tag'@(StructUnionCT (CStruct _ (Just _ ) _ _ _)) (StructUnionCT (CStruct _ (Just ide') Nothing _ _)) = Just (tag', ide') isRefinedOrUse (EnumCT (CEnum (Just ide') Nothing _ _)) tag'@(EnumCT (CEnum (Just _ ) _ _ _)) = Just (tag', ide') isRefinedOrUse tag'@(EnumCT (CEnum (Just ide') _ _ _)) (EnumCT (CEnum (Just _ ) _ _ _)) = Just (tag', ide') isRefinedOrUse _ _ = Nothing -- | find an definition in the tag name space -- findTag :: Ident -> CT s (Maybe CTag) findTag ide = readAttrCCT $ \ac -> lookupDefTagC ac ide -- | find an definition in the tag name space; if nothing found, try -- whether there is a shadow identifier that matches -- findTagShadow :: Ident -> CT s (Maybe (CTag, Ident)) findTagShadow ide = readAttrCCT $ \ac -> lookupDefTagCShadow ac ide -- | enrich the object and tag name space with identifiers obtained by dropping -- the given prefix from the identifiers already in the name space -- -- * if a new identifier would collides with an existing one, the new one is -- discarded, ie, all associations that existed before the transformation -- started are still in effect after the transformation -- applyPrefixToNameSpaces :: String -> String -> CT s () applyPrefixToNameSpaces prefix repprefix = transAttrCCT $ \ac -> (applyPrefix ac prefix repprefix, ()) -- definition attribute -- -- | get the definition of an identifier -- -- * the attribute must be defined, ie, a definition must be associated with -- the given identifier -- getDefOf :: Ident -> CT s CDef getDefOf ide = do def <- readAttrCCT $ \ac -> getDefOfIdentC ac ide assert (not . isUndef $ def) $ return def -- | set the definition of an identifier -- refersToDef :: Ident -> CDef -> CT s () refersToDef ide def = do traceCTrav $ "linking identifier: "++ dumpIdent ide ++ " --> " ++ show def transAttrCCT $ \akl -> (setDefOfIdentC akl ide def, ()) -- | update the definition of an identifier -- refersToNewDef :: Ident -> CDef -> CT s () refersToNewDef ide def = transAttrCCT $ \akl -> (updDefOfIdentC akl ide def, ()) -- | get the declarator of an identifier -- getDeclOf :: Ident -> CT s CDecl getDeclOf ide = do traceEnter def <- getDefOf ide case def of UndefCD -> interr "CTrav.getDeclOf: Undefined!" DontCareCD -> interr "CTrav.getDeclOf: Don't care!" TagCD _ -> interr "CTrav.getDeclOf: Illegal tag!" ObjCD obj -> case obj of TypeCO decl -> traceTypeCO decl >> return decl ObjCO decl -> traceObjCO decl >> return decl EnumCO _ _ -> illegalEnum BuiltinCO Nothing -> illegalBuiltin BuiltinCO (Just decl) -> traceBuiltinCO >> return decl where illegalEnum = interr "CTrav.getDeclOf: Illegal enum!" illegalBuiltin = interr "CTrav.getDeclOf: Attempted to get declarator of \ \builtin entity!" -- if the latter ever becomes necessary, we have to -- change the representation of builtins and give them -- some dummy declarator traceEnter = traceCTrav $ "Entering `getDeclOf' for `" ++ identToString ide ++ "'...\n" traceTypeCO decl = traceCTrav $ "...found a type object:\n" ++ show decl ++ "\n" traceObjCO decl = traceCTrav $ "...found a vanilla object:\n" ++ show decl ++ "\n" traceBuiltinCO = traceCTrav $ "...found a builtin object with a proxy decl.\n" -- convenience functions -- findTypeObjMaybeWith :: Bool -> Ident -> Bool -> CT s (Maybe (CObj, Ident)) findTypeObjMaybeWith soft ide useShadows = do oobj <- if useShadows then findObjShadow ide else liftM (fmap (\obj -> (obj, ide))) $ findObj ide case oobj of Just obj@(TypeCO _ , _) -> return $ Just obj Just obj@(BuiltinCO _, _) -> return $ Just obj Just _ -> if soft then return Nothing else typedefExpectedErr ide Nothing -> return $ Nothing -- | find a type object in the object name space; returns 'Nothing' if the -- identifier is not defined -- -- * if the second argument is 'True', use 'findObjShadow' -- findTypeObjMaybe :: Ident -> Bool -> CT s (Maybe (CObj, Ident)) findTypeObjMaybe = findTypeObjMaybeWith False -- | find a type object in the object name space; raises an error and exception -- if the identifier is not defined -- -- * if the second argument is 'True', use 'findObjShadow' -- findTypeObj :: Ident -> Bool -> CT s (CObj, Ident) findTypeObj ide useShadows = do oobj <- findTypeObjMaybe ide useShadows case oobj of Nothing -> unknownObjErr ide Just obj -> return obj -- | find an object, function, or enumerator in the object name space; raises an -- error and exception if the identifier is not defined -- -- * if the second argument is 'True', use 'findObjShadow' -- findValueObj :: Ident -> Bool -> CT s (CObj, Ident) findValueObj ide useShadows = do oobj <- if useShadows then findObjShadow ide else liftM (fmap (\obj -> (obj, ide))) $ findObj ide case oobj of Just obj@(ObjCO _ , _) -> return obj Just obj@(EnumCO _ _, _) -> return obj Just _ -> unexpectedTypedefErr (posOf ide) Nothing -> unknownObjErr ide -- | find a function in the object name space; raises an error and exception if -- the identifier is not defined -- -- * if the second argument is 'True', use 'findObjShadow' -- findFunObj :: Ident -> Bool -> CT s (CObj, Ident) findFunObj ide useShadows = do (obj, ide') <- findValueObj ide useShadows case obj of EnumCO _ _ -> funExpectedErr (posOf ide) ObjCO decl -> do let declr = ide' `declrFromDecl` decl assertFunDeclr (posOf ide) declr return (obj, ide') -- C structure tree query routines -- ------------------------------- -- | test if this is a type definition specification -- isTypedef :: CDecl -> Bool isTypedef (CDecl specs _ _) = not . null $ [() | CStorageSpec (CTypedef _) <- specs] -- | discard all declarators but the one declaring the given identifier -- -- * the declaration must contain the identifier -- simplifyDecl :: Ident -> CDecl -> CDecl ide `simplifyDecl` (CDecl specs declrs at) = case find (`declrPlusNamed` ide) declrs of Nothing -> err Just declr -> CDecl specs [declr] at where (Just declr, _, _) `declrPlusNamed` ide' = declr `declrNamed` ide' _ `declrPlusNamed` _ = False -- err = interr $ "CTrav.simplifyDecl: Wrong C object!\n\ \ Looking for `" ++ identToString ide ++ "' in decl \ \at " ++ show (posOf at) -- | extract the declarator that declares the given identifier -- -- * the declaration must contain the identifier -- declrFromDecl :: Ident -> CDecl -> CDeclr ide `declrFromDecl` decl = let CDecl _ [(Just declr, _, _)] _ = ide `simplifyDecl` decl in declr -- | tests whether the given declarator has the given name -- declrNamed :: CDeclr -> Ident -> Bool declr `declrNamed` ide = declrName declr == Just ide -- | get the declarator of a declaration that has at most one declarator -- declaredDeclr :: CDecl -> Maybe CDeclr declaredDeclr (CDecl _ [] _) = Nothing declaredDeclr (CDecl _ [(odeclr, _, _)] _) = odeclr declaredDeclr decl = interr $ "CTrav.declaredDeclr: Too many declarators!\n\ \ Declaration at " ++ show (posOf decl) -- | get the initialiser of a declaration that has at most one initialiser -- initDeclr :: CDecl -> Maybe (CInitializer NodeInfo) initDeclr (CDecl _ [] _) = Nothing initDeclr (CDecl _ [(_, ini, _)] _) = ini initDeclr decl = interr $ "CTrav.initDeclr: Too many declarators!\n\ \ Declaration at " ++ show (posOf decl) -- | get the name declared by a declaration that has exactly one declarator -- declaredName :: CDecl -> Maybe Ident declaredName decl = declaredDeclr decl >>= declrName -- | obtains the member definitions and the tag of a struct -- -- * member definitions are expanded -- structMembers :: CStructUnion -> ([CDecl], CStructTag) structMembers (CStruct tag _ members _ _) = (concat . map expandDecl $ maybe [] id members, tag) -- | expand declarators declaring more than one identifier into multiple -- declarators, eg, `int x, y;' becomes `int x; int y;' -- For case of a declarator that declares no identifier, preserve the no-identifier decl. -- expandDecl :: CDecl -> [CDecl] expandDecl decl@(CDecl _ [] _) = [decl] -- no name member stays as member without a name. expandDecl (CDecl specs decls at) = map (\decl -> CDecl specs [decl] at) decls -- | get a struct's name -- structName :: CStructUnion -> Maybe Ident structName (CStruct _ oide _ _ _) = oide -- | get an enum's name -- enumName :: CEnum -> Maybe Ident enumName (CEnum oide _ _ _) = oide -- | get a tag's name -- -- * fail if the tag is anonymous -- tagName :: CTag -> Ident tagName tag = case tag of StructUnionCT struct -> maybe err id $ structName struct EnumCT enum -> maybe err id $ enumName enum where err = interr "CTrav.tagName: Anonymous tag definition" -- | checks whether the given declarator defines an object that is a pointer to -- some other type -- -- * as far as parameter passing is concerned, arrays are also pointer -- isPtrDeclr :: CDeclr -> Bool isPtrDeclr (CDeclr _ (CPtrDeclr _ _:_) _ _ _) = True isPtrDeclr (CDeclr _ (CArrDeclr _ _ _:_) _ _ _) = True isPtrDeclr _ = False -- | Need to distinguish between pointer and array declarations within -- structures. -- isArrDeclr :: CDeclr -> Maybe Int isArrDeclr (CDeclr _ (CArrDeclr _ sz _:_) _ _ _) = Just $ szToInt sz where szToInt (CArrSize _ (CConst (CIntConst s _))) = fromIntegral $ getCInteger s szToInt _ = 1 isArrDeclr _ = Nothing -- | drops the first pointer level from the given declarator -- -- * the declarator must declare a pointer object -- -- * arrays are considered to be pointers -- -- FIXME: this implementation isn't nice, because we retain the 'CVarDeclr' -- unchanged; as the declarator is changed, we should maybe make this -- into an anonymous declarator and also change its attributes -- dropPtrDeclr :: CDeclr -> CDeclr dropPtrDeclr (CDeclr ide (outermost:derived) asm ats node) = case outermost of (CPtrDeclr _ _) -> CDeclr ide derived asm ats node (CArrDeclr _ _ _) -> CDeclr ide derived asm ats node _ -> interr "CTrav.dropPtrDeclr: No pointer!" -- | checks whether the given declaration defines a pointer object -- -- * there may only be a single declarator in the declaration -- isPtrDecl :: CDecl -> Bool isPtrDecl (CDecl _ [] _) = False isPtrDecl (CDecl _ [(Just declr, _, _)] _) = isPtrDeclr declr isPtrDecl _ = interr "CTrav.isPtrDecl: There was more than one declarator!" isArrDecl :: CDecl -> Maybe Int isArrDecl (CDecl _ [] _) = Nothing isArrDecl (CDecl _ [(Just declr, _, _)] _) = isArrDeclr declr isArrDecl _ = interr "CTrav.isArrDecl: There was more than one declarator!" -- | checks whether the given declarator defines a function object -- isFunDeclr :: CDeclr -> Bool isFunDeclr (CDeclr _ (CFunDeclr _ _ _:_) _ _ _) = True isFunDeclr _ = False -- | extract the structure from the type specifiers of a declaration -- structFromDecl :: Position -> CDecl -> CT s CStructUnion structFromDecl pos (CDecl specs _ _) = case head [ts | CTypeSpec ts <- specs] of CSUType su _ -> extractStruct pos (StructUnionCT su) _ -> structExpectedErr pos structFromDecl' :: Position -> CDecl -> CT s (Maybe CStructUnion) structFromDecl' pos (CDecl specs _ _) = case head [ts | CTypeSpec ts <- specs] of CSUType su _ -> extractStruct' pos (StructUnionCT su) _ -> structExpectedErr pos -- | extracts the arguments from a function declaration (must be a unique -- declarator) and constructs a declaration for the result of the function -- -- * the boolean result indicates whether the function is variadic -- -- * returns an abstract declarator funResultAndArgs :: CDecl -> ([CDecl], CDecl, Bool) funResultAndArgs cdecl@(CDecl specs [(Just declr, _, _)] _) = let (args, declr', variadic) = funArgs declr result = CDecl specs [(Just declr', Nothing, Nothing)] (newAttrsOnlyPos (posOf cdecl)) in (args, result, variadic) where funArgs (CDeclr _ide derived _asm _ats node) = case derived of (CFunDeclr (Right (args,variadic)) _ats' _dnode : derived') -> (args, CDeclr Nothing derived' Nothing [] node, variadic) (CFunDeclr (Left _) _ _ : _) -> interr "CTrav.funResultAndArgs: Old style function definition" _ -> interr "CTrav.funResultAndArgs: Illegal declarator!" -- name chasing -- -- | find the declarator identified by the given identifier; if the declarator -- is itself only a 'typedef'ed name, the operation recursively searches for -- the declarator associated with that name (this is called ``typedef -- chasing'') -- -- * if `ind = True', we have to hop over one indirection -- -- * remove all declarators except the one we just looked up -- chaseDecl :: Ident -> Bool -> CT s CDecl -- -- * cycles are no issue, as they cannot occur in a correct C header (we would -- have spotted the problem during name analysis) -- chaseDecl ide ind = do traceEnter cdecl <- getDeclOf ide let sdecl = ide `simplifyDecl` cdecl case extractAlias sdecl ind of Just (ide', ind') -> chaseDecl ide' ind' Nothing -> return sdecl where traceEnter = traceCTrav $ "Entering `chaseDecl' for `" ++ identToString ide ++ "' " ++ (if ind then "" else "not ") ++ "following indirections...\n" -- | find type object in object name space and then chase it -- -- * see also 'chaseDecl' -- -- * also create an object association from the given identifier to the object -- that it _directly_ represents -- -- * if the third argument is 'True', use 'findObjShadow' -- findAndChaseDecl :: Ident -> Bool -> Bool -> CT s CDecl findAndChaseDecl ide ind useShadows = do traceCTrav $ "findAndChaseDecl: " ++ show ide ++ " (" ++ show useShadows ++ ")\n" (obj, ide') <- findTypeObj ide useShadows -- is there an object def? ide `refersToNewDef` ObjCD obj ide' `refersToNewDef` ObjCD obj -- assoc needed for chasing chaseDecl ide' ind findAndChaseDeclOrTag :: Ident -> Bool -> Bool -> CT s CDecl findAndChaseDeclOrTag ide ind useShadows = do traceCTrav $ "findAndChaseDeclOrTag: " ++ show ide ++ " (" ++ show useShadows ++ ")\n" mobjide <- findTypeObjMaybeWith True ide useShadows -- is there an object def? case mobjide of Just (obj, ide') -> do ide `refersToNewDef` ObjCD obj ide' `refersToNewDef` ObjCD obj -- assoc needed for chasing chaseDecl ide' ind Nothing -> do otag <- if useShadows then findTagShadow ide else liftM (fmap (\tag -> (tag, ide))) $ findTag ide case otag of Just (StructUnionCT su, _) -> do let (CStruct _ _ _ _ nodeinfo) = su return $ CDecl [CTypeSpec (CSUType su nodeinfo)] [] nodeinfo _ -> unknownObjErr ide -- | given a declaration (which must have exactly one declarator), if the -- declarator is an alias, chase it to the actual declaration -- checkForAlias :: CDecl -> CT s (Maybe CDecl) checkForAlias decl = case extractAlias decl False of Nothing -> return Nothing Just (ide', _) -> liftM Just $ chaseDecl ide' False -- | given a declaration (which must have exactly one declarator), if the -- declarator is an alias, yield the alias name; *no* chasing -- checkForOneAliasName :: CDecl -> Maybe Ident checkForOneAliasName decl = fmap fst $ extractAlias decl False -- | given a declaration, find the name of the struct/union type checkForOneCUName :: CDecl -> Maybe Ident checkForOneCUName decl@(CDecl specs _ _) = case [ts | CTypeSpec ts <- specs] of [CSUType (CStruct _ n _ _ _) _] -> case declaredDeclr decl of Nothing -> n Just (CDeclr _ [] _ _ _) -> n -- no type derivations _ -> Nothing _ -> Nothing -- smart lookup -- -- | for the given identifier, either find an enumeration in the tag name space -- or a type definition referring to an enumeration in the object name space; -- raises an error and exception if the identifier is not defined -- -- * if the second argument is 'True', use 'findTagShadow' -- lookupEnum :: Ident -> Bool -> CT s CEnum lookupEnum ide useShadows = do otag <- if useShadows then liftM (fmap fst) $ findTagShadow ide else findTag ide case otag of Just (StructUnionCT _ ) -> enumExpectedErr ide -- wrong tag definition Just (EnumCT enum) -> return enum -- enum tag definition Nothing -> do -- no tag definition oobj <- if useShadows then liftM (fmap fst) $ findObjShadow ide else findObj ide case oobj of Just (EnumCO _ enum) -> return enum -- anonymous enum _ -> do -- no value definition (CDecl specs _ _) <- findAndChaseDecl ide False useShadows case head [ts | CTypeSpec ts <- specs] of CEnumType enum _ -> return enum _ -> enumExpectedErr ide -- | for the given identifier, either find a struct/union in the tag name space -- or a type definition referring to a struct/union in the object name space; -- raises an error and exception if the identifier is not defined -- -- * the parameter `preferTag' determines whether tags or typedefs are -- searched first -- -- * if the third argument is `True', use `findTagShadow' -- -- * when finding a forward definition of a tag, follow it to the real -- definition -- lookupStructUnion :: Ident -> Bool -> Bool -> CT s CStructUnion lookupStructUnion ide preferTag useShadows = do traceCTrav $ "lookupStructUnion: ide=" ++ show ide ++ " preferTag=" ++ show preferTag ++ " useShadows=" ++ show useShadows ++ "\n" otag <- if useShadows then liftM (fmap fst) $ findTagShadow ide else findTag ide mobj <- if useShadows then findObjShadow ide else liftM (fmap (\obj -> (obj, ide))) $ findObj ide let oobj = case mobj of Just obj@(TypeCO{}, _) -> Just obj Just obj@(BuiltinCO{}, _) -> Just obj _ -> Nothing case preferTag of True -> case otag of Just tag -> extractStruct (posOf ide) tag Nothing -> do decl <- findAndChaseDecl ide True useShadows structFromDecl (posOf ide) decl False -> case oobj of Just _ -> do decl <- findAndChaseDecl ide True useShadows mres <- structFromDecl' (posOf ide) decl case mres of Just su -> return su Nothing -> case otag of Just tag -> extractStruct (posOf ide) tag Nothing -> unknownObjErr ide Nothing -> case otag of Just tag -> extractStruct (posOf ide) tag Nothing -> unknownObjErr ide -- | for the given identifier, check for the existance of both a type definition -- or a struct, union, or enum definition -- -- * if a typedef and a tag exists, the typedef takes precedence -- -- * typedefs are chased -- -- * if the second argument is `True', look for shadows, too -- lookupDeclOrTag :: Ident -> Bool -> CT s (Either CDecl CTag) lookupDeclOrTag ide useShadows = do oobj <- findTypeObjMaybeWith True ide useShadows case oobj of Just (_, ide') -> liftM Left $ findAndChaseDecl ide' False False -- already did check shadows Nothing -> do otag <- if useShadows then liftM (fmap fst) $ findTagShadow ide else findTag ide case otag of Nothing -> unknownObjErr ide Just tag -> return $ Right tag -- auxiliary routines (internal) -- -- | if the given declaration (which may have at most one declarator) is a -- `typedef' alias, yield the referenced name -- -- * a `typedef' alias has one of the following forms -- -- at x, ...; -- at *x, ...; -- -- where `at' is the alias type, which has been defined by a `typedef', and -- are arbitrary specifiers and qualifiers. Note that `x' may be a -- variable, a type name (if `typedef' is in ), or be entirely -- omitted. -- -- * if `ind = True', the alias may be via an indirection -- -- * if `ind = True' and the alias is _not_ over an indirection, yield `True'; -- otherwise `False' (ie, the ability to hop over an indirection is consumed) -- -- * this may be an anonymous declaration, ie, the name in `CVarDeclr' may be -- omitted or there may be no declarator at all -- extractAlias :: CDecl -> Bool -> Maybe (Ident, Bool) extractAlias decl@(CDecl specs _ _) ind = case [ts | CTypeSpec ts <- specs] of [CTypeDef ide' _] -> -- type spec is aliased ident case declaredDeclr decl of Nothing -> Just (ide', ind) Just (CDeclr _ [] _ _ _) -> Just (ide', ind) -- no type derivations Just (CDeclr _ [CPtrDeclr _ _] _ _ _) -- one pointer indirection | ind -> Just (ide', False) | otherwise -> Nothing _ -> Nothing _ -> Nothing -- | if the given tag is a forward declaration of a structure, follow the -- reference to the full declaration -- -- * the recursive call is not dangerous as there can't be any cycles -- extractStruct :: Position -> CTag -> CT s CStructUnion extractStruct pos (EnumCT _ ) = structExpectedErr pos extractStruct pos (StructUnionCT su) = do traceCTrav $ "extractStruct: " ++ show su ++ "\n" case su of CStruct _ (Just ide') Nothing _ _ -> do -- found forward definition def <- getDefOf ide' traceCTrav $ "def=" ++ show def ++ "\n" case def of TagCD tag -> extractStruct pos tag UndefCD -> incompleteTypeErr pos bad_obj -> err ide' bad_obj _ -> return su where err ide bad_obj = do interr $ "CTrav.extractStruct: Illegal reference! Expected " ++ dumpIdent ide ++ " to link to TagCD but refers to "++ (show bad_obj) ++ "\n" extractStruct' :: Position -> CTag -> CT s (Maybe CStructUnion) extractStruct' pos (EnumCT _ ) = structExpectedErr pos extractStruct' pos (StructUnionCT su) = do traceCTrav $ "extractStruct': " ++ show su ++ "\n" case su of CStruct _ (Just ide') Nothing _ _ -> do def <- getDefOf ide' traceCTrav $ "def=" ++ show def ++ "\n" case def of TagCD tag -> do res <- extractStruct pos tag return . Just $ res _ -> return Nothing _ -> return . Just $ su -- | yield the name declared by a declarator if any -- declrName :: CDeclr -> Maybe Ident declrName (CDeclr oide _ _ _ _) = oide -- | raise an error if the given declarator does not declare a C function or if -- the function is supposed to return an array (the latter is illegal in C) -- assertFunDeclr :: Position -> CDeclr -> CT s () assertFunDeclr pos (CDeclr _ (CFunDeclr _ _ _:retderiv) _ _ _) = case retderiv of (CArrDeclr _ _ _:_) -> illegalFunResultErr pos _ -> return () -- ok, we have a function which doesn't return an array assertFunDeclr pos _ = funExpectedErr pos -- | trace for this module -- traceCTrav :: String -> CT s () traceCTrav = putTraceStr traceCTravSW -- error messages -- -------------- unknownObjErr :: Ident -> CT s a unknownObjErr ide = raiseErrorCTExc (posOf ide) ["Unknown identifier!", "Cannot find a definition for `" ++ identToString ide ++ "' in the \ \header file."] typedefExpectedErr :: Ident -> CT s a typedefExpectedErr ide = raiseErrorCTExc (posOf ide) ["Expected type definition!", "The identifier `" ++ identToString ide ++ "' needs to be a C type name."] unexpectedTypedefErr :: Position -> CT s a unexpectedTypedefErr pos = raiseErrorCTExc pos ["Unexpected type name!", "An object, function, or enum constant is required here."] illegalFunResultErr :: Position -> CT s a illegalFunResultErr pos = raiseErrorCTExc pos ["Function cannot return an array!", "ANSI C does not allow functions to return an array."] funExpectedErr :: Position -> CT s a funExpectedErr pos = raiseErrorCTExc pos ["Function expected!", "A function is needed here, but this declarator does not declare", "a function."] enumExpectedErr :: Ident -> CT s a enumExpectedErr ide = raiseErrorCTExc (posOf ide) ["Expected enum!", "Expected `" ++ identToString ide ++ "' to denote an enum; instead found", "a struct, union, or object."] structExpectedErr :: Position -> CT s a structExpectedErr pos = raiseErrorCTExc pos ["Expected a struct!", "Expected a structure or union; instead found an enum or basic type."] incompleteTypeErr :: Position -> CT s a incompleteTypeErr pos = raiseErrorCTExc pos ["Illegal use of incomplete type!", "Expected a fully defined structure or union tag; instead found incomplete type."]