Types.Internal

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 Arbitrary instances are provided for all the data types.

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

Parser type

type CParser m = (Monad m, Functor m, Applicative m, MonadPlus m, Parsing m, CharParsing m, TokenParsing m, LookAheadParsing m, MonadReader IsTypeName m)

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.

The MonadReader with IsTypeName is required for parsing C, see http://en.wikipedia.org/wiki/The_lexer_hack.

type IsTypeName = Identifier -> Bool

Function used to determine whether an Id is a type name.

runCParser

Arguments

:: Stream s Identity Char

=> IsTypeName

Function determining if an identifier is a type name.

-> String

Source name.

-> s

String to parse.

-> ReaderT IsTypeName (Parsec s ()) a

Parser. Anything with type forall m. CParser m => m a is a valid argument.

-> Either ParseError a

Runs a CParser using parsec.

quickCParser

Arguments

:: IsTypeName

Function determining if an identifier is a type name.

-> String

String to parse.

-> ReaderT IsTypeName (Parsec String ()) a

Parser. Anything with type forall m. CParser m => m a is a valid argument.

-> a

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

quickCParser_

Arguments

:: String

String to parse.

-> ReaderT IsTypeName (Parsec String ()) a

Parser. Anything with type forall m. CParser m => m a is a valid argument.

-> a

Like quickCParser, but uses const False as IsTypeName.

Types and parsing

newtype Identifier

Constructors

Identifier

Fields

• unIdentifier :: String

Instances

Eq Identifier

Defined in Types.Internal

Methods

(==) :: Identifier -> Identifier -> Bool

(/=) :: Identifier -> Identifier -> Bool

Ord Identifier

Defined in Types.Internal

Methods

compare :: Identifier -> Identifier -> Ordering

(<) :: Identifier -> Identifier -> Bool

(<=) :: Identifier -> Identifier -> Bool

(>) :: Identifier -> Identifier -> Bool

(>=) :: Identifier -> Identifier -> Bool

max :: Identifier -> Identifier -> Identifier

min :: Identifier -> Identifier -> Identifier

Show Identifier

Defined in Types.Internal

Methods

showsPrec :: Int -> Identifier -> ShowS

show :: Identifier -> String

showList :: [Identifier] -> ShowS

IsString Identifier

Defined in Types.Internal

Methods

fromString :: String -> Identifier

Pretty Identifier

Defined in Types.Internal

Methods

pretty :: Identifier -> Doc

prettyList :: [Identifier] -> Doc

identifier :: CParser m => m Identifier

identifier_no_lex :: CParser m => m Identifier

This parser parses an Id and nothing else -- it does not consume trailing spaces and the like.

data DeclarationSpecifier

Constructors

StorageClassSpecifier StorageClassSpecifier

TypeSpecifier TypeSpecifier

TypeQualifier TypeQualifier

FunctionSpecifier FunctionSpecifier

Instances

Eq DeclarationSpecifier

Defined in Types.Internal

Methods

(==) :: DeclarationSpecifier -> DeclarationSpecifier -> Bool

(/=) :: DeclarationSpecifier -> DeclarationSpecifier -> Bool

Ord DeclarationSpecifier

Defined in Types.Internal

Methods

compare :: DeclarationSpecifier -> DeclarationSpecifier -> Ordering

(<) :: DeclarationSpecifier -> DeclarationSpecifier -> Bool

(<=) :: DeclarationSpecifier -> DeclarationSpecifier -> Bool

(>) :: DeclarationSpecifier -> DeclarationSpecifier -> Bool

(>=) :: DeclarationSpecifier -> DeclarationSpecifier -> Bool

max :: DeclarationSpecifier -> DeclarationSpecifier -> DeclarationSpecifier

min :: DeclarationSpecifier -> DeclarationSpecifier -> DeclarationSpecifier

Show DeclarationSpecifier

Defined in Types.Internal

Methods

showsPrec :: Int -> DeclarationSpecifier -> ShowS

show :: DeclarationSpecifier -> String

showList :: [DeclarationSpecifier] -> ShowS

Pretty DeclarationSpecifier

Defined in Types.Internal

Methods

pretty :: DeclarationSpecifier -> Doc

prettyList :: [DeclarationSpecifier] -> Doc

declaration_specifiers :: forall m. CParser m => m [DeclarationSpecifier]

data StorageClassSpecifier

Constructors

TYPEDEF

EXTERN

STATIC

AUTO

REGISTER

Instances

Eq StorageClassSpecifier

Defined in Types.Internal

Methods

(==) :: StorageClassSpecifier -> StorageClassSpecifier -> Bool

(/=) :: StorageClassSpecifier -> StorageClassSpecifier -> Bool

Ord StorageClassSpecifier

Defined in Types.Internal

Methods

compare :: StorageClassSpecifier -> StorageClassSpecifier -> Ordering

(<) :: StorageClassSpecifier -> StorageClassSpecifier -> Bool

(<=) :: StorageClassSpecifier -> StorageClassSpecifier -> Bool

(>) :: StorageClassSpecifier -> StorageClassSpecifier -> Bool

(>=) :: StorageClassSpecifier -> StorageClassSpecifier -> Bool

max :: StorageClassSpecifier -> StorageClassSpecifier -> StorageClassSpecifier

min :: StorageClassSpecifier -> StorageClassSpecifier -> StorageClassSpecifier

Show StorageClassSpecifier

Defined in Types.Internal

Methods

showsPrec :: Int -> StorageClassSpecifier -> ShowS

show :: StorageClassSpecifier -> String

showList :: [StorageClassSpecifier] -> ShowS

Pretty StorageClassSpecifier

Defined in Types.Internal

Methods

pretty :: StorageClassSpecifier -> Doc

prettyList :: [StorageClassSpecifier] -> Doc

storage_class_specifier :: CParser m => m StorageClassSpecifier

data TypeSpecifier

Constructors

VOID

CHAR

SHORT

INT

LONG

FLOAT

DOUBLE

SIGNED

UNSIGNED

Struct Identifier

Enum Identifier

TypeName Identifier

Instances

Eq TypeSpecifier

Defined in Types.Internal

Methods

(==) :: TypeSpecifier -> TypeSpecifier -> Bool

(/=) :: TypeSpecifier -> TypeSpecifier -> Bool

Ord TypeSpecifier

Defined in Types.Internal

Methods

compare :: TypeSpecifier -> TypeSpecifier -> Ordering

(<) :: TypeSpecifier -> TypeSpecifier -> Bool

(<=) :: TypeSpecifier -> TypeSpecifier -> Bool

(>) :: TypeSpecifier -> TypeSpecifier -> Bool

(>=) :: TypeSpecifier -> TypeSpecifier -> Bool

max :: TypeSpecifier -> TypeSpecifier -> TypeSpecifier

min :: TypeSpecifier -> TypeSpecifier -> TypeSpecifier

Show TypeSpecifier

Defined in Types.Internal

Methods

showsPrec :: Int -> TypeSpecifier -> ShowS

show :: TypeSpecifier -> String

showList :: [TypeSpecifier] -> ShowS

Pretty TypeSpecifier

Defined in Types.Internal

Methods

pretty :: TypeSpecifier -> Doc

prettyList :: [TypeSpecifier] -> Doc

type_specifier :: CParser m => m TypeSpecifier

data TypeQualifier

Constructors

CONST

RESTRICT

VOLATILE

Instances

Eq TypeQualifier

Defined in Types.Internal

Methods

(==) :: TypeQualifier -> TypeQualifier -> Bool

(/=) :: TypeQualifier -> TypeQualifier -> Bool

Ord TypeQualifier

Defined in Types.Internal

Methods

compare :: TypeQualifier -> TypeQualifier -> Ordering

(<) :: TypeQualifier -> TypeQualifier -> Bool

(<=) :: TypeQualifier -> TypeQualifier -> Bool

(>) :: TypeQualifier -> TypeQualifier -> Bool

(>=) :: TypeQualifier -> TypeQualifier -> Bool

max :: TypeQualifier -> TypeQualifier -> TypeQualifier

min :: TypeQualifier -> TypeQualifier -> TypeQualifier

Show TypeQualifier

Defined in Types.Internal

Methods

showsPrec :: Int -> TypeQualifier -> ShowS

show :: TypeQualifier -> String

showList :: [TypeQualifier] -> ShowS

Pretty TypeQualifier

Defined in Types.Internal

Methods

pretty :: TypeQualifier -> Doc

prettyList :: [TypeQualifier] -> Doc

type_qualifier :: CParser m => m TypeQualifier

data FunctionSpecifier

Constructors

INLINE

Instances

Eq FunctionSpecifier

Defined in Types.Internal

Methods

(==) :: FunctionSpecifier -> FunctionSpecifier -> Bool

(/=) :: FunctionSpecifier -> FunctionSpecifier -> Bool

Ord FunctionSpecifier

Defined in Types.Internal

Methods

compare :: FunctionSpecifier -> FunctionSpecifier -> Ordering

(<) :: FunctionSpecifier -> FunctionSpecifier -> Bool

(<=) :: FunctionSpecifier -> FunctionSpecifier -> Bool

(>) :: FunctionSpecifier -> FunctionSpecifier -> Bool

(>=) :: FunctionSpecifier -> FunctionSpecifier -> Bool

max :: FunctionSpecifier -> FunctionSpecifier -> FunctionSpecifier

min :: FunctionSpecifier -> FunctionSpecifier -> FunctionSpecifier

Show FunctionSpecifier

Defined in Types.Internal

Methods

showsPrec :: Int -> FunctionSpecifier -> ShowS

show :: FunctionSpecifier -> String

showList :: [FunctionSpecifier] -> ShowS

Pretty FunctionSpecifier

Defined in Types.Internal

Methods

pretty :: FunctionSpecifier -> Doc

prettyList :: [FunctionSpecifier] -> Doc

function_specifier :: CParser m => m FunctionSpecifier

data Declarator

Constructors

Declarator

Fields

• declaratorPointers :: [Pointer]
• declaratorDirect :: DirectDeclarator

Instances

Eq Declarator

Defined in Types.Internal

Methods

(==) :: Declarator -> Declarator -> Bool

(/=) :: Declarator -> Declarator -> Bool

Ord Declarator

Defined in Types.Internal

Methods

compare :: Declarator -> Declarator -> Ordering

(<) :: Declarator -> Declarator -> Bool

(<=) :: Declarator -> Declarator -> Bool

(>) :: Declarator -> Declarator -> Bool

(>=) :: Declarator -> Declarator -> Bool

max :: Declarator -> Declarator -> Declarator

min :: Declarator -> Declarator -> Declarator

Show Declarator

Defined in Types.Internal

Methods

showsPrec :: Int -> Declarator -> ShowS

show :: Declarator -> String

showList :: [Declarator] -> ShowS

Pretty Declarator

Defined in Types.Internal

Methods

pretty :: Declarator -> Doc

prettyList :: [Declarator] -> Doc

declarator :: CParser m => m Declarator

data DirectDeclarator

Constructors

DeclaratorRoot Identifier

ArrayOrProto DirectDeclarator ArrayOrProto

DeclaratorParens Declarator

Instances

Eq DirectDeclarator

Defined in Types.Internal

Methods

(==) :: DirectDeclarator -> DirectDeclarator -> Bool

(/=) :: DirectDeclarator -> DirectDeclarator -> Bool

Ord DirectDeclarator

Defined in Types.Internal

Methods

compare :: DirectDeclarator -> DirectDeclarator -> Ordering

(<) :: DirectDeclarator -> DirectDeclarator -> Bool

(<=) :: DirectDeclarator -> DirectDeclarator -> Bool

(>) :: DirectDeclarator -> DirectDeclarator -> Bool

(>=) :: DirectDeclarator -> DirectDeclarator -> Bool

max :: DirectDeclarator -> DirectDeclarator -> DirectDeclarator

min :: DirectDeclarator -> DirectDeclarator -> DirectDeclarator

Show DirectDeclarator

Defined in Types.Internal

Methods

showsPrec :: Int -> DirectDeclarator -> ShowS

show :: DirectDeclarator -> String

showList :: [DirectDeclarator] -> ShowS

Pretty DirectDeclarator

Defined in Types.Internal

Methods

pretty :: DirectDeclarator -> Doc

prettyList :: [DirectDeclarator] -> Doc

direct_declarator :: CParser m => m DirectDeclarator

data ArrayOrProto

Constructors

Array ArrayType

Proto [ParameterDeclaration]

Instances

Eq ArrayOrProto

Defined in Types.Internal

Methods

(==) :: ArrayOrProto -> ArrayOrProto -> Bool

(/=) :: ArrayOrProto -> ArrayOrProto -> Bool

Ord ArrayOrProto

Defined in Types.Internal

Methods

compare :: ArrayOrProto -> ArrayOrProto -> Ordering

(<) :: ArrayOrProto -> ArrayOrProto -> Bool

(<=) :: ArrayOrProto -> ArrayOrProto -> Bool

(>) :: ArrayOrProto -> ArrayOrProto -> Bool

(>=) :: ArrayOrProto -> ArrayOrProto -> Bool

max :: ArrayOrProto -> ArrayOrProto -> ArrayOrProto

min :: ArrayOrProto -> ArrayOrProto -> ArrayOrProto

Show ArrayOrProto

Defined in Types.Internal

Methods

showsPrec :: Int -> ArrayOrProto -> ShowS

show :: ArrayOrProto -> String

showList :: [ArrayOrProto] -> ShowS

Pretty ArrayOrProto

Defined in Types.Internal

Methods

pretty :: ArrayOrProto -> Doc

prettyList :: [ArrayOrProto] -> Doc

array_or_proto :: CParser m => m ArrayOrProto

data ArrayType

Constructors

VariablySized

Unsized

SizedByInteger Integer

SizedByIdentifier Identifier

Instances

Eq ArrayType

Defined in Types.Internal

Methods

(==) :: ArrayType -> ArrayType -> Bool

(/=) :: ArrayType -> ArrayType -> Bool

Ord ArrayType

Defined in Types.Internal

Methods

compare :: ArrayType -> ArrayType -> Ordering

(<) :: ArrayType -> ArrayType -> Bool

(<=) :: ArrayType -> ArrayType -> Bool

(>) :: ArrayType -> ArrayType -> Bool

(>=) :: ArrayType -> ArrayType -> Bool

max :: ArrayType -> ArrayType -> ArrayType

min :: ArrayType -> ArrayType -> ArrayType

Show ArrayType

Defined in Types.Internal

Methods

showsPrec :: Int -> ArrayType -> ShowS

show :: ArrayType -> String

showList :: [ArrayType] -> ShowS

Pretty ArrayType

Defined in Types.Internal

Methods

pretty :: ArrayType -> Doc

prettyList :: [ArrayType] -> Doc

array_type :: CParser m => m ArrayType

data Pointer

Constructors

Pointer [TypeQualifier]

Instances

Eq Pointer

Defined in Types.Internal

Methods

(==) :: Pointer -> Pointer -> Bool

(/=) :: Pointer -> Pointer -> Bool

Ord Pointer

Defined in Types.Internal

Methods

compare :: Pointer -> Pointer -> Ordering

(<) :: Pointer -> Pointer -> Bool

(<=) :: Pointer -> Pointer -> Bool

(>) :: Pointer -> Pointer -> Bool

(>=) :: Pointer -> Pointer -> Bool

max :: Pointer -> Pointer -> Pointer

min :: Pointer -> Pointer -> Pointer

Show Pointer

Defined in Types.Internal

Methods

showsPrec :: Int -> Pointer -> ShowS

show :: Pointer -> String

showList :: [Pointer] -> ShowS

Pretty Pointer

Defined in Types.Internal

Methods

pretty :: Pointer -> Doc

prettyList :: [Pointer] -> Doc

pointer :: CParser m => m Pointer

data ParameterDeclaration

Constructors

ParameterDeclaration

Fields

• parameterDeclarationSpecifiers :: [DeclarationSpecifier]
• parameterDeclarationDeclarator :: Either Declarator AbstractDeclarator

Instances

Eq ParameterDeclaration

Defined in Types.Internal

Methods

(==) :: ParameterDeclaration -> ParameterDeclaration -> Bool

(/=) :: ParameterDeclaration -> ParameterDeclaration -> Bool

Ord ParameterDeclaration

Defined in Types.Internal

Methods

compare :: ParameterDeclaration -> ParameterDeclaration -> Ordering

(<) :: ParameterDeclaration -> ParameterDeclaration -> Bool

(<=) :: ParameterDeclaration -> ParameterDeclaration -> Bool

(>) :: ParameterDeclaration -> ParameterDeclaration -> Bool

(>=) :: ParameterDeclaration -> ParameterDeclaration -> Bool

max :: ParameterDeclaration -> ParameterDeclaration -> ParameterDeclaration

min :: ParameterDeclaration -> ParameterDeclaration -> ParameterDeclaration

Show ParameterDeclaration

Defined in Types.Internal

Methods

showsPrec :: Int -> ParameterDeclaration -> ShowS

show :: ParameterDeclaration -> String

showList :: [ParameterDeclaration] -> ShowS

Pretty ParameterDeclaration

Defined in Types.Internal

Methods

pretty :: ParameterDeclaration -> Doc

prettyList :: [ParameterDeclaration] -> Doc

parameter_declaration :: CParser m => m ParameterDeclaration

parameter_list :: CParser m => m [ParameterDeclaration]

data AbstractDeclarator

Constructors

AbstractDeclarator

Fields

• abstractDeclaratorPointers :: [Pointer]
• abstractDeclaratorDirect :: Maybe DirectAbstractDeclarator

Instances

Eq AbstractDeclarator

Defined in Types.Internal

Methods

(==) :: AbstractDeclarator -> AbstractDeclarator -> Bool

(/=) :: AbstractDeclarator -> AbstractDeclarator -> Bool

Ord AbstractDeclarator

Defined in Types.Internal

Methods

compare :: AbstractDeclarator -> AbstractDeclarator -> Ordering

(<) :: AbstractDeclarator -> AbstractDeclarator -> Bool

(<=) :: AbstractDeclarator -> AbstractDeclarator -> Bool

(>) :: AbstractDeclarator -> AbstractDeclarator -> Bool

(>=) :: AbstractDeclarator -> AbstractDeclarator -> Bool

max :: AbstractDeclarator -> AbstractDeclarator -> AbstractDeclarator

min :: AbstractDeclarator -> AbstractDeclarator -> AbstractDeclarator

Show AbstractDeclarator

Defined in Types.Internal

Methods

showsPrec :: Int -> AbstractDeclarator -> ShowS

show :: AbstractDeclarator -> String

showList :: [AbstractDeclarator] -> ShowS

Pretty AbstractDeclarator

Defined in Types.Internal

Methods

pretty :: AbstractDeclarator -> Doc

prettyList :: [AbstractDeclarator] -> Doc

abstract_declarator :: CParser m => m AbstractDeclarator

data DirectAbstractDeclarator

Constructors

ArrayOrProtoHere ArrayOrProto

ArrayOrProtoThere DirectAbstractDeclarator ArrayOrProto

AbstractDeclaratorParens AbstractDeclarator

Instances

Eq DirectAbstractDeclarator

Defined in Types.Internal

Methods

(==) :: DirectAbstractDeclarator -> DirectAbstractDeclarator -> Bool

(/=) :: DirectAbstractDeclarator -> DirectAbstractDeclarator -> Bool

Ord DirectAbstractDeclarator

Defined in Types.Internal

Methods

compare :: DirectAbstractDeclarator -> DirectAbstractDeclarator -> Ordering

(<) :: DirectAbstractDeclarator -> DirectAbstractDeclarator -> Bool

(<=) :: DirectAbstractDeclarator -> DirectAbstractDeclarator -> Bool

(>) :: DirectAbstractDeclarator -> DirectAbstractDeclarator -> Bool

(>=) :: DirectAbstractDeclarator -> DirectAbstractDeclarator -> Bool

max :: DirectAbstractDeclarator -> DirectAbstractDeclarator -> DirectAbstractDeclarator

min :: DirectAbstractDeclarator -> DirectAbstractDeclarator -> DirectAbstractDeclarator

Show DirectAbstractDeclarator

Defined in Types.Internal

Methods

showsPrec :: Int -> DirectAbstractDeclarator -> ShowS

show :: DirectAbstractDeclarator -> String

showList :: [DirectAbstractDeclarator] -> ShowS

Pretty DirectAbstractDeclarator

Defined in Types.Internal

Methods

pretty :: DirectAbstractDeclarator -> Doc

prettyList :: [DirectAbstractDeclarator] -> Doc

direct_abstract_declarator :: CParser m => m DirectAbstractDeclarator

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);
}