-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Analysis and generation of C code -- -- Language C is a haskell library for the analysis and generation of C -- code. It features a complete, well tested parser and pretty printer -- for all of C99 and a large set of C11 and clang/GNU extensions. @package language-c @version 0.6 -- | Unary, binary and asssignment operators. Exported via AST. module Language.C.Syntax.Ops -- | C assignment operators (K&R A7.17) data CAssignOp CAssignOp :: CAssignOp CMulAssOp :: CAssignOp CDivAssOp :: CAssignOp -- | remainder and assignment CRmdAssOp :: CAssignOp CAddAssOp :: CAssignOp CSubAssOp :: CAssignOp CShlAssOp :: CAssignOp CShrAssOp :: CAssignOp CAndAssOp :: CAssignOp CXorAssOp :: CAssignOp COrAssOp :: CAssignOp assignBinop :: CAssignOp -> CBinaryOp -- | C binary operators (K&R A7.6-15) data CBinaryOp CMulOp :: CBinaryOp CDivOp :: CBinaryOp -- | remainder of division CRmdOp :: CBinaryOp CAddOp :: CBinaryOp CSubOp :: CBinaryOp -- | shift left CShlOp :: CBinaryOp -- | shift right CShrOp :: CBinaryOp -- | less CLeOp :: CBinaryOp -- | greater CGrOp :: CBinaryOp -- | less or equal CLeqOp :: CBinaryOp -- | greater or equal CGeqOp :: CBinaryOp -- | equal CEqOp :: CBinaryOp -- | not equal CNeqOp :: CBinaryOp -- | bitwise and CAndOp :: CBinaryOp -- | exclusive bitwise or CXorOp :: CBinaryOp -- | inclusive bitwise or COrOp :: CBinaryOp -- | logical and CLndOp :: CBinaryOp -- | logical or CLorOp :: CBinaryOp isCmpOp :: CBinaryOp -> Bool isPtrOp :: CBinaryOp -> Bool isBitOp :: CBinaryOp -> Bool isLogicOp :: CBinaryOp -> Bool -- | C unary operator (K&R A7.3-4) data CUnaryOp -- | prefix increment operator CPreIncOp :: CUnaryOp -- | prefix decrement operator CPreDecOp :: CUnaryOp -- | postfix increment operator CPostIncOp :: CUnaryOp -- | postfix decrement operator CPostDecOp :: CUnaryOp -- | address operator CAdrOp :: CUnaryOp -- | indirection operator CIndOp :: CUnaryOp -- | prefix plus CPlusOp :: CUnaryOp -- | prefix minus CMinOp :: CUnaryOp -- | one's complement CCompOp :: CUnaryOp -- | logical negation CNegOp :: CUnaryOp isEffectfulOp :: CUnaryOp -> Bool instance Data.Data.Data Language.C.Syntax.Ops.CUnaryOp instance GHC.Show.Show Language.C.Syntax.Ops.CUnaryOp instance GHC.Classes.Ord Language.C.Syntax.Ops.CUnaryOp instance GHC.Classes.Eq Language.C.Syntax.Ops.CUnaryOp instance Data.Data.Data Language.C.Syntax.Ops.CBinaryOp instance GHC.Show.Show Language.C.Syntax.Ops.CBinaryOp instance GHC.Classes.Ord Language.C.Syntax.Ops.CBinaryOp instance GHC.Classes.Eq Language.C.Syntax.Ops.CBinaryOp instance Data.Data.Data Language.C.Syntax.Ops.CAssignOp instance GHC.Show.Show Language.C.Syntax.Ops.CAssignOp instance GHC.Classes.Ord Language.C.Syntax.Ops.CAssignOp instance GHC.Classes.Eq Language.C.Syntax.Ops.CAssignOp -- | This module provides support for representing, checking and exporting -- c constants, i.e. integral, float, character and string constants. module Language.C.Syntax.Constants escapeChar :: Char -> String unescapeChar :: String -> (Char, String) unescapeString :: String -> String newtype Flags f Flags :: Integer -> Flags f noFlags :: Flags f setFlag :: (Enum f) => f -> Flags f -> Flags f clearFlag :: (Enum f) => f -> Flags f -> Flags f testFlag :: (Enum f) => f -> Flags f -> Bool -- | construct a character constant from a haskell Char Use -- cchar_w if you want a wide character constant. cChar :: Char -> CChar -- | construct a wide chararacter constant cChar_w :: Char -> CChar -- | create a multi-character character constant cChars :: String -> Bool -> CChar -- | C char constants (abstract) data CChar CChar :: !Char -> !Bool -> CChar CChars :: [Char] -> !Bool -> CChar -- | get the haskell representation of a char constant getCChar :: CChar -> String -- | get integer value of a C char constant undefined result for multi-char -- char constants getCCharAsInt :: CChar -> Integer -- | return true if the character constant is wide. isWideChar :: CChar -> Bool -- | showCharConst c prepends _a_ String representing the C char -- constant corresponding to c. If necessary uses octal or -- hexadecimal escape sequences. showCharConst :: Char -> ShowS -- | datatype representing type flags for integers data CIntFlag FlagUnsigned :: CIntFlag FlagLong :: CIntFlag FlagLongLong :: CIntFlag FlagImag :: CIntFlag -- | datatype for memorizing the representation of an integer data CIntRepr DecRepr :: CIntRepr HexRepr :: CIntRepr OctalRepr :: CIntRepr -- | construct a integer constant (without type flags) from a haskell -- integer cInteger :: Integer -> CInteger data CInteger CInteger :: !Integer -> !CIntRepr -> !(Flags CIntFlag) -> CInteger getCInteger :: CInteger -> Integer readCInteger :: CIntRepr -> String -> Either String CInteger cFloat :: Float -> CFloat -- | Floats (represented as strings) data CFloat CFloat :: !String -> CFloat readCFloat :: String -> CFloat cString :: String -> CString cString_w :: String -> CString -- | C String literals data CString CString :: String -> Bool -> CString getCString :: CString -> String -- | showStringLiteral s prepends a String representing the C -- string literal corresponding to s. If necessary it uses octal -- or hexadecimal escape sequences. showStringLit :: String -> ShowS -- | concatenate a list of C string literals concatCStrings :: [CString] -> CString -- | Clang dotted version literal -- https://clang.llvm.org/docs/AttributeReference.html#availability data ClangCVersion ClangCVersion :: !String -> ClangCVersion readClangCVersion :: String -> ClangCVersion instance Data.Data.Data Language.C.Syntax.Constants.CInteger instance GHC.Classes.Ord Language.C.Syntax.Constants.CInteger instance GHC.Classes.Eq Language.C.Syntax.Constants.CInteger instance Data.Data.Data f => Data.Data.Data (Language.C.Syntax.Constants.Flags f) instance GHC.Classes.Ord (Language.C.Syntax.Constants.Flags f) instance GHC.Classes.Eq (Language.C.Syntax.Constants.Flags f) instance Data.Data.Data Language.C.Syntax.Constants.CString instance GHC.Classes.Ord Language.C.Syntax.Constants.CString instance GHC.Classes.Eq Language.C.Syntax.Constants.CString instance Data.Data.Data Language.C.Syntax.Constants.ClangCVersion instance GHC.Classes.Ord Language.C.Syntax.Constants.ClangCVersion instance GHC.Classes.Eq Language.C.Syntax.Constants.ClangCVersion instance Data.Data.Data Language.C.Syntax.Constants.CFloat instance GHC.Classes.Ord Language.C.Syntax.Constants.CFloat instance GHC.Classes.Eq Language.C.Syntax.Constants.CFloat instance Data.Data.Data Language.C.Syntax.Constants.CIntFlag instance GHC.Enum.Bounded Language.C.Syntax.Constants.CIntFlag instance GHC.Enum.Enum Language.C.Syntax.Constants.CIntFlag instance GHC.Classes.Ord Language.C.Syntax.Constants.CIntFlag instance GHC.Classes.Eq Language.C.Syntax.Constants.CIntFlag instance Data.Data.Data Language.C.Syntax.Constants.CIntRepr instance GHC.Enum.Bounded Language.C.Syntax.Constants.CIntRepr instance GHC.Enum.Enum Language.C.Syntax.Constants.CIntRepr instance GHC.Classes.Ord Language.C.Syntax.Constants.CIntRepr instance GHC.Classes.Eq Language.C.Syntax.Constants.CIntRepr instance Data.Data.Data Language.C.Syntax.Constants.CChar instance GHC.Classes.Ord Language.C.Syntax.Constants.CChar instance GHC.Classes.Eq Language.C.Syntax.Constants.CChar instance GHC.Show.Show Language.C.Syntax.Constants.CChar instance GHC.Show.Show Language.C.Syntax.Constants.CIntFlag instance GHC.Show.Show Language.C.Syntax.Constants.CInteger instance GHC.Show.Show Language.C.Syntax.Constants.CFloat instance GHC.Show.Show Language.C.Syntax.Constants.ClangCVersion instance GHC.Show.Show Language.C.Syntax.Constants.CString -- | Source code position module Language.C.Data.Position -- | uniform representation of source file positions data Position -- | position absoluteOffset fileName lineNumber columnNumber -- initializes a Position using the given arguments position :: Int -> String -> Int -> Int -> Position -- | Position and length of a token type PosLength = (Position, Int) -- | source file posFile :: Position -> String -- | row (line) in the original file. Affected by #LINE pragmas. posRow :: Position -> Int -- | column in the preprocessed file. Inaccurate w.r.t. to the original -- file in the presence of preprocessor macros. posColumn :: Position -> Int -- | absolute offset in the preprocessed file posOffset :: Position -> Int -- | initialize a Position to the start of the translation unit starting in -- the given file initPos :: FilePath -> Position -- | returns True if the given position refers to an actual source -- file isSourcePos :: Position -> Bool -- | no position (for unknown position information) nopos :: Position -- | returns True if the there is no position information -- available isNoPos :: Position -> Bool -- | position attached to built-in objects builtinPos :: Position -- | returns True if the given position refers to a builtin -- definition isBuiltinPos :: Position -> Bool -- | position used for internal errors internalPos :: Position -- | returns True if the given position is internal isInternalPos :: Position -> Bool -- | advance column incPos :: Position -> Int -> Position -- | advance to next line retPos :: Position -> Position -- | adjust position: change file and line number, reseting column to 1. -- This is usually used for #LINE pragmas. The absolute offset is not -- changed - this can be done by adjustPos newFile line . incPos -- (length pragma). adjustPos :: FilePath -> Int -> Position -> Position -- | advance just the offset incOffset :: Position -> Int -> Position -- | class of type which aggregate a source code location class Pos a posOf :: Pos a => a -> Position instance Data.Data.Data Language.C.Data.Position.Position instance GHC.Classes.Ord Language.C.Data.Position.Position instance GHC.Classes.Eq Language.C.Data.Position.Position instance GHC.Show.Show Language.C.Data.Position.Position -- | Unique Names with fast equality (newtype Int) module Language.C.Data.Name -- | Name is a unique identifier newtype Name Name :: Int -> Name [nameId] :: Name -> Int -- | return an infinite stream of Names starting with -- nameId 0 newNameSupply :: [Name] -- | get the infinite stream of unique names starting from the given -- integer namesStartingFrom :: Int -> [Name] instance Data.Data.Data Language.C.Data.Name.Name instance GHC.Arr.Ix Language.C.Data.Name.Name instance GHC.Classes.Ord Language.C.Data.Name.Name instance GHC.Classes.Eq Language.C.Data.Name.Name instance GHC.Read.Read Language.C.Data.Name.Name instance GHC.Show.Show Language.C.Data.Name.Name instance GHC.Enum.Enum Language.C.Data.Name.Name -- | source position and unqiue name module Language.C.Data.Node -- | Parsed entity attribute data NodeInfo OnlyPos :: Position -> {-# UNPACK #-} !PosLength -> NodeInfo NodeInfo :: Position -> {-# UNPACK #-} !PosLength -> !Name -> NodeInfo -- | create a node with neither name nor positional information undefNode :: NodeInfo -- | return True if the node carries neither name nor positional -- information isUndefNode :: NodeInfo -> Bool -- | | Given only a source position, create a new node attribute mkNodeInfoOnlyPos :: Position -> NodeInfo -- | Given a source position and the position and length of the last token, -- create a new node attribute mkNodeInfoPosLen :: Position -> PosLength -> NodeInfo -- | Given a source position and a unique name, create a new attribute -- identifier mkNodeInfo :: Position -> Name -> NodeInfo -- | Given a source position, the position and length of the last token and -- a unique name, create a new attribute identifier. Strict in mkNodeInfo' :: Position -> PosLength -> Name -> NodeInfo -- | Deprecated: use undefNode instead internalNode :: NodeInfo -- | a class for convenient access to the attributes of an attributed -- object class CNode a nodeInfo :: CNode a => a -> NodeInfo fileOfNode :: (CNode a) => a -> Maybe FilePath posOfNode :: NodeInfo -> Position nameOfNode :: NodeInfo -> Maybe Name -- | get the position and length of the last token getLastTokenPos :: NodeInfo -> PosLength -- | get the number of characters an AST node spans lengthOfNode :: NodeInfo -> Maybe Int -- | equality by name eqByName :: CNode a => a -> a -> Bool instance GHC.Classes.Ord Language.C.Data.Node.NodeInfo instance GHC.Classes.Eq Language.C.Data.Node.NodeInfo instance Data.Data.Data Language.C.Data.Node.NodeInfo instance GHC.Show.Show Language.C.Data.Node.NodeInfo instance Language.C.Data.Position.Pos Language.C.Data.Node.NodeInfo instance Language.C.Data.Node.CNode Language.C.Data.Node.NodeInfo instance (Language.C.Data.Node.CNode a, Language.C.Data.Node.CNode b) => Language.C.Data.Node.CNode (Data.Either.Either a b) -- | Compile time input abstraction for the parser, relying on ByteString. -- The String interface only supports Latin-1 since alex-3, as alex now -- requires byte based access to the input stream. module Language.C.Data.InputStream type InputStream = ByteString -- | read a file into an InputStream readInputStream :: FilePath -> IO InputStream -- | convert InputStream to String inputStreamToString :: InputStream -> String -- | convert a String to an InputStream inputStreamFromString :: String -> InputStream -- | (b,is') = takeByte is reads and removes the first byte -- b from the InputStream is takeByte :: InputStream -> (Word8, InputStream) -- | (c,is') = takeChar is reads and removes the first character -- c from the InputStream is takeChar :: InputStream -> (Char, InputStream) -- | return True if the given input stream is empty inputStreamEmpty :: InputStream -> Bool -- | str = takeChars n is returns the first n characters -- of the given input stream, without removing them takeChars :: Int -> InputStream -> [Char] -- | countLines returns the number of text lines in the given -- InputStream countLines :: InputStream -> Int -- | Invoking external preprocessors. module Language.C.System.Preprocess -- | Preprocessor encapsulates the abstract interface for invoking C -- preprocessors class Preprocessor cpp -- | parse the given command line arguments, and return a pair of parsed -- and ignored arguments parseCPPArgs :: Preprocessor cpp => cpp -> [String] -> Either String (CppArgs, [String]) -- | run the preprocessor runCPP :: Preprocessor cpp => cpp -> CppArgs -> IO ExitCode -- | Generic Options for the preprocessor data CppOption IncludeDir :: FilePath -> CppOption Define :: String -> String -> CppOption Undefine :: String -> CppOption IncludeFile :: FilePath -> CppOption -- | Generic arguments for the preprocessor data CppArgs CppArgs :: [CppOption] -> [String] -> Maybe FilePath -> FilePath -> Maybe FilePath -> CppArgs [cppOptions] :: CppArgs -> [CppOption] [extraOptions] :: CppArgs -> [String] [cppTmpDir] :: CppArgs -> Maybe FilePath [inputFile] :: CppArgs -> FilePath [outputFile] :: CppArgs -> Maybe FilePath -- | use the given preprocessor arguments without analyzing them rawCppArgs :: [String] -> FilePath -> CppArgs -- | add a typed option to the given preprocessor arguments addCppOption :: CppArgs -> CppOption -> CppArgs -- | add a string option to the given preprocessor arguments addExtraOption :: CppArgs -> String -> CppArgs -- | Cpp arguments that only specify the input file name. cppFile :: FilePath -> CppArgs -- | run the preprocessor and return an InputStream if -- preprocesssing succeeded runPreprocessor :: (Preprocessor cpp) => cpp -> CppArgs -> IO (Either ExitCode InputStream) -- | guess whether a file is preprocessed (file end with .i) isPreprocessed :: FilePath -> Bool -- | Invoking gcc for preprocessing and compiling. module Language.C.System.GCC -- | GCC represents a reference to the gcc compiler data GCC -- | create a reference to gcc newGCC :: FilePath -> GCC instance Language.C.System.Preprocess.Preprocessor Language.C.System.GCC.GCC -- | This module provides the notion of identifiers in C, speed up using -- hashing. Identifiers are associated optionally associated with a -- NodeInfo, i.e. with a unique Name and a source location -- (Position). The ordering relation on identifiers is based on -- the hash and does not follow the lexical order. module Language.C.Data.Ident -- | C identifiers data Ident Ident :: String -> {-# UNPACK #-} !Int -> NodeInfo -> Ident -- | References uniquely determining a struct, union or enum type. Those -- are either identified by an string identifier, or by a unique name -- (anonymous types). data SUERef AnonymousRef :: Name -> SUERef NamedRef :: Ident -> SUERef -- | Return true if the struct/union/enum reference is anonymous. isAnonymousRef :: SUERef -> Bool -- | build an identifier from a string. -- --
-- typeof(expr) --CTypeOfExpr :: (CExpression a) -> a -> CTypeSpecifier a -- |
-- typeof(type) --CTypeOfType :: (CDeclaration a) -> a -> CTypeSpecifier a -- |
-- _Atomic(type) --CAtomicType :: (CDeclaration a) -> a -> CTypeSpecifier a data CAlignmentSpecifier a -- |
-- _Alignas(type) --CAlignAsType :: (CDeclaration a) -> a -> CAlignmentSpecifier a -- |
-- _Alignas(expr) --CAlignAsExpr :: (CExpression a) -> a -> CAlignmentSpecifier a data CTypeQualifier a CConstQual :: a -> CTypeQualifier a CVolatQual :: a -> CTypeQualifier a CRestrQual :: a -> CTypeQualifier a CAtomicQual :: a -> CTypeQualifier a CAttrQual :: (CAttribute a) -> CTypeQualifier a CNullableQual :: a -> CTypeQualifier a CNonnullQual :: a -> CTypeQualifier a data CAttribute a CAttr :: Ident -> [CExpression a] -> a -> CAttribute a -- | C declarator (K&R A8.5, C99 6.7.5) and abstract declarator -- (K&R A8.8, C99 6.7.6) -- -- A declarator declares a single object, function, or type. It is always -- associated with a declaration (CDecl), which specifies the -- declaration's type and the additional storage qualifiers and -- attributes, which apply to the declared object. -- -- A declarator is of the form CDeclr name? indirections asm-name? -- attrs _, where name is the name of the declared object -- (missing for abstract declarators), declquals is a set of -- additional declaration specifiers, asm-name is the optional -- assembler name and attributes is a set of attrs is a set of -- attribute annotations for the declared object. -- -- indirections is a set of pointer, array and function -- declarators, which modify the type of the declared object as described -- below. If the declaration specifies the non-derived type -- T, and we have indirections = [D1, D2, ..., Dn] than -- the declared object has type (D1 indirect (D2 -- indirect ... (Dn indirect T))), where -- --
-- int x; -- CDeclr "x" [] ---- --
-- const int * const * restrict x; -- CDeclr "x" [CPtrDeclr [restrict], CPtrDeclr [const]] ---- --
-- int* const f(); -- CDeclr "f" [CFunDeclr [],CPtrDeclr [const]] ---- --
-- int (* const f)(); ==> -- CDeclr "f" [CPtrDeclr [const], CFunDeclr []] --type CDeclr = CDeclarator NodeInfo -- | Derived declarators, see CDeclr -- -- Indirections are qualified using type-qualifiers and generic -- attributes, and additionally -- --
-- CUnknownSize isCompleteType --CNoArrSize :: Bool -> CArraySize a -- |
-- CArrSize isStatic expr --CArrSize :: Bool -> (CExpression a) -> CArraySize a -- | C initialization (K&R A8.7, C99 6.7.8) -- -- Initializers are either assignment expressions or initializer lists -- (surrounded in curly braces), whose elements are themselves -- initializers, paired with an optional list of designators. type CInit = CInitializer NodeInfo -- | Initializer List -- -- The members of an initializer list are of the form -- (designator-list,initializer). The designator-list -- specifies one member of the compound type which is initialized. It is -- allowed to be empty - in this case the initializer refers to the -- 'next' member of the compound type (see C99 6.7.8). -- -- Examples (simplified expressions and identifiers): -- --
-- -- int x[3][4] = { [0][3] = 4, [2] = 5, 8 };
-- -- corresponds to the assignments
-- -- x[0][3] = 4; x[2][0] = 5; x[2][1] = 8;
-- let init1 = ([CArrDesig 0, CArrDesig 3], CInitExpr 4)
-- init2 = ([CArrDesig 2] , CInitExpr 5)
-- init3 = ([] , CInitExpr 8)
-- in CInitList [init1, init2, init3]
--
--
--
-- -- struct { struct { int a[2]; int b[2]; int c[2]; } s; } x = { .s = { {2,3} , .c[0] = 1 } };
-- -- corresponds to the assignments
-- -- x.s.a[0] = 2; x.s.a[1] = 3; x.s.c[0] = 1;
-- let init_s_0 = CInitList [ ([], CInitExpr 2), ([], CInitExpr 3)]
-- init_s = CInitList [
-- ([], init_s_0),
-- ([CMemberDesig "c", CArrDesig 0], CInitExpr 1)
-- ]
-- in CInitList [(CMemberDesig "s", init_s)]
--
type CInitList = CInitializerList NodeInfo
-- | Designators
--
-- A designator specifies a member of an object, either an element or
-- range of an array, or the named member of a struct / union.
type CDesignator = CPartDesignator NodeInfo
data CInitializer a
-- | assignment expression
CInitExpr :: (CExpression a) -> a -> CInitializer a
-- | initialization list (see CInitList)
CInitList :: (CInitializerList a) -> a -> CInitializer a
type CInitializerList a = [([CPartDesignator a], CInitializer a)]
data CPartDesignator a
-- | array position designator
CArrDesig :: (CExpression a) -> a -> CPartDesignator a
-- | member designator
CMemberDesig :: Ident -> a -> CPartDesignator a
-- | array range designator CRangeDesig from to _ (GNU C)
CRangeDesig :: (CExpression a) -> (CExpression a) -> a -> CPartDesignator a
-- | C statement (K&R A9, C99 6.8)
type CStat = CStatement NodeInfo
-- | C99 Block items
--
-- Things that may appear in compound statements: either statements,
-- declarations or nested function definitions.
type CBlockItem = CCompoundBlockItem NodeInfo
-- | GNU Assembler statement
--
-- -- CAssemblyStatement type-qual? asm-expr out-ops in-ops clobbers _ ---- -- is an inline assembler statement. The only type-qualifier (if any) -- allowed is volatile. asm-expr is the actual assembler -- epxression (a string), out-ops and in-ops are the -- input and output operands of the statement. clobbers is a -- list of registers which are clobbered when executing the assembler -- statement type CAsmStmt = CAssemblyStatement NodeInfo -- | Assembler operand -- -- CAsmOperand argName? constraintExpr arg specifies an operand -- for an assembler statement. type CAsmOperand = CAssemblyOperand NodeInfo data CStatement a -- | An (attributed) label followed by a statement CLabel :: Ident -> (CStatement a) -> [CAttribute a] -> a -> CStatement a -- | A statement of the form case expr : stmt CCase :: (CExpression a) -> (CStatement a) -> a -> CStatement a -- | A case range of the form case lower ... upper : stmt CCases :: (CExpression a) -> (CExpression a) -> (CStatement a) -> a -> CStatement a -- | The default case default : stmt CDefault :: (CStatement a) -> a -> CStatement a -- | A simple statement, that is in C: evaluating an expression with -- side-effects and discarding the result. CExpr :: (Maybe (CExpression a)) -> a -> CStatement a -- | compound statement CCompound localLabels blockItems at CCompound :: [Ident] -> [CCompoundBlockItem a] -> a -> CStatement a -- | conditional statement CIf ifExpr thenStmt maybeElseStmt at CIf :: (CExpression a) -> (CStatement a) -> (Maybe (CStatement a)) -> a -> CStatement a -- | switch statement CSwitch selectorExpr switchStmt, where -- switchStmt usually includes case, break and -- default statements CSwitch :: (CExpression a) -> (CStatement a) -> a -> CStatement a -- | while or do-while statement CWhile guard stmt isDoWhile at CWhile :: (CExpression a) -> (CStatement a) -> Bool -> a -> CStatement a -- | for statement CFor init expr-2 expr-3 stmt, where -- init is either a declaration or initializing expression CFor :: (Either (Maybe (CExpression a)) (CDeclaration a)) -> (Maybe (CExpression a)) -> (Maybe (CExpression a)) -> (CStatement a) -> a -> CStatement a -- | goto statement CGoto label CGoto :: Ident -> a -> CStatement a -- | computed goto CGotoPtr labelExpr CGotoPtr :: (CExpression a) -> a -> CStatement a -- | continue statement CCont :: a -> CStatement a -- | break statement CBreak :: a -> CStatement a -- | return statement CReturn returnExpr CReturn :: (Maybe (CExpression a)) -> a -> CStatement a -- | assembly statement CAsm :: (CAssemblyStatement a) -> a -> CStatement a data CCompoundBlockItem a -- | A statement CBlockStmt :: (CStatement a) -> CCompoundBlockItem a -- | A local declaration CBlockDecl :: (CDeclaration a) -> CCompoundBlockItem a -- | A nested function (GNU C) CNestedFunDef :: (CFunctionDef a) -> CCompoundBlockItem a data CAssemblyStatement a CAsmStmt :: (Maybe (CTypeQualifier a)) -> (CStringLiteral a) -> [CAssemblyOperand a] -> [CAssemblyOperand a] -> [CStringLiteral a] -> a -> CAssemblyStatement a data CAssemblyOperand a CAsmOperand :: (Maybe Ident) -> (CStringLiteral a) -> (CExpression a) -> a -> CAssemblyOperand a -- | C expression (K&R A7) -- --
-- (expr, type) --CBuiltinVaArg :: (CExpression a) -> (CDeclaration a) -> a -> CBuiltinThing a -- |
-- (type, designator-list) --CBuiltinOffsetOf :: (CDeclaration a) -> [CPartDesignator a] -> a -> CBuiltinThing a -- |
-- (type,type) --CBuiltinTypesCompatible :: (CDeclaration a) -> (CDeclaration a) -> a -> CBuiltinThing a -- | C constant (K&R A2.5 & A7.2) type CConst = CConstant NodeInfo -- | Attributed string literals type CStrLit = CStringLiteral NodeInfo cstringOfLit :: CStringLiteral a -> CString -- | Lift a string literal to a C constant liftStrLit :: CStringLiteral a -> CConstant a data CConstant a CIntConst :: CInteger -> a -> CConstant a CCharConst :: CChar -> a -> CConstant a CFloatConst :: CFloat -> a -> CConstant a CStrConst :: CString -> a -> CConstant a data CStringLiteral a CStrLit :: CString -> a -> CStringLiteral a -- | All AST nodes are annotated. Inspired by the Annotated class of Niklas -- Broberg's haskell-src-exts package. In principle, we could have -- Copointed superclass instead of ann, for the price of another -- dependency. class (Functor ast) => Annotated ast -- | get the annotation of an AST node annotation :: Annotated ast => ast a -> a -- | change the annotation (non-recursively) of an AST node. Use fmap for -- recursively modifying the annotation. amap :: Annotated ast => (a -> a) -> ast a -> ast a instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CTranslationUnit a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CTranslationUnit a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CExternalDeclaration a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CExternalDeclaration a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CAssemblyOperand a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CAssemblyOperand a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CAssemblyStatement a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CAssemblyStatement a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CArraySize a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CArraySize a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CDerivedDeclarator a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CDerivedDeclarator a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CDeclarator a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CDeclarator a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CStructureUnion a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CStructureUnion a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CEnumeration a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CEnumeration a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CTypeSpecifier a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CTypeSpecifier a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CTypeQualifier a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CTypeQualifier a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CAlignmentSpecifier a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CAlignmentSpecifier a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CDeclarationSpecifier a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CDeclarationSpecifier a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CFunctionDef a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CFunctionDef a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CCompoundBlockItem a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CCompoundBlockItem a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CAttribute a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CAttribute a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CStatement a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CStatement a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CInitializer a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CInitializer a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CPartDesignator a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CPartDesignator a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CBuiltinThing a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CBuiltinThing a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CExpression a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CExpression a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CDeclaration a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CDeclaration a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CStringLiteral a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CStringLiteral a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CConstant a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CConstant a) instance Data.Data.Data Language.C.Syntax.AST.CStructTag instance GHC.Classes.Eq Language.C.Syntax.AST.CStructTag instance GHC.Show.Show Language.C.Syntax.AST.CStructTag instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CFunctionSpecifier a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CFunctionSpecifier a) instance Data.Data.Data a => Data.Data.Data (Language.C.Syntax.AST.CStorageSpecifier a) instance GHC.Classes.Ord a => GHC.Classes.Ord (Language.C.Syntax.AST.CStorageSpecifier a) instance GHC.Classes.Eq a => GHC.Classes.Eq (Language.C.Syntax.AST.CStorageSpecifier a) instance GHC.Show.Show a => GHC.Show.Show (Language.C.Syntax.AST.CStorageSpecifier a) instance GHC.Base.Functor Language.C.Syntax.AST.CDeclaration instance GHC.Base.Functor Language.C.Syntax.AST.CDerivedDeclarator instance GHC.Base.Functor Language.C.Syntax.AST.CStatement instance GHC.Base.Functor Language.C.Syntax.AST.CInitializer instance GHC.Base.Functor Language.C.Syntax.AST.CExpression instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CTranslationUnit t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CTranslationUnit t1) instance GHC.Base.Functor Language.C.Syntax.AST.CTranslationUnit instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CTranslationUnit instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CExternalDeclaration t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CExternalDeclaration t1) instance GHC.Base.Functor Language.C.Syntax.AST.CExternalDeclaration instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CExternalDeclaration instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CFunctionDef t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CFunctionDef t1) instance GHC.Base.Functor Language.C.Syntax.AST.CFunctionDef instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CFunctionDef instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CDeclaration t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CDeclaration t1) instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CDeclaration instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CDeclarator t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CDeclarator t1) instance GHC.Base.Functor Language.C.Syntax.AST.CDeclarator instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CDeclarator instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CDerivedDeclarator t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CDerivedDeclarator t1) instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CDerivedDeclarator instance GHC.Base.Functor Language.C.Syntax.AST.CArraySize instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CStatement t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CStatement t1) instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CStatement instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CAssemblyStatement t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CAssemblyStatement t1) instance GHC.Base.Functor Language.C.Syntax.AST.CAssemblyStatement instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CAssemblyStatement instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CAssemblyOperand t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CAssemblyOperand t1) instance GHC.Base.Functor Language.C.Syntax.AST.CAssemblyOperand instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CAssemblyOperand instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CCompoundBlockItem t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CCompoundBlockItem t1) instance GHC.Base.Functor Language.C.Syntax.AST.CCompoundBlockItem instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CCompoundBlockItem instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CDeclarationSpecifier t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CDeclarationSpecifier t1) instance GHC.Base.Functor Language.C.Syntax.AST.CDeclarationSpecifier instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CDeclarationSpecifier instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CStorageSpecifier t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CStorageSpecifier t1) instance GHC.Base.Functor Language.C.Syntax.AST.CStorageSpecifier instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CStorageSpecifier instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CTypeSpecifier t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CTypeSpecifier t1) instance GHC.Base.Functor Language.C.Syntax.AST.CTypeSpecifier instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CTypeSpecifier instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CTypeQualifier t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CTypeQualifier t1) instance GHC.Base.Functor Language.C.Syntax.AST.CTypeQualifier instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CTypeQualifier instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CFunctionSpecifier t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CFunctionSpecifier t1) instance GHC.Base.Functor Language.C.Syntax.AST.CFunctionSpecifier instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CFunctionSpecifier instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CAlignmentSpecifier t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CAlignmentSpecifier t1) instance GHC.Base.Functor Language.C.Syntax.AST.CAlignmentSpecifier instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CAlignmentSpecifier instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CStructureUnion t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CStructureUnion t1) instance GHC.Base.Functor Language.C.Syntax.AST.CStructureUnion instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CStructureUnion instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CEnumeration t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CEnumeration t1) instance GHC.Base.Functor Language.C.Syntax.AST.CEnumeration instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CEnumeration instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CInitializer t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CInitializer t1) instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CInitializer instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CPartDesignator t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CPartDesignator t1) instance GHC.Base.Functor Language.C.Syntax.AST.CPartDesignator instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CPartDesignator instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CAttribute t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CAttribute t1) instance GHC.Base.Functor Language.C.Syntax.AST.CAttribute instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CAttribute instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CExpression t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CExpression t1) instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CExpression instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CBuiltinThing t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CBuiltinThing t1) instance GHC.Base.Functor Language.C.Syntax.AST.CBuiltinThing instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CBuiltinThing instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CConstant t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CConstant t1) instance GHC.Base.Functor Language.C.Syntax.AST.CConstant instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CConstant instance Language.C.Data.Node.CNode t1 => Language.C.Data.Node.CNode (Language.C.Syntax.AST.CStringLiteral t1) instance Language.C.Data.Node.CNode t1 => Language.C.Data.Position.Pos (Language.C.Syntax.AST.CStringLiteral t1) instance GHC.Base.Functor Language.C.Syntax.AST.CStringLiteral instance Language.C.Syntax.AST.Annotated Language.C.Syntax.AST.CStringLiteral -- | Syntax of C files: The abstract syntax tree and constants. module Language.C.Syntax module Language.C.Syntax.Utils getSubStmts :: CStat -> [CStat] mapSubStmts :: (CStat -> Bool) -> (CStat -> CStat) -> CStat -> CStat mapBlockItemStmts :: (CStat -> Bool) -> (CStat -> CStat) -> CBlockItem -> CBlockItem getLabels :: CStat -> [Ident] -- | Base type for errors occurring in parsing, analysing and -- pretty-printing. With ideas from Simon Marlow's "An extensible -- dynamically-typed hierarchy of execeptions [2006]" module Language.C.Data.Error -- | Error levels (severity) data ErrorLevel LevelWarn :: ErrorLevel LevelError :: ErrorLevel LevelFatal :: ErrorLevel -- | return True when the given error makes it impossible to -- continue analysis or compilation. isHardError :: (Error ex) => ex -> Bool -- | errors in Language.C are instance of Error class (Typeable e, Show e) => Error e where fromError (CError e) = cast e toError = CError changeErrorLevel e lvl = if errorLevel e == lvl then e else error $ "changeErrorLevel: not possible for " ++ show e -- | obtain source location etc. of an error errorInfo :: Error e => e -> ErrorInfo -- | wrap error in CError toError :: Error e => e -> CError -- | try to cast a generic CError to the specific error type fromError :: Error e => CError -> (Maybe e) -- | modify the error level changeErrorLevel :: Error e => e -> ErrorLevel -> e -- | position of an Error errorPos :: (Error e) => e -> Position -- | severity level of an Error errorLevel :: (Error e) => e -> ErrorLevel -- | message lines of an Error errorMsgs :: (Error e) => e -> [String] -- | supertype of all errors data CError CError :: err -> CError -- | information attached to every error in Language.C data ErrorInfo ErrorInfo :: ErrorLevel -> Position -> [String] -> ErrorInfo showError :: (Error e) => String -> e -> String -- | converts an error into a string using a fixed format -- --
-- <fname>:<row>: (column <col>) [<err lvl>] -- >>> <line_1> -- <line_2> -- ... -- <line_n> --showErrorInfo :: String -> ErrorInfo -> String mkErrorInfo :: ErrorLevel -> String -> NodeInfo -> ErrorInfo -- | error raised if a operation requires an unsupported or not yet -- implemented feature. data UnsupportedFeature unsupportedFeature :: (Pos a) => String -> a -> UnsupportedFeature unsupportedFeature_ :: String -> UnsupportedFeature -- | unspecified error raised by the user (in case the user does not want -- to define her own error types). data UserError userErr :: String -> UserError -- | raise a fatal internal error; message may have multiple lines internalErr :: String -> a instance GHC.Classes.Ord Language.C.Data.Error.ErrorLevel instance GHC.Classes.Eq Language.C.Data.Error.ErrorLevel instance GHC.Show.Show Language.C.Data.Error.ErrorLevel instance GHC.Show.Show Language.C.Data.Error.ErrorInfo instance Language.C.Data.Error.Error Language.C.Data.Error.ErrorInfo instance GHC.Show.Show Language.C.Data.Error.CError instance Language.C.Data.Error.Error Language.C.Data.Error.CError instance Language.C.Data.Error.Error Language.C.Data.Error.UnsupportedFeature instance GHC.Show.Show Language.C.Data.Error.UnsupportedFeature instance Language.C.Data.Error.Error Language.C.Data.Error.UserError instance GHC.Show.Show Language.C.Data.Error.UserError -- | Common data types for Language.C: Identifiers, unique names, source -- code locations, ast node attributes and extensible errors. module Language.C.Data -- | References uniquely determining a struct, union or enum type. Those -- are either identified by an string identifier, or by a unique name -- (anonymous types). data SUERef AnonymousRef :: Name -> SUERef NamedRef :: Ident -> SUERef -- | Return true if the struct/union/enum reference is anonymous. isAnonymousRef :: SUERef -> Bool -- | C identifiers data Ident -- | build an identifier from a string. -- --
-- MemberDecl vardecl bitfieldsize node --MemberDecl :: VarDecl -> (Maybe Expr) -> NodeInfo -> MemberDecl -- |
-- AnonBitField typ size --AnonBitField :: Type -> Expr -> NodeInfo -> MemberDecl -- | typedef definitions. -- -- The identifier is a new name for the given type. data TypeDef TypeDef :: Ident -> Type -> Attributes -> NodeInfo -> TypeDef -- | return the idenitifier of a typedef identOfTypeDef :: TypeDef -> Ident -- | Generic variable declarations data VarDecl VarDecl :: VarName -> DeclAttrs -> Type -> VarDecl -- | Declaration attributes of the form DeclAttrs isInlineFunction -- storage linkage attrs -- -- They specify the storage and linkage of a declared object. data DeclAttrs -- |
-- DeclAttrs fspecs storage attrs --DeclAttrs :: FunctionAttrs -> Storage -> Attributes -> DeclAttrs isExtDecl :: (Declaration n) => n -> Bool data FunctionAttrs FunctionAttrs :: Bool -> Bool -> FunctionAttrs [isInline] :: FunctionAttrs -> Bool [isNoreturn] :: FunctionAttrs -> Bool -- | get the `function attributes' of a declaration functionAttrs :: (Declaration d) => d -> FunctionAttrs noFunctionAttrs :: FunctionAttrs -- | Storage duration and linkage of a variable data Storage -- | no storage NoStorage :: Storage -- | automatic storage (optional: register) Auto :: Register -> Storage -- | static storage, linkage spec and thread local specifier (gnu c) Static :: Linkage -> ThreadLocal -> Storage -- | function, either internal or external linkage FunLinkage :: Linkage -> Storage -- | get the Storage of a declaration declStorage :: (Declaration d) => d -> Storage type ThreadLocal = Bool type Register = Bool -- | Linkage: Either no linkage, internal to the translation unit or -- external data Linkage NoLinkage :: Linkage InternalLinkage :: Linkage ExternalLinkage :: Linkage -- | return True if the object has linkage hasLinkage :: Storage -> Bool -- | Get the linkage of a definition declLinkage :: (Declaration d) => d -> Linkage -- | types of C objects data Type -- | a non-derived type DirectType :: TypeName -> TypeQuals -> Attributes -> Type -- | pointer type PtrType :: Type -> TypeQuals -> Attributes -> Type -- | array type ArrayType :: Type -> ArraySize -> TypeQuals -> Attributes -> Type -- | function type FunctionType :: FunType -> Attributes -> Type -- | a defined type TypeDefType :: TypeDefRef -> TypeQuals -> Attributes -> Type -- | Function types are of the form FunType return-type params -- isVariadic. -- -- If the parameter types aren't yet known, the function has type -- FunTypeIncomplete type attrs. data FunType FunType :: Type -> [ParamDecl] -> Bool -> FunType FunTypeIncomplete :: Type -> FunType -- | An array type may either have unknown size or a specified array size, -- the latter either variable or constant. Furthermore, when used as a -- function parameters, the size may be qualified as static. In a -- function prototype, the size may be `Unspecified variable size' -- ([*]). data ArraySize -- |
-- UnknownArraySize is-starred --UnknownArraySize :: Bool -> ArraySize -- |
-- FixedSizeArray is-static size-expr --ArraySize :: Bool -> Expr -> ArraySize -- | typdef references If the actual type is known, it is attached for -- convenience data TypeDefRef TypeDefRef :: Ident -> Type -> NodeInfo -> TypeDefRef -- | normalized type representation data TypeName TyVoid :: TypeName TyIntegral :: IntType -> TypeName TyFloating :: FloatType -> TypeName TyComplex :: FloatType -> TypeName TyComp :: CompTypeRef -> TypeName TyEnum :: EnumTypeRef -> TypeName TyBuiltin :: BuiltinType -> TypeName -- | Builtin type (va_list, anything) data BuiltinType TyVaList :: BuiltinType TyAny :: BuiltinType -- | integral types (C99 6.7.2.2) data IntType TyBool :: IntType TyChar :: IntType TySChar :: IntType TyUChar :: IntType TyShort :: IntType TyUShort :: IntType TyInt :: IntType TyUInt :: IntType TyInt128 :: IntType TyUInt128 :: IntType TyLong :: IntType TyULong :: IntType TyLLong :: IntType TyULLong :: IntType -- | floating point type (C99 6.7.2.2) data FloatType TyFloat :: FloatType TyDouble :: FloatType TyLDouble :: FloatType -- | accessor class : struct/union/enum names class HasSUERef a sueRef :: HasSUERef a => a -> SUERef -- | accessor class : composite type tags (struct or union) class HasCompTyKind a compTag :: HasCompTyKind a => a -> CompTyKind -- | composite type declarations data CompTypeRef CompTypeRef :: SUERef -> CompTyKind -> NodeInfo -> CompTypeRef -- | Composite type (struct or union). data CompType CompType :: SUERef -> CompTyKind -> [MemberDecl] -> Attributes -> NodeInfo -> CompType -- | return the type of a composite type definition typeOfCompDef :: CompType -> TypeName -- | a tag to determine wheter we refer to a struct or -- union, see CompType. data CompTyKind StructTag :: CompTyKind UnionTag :: CompTyKind data EnumTypeRef EnumTypeRef :: SUERef -> NodeInfo -> EnumTypeRef -- | Representation of C enumeration types data EnumType -- |
-- EnumType name enumeration-constants attrs node --EnumType :: SUERef -> [Enumerator] -> Attributes -> NodeInfo -> EnumType -- | return the type of an enum definition typeOfEnumDef :: EnumType -> TypeName -- | An Enumerator consists of an identifier, a constant expressions and -- the link to its type data Enumerator Enumerator :: Ident -> Expr -> EnumType -> NodeInfo -> Enumerator -- | Type qualifiers: constant, volatile and restrict data TypeQuals TypeQuals :: Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> TypeQuals [constant] :: TypeQuals -> Bool [volatile] :: TypeQuals -> Bool [restrict] :: TypeQuals -> Bool [atomic] :: TypeQuals -> Bool [nullable] :: TypeQuals -> Bool [nonnull] :: TypeQuals -> Bool -- | no type qualifiers noTypeQuals :: TypeQuals -- | merge (&&) two type qualifier sets mergeTypeQuals :: TypeQuals -> TypeQuals -> TypeQuals -- | VarName name assembler-name is a name of an declared object data VarName VarName :: Ident -> (Maybe AsmName) -> VarName NoName :: VarName identOfVarName :: VarName -> Ident isNoName :: VarName -> Bool -- | Assembler name (alias for CStrLit) type AsmName = CStrLit -- | attribute annotations -- -- Those are of the form Attr attribute-name -- attribute-parameters, and serve as generic properties of some -- syntax tree elements. -- -- Some examples: -- --
-- nameSpaceToList ns = (localDefInnermost ns ++ .. ++ localDefsOutermost ns) ++ globalDefs ns --nsMapToList :: (Ord k) => NameSpaceMap k a -> [(k, a)] globalNames :: (Ord k) => NameSpaceMap k v -> Map k v localNames :: (Ord k) => NameSpaceMap k v -> [[(k, v)]] hasLocalNames :: NameSpaceMap k v -> Bool -- | Add global definition -- -- (ns',oldDef) = defGlobal ns ident def adds a global -- definition ident := def to the namespace. It returns the -- modified namespace ns'. If the identifier is already declared -- in the global namespace, the definition is overwritten and the old -- definition oldDef is returned. defGlobal :: (Ord k) => NameSpaceMap k a -> k -> a -> (NameSpaceMap k a, Maybe a) -- | Enter new local scope -- -- ns' = enterNewScope ns creates and enters a new local scope. enterNewScope :: (Ord k) => NameSpaceMap k a -> NameSpaceMap k a -- | Leave innermost local scope -- -- (ns',defs) = leaveScope ns pops leaves the innermost local -- scope. and returns its definitions leaveScope :: (Ord k) => NameSpaceMap k a -> (NameSpaceMap k a, [(k, a)]) -- | Add local definition -- -- (ns',oldDef) = defLocal ns ident def adds the local -- definition ident := def to the innermost local scope, if -- there is a local scope, and to the global scope otherwise. It returns -- the modified name space ns' and the old binding of the -- identifier oldDef, which is overwritten. defLocal :: (Ord k) => NameSpaceMap k a -> k -> a -> (NameSpaceMap k a, Maybe a) -- | Search for a definition -- -- def = find ns ident returns the definition in some scope -- (inner to outer), if there is one. lookupName :: (Ord k) => NameSpaceMap k a -> k -> Maybe a lookupGlobal :: (Ord k) => NameSpaceMap k a -> k -> Maybe a lookupInnermostScope :: (Ord k) => NameSpaceMap k a -> k -> Maybe a -- | Merge two namespaces. If they disagree on the types of any variables, -- all bets are off. mergeNameSpace :: (Ord k) => NameSpaceMap k a -> NameSpaceMap k a -> NameSpaceMap k a -- | WARNING : This is just an implementation sketch and not very -- well tested. -- -- Export SemRep entities to AST nodes. module Language.C.Analysis.Export -- | Export Declarator -- -- Synopsis: exportDeclr other_specs type attributes -- variable-name exportDeclr :: [CDeclSpec] -> Type -> Attributes -> VarName -> ([CDeclSpec], CDeclr) -- | Export a type to syntax exportType :: Type -> ([CDeclSpec], [CDerivedDeclr]) exportTypeDecl :: Type -> CDecl exportTypeSpec :: TypeName -> [CTypeSpec] exportTypeDef :: TypeDef -> CDecl exportCompType :: CompType -> [CTypeSpec] exportCompTypeDecl :: CompTypeRef -> [CTypeSpec] exportCompTypeRef :: CompType -> [CTypeSpec] exportEnumType :: EnumType -> [CTypeSpec] exportEnumTypeDecl :: EnumTypeRef -> [CTypeSpec] exportEnumTypeRef :: EnumType -> [CTypeSpec] -- | This module manages symbols in local and global scopes. -- -- There are four different kind of identifiers: ordinary identifiers -- (henceforth simply called identifier), tag names (names of -- struct/union/enum types), labels and structure members. module Language.C.Analysis.DefTable -- | All ordinary identifiers map to IdenTyDecl: either a typedef -- or a object/function/enumerator type IdentEntry = Either TypeDef IdentDecl identOfTyDecl :: IdentEntry -> Ident -- | Tag names map to forward declarations or definitions of -- struct/union/enum types type TagEntry = Either TagFwdDecl TagDef data TagFwdDecl CompDecl :: CompTypeRef -> TagFwdDecl EnumDecl :: EnumTypeRef -> TagFwdDecl -- | Table holding current definitions data DefTable DefTable :: NameSpaceMap Ident IdentEntry -> NameSpaceMap SUERef TagEntry -> NameSpaceMap Ident Ident -> NameSpaceMap Ident MemberDecl -> IntMap Name -> IntMap Type -> DefTable -- | declared `ordinary identifiers' [identDecls] :: DefTable -> NameSpaceMap Ident IdentEntry -- | declared structunionenum tags [tagDecls] :: DefTable -> NameSpaceMap SUERef TagEntry -- | defined labels [labelDefs] :: DefTable -> NameSpaceMap Ident Ident -- | member declarations (only local) [memberDecls] :: DefTable -> NameSpaceMap Ident MemberDecl -- | link names with definitions [refTable] :: DefTable -> IntMap Name [typeTable] :: DefTable -> IntMap Type -- | empty definition table, with all name space maps in global scope emptyDefTable :: DefTable -- | get the globally defined entries of a definition table globalDefs :: DefTable -> GlobalDecls inFileScope :: DefTable -> Bool -- | Enter function scope (AND the corresponding block scope) enterFunctionScope :: DefTable -> DefTable -- | Leave function scope, and return the associated DefTable. Error if not -- in function scope. leaveFunctionScope :: DefTable -> DefTable -- | Enter new block scope enterBlockScope :: DefTable -> DefTable -- | Leave innermost block scope leaveBlockScope :: DefTable -> DefTable -- | Enter new member declaration scope enterMemberDecl :: DefTable -> DefTable -- | Leave innermost member declaration scope leaveMemberDecl :: DefTable -> ([MemberDecl], DefTable) -- | Status of a declaration data DeclarationStatus t -- | new entry NewDecl :: DeclarationStatus t -- | old def was overwritten Redeclared :: t -> DeclarationStatus t -- | new def was discarded KeepDef :: t -> DeclarationStatus t -- | new def shadows one in outer scope Shadowed :: t -> DeclarationStatus t -- | kind mismatch KindMismatch :: t -> DeclarationStatus t declStatusDescr :: DeclarationStatus t -> String defineTypeDef :: Ident -> TypeDef -> DefTable -> (DeclarationStatus IdentEntry, DefTable) -- | declare/define a global object/function/typeDef -- -- returns Redeclared def if there is already an -- object/function/typeDef in global scope, or DifferentKindRedec -- def if the old declaration is of a different kind. defineGlobalIdent :: Ident -> IdentDecl -> DefTable -> (DeclarationStatus IdentEntry, DefTable) -- | declare/define a object/function/typeDef with lexical scope -- -- returns Redeclared def or DifferentKindRedec def if -- there is already an object/function/typeDef in the same scope. defineScopedIdent :: Ident -> IdentDecl -> DefTable -> (DeclarationStatus IdentEntry, DefTable) -- | declare/define a object/function/typeDef with lexical scope, if the -- given predicate holds on the old entry. -- -- returns Keep old_def if the old definition shouldn't be -- overwritten, and otherwise Redeclared def or -- DifferentKindRedecl def if there is already an -- object/function/typeDef in the same scope. defineScopedIdentWhen :: (IdentDecl -> Bool) -> Ident -> IdentDecl -> DefTable -> (DeclarationStatus IdentEntry, DefTable) -- | declare a tag (fwd decl in case the struct name isn't defined yet) declareTag :: SUERef -> TagFwdDecl -> DefTable -> (DeclarationStatus TagEntry, DefTable) -- | define a tag defineTag :: SUERef -> TagDef -> DefTable -> (DeclarationStatus TagEntry, DefTable) -- | define a label Return the old label if it is already defined in this -- function's scope defineLabel :: Ident -> DefTable -> (DeclarationStatus Ident, DefTable) -- | lookup identifier (object, function, typeDef, enumerator) lookupIdent :: Ident -> DefTable -> Maybe IdentEntry -- | lookup tag lookupTag :: SUERef -> DefTable -> Maybe TagEntry -- | lookup label lookupLabel :: Ident -> DefTable -> Maybe Ident -- | lookup an object in the innermost scope lookupIdentInner :: Ident -> DefTable -> Maybe IdentEntry -- | lookup an identifier in the innermost scope lookupTagInner :: SUERef -> DefTable -> Maybe TagEntry -- | Record the type of a node. insertType :: DefTable -> Name -> Type -> DefTable -- | Lookup the type of a node. lookupType :: DefTable -> Name -> Maybe Type -- | Merge two DefTables. If both tables contain an entry for a given key, -- they must agree on its value. mergeDefTable :: DefTable -> DefTable -> DefTable instance GHC.Classes.Ord Language.C.Analysis.DefTable.TagEntryKind instance GHC.Classes.Eq Language.C.Analysis.DefTable.TagEntryKind instance Data.Data.Data t => Data.Data.Data (Language.C.Analysis.DefTable.DeclarationStatus t) instance Language.C.Analysis.SemRep.HasSUERef Language.C.Analysis.DefTable.TagFwdDecl instance Language.C.Data.Node.CNode Language.C.Analysis.DefTable.TagFwdDecl instance GHC.Show.Show Language.C.Analysis.DefTable.TagEntryKind -- | Pretty printing the semantic analysis representation. This is -- currently only intended for debugging purposes. module Language.C.Analysis.Debug globalDeclStats :: (FilePath -> Bool) -> GlobalDecls -> [(String, Int)] prettyAssocs :: (Pretty k, Pretty v) => String -> [(k, v)] -> Doc prettyAssocsWith :: String -> (k -> Doc) -> (v -> Doc) -> [(k, v)] -> Doc instance Language.C.Pretty.Pretty Language.C.Analysis.DefTable.DefTable instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.GlobalDecls instance (Language.C.Pretty.Pretty a, Language.C.Pretty.Pretty b) => Language.C.Pretty.Pretty (Data.Either.Either a b) instance Language.C.Pretty.Pretty Language.C.Analysis.DefTable.TagFwdDecl instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.CompTyKind instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.CompTypeRef instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.EnumTypeRef instance Language.C.Pretty.Pretty Language.C.Data.Ident.Ident instance Language.C.Pretty.Pretty Language.C.Data.Ident.SUERef instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.TagDef instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.IdentDecl instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.Decl instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.TypeDef instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.ObjDef instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.FunDef instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.VarDecl instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.ParamDecl instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.DeclAttrs instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.Type instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.TypeQuals instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.CompType instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.MemberDecl instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.EnumType instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.Enumerator instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.FunctionAttrs instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.Storage instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.Linkage instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.VarName instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.Attributes instance Language.C.Pretty.Pretty Language.C.Analysis.SemRep.Attr module Language.C.Analysis.Builtins builtins :: DefTable -- | 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. module Language.C.Analysis.TravMonad class (Monad m) => MonadName m -- | unique name generation genName :: MonadName m => m Name class (Monad m) => MonadSymtab m -- | return the definition table getDefTable :: MonadSymtab m => m DefTable -- | perform an action modifying the definition table withDefTable :: MonadSymtab m => (DefTable -> (a, DefTable)) -> m a class (Monad m) => MonadCError m -- | throw an Error throwTravError :: (MonadCError m, Error e) => e -> m a -- | catch an Error (we could implement dynamically-typed catch -- here) catchTravError :: MonadCError m => m a -> (CError -> m a) -> m a -- | remember that an Error occurred (without throwing it) recordError :: (MonadCError m, Error e) => e -> m () -- | return the list of recorded errors getErrors :: MonadCError m => m [CError] -- | Traversal monad class (MonadName m, MonadSymtab m, MonadCError m) => MonadTrav m -- | handling declarations and definitions handleDecl :: MonadTrav m => DeclEvent -> m () -- | forward declaration of a tag. Only necessary for name analysis, but -- otherwise no semantic consequences. handleTagDecl :: (MonadCError m, MonadSymtab m) => TagFwdDecl -> 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). handleTagDef :: (MonadTrav m) => TagDef -> m () handleEnumeratorDef :: (MonadCError m, MonadSymtab m) => Enumerator -> m () handleTypeDef :: (MonadTrav m) => TypeDef -> m () -- | handle object defintions (maybe tentative) handleObjectDef :: (MonadTrav m) => Bool -> Ident -> ObjDef -> m () -- | handle function definitions handleFunDef :: (MonadTrav m) => Ident -> FunDef -> 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 handleVarDecl :: (MonadTrav m) => Bool -> Decl -> 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 handleParamDecl :: (MonadTrav m) => ParamDecl -> m () handleAsmBlock :: (MonadTrav m) => AsmBlock -> m () enterPrototypeScope :: (MonadSymtab m) => m () leavePrototypeScope :: (MonadSymtab m) => m () enterFunctionScope :: (MonadSymtab m) => m () leaveFunctionScope :: (MonadSymtab m) => m () enterBlockScope :: (MonadSymtab m) => m () leaveBlockScope :: (MonadSymtab m) => m () -- | lookup a type definition the 'wrong kind of object' is an internal -- error here, because the parser should distinguish typeDefs and other -- objects lookupTypeDef :: (MonadCError m, MonadSymtab m) => Ident -> m Type -- | lookup an object, function or enumerator lookupObject :: (MonadCError m, MonadSymtab m) => Ident -> m (Maybe IdentDecl) -- | 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. createSUERef :: (MonadCError m, MonadSymtab m) => NodeInfo -> Maybe Ident -> m SUERef -- | check wheter non-recoverable errors occurred hadHardErrors :: [CError] -> Bool handleTravError :: (MonadCError m) => m a -> m (Maybe a) -- | raise an error based on an Either argument throwOnLeft :: (MonadCError m, Error e) => Either e a -> m a -- | raise an error caused by a malformed AST astError :: (MonadCError m) => NodeInfo -> String -> m a warn :: (Error e, MonadCError m) => e -> m () -- | simple traversal monad, providing user state and callbacks data Trav s a runTrav :: forall s a. s -> Trav s a -> Either [CError] (a, TravState s) runTrav_ :: Trav () a -> Either [CError] (a, [CError]) data TravState s initTravState :: s -> TravState s withExtDeclHandler :: Trav s a -> (DeclEvent -> Trav s ()) -> Trav s a modifyUserState :: (s -> s) -> Trav s () userState :: TravState s -> s getUserState :: Trav s s data TravOptions TravOptions :: CLanguage -> TravOptions [language] :: TravOptions -> CLanguage modifyOptions :: (TravOptions -> TravOptions) -> Trav s () travErrors :: TravState s -> [CError] -- | The variety of the C language to accept. Note: this is not yet -- enforced. data CLanguage C89 :: CLanguage C99 :: CLanguage GNU89 :: CLanguage GNU99 :: CLanguage mapMaybeM :: (Monad m) => (Maybe a) -> (a -> m b) -> m (Maybe b) maybeM :: (Monad m) => (Maybe a) -> (a -> m ()) -> m () mapSndM :: (Monad m) => (b -> m c) -> (a, b) -> m (a, c) concatMapM :: (Monad m) => (a -> m [b]) -> [a] -> m [b] instance GHC.Base.Functor (Language.C.Analysis.TravMonad.Trav s) instance GHC.Base.Applicative (Language.C.Analysis.TravMonad.Trav s) instance GHC.Base.Monad (Language.C.Analysis.TravMonad.Trav s) instance Language.C.Analysis.TravMonad.MonadName (Language.C.Analysis.TravMonad.Trav s) instance Language.C.Analysis.TravMonad.MonadSymtab (Language.C.Analysis.TravMonad.Trav s) instance Language.C.Analysis.TravMonad.MonadCError (Language.C.Analysis.TravMonad.Trav s) instance Language.C.Analysis.TravMonad.MonadTrav (Language.C.Analysis.TravMonad.Trav s) module Language.C.Analysis.TypeCheck pType :: Type -> String typeErrorOnLeft :: (MonadCError m) => NodeInfo -> Either String a -> m a typeError :: MonadCError m => NodeInfo -> String -> m a notFound :: Ident -> Either String a checkScalar' :: MonadCError m => NodeInfo -> Type -> m () checkIntegral' :: MonadCError m => NodeInfo -> Type -> m () assignCompatible' :: MonadCError m => NodeInfo -> CAssignOp -> Type -> Type -> m () binopType' :: MonadCError m => NodeInfo -> CBinaryOp -> Type -> Type -> m Type conditionalType' :: MonadCError m => NodeInfo -> Type -> Type -> m Type checkScalar :: Type -> Either String () checkIntegral :: Type -> Either String () -- | Determine the type of a constant. constType :: (MonadCError m, MonadName m) => CConst -> m Type -- | Determine whether two types are compatible. compatible :: Type -> Type -> Either String () -- | Determine the composite type of two compatible types. compositeType :: Type -> Type -> Either String Type compositeSize :: ArraySize -> ArraySize -> Either String ArraySize sizeEqual :: CExpr -> CExpr -> Bool mergeAttrs :: Attributes -> Attributes -> Attributes compositeParamDecl :: ParamDecl -> ParamDecl -> Either String ParamDecl compositeParamDecl' :: (VarDecl -> NodeInfo -> ParamDecl) -> VarDecl -> VarDecl -> NodeInfo -> Either String ParamDecl compositeVarDecl :: VarDecl -> VarDecl -> Either String VarDecl compositeDeclAttrs :: DeclAttrs -> DeclAttrs -> DeclAttrs castCompatible :: Type -> Type -> Either String () -- | Determine whether two types are compatible in an assignment -- expression. assignCompatible :: CAssignOp -> Type -> Type -> Either String () -- | Determine the type of a binary operation. binopType :: CBinaryOp -> Type -> Type -> Either String Type -- | Determine the type of a conditional expression. conditionalType :: Type -> Type -> Either String Type derefType :: Type -> Either String Type varAddrType :: IdentDecl -> Either String Type -- | Get the type of field m of type t fieldType :: (MonadCError m, MonadSymtab m) => NodeInfo -> Ident -> Type -> m Type -- | Get all members of a struct, union, or enum, with their types. -- Collapse fields of anonymous members. tagMembers :: (MonadCError m, MonadSymtab m) => NodeInfo -> TagDef -> m [(Ident, Type)] -- | Expand an anonymous composite type into a list of member names and -- their associated types. expandAnonymous :: (MonadCError m, MonadSymtab m) => NodeInfo -> (VarName, Type) -> m [(Ident, Type)] lookupSUE :: (MonadCError m, MonadSymtab m) => NodeInfo -> SUERef -> m TagDef deepTypeAttrs :: (MonadCError m, MonadSymtab m) => Type -> m Attributes typeDefAttrs :: (MonadCError m, MonadSymtab m) => NodeInfo -> Ident -> m Attributes sueAttrs :: (MonadCError m, MonadSymtab m) => NodeInfo -> SUERef -> m Attributes -- | This module performs the analysis of declarations and the translation -- of type specifications in the AST. module Language.C.Analysis.DeclAnalysis -- | get the type of a type declaration -- -- A type declaration T may appear in thre forms: -- --
typeof(T)
-- int f(d,c,a,b)
-- char a,*b;
-- int c;
-- { }
--
--
-- is converted to
--
-- -- int f(int d, int c, char a, char* b) ---- -- TODO: This could be moved to syntax, as it operates on the AST only mergeOldStyle :: (MonadCError m) => NodeInfo -> [CDecl] -> [CDerivedDeclr] -> m [CDerivedDeclr] canonicalTypeSpec :: (MonadTrav m) => [CTypeSpec] -> m TypeSpecAnalysis data NumBaseType NoBaseType :: NumBaseType BaseChar :: NumBaseType BaseInt :: NumBaseType BaseInt128 :: NumBaseType BaseFloat :: NumBaseType BaseDouble :: NumBaseType data SignSpec NoSignSpec :: SignSpec Signed :: SignSpec Unsigned :: SignSpec data SizeMod NoSizeMod :: SizeMod ShortMod :: SizeMod LongMod :: SizeMod LongLongMod :: SizeMod data NumTypeSpec NumTypeSpec :: NumBaseType -> SignSpec -> SizeMod -> Bool -> NumTypeSpec [base] :: NumTypeSpec -> NumBaseType [signSpec] :: NumTypeSpec -> SignSpec [sizeMod] :: NumTypeSpec -> SizeMod [isComplex] :: NumTypeSpec -> Bool data TypeSpecAnalysis TSNone :: TypeSpecAnalysis TSVoid :: TypeSpecAnalysis TSBool :: TypeSpecAnalysis TSNum :: NumTypeSpec -> TypeSpecAnalysis TSTypeDef :: TypeDefRef -> TypeSpecAnalysis TSType :: Type -> TypeSpecAnalysis TSNonBasic :: CTypeSpec -> TypeSpecAnalysis canonicalStorageSpec :: (MonadCError m) => [CStorageSpec] -> m StorageSpec data StorageSpec NoStorageSpec :: StorageSpec AutoSpec :: StorageSpec RegSpec :: StorageSpec ThreadSpec :: StorageSpec StaticSpec :: Bool -> StorageSpec ExternSpec :: Bool -> StorageSpec hasThreadLocalSpec :: StorageSpec -> Bool isTypeDef :: [CDeclSpec] -> Bool data VarDeclInfo VarDeclInfo :: VarName -> FunctionAttrs -> StorageSpec -> Attributes -> Type -> NodeInfo -> VarDeclInfo -- | translate attribute annotations TODO: This is a unwrap -- and wrap stub tAttr :: (MonadCError m, MonadSymtab m) => CAttr -> m Attr -- | construct a name for a variable TODO: more or less bogus mkVarName :: (MonadCError m, MonadSymtab m) => NodeInfo -> Maybe Ident -> Maybe AsmName -> m VarName getOnlyDeclr :: (MonadCError m) => CDecl -> m CDeclr nameOfDecl :: (MonadCError m) => CDecl -> m Ident -- | analyse declarators analyseVarDecl :: (MonadTrav m) => Bool -> [CStorageSpec] -> [CAttr] -> [CTypeQual] -> TypeSpecAnalysis -> [CFunSpec] -> CDeclr -> [CDecl] -> Maybe CInit -> m VarDeclInfo analyseVarDecl' :: (MonadTrav m) => Bool -> [CDeclSpec] -> CDeclr -> [CDecl] -> Maybe CInit -> m VarDeclInfo instance GHC.Classes.Ord Language.C.Analysis.DeclAnalysis.SizeMod instance GHC.Classes.Eq Language.C.Analysis.DeclAnalysis.SizeMod instance GHC.Classes.Ord Language.C.Analysis.DeclAnalysis.SignSpec instance GHC.Classes.Eq Language.C.Analysis.DeclAnalysis.SignSpec instance GHC.Classes.Ord Language.C.Analysis.DeclAnalysis.NumBaseType instance GHC.Classes.Eq Language.C.Analysis.DeclAnalysis.NumBaseType instance GHC.Read.Read Language.C.Analysis.DeclAnalysis.StorageSpec instance GHC.Show.Show Language.C.Analysis.DeclAnalysis.StorageSpec instance GHC.Classes.Ord Language.C.Analysis.DeclAnalysis.StorageSpec instance GHC.Classes.Eq Language.C.Analysis.DeclAnalysis.StorageSpec module Language.C.Analysis.ConstEval data MachineDesc MachineDesc :: (IntType -> Integer) -> (FloatType -> Integer) -> (BuiltinType -> Integer) -> Integer -> Integer -> (IntType -> Integer) -> (FloatType -> Integer) -> (BuiltinType -> Integer) -> Integer -> Integer -> MachineDesc [iSize] :: MachineDesc -> IntType -> Integer [fSize] :: MachineDesc -> FloatType -> Integer [builtinSize] :: MachineDesc -> BuiltinType -> Integer [ptrSize] :: MachineDesc -> Integer [voidSize] :: MachineDesc -> Integer [iAlign] :: MachineDesc -> IntType -> Integer [fAlign] :: MachineDesc -> FloatType -> Integer [builtinAlign] :: MachineDesc -> BuiltinType -> Integer [ptrAlign] :: MachineDesc -> Integer [voidAlign] :: MachineDesc -> Integer intExpr :: (Pos n, MonadName m) => n -> Integer -> m CExpr sizeofType :: (MonadTrav m, CNode n) => MachineDesc -> n -> Type -> m Integer alignofType :: (MonadTrav m, CNode n) => MachineDesc -> n -> Type -> m Integer compSize :: MonadTrav m => MachineDesc -> CompTypeRef -> m Integer intOp :: CBinaryOp -> Integer -> Integer -> Integer intUnOp :: CUnaryOp -> Integer -> Maybe Integer withWordBytes :: Int -> Integer -> Integer boolValue :: CExpr -> Maybe Bool intValue :: CExpr -> Maybe Integer constEval :: (MonadTrav m) => MachineDesc -> Map Ident CExpr -> CExpr -> m CExpr -- | Analyse the parse tree -- -- Traverses the AST, analyses declarations and invokes handlers. module Language.C.Analysis.AstAnalysis -- | Analyse the given AST -- -- analyseAST ast results in global declaration dictionaries. If -- you want to perform specific actions on declarations or definitions, -- you may provide callbacks in the MonadTrav m. -- -- Returns the set of global declarations and definitions which where -- successfully translated. It is the users responsibility to check -- whether any hard errors occurred (runTrav does this for you). analyseAST :: (MonadTrav m) => CTranslUnit -> m GlobalDecls -- | Analyse an top-level declaration analyseExt :: (MonadTrav m) => CExtDecl -> m () -- | Analyse a function definition analyseFunDef :: (MonadTrav m) => CFunDef -> m () -- | Analyse a declaration other than a function definition -- -- Note: static assertions are not analysed analyseDecl :: (MonadTrav m) => Bool -> CDecl -> m () analyseFunctionBody :: (MonadTrav m) => NodeInfo -> VarDecl -> CStat -> m Stmt defineParams :: MonadTrav m => NodeInfo -> VarDecl -> m () tExpr :: MonadTrav m => [StmtCtx] -> ExprSide -> CExpr -> m Type data ExprSide LValue :: ExprSide RValue :: ExprSide -- | Typecheck a statement, given a statement context. The type of a -- statement is usually void, but expression statements and -- blocks can sometimes have other types. tStmt :: MonadTrav m => [StmtCtx] -> CStat -> m Type data StmtCtx FunCtx :: VarDecl -> StmtCtx LoopCtx :: StmtCtx SwitchCtx :: StmtCtx tDesignator :: MonadTrav m => Type -> [CDesignator] -> m Type defaultMD :: MachineDesc instance GHC.Show.Show Language.C.Analysis.AstAnalysis.ExprSide instance GHC.Classes.Eq Language.C.Analysis.AstAnalysis.ExprSide -- | Analysis of the AST. -- -- Currently, we provide a monad for analysis and analyze declarations -- and types. Especially note that there is no direct support for -- analyzing function bodies and constant expressions. -- -- NOTE This is an experimental interface, and therefore the API -- will change in the future. -- -- DONE: -- --
-- Synopsis: parseCFile preprocesssor tmp-dir? cpp-opts file -- Example: parseCFile (newGCC "gcc") Nothing ["-I/usr/include/gtk-2.0"] my-gtk-exts.c --parseCFile :: (Preprocessor cpp) => cpp -> Maybe FilePath -> [String] -> FilePath -> IO (Either ParseError CTranslUnit) -- | parse an already preprocessed C file -- --
-- Synopsis: parseCFilePre file.i --parseCFilePre :: FilePath -> IO (Either ParseError CTranslUnit)