Types

Views of C datatypes. While Language.C.Types.Parse defines datatypes for representing the concrete syntax tree of C types, this module provides friendlier views of C types, by turning them into a data type matching more closely how we read and think about types, both in Haskell and in C. To appreciate the difference, look at the difference between ParameterDeclaration and ParameterDeclaration.

As a bonus, routines are provided for describing types in natural language (English) -- see describeParameterDeclaration and describeType.

Types

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

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

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

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

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

data Specifiers

Constructors

Specifiers

Fields

• storageClassSpecifiers :: [StorageClassSpecifier]
• typeQualifiers :: [TypeQualifier]
• functionSpecifiers :: [FunctionSpecifier]

Instances

Eq Specifiers

Defined in Types

Methods

(==) :: Specifiers -> Specifiers -> Bool

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

Ord Specifiers

Defined in Types

Methods

compare :: Specifiers -> Specifiers -> Ordering

(<) :: Specifiers -> Specifiers -> Bool

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

(>) :: Specifiers -> Specifiers -> Bool

(>=) :: Specifiers -> Specifiers -> Bool

max :: Specifiers -> Specifiers -> Specifiers

min :: Specifiers -> Specifiers -> Specifiers

Show Specifiers

Defined in Types

Methods

showsPrec :: Int -> Specifiers -> ShowS

show :: Specifiers -> String

showList :: [Specifiers] -> ShowS

Semigroup Specifiers

Defined in Types

Methods

(<>) :: Specifiers -> Specifiers -> Specifiers

sconcat :: NonEmpty Specifiers -> Specifiers

stimes :: Integral b => b -> Specifiers -> Specifiers

Monoid Specifiers

Defined in Types

Methods

mempty :: Specifiers

mappend :: Specifiers -> Specifiers -> Specifiers

mconcat :: [Specifiers] -> Specifiers

data Type

Constructors

TypeSpecifier Specifiers TypeSpecifier

Ptr [TypeQualifier] Type

Array ArrayType Type

Proto Type [ParameterDeclaration]

Instances

Eq Type

Defined in Types

Methods

(==) :: Type -> Type -> Bool

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

Ord Type

Defined in Types

Methods

compare :: Type -> Type -> Ordering

(<) :: Type -> Type -> Bool

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

(>) :: Type -> Type -> Bool

(>=) :: Type -> Type -> Bool

max :: Type -> Type -> Type

min :: Type -> Type -> Type

Show Type

Defined in Types

Methods

showsPrec :: Int -> Type -> ShowS

show :: Type -> String

showList :: [Type] -> ShowS

FromJSON Type

Defined in Spec

Methods

parseJSON :: Value -> Parser Type

parseJSONList :: Value -> Parser [Type]

Pretty Type

Defined in Types

Methods

pretty :: Type -> Doc

prettyList :: [Type] -> Doc

data TypeSpecifier

Constructors

Void

Char (Maybe Sign)

Short Sign

Int Sign

Long Sign

LLong Sign

Float

Double

LDouble

TypeName Identifier

Struct Identifier

Enum Identifier

Instances

Eq TypeSpecifier

Defined in Types

Methods

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

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

Ord TypeSpecifier

Defined in Types

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

Methods

showsPrec :: Int -> TypeSpecifier -> ShowS

show :: TypeSpecifier -> String

showList :: [TypeSpecifier] -> ShowS

Pretty TypeSpecifier

Defined in Types

Methods

pretty :: TypeSpecifier -> Doc

prettyList :: [TypeSpecifier] -> Doc

data Sign

Constructors

Signed

Unsigned

Instances

Eq Sign

Defined in Types

Methods

(==) :: Sign -> Sign -> Bool

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

Ord Sign

Defined in Types

Methods

compare :: Sign -> Sign -> Ordering

(<) :: Sign -> Sign -> Bool

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

(>) :: Sign -> Sign -> Bool

(>=) :: Sign -> Sign -> Bool

max :: Sign -> Sign -> Sign

min :: Sign -> Sign -> Sign

Show Sign

Defined in Types

Methods

showsPrec :: Int -> Sign -> ShowS

show :: Sign -> String

showList :: [Sign] -> ShowS

data ParameterDeclaration

Constructors

ParameterDeclaration

Fields

• parameterDeclarationId :: Maybe Identifier
• parameterDeclarationType :: Type

Instances

Eq ParameterDeclaration

Defined in Types

Methods

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

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

Ord ParameterDeclaration

Defined in Types

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

Methods

showsPrec :: Int -> ParameterDeclaration -> ShowS

show :: ParameterDeclaration -> String

showList :: [ParameterDeclaration] -> ShowS

Pretty ParameterDeclaration

Defined in Types

Methods

pretty :: ParameterDeclaration -> Doc

prettyList :: [ParameterDeclaration] -> Doc

Parsing

type IsTypeName = Identifier -> Bool

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

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.

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.

parseParameterDeclaration :: CParser m => m ParameterDeclaration

parseParameterList :: CParser m => m [ParameterDeclaration]

parseIdentifier :: CParser m => m Identifier

parseType :: CParser m => m Type

Convert to and from high-level views

data UntangleErr

Constructors

MultipleDataTypes [DeclarationSpecifier]

NoDataTypes [DeclarationSpecifier]

IllegalSpecifiers String [TypeSpecifier]

Instances

Eq UntangleErr

Defined in Types

Methods

(==) :: UntangleErr -> UntangleErr -> Bool

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

Show UntangleErr

Defined in Types

Methods

showsPrec :: Int -> UntangleErr -> ShowS

show :: UntangleErr -> String

showList :: [UntangleErr] -> ShowS

Pretty UntangleErr

Defined in Types

Methods

pretty :: UntangleErr -> Doc

prettyList :: [UntangleErr] -> Doc

untangleParameterDeclaration :: ParameterDeclaration -> Either UntangleErr ParameterDeclaration

tangleParameterDeclaration :: ParameterDeclaration -> ParameterDeclaration

To english

describeParameterDeclaration :: ParameterDeclaration -> Doc

describeType :: Type -> Doc