| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Language.C.Types.Parse
Contents
Description
A parser for C99 declarations. Currently, the parser has the following limitations:
- Array sizes can only be
*,n(where n is a positive integer),x(wherexis a C identifier). In C99 they can be arbitrary expressions. See thedata type.ArrayType _Bool,_Complex, and_Imaginaryare not present.- Untyped parameter lists (pre-K&R C) are not allowed.
The parser is incremental and generic (see CParser). Pretty
and Arbitrary instances are provided for all the data types.
The entry point if you want to parse C declarations is
.parameter_declaration
Synopsis
- type TypeNames = HashSet CIdentifier
- data CParserContext i = CParserContext {
- cpcIdentName :: String
- cpcTypeNames :: TypeNames
- cpcParseIdent :: forall m. CParser i m => m i
- cpcIdentToString :: i -> String
- data CIdentifier
- unCIdentifier :: CIdentifier -> String
- cIdentifierFromString :: String -> Either String CIdentifier
- cCParserContext :: TypeNames -> CParserContext CIdentifier
- type CParser i m = (Monad m, Functor m, Applicative m, MonadPlus m, Parsing m, CharParsing m, TokenParsing m, LookAheadParsing m, MonadReader (CParserContext i) m, Hashable i)
- runCParser :: Stream s Identity Char => CParserContext i -> String -> s -> ReaderT (CParserContext i) (Parsec s ()) a -> Either ParseError a
- quickCParser :: CParserContext i -> String -> ReaderT (CParserContext i) (Parsec String ()) a -> a
- quickCParser_ :: String -> ReaderT (CParserContext CIdentifier) (Parsec String ()) a -> a
- identifier_no_lex :: CParser i m => m i
- data DeclarationSpecifier
- declaration_specifiers :: CParser i m => m [DeclarationSpecifier]
- data StorageClassSpecifier
- storage_class_specifier :: CParser i m => m StorageClassSpecifier
- data TypeSpecifier
- = VOID
- | CHAR
- | SHORT
- | INT
- | LONG
- | FLOAT
- | DOUBLE
- | SIGNED
- | UNSIGNED
- | Struct CIdentifier
- | Enum CIdentifier
- | TypeName CIdentifier
- type_specifier :: CParser i m => m TypeSpecifier
- data TypeQualifier
- type_qualifier :: CParser i m => m TypeQualifier
- data FunctionSpecifier = INLINE
- function_specifier :: CParser i m => m FunctionSpecifier
- data Declarator i = Declarator {}
- declarator :: CParser i m => m (Declarator i)
- data DirectDeclarator i
- = DeclaratorRoot i
- | ArrayOrProto (DirectDeclarator i) (ArrayOrProto i)
- | DeclaratorParens (Declarator i)
- direct_declarator :: CParser i m => m (DirectDeclarator i)
- data ArrayOrProto i
- = Array (ArrayType i)
- | Proto [ParameterDeclaration i]
- array_or_proto :: CParser i m => m (ArrayOrProto i)
- data ArrayType i
- array_type :: CParser i m => m (ArrayType i)
- data Pointer = Pointer [TypeQualifier]
- pointer :: CParser i m => m Pointer
- data ParameterDeclaration i = ParameterDeclaration {}
- data DeclaratorOrAbstractDeclarator i
- parameter_declaration :: CParser i m => m (ParameterDeclaration i)
- parameter_list :: CParser i m => m [ParameterDeclaration i]
- data AbstractDeclarator i = AbstractDeclarator {}
- abstract_declarator :: CParser i m => m (AbstractDeclarator i)
- data DirectAbstractDeclarator i
- direct_abstract_declarator :: CParser i m => m (DirectAbstractDeclarator i)
- cIdentStart :: [Char]
- cIdentLetter :: [Char]
- cReservedWords :: HashSet String
- isTypeName :: TypeNames -> String -> Bool
Parser configuration
type TypeNames = HashSet CIdentifier #
A collection of named types (typedefs)
data CParserContext i #
Constructors
| CParserContext | |
Fields
| |
Default configuration
data CIdentifier #
A type for C identifiers.
Instances
| Eq CIdentifier # | |
Defined in Language.C.Types.Parse | |
| Ord CIdentifier # | |
Defined in Language.C.Types.Parse Methods compare :: CIdentifier -> CIdentifier -> Ordering # (<) :: CIdentifier -> CIdentifier -> Bool # (<=) :: CIdentifier -> CIdentifier -> Bool # (>) :: CIdentifier -> CIdentifier -> Bool # (>=) :: CIdentifier -> CIdentifier -> Bool # max :: CIdentifier -> CIdentifier -> CIdentifier # min :: CIdentifier -> CIdentifier -> CIdentifier # | |
| Show CIdentifier # | |
Defined in Language.C.Types.Parse Methods showsPrec :: Int -> CIdentifier -> ShowS # show :: CIdentifier -> String # showList :: [CIdentifier] -> ShowS # | |
| IsString CIdentifier # | |
Defined in Language.C.Types.Parse Methods fromString :: String -> CIdentifier # | |
| Pretty CIdentifier # | |
Defined in Language.C.Types.Parse | |
| Hashable CIdentifier # | |
Defined in Language.C.Types.Parse | |
unCIdentifier :: CIdentifier -> String #
Parser type
type CParser i m = (Monad m, Functor m, Applicative m, MonadPlus m, Parsing m, CharParsing m, TokenParsing m, LookAheadParsing m, MonadReader (CParserContext i) m, Hashable i) #
All the parsing is done using the type classes provided by the
parsers package. You can use the parsing routines with any of the parsers
that implement the classes, such as parsec or trifecta.
We parametrize the parsing by the type of the variable identifiers,
i. We do so because we use this parser to implement anti-quoters
referring to Haskell variables, and thus we need to parse Haskell
identifiers in certain positions.
Arguments
| :: Stream s Identity Char | |
| => CParserContext i | |
| -> String | Source name. |
| -> s | String to parse. |
| -> ReaderT (CParserContext i) (Parsec s ()) a | Parser. Anything with type |
| -> Either ParseError a |
Runs a using CParserparsec.
Arguments
| :: CParserContext i | |
| -> String | String to parse. |
| -> ReaderT (CParserContext i) (Parsec String ()) a | Parser. Anything with type |
| -> a |
Useful for quick testing. Uses "quickCParser" as source name, and throws
an error if parsing fails.
Arguments
| :: String | String to parse. |
| -> ReaderT (CParserContext CIdentifier) (Parsec String ()) a | Parser. Anything with type |
| -> a |
Like quickCParser, but uses as
cCParserContext (const False)CParserContext.
Types and parsing
identifier_no_lex :: CParser i m => m i #
data DeclarationSpecifier #
Constructors
| StorageClassSpecifier StorageClassSpecifier | |
| TypeSpecifier TypeSpecifier | |
| TypeQualifier TypeQualifier | |
| FunctionSpecifier FunctionSpecifier |
Instances
| Eq DeclarationSpecifier # | |
Defined in Language.C.Types.Parse Methods (==) :: DeclarationSpecifier -> DeclarationSpecifier -> Bool # (/=) :: DeclarationSpecifier -> DeclarationSpecifier -> Bool # | |
| Show DeclarationSpecifier # | |
Defined in Language.C.Types.Parse Methods showsPrec :: Int -> DeclarationSpecifier -> ShowS # show :: DeclarationSpecifier -> String # showList :: [DeclarationSpecifier] -> ShowS # | |
| Pretty DeclarationSpecifier # | |
Defined in Language.C.Types.Parse | |
declaration_specifiers :: CParser i m => m [DeclarationSpecifier] #
data StorageClassSpecifier #
Instances
| Eq StorageClassSpecifier # | |
Defined in Language.C.Types.Parse Methods (==) :: StorageClassSpecifier -> StorageClassSpecifier -> Bool # (/=) :: StorageClassSpecifier -> StorageClassSpecifier -> Bool # | |
| Show StorageClassSpecifier # | |
Defined in Language.C.Types.Parse Methods showsPrec :: Int -> StorageClassSpecifier -> ShowS # show :: StorageClassSpecifier -> String # showList :: [StorageClassSpecifier] -> ShowS # | |
| Pretty StorageClassSpecifier # | |
Defined in Language.C.Types.Parse | |
storage_class_specifier :: CParser i m => m StorageClassSpecifier #
data TypeSpecifier #
Constructors
| VOID | |
| CHAR | |
| SHORT | |
| INT | |
| LONG | |
| FLOAT | |
| DOUBLE | |
| SIGNED | |
| UNSIGNED | |
| Struct CIdentifier | |
| Enum CIdentifier | |
| TypeName CIdentifier |
Instances
| Eq TypeSpecifier # | |
Defined in Language.C.Types.Parse Methods (==) :: TypeSpecifier -> TypeSpecifier -> Bool # (/=) :: TypeSpecifier -> TypeSpecifier -> Bool # | |
| Show TypeSpecifier # | |
Defined in Language.C.Types.Parse Methods showsPrec :: Int -> TypeSpecifier -> ShowS # show :: TypeSpecifier -> String # showList :: [TypeSpecifier] -> ShowS # | |
| Pretty TypeSpecifier # | |
Defined in Language.C.Types.Parse | |
type_specifier :: CParser i m => m TypeSpecifier #
data TypeQualifier #
Instances
| Eq TypeQualifier # | |
Defined in Language.C.Types.Parse Methods (==) :: TypeQualifier -> TypeQualifier -> Bool # (/=) :: TypeQualifier -> TypeQualifier -> Bool # | |
| Show TypeQualifier # | |
Defined in Language.C.Types.Parse Methods showsPrec :: Int -> TypeQualifier -> ShowS # show :: TypeQualifier -> String # showList :: [TypeQualifier] -> ShowS # | |
| Pretty TypeQualifier # | |
Defined in Language.C.Types.Parse | |
type_qualifier :: CParser i m => m TypeQualifier #
data FunctionSpecifier #
Constructors
| INLINE |
Instances
| Eq FunctionSpecifier # | |
Defined in Language.C.Types.Parse Methods (==) :: FunctionSpecifier -> FunctionSpecifier -> Bool # (/=) :: FunctionSpecifier -> FunctionSpecifier -> Bool # | |
| Show FunctionSpecifier # | |
Defined in Language.C.Types.Parse Methods showsPrec :: Int -> FunctionSpecifier -> ShowS # show :: FunctionSpecifier -> String # showList :: [FunctionSpecifier] -> ShowS # | |
| Pretty FunctionSpecifier # | |
Defined in Language.C.Types.Parse | |
function_specifier :: CParser i m => m FunctionSpecifier #
data Declarator i #
Constructors
| Declarator | |
Fields | |
Instances
declarator :: CParser i m => m (Declarator i) #
data DirectDeclarator i #
Constructors
| DeclaratorRoot i | |
| ArrayOrProto (DirectDeclarator i) (ArrayOrProto i) | |
| DeclaratorParens (Declarator i) |
Instances
direct_declarator :: CParser i m => m (DirectDeclarator i) #
data ArrayOrProto i #
Constructors
| Array (ArrayType i) | |
| Proto [ParameterDeclaration i] |
Instances
array_or_proto :: CParser i m => m (ArrayOrProto i) #
Constructors
| VariablySized | |
| Unsized | |
| SizedByInteger Integer | |
| SizedByIdentifier i |
Instances
| Functor ArrayType # | |
| Foldable ArrayType # | |
Defined in Language.C.Types.Parse Methods fold :: Monoid m => ArrayType m -> m # foldMap :: Monoid m => (a -> m) -> ArrayType a -> m # foldr :: (a -> b -> b) -> b -> ArrayType a -> b # foldr' :: (a -> b -> b) -> b -> ArrayType a -> b # foldl :: (b -> a -> b) -> b -> ArrayType a -> b # foldl' :: (b -> a -> b) -> b -> ArrayType a -> b # foldr1 :: (a -> a -> a) -> ArrayType a -> a # foldl1 :: (a -> a -> a) -> ArrayType a -> a # toList :: ArrayType a -> [a] # length :: ArrayType a -> Int # elem :: Eq a => a -> ArrayType a -> Bool # maximum :: Ord a => ArrayType a -> a # minimum :: Ord a => ArrayType a -> a # | |
| Traversable ArrayType # | |
Defined in Language.C.Types.Parse | |
| Eq i => Eq (ArrayType i) # | |
| Show i => Show (ArrayType i) # | |
| Pretty i => Pretty (ArrayType i) # | |
Defined in Language.C.Types.Parse | |
array_type :: CParser i m => m (ArrayType i) #
Constructors
| Pointer [TypeQualifier] |
data ParameterDeclaration i #
Constructors
| ParameterDeclaration | |
Instances
data DeclaratorOrAbstractDeclarator i #
Constructors
| IsDeclarator (Declarator i) | |
| IsAbstractDeclarator (AbstractDeclarator i) |
Instances
parameter_declaration :: CParser i m => m (ParameterDeclaration i) #
parameter_list :: CParser i m => m [ParameterDeclaration i] #
data AbstractDeclarator i #
Constructors
| AbstractDeclarator | |
Fields | |
Instances
abstract_declarator :: CParser i m => m (AbstractDeclarator i) #
data DirectAbstractDeclarator i #
Constructors
| ArrayOrProtoHere (ArrayOrProto i) | |
| ArrayOrProtoThere (DirectAbstractDeclarator i) (ArrayOrProto i) | |
| AbstractDeclaratorParens (AbstractDeclarator i) |
Instances
direct_abstract_declarator :: CParser i m => m (DirectAbstractDeclarator i) #
YACC grammar
The parser above is derived from a modification of the YACC grammar for C99 found at http://www.quut.com/c/ANSI-C-grammar-y-1999.html, reproduced below.
%token IDENTIFIER TYPE_NAME INTEGER
%token TYPEDEF EXTERN STATIC AUTO REGISTER INLINE RESTRICT
%token CHAR SHORT INT LONG SIGNED UNSIGNED FLOAT DOUBLE CONST VOLATILE VOID
%token BOOL COMPLEX IMAGINARY
%token STRUCT UNION ENUM
%start parameter_list
%%
declaration_specifiers
: storage_class_specifier
| storage_class_specifier declaration_specifiers
| type_specifier
| type_specifier declaration_specifiers
| type_qualifier
| type_qualifier declaration_specifiers
| function_specifier
| function_specifier declaration_specifiers
;
storage_class_specifier
: TYPEDEF
| EXTERN
| STATIC
| AUTO
| REGISTER
;
type_specifier
: VOID
| CHAR
| SHORT
| INT
| LONG
| FLOAT
| DOUBLE
| SIGNED
| UNSIGNED
| BOOL
| COMPLEX
| IMAGINARY
| STRUCT IDENTIFIER
| UNION IDENTIFIER
| ENUM IDENTIFIER
| TYPE_NAME
;
type_qualifier
: CONST
| RESTRICT
| VOLATILE
;
function_specifier
: INLINE
;
declarator
: pointer direct_declarator
| direct_declarator
;
direct_declarator
: IDENTIFIER
| '(' declarator ')'
| direct_declarator '[' type_qualifier_list ']'
| direct_declarator '[' type_qualifier_list * ']'
| direct_declarator '[' * ']'
| direct_declarator '[' IDENTIFIER ']'
| direct_declarator '[' INTEGER ']'
| direct_declarator '[' ']'
| direct_declarator '(' parameter_list ')'
| direct_declarator '(' ')'
;
pointer
: *
| * type_qualifier_list
| * pointer
| * type_qualifier_list pointer
;
type_qualifier_list
: type_qualifier
| type_qualifier_list type_qualifier
;
parameter_list
: parameter_declaration
| parameter_list ',' parameter_declaration
;
parameter_declaration
: declaration_specifiers declarator
| declaration_specifiers abstract_declarator
| declaration_specifiers
;
abstract_declarator
: pointer
| direct_abstract_declarator
| pointer direct_abstract_declarator
;
direct_abstract_declarator
: '(' abstract_declarator ')'
| '[' ']'
| direct_abstract_declarator '[' ']'
| '[' * ']'
| direct_abstract_declarator '[' * ']'
| '[' IDENTIFIER ']'
| direct_abstract_declarator '[' IDENTIFIER ']'
| '[' INTEGER ']'
| direct_abstract_declarator '[' INTEGER ']'
| '(' ')'
| '(' parameter_list ')'
| direct_abstract_declarator '(' ')'
| direct_abstract_declarator '(' parameter_list ')'
;
%%
#include <stdio.h>
extern char yytext[];
extern int column;
void yyerror(char const *s)
{
fflush(stdout);
printf("n%*sn%*sn", column, "^", column, s);
}
Testing utilities
cIdentStart :: [Char] #
cIdentLetter :: [Char] #
isTypeName :: TypeNames -> String -> Bool #