Moduleinline-c-0.9.1.10Haskell2010

Language.C.Types.Parse

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 (where x is a C identifier). In C99 they can be arbitrary expressions. See the ArrayType data type.
_Bool, _Complex, and _Imaginary are not present.
Untyped parameter lists (pre-K&R C) are not allowed.

The parser is incremental and generic (see CParser). Pretty and QC.Arbitrary instances are provided for all the data types.

The entry point if you want to parse C declarations is parameter_declaration.

18 types
25 values

Packageinline-c-0.9.1.10
Exports43
LanguageHaskell2010
LicenceMIT
SourceParse.hs

Parser configuration

2 declarations

typetype TypeNames = HashSet CIdentifier

A collection of named types (typedefs)

datadata CParserContext i

Constructors

CParserContext
- cpcIdentName :: String
- cpcTypeNames :: TypeNames
  Function used to determine whether an identifier is a type name.
- cpcParseIdent :: forall (m :: Type -> Type). CParser i m => m i
  Parses an identifier, *without consuming whitespace afterwards*.
- cpcIdentToString :: i -> String
- cpcEnableCpp :: Bool

Default configuration

newtypenewtype CIdentifier

A type for C identifiers.

Instances6Eq, Ord, Show, IsString, Hashable, Pretty

Eq CIdentifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Ord CIdentifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Show CIdentifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
IsString CIdentifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Hashable CIdentifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Pretty CIdentifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse

valueunCIdentifier :: CIdentifier -> String

valuecIdentifierFromString :: Bool -> String -> Either String CIdentifier

valuecCParserContext :: Bool -> TypeNames -> CParserContext CIdentifier

Parser type

4 declarations

type

type CParser i (m :: Type -> Type) = (Monad m, Functor m, Applicative m, MonadPlus m, Parsing m, CharParsing m, TokenParsing m, LookAheadParsing m, MonadReader (CParserContext i) m, MonadFail 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.

valuerunCParser

:: Stream s Identity Char
=> CParserContext i
-> String
Source name.
-> s
String to parse.
-> ReaderT (CParserContext i) (Parsec s ()) a
Parser. Anything with type forall m. CParser i m => m a is a valid argument.
-> Either ParseError a

Runs a CParser using parsec.

valuequickCParser

:: CParserContext i
-> String
String to parse.
-> ReaderT (CParserContext i) (Parsec String ()) a
Parser. Anything with type forall m. CParser i m => m a is a valid argument.
-> a

Useful for quick testing. Uses "quickCParser" as source name, and throws an error if parsing fails.

valuequickCParser_

:: Bool
-> String
String to parse.
-> ReaderT (CParserContext CIdentifier) (Parsec String ()) a
Parser. Anything with type forall m. CParser i m => m a is a valid argument.
-> a

Like quickCParser, but uses cCParserContext (const False) as CParserContext.

Types and parsing

29 declarations

valueidentifier_no_lex :: CParser i m => m i

datadata DeclarationSpecifier

Constructors

StorageClassSpecifier StorageClassSpecifier
TypeSpecifier TypeSpecifier
TypeQualifier TypeQualifier
FunctionSpecifier FunctionSpecifier

Instances3Eq, Show, Pretty

Eq DeclarationSpecifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Show DeclarationSpecifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Pretty DeclarationSpecifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse

valuedeclaration_specifiers :: CParser i m => m [DeclarationSpecifier]

datadata StorageClassSpecifier

TYPEDEF EXTERN STATIC AUTO REGISTER

Instances3Eq, Show, Pretty

Eq StorageClassSpecifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Show StorageClassSpecifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Pretty StorageClassSpecifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse

valuestorage_class_specifier :: CParser i m => m StorageClassSpecifier

datadata TypeSpecifier

Constructors

VOID
BOOL
CHAR
SHORT
INT
LONG
FLOAT
DOUBLE
SIGNED
UNSIGNED
Struct CIdentifier
Enum CIdentifier
TypeName CIdentifier
Template CIdentifier [[TypeSpecifier]]
TemplateConst String
TemplatePointer TypeSpecifier

Instances3Eq, Show, Pretty

Eq TypeSpecifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Show TypeSpecifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Pretty TypeSpecifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse

valuetype_specifier :: CParser i m => m TypeSpecifier

datadata TypeQualifier

CONST RESTRICT VOLATILE

Instances3Eq, Show, Pretty

Eq TypeQualifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Show TypeQualifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Pretty TypeQualifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse

valuetype_qualifier :: CParser i m => m TypeQualifier

datadata FunctionSpecifier

INLINE

Instances3Eq, Show, Pretty

Eq FunctionSpecifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Show FunctionSpecifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Pretty FunctionSpecifierDefined in inline-c-0.9.1.10 · Language.C.Types.Parse

valuefunction_specifier :: CParser i m => m FunctionSpecifier

datadata Declarator i

Constructors

Declarator
- declaratorPointers :: [Pointer]
- declaratorDirect :: DirectDeclarator i

Instances6Functor, Foldable, Traversable, Eq, Show, Pretty

Functor DeclaratorDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Foldable DeclaratorDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Traversable DeclaratorDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Eq i => Eq (Declarator i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse
Show i => Show (Declarator i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse
Pretty i => Pretty (Declarator i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse

valuedeclarator :: CParser i m => m (Declarator i)

datadata DirectDeclarator i

Constructors

DeclaratorRoot i
ArrayOrProto (DirectDeclarator i) (ArrayOrProto i)
DeclaratorParens (Declarator i)

Instances6Functor, Foldable, Traversable, Eq, Show, Pretty

Functor DirectDeclaratorDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Foldable DirectDeclaratorDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Traversable DirectDeclaratorDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Eq i => Eq (DirectDeclarator i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse
Show i => Show (DirectDeclarator i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse
Pretty i => Pretty (DirectDeclarator i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse

valuedirect_declarator :: CParser i m => m (DirectDeclarator i)

datadata ArrayOrProto i

Instances6Functor, Foldable, Traversable, Eq, Show, Pretty

Functor ArrayOrProtoDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Foldable ArrayOrProtoDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Traversable ArrayOrProtoDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Eq i => Eq (ArrayOrProto i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse
Show i => Show (ArrayOrProto i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse
Pretty i => Pretty (ArrayOrProto i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse

valuearray_or_proto :: CParser i m => m (ArrayOrProto i)

datadata ArrayType i

Constructors

VariablySized
Unsized
SizedByInteger Integer
SizedByIdentifier i

Instances6Functor, Foldable, Traversable, Eq, Show, Pretty

Functor ArrayTypeDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Foldable ArrayTypeDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Traversable ArrayTypeDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Eq i => Eq (ArrayType i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse
Show i => Show (ArrayType i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse
Pretty i => Pretty (ArrayType i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse

valuearray_type :: CParser i m => m (ArrayType i)

datadata Pointer

Constructors

Pointer [TypeQualifier]

Instances3Eq, Show, Pretty

Eq PointerDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Show PointerDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Pretty PointerDefined in inline-c-0.9.1.10 · Language.C.Types.Parse

valuepointer :: CParser i m => m Pointer

datadata ParameterDeclaration i

Constructors

ParameterDeclaration
- parameterDeclarationSpecifiers :: [DeclarationSpecifier]
- parameterDeclarationDeclarator :: DeclaratorOrAbstractDeclarator i

Instances6Functor, Foldable, Traversable, Eq, Show, Pretty

Functor ParameterDeclarationDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Foldable ParameterDeclarationDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Traversable ParameterDeclarationDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Eq i => Eq (ParameterDeclaration i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse
Show i => Show (ParameterDeclaration i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse
Pretty i => Pretty (ParameterDeclaration i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse

datadata DeclaratorOrAbstractDeclarator i

Constructors

IsDeclarator (Declarator i)
IsAbstractDeclarator (AbstractDeclarator i)

Instances5Functor, Foldable, Traversable, Eq, Show

Functor DeclaratorOrAbstractDeclaratorDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Foldable DeclaratorOrAbstractDeclaratorDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Traversable DeclaratorOrAbstractDeclaratorDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Eq i => Eq (DeclaratorOrAbstractDeclarator i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse
Show i => Show (DeclaratorOrAbstractDeclarator i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse

valueparameter_declaration :: CParser i m => m (ParameterDeclaration i)

valueparameter_list :: CParser i m => m [ParameterDeclaration i]

datadata AbstractDeclarator i

Constructors

AbstractDeclarator
- abstractDeclaratorPointers :: [Pointer]
- abstractDeclaratorDirect :: Maybe (DirectAbstractDeclarator i)

Instances6Functor, Foldable, Traversable, Eq, Show, Pretty

Functor AbstractDeclaratorDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Foldable AbstractDeclaratorDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Traversable AbstractDeclaratorDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Eq i => Eq (AbstractDeclarator i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse
Show i => Show (AbstractDeclarator i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse
Pretty i => Pretty (AbstractDeclarator i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse

valueabstract_declarator :: CParser i m => m (AbstractDeclarator i)

datadata DirectAbstractDeclarator i

Constructors

ArrayOrProtoHere (ArrayOrProto i)
ArrayOrProtoThere (DirectAbstractDeclarator i) (ArrayOrProto i)
AbstractDeclaratorParens (AbstractDeclarator i)

Instances6Functor, Foldable, Traversable, Eq, Show, Pretty

Functor DirectAbstractDeclaratorDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Foldable DirectAbstractDeclaratorDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Traversable DirectAbstractDeclaratorDefined in inline-c-0.9.1.10 · Language.C.Types.Parse
Eq i => Eq (DirectAbstractDeclarator i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse
Show i => Show (DirectAbstractDeclarator i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse
Pretty i => Pretty (DirectAbstractDeclarator i)Defined in inline-c-0.9.1.10 · Language.C.Types.Parse

valuedirect_abstract_declarator :: CParser i m => m (DirectAbstractDeclarator i)

YACC grammar

0 declarations

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

4 declarations

valuecIdentStart :: [Char]

valuecIdentLetter :: [Char]

valuecReservedWords :: HashSet String

valueisTypeName :: Bool -> TypeNames -> String -> Bool