Moduleinline-c-0.9.1.10Haskell2010

Language.C.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.

14 types
15 values

Packageinline-c-0.9.1.10
Exports29
LanguageHaskell2010
LicenceMIT
SourceTypes.hs

Types

12 declarations

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

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

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

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

datadata ArrayType i

Constructors

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

datadata Specifiers

Constructors

Specifiers
- storageClassSpecifiers :: [StorageClassSpecifier]
- typeQualifiers :: [TypeQualifier]
- functionSpecifiers :: [FunctionSpecifier]

Instances4Eq, Show, Semigroup, Monoid

Eq SpecifiersDefined in inline-c-0.9.1.10 · Language.C.Types
Show SpecifiersDefined in inline-c-0.9.1.10 · Language.C.Types
Semigroup SpecifiersDefined in inline-c-0.9.1.10 · Language.C.Types
Monoid SpecifiersDefined in inline-c-0.9.1.10 · Language.C.Types

datadata Type i

Constructors

TypeSpecifier Specifiers TypeSpecifier
Ptr [TypeQualifier] (Type i)
Array (ArrayType i) (Type i)
Proto (Type i) [ParameterDeclaration i]

Instances6Functor, Foldable, Traversable, Eq, Show, Pretty

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

datadata TypeSpecifier

Constructors

Void
Bool
Char (Maybe Sign)
Short Sign
Int Sign
Long Sign
LLong Sign
Float
Double
LDouble
TypeName CIdentifier
Struct CIdentifier
Enum CIdentifier
Template CIdentifier [TypeSpecifier]
TemplateConst String
TemplatePointer TypeSpecifier

Instances4Eq, Ord, Show, Pretty

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

datadata Sign

Signed Unsigned

Instances3Eq, Ord, Show

Eq SignDefined in inline-c-0.9.1.10 · Language.C.Types
Ord SignDefined in inline-c-0.9.1.10 · Language.C.Types
Show SignDefined in inline-c-0.9.1.10 · Language.C.Types

datadata ParameterDeclaration i

Constructors

ParameterDeclaration
- parameterDeclarationId :: Maybe i
- parameterDeclarationType :: Type i

Instances6Functor, Foldable, Traversable, Eq, Show, Pretty

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

Parsing

12 declarations

typetype TypeNames = HashSet CIdentifier

A collection of named types (typedefs)

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.

datadata CParserContext i

valuecCParserContext :: Bool -> TypeNames -> CParserContext CIdentifier

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.

valueparseParameterDeclaration :: (CParser i m, Pretty i) => m (ParameterDeclaration i)

valueparseParameterList :: (CParser i m, Pretty i) => m [ParameterDeclaration i]

valueparseIdentifier :: CParser i m => m i

valueparseEnableCpp :: CParser i m => m Bool

valueparseType :: (CParser i m, Pretty i) => m (Type i)

Convert to and from high-level views

3 declarations

datadata UntangleErr

Constructors

Instances3Eq, Show, Pretty

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

valueuntangleParameterDeclaration

:: ParameterDeclaration i
-> Either UntangleErr (ParameterDeclaration i)

valuetangleParameterDeclaration

:: ParameterDeclaration i
-> ParameterDeclaration i

To english

2 declarations

valuedescribeParameterDeclaration

:: Pretty i
=> ParameterDeclaration i
-> Doc ann

valuedescribeType :: Pretty i => Type i -> Doc ann