Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.C.Types

Contents

Types
Parsing
Convert to and from high-level views
To english

Description

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.

Synopsis

data CIdentifier
unCIdentifier :: CIdentifier -> String
cIdentifierFromString :: Bool -> String -> Either String CIdentifier
data StorageClassSpecifier
- = TYPEDEF
- | EXTERN
- | STATIC
- | AUTO
- | REGISTER
data TypeQualifier
- = CONST
- | RESTRICT
- | VOLATILE
data FunctionSpecifier = INLINE
data ArrayType i
- = VariablySized
- | Unsized
- | SizedByInteger Integer
- | SizedByIdentifier i
data Specifiers = Specifiers {
- storageClassSpecifiers :: [StorageClassSpecifier]
- typeQualifiers :: [TypeQualifier]
- functionSpecifiers :: [FunctionSpecifier]
}
data Type i
- = TypeSpecifier Specifiers TypeSpecifier
- | Ptr [TypeQualifier] (Type i)
- | Array (ArrayType i) (Type i)
- | Proto (Type i) [ParameterDeclaration i]
data TypeSpecifier
- = 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
data Sign
- = Signed
- | Unsigned
data ParameterDeclaration i = ParameterDeclaration {
- parameterDeclarationId :: Maybe i
- parameterDeclarationType :: Type i
}
type TypeNames = HashSet 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, MonadFail m, Hashable i)
data CParserContext i
cCParserContext :: Bool -> TypeNames -> CParserContext CIdentifier
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_ :: Bool -> String -> ReaderT (CParserContext CIdentifier) (Parsec String ()) a -> a
parseParameterDeclaration :: (CParser i m, Pretty i) => m (ParameterDeclaration i)
parseParameterList :: (CParser i m, Pretty i) => m [ParameterDeclaration i]
parseIdentifier :: CParser i m => m i
parseEnableCpp :: CParser i m => m Bool
parseType :: (CParser i m, Pretty i) => m (Type i)
data UntangleErr
- = MultipleDataTypes [DeclarationSpecifier]
- | NoDataTypes [DeclarationSpecifier]
- | IllegalSpecifiers String [TypeSpecifier]
untangleParameterDeclaration :: ParameterDeclaration i -> Either UntangleErr (ParameterDeclaration i)
tangleParameterDeclaration :: forall i. ParameterDeclaration i -> ParameterDeclaration i
describeParameterDeclaration :: Pretty i => ParameterDeclaration i -> Doc ann
describeType :: Pretty i => Type i -> Doc ann

Types

data CIdentifier Source #

A type for C identifiers.

Instances

Instances details

IsString CIdentifier Source #
Instance details Defined in Language.C.Types.Parse Methods fromString :: String -> CIdentifier #
Show CIdentifier Source #
Instance details Defined in Language.C.Types.Parse Methods showsPrec :: Int -> CIdentifier -> ShowS # show :: CIdentifier -> String # showList :: [CIdentifier] -> ShowS #
Eq CIdentifier Source #
Instance details Defined in Language.C.Types.Parse Methods (==) :: CIdentifier -> CIdentifier -> Bool # (/=) :: CIdentifier -> CIdentifier -> Bool #
Ord CIdentifier Source #
Instance details 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 #
Hashable CIdentifier Source #
Instance details Defined in Language.C.Types.Parse Methods hashWithSalt :: Int -> CIdentifier -> Int # hash :: CIdentifier -> Int #
Pretty CIdentifier Source #
Instance details Defined in Language.C.Types.Parse Methods pretty :: CIdentifier -> Doc ann # prettyList :: [CIdentifier] -> Doc ann #

unCIdentifier :: CIdentifier -> String Source #

cIdentifierFromString :: Bool -> String -> Either String CIdentifier Source #

data StorageClassSpecifier Source #

Constructors

TYPEDEF
EXTERN
STATIC
AUTO
REGISTER

Instances

Instances details

Show StorageClassSpecifier Source #
Instance details Defined in Language.C.Types.Parse Methods showsPrec :: Int -> StorageClassSpecifier -> ShowS # show :: StorageClassSpecifier -> String # showList :: [StorageClassSpecifier] -> ShowS #
Eq StorageClassSpecifier Source #
Instance details Defined in Language.C.Types.Parse Methods (==) :: StorageClassSpecifier -> StorageClassSpecifier -> Bool # (/=) :: StorageClassSpecifier -> StorageClassSpecifier -> Bool #
Pretty StorageClassSpecifier Source #
Instance details Defined in Language.C.Types.Parse Methods pretty :: StorageClassSpecifier -> Doc ann # prettyList :: [StorageClassSpecifier] -> Doc ann #

data TypeQualifier Source #

Constructors

CONST
RESTRICT
VOLATILE

Instances

Instances details

Show TypeQualifier Source #
Instance details Defined in Language.C.Types.Parse Methods showsPrec :: Int -> TypeQualifier -> ShowS # show :: TypeQualifier -> String # showList :: [TypeQualifier] -> ShowS #
Eq TypeQualifier Source #
Instance details Defined in Language.C.Types.Parse Methods (==) :: TypeQualifier -> TypeQualifier -> Bool # (/=) :: TypeQualifier -> TypeQualifier -> Bool #
Pretty TypeQualifier Source #
Instance details Defined in Language.C.Types.Parse Methods pretty :: TypeQualifier -> Doc ann # prettyList :: [TypeQualifier] -> Doc ann #

data FunctionSpecifier Source #

Constructors

INLINE

Instances

Instances details

Show FunctionSpecifier Source #
Instance details Defined in Language.C.Types.Parse Methods showsPrec :: Int -> FunctionSpecifier -> ShowS # show :: FunctionSpecifier -> String # showList :: [FunctionSpecifier] -> ShowS #
Eq FunctionSpecifier Source #
Instance details Defined in Language.C.Types.Parse Methods (==) :: FunctionSpecifier -> FunctionSpecifier -> Bool # (/=) :: FunctionSpecifier -> FunctionSpecifier -> Bool #
Pretty FunctionSpecifier Source #
Instance details Defined in Language.C.Types.Parse Methods pretty :: FunctionSpecifier -> Doc ann # prettyList :: [FunctionSpecifier] -> Doc ann #

data ArrayType i Source #

Constructors

VariablySized
Unsized
SizedByInteger Integer
SizedByIdentifier i

Instances

Instances details

Foldable ArrayType Source #
Instance details Defined in Language.C.Types.Parse Methods fold :: Monoid m => ArrayType m -> m # foldMap :: Monoid m => (a -> m) -> ArrayType a -> 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] # null :: ArrayType a -> Bool # length :: ArrayType a -> Int # elem :: Eq a => a -> ArrayType a -> Bool # maximum :: Ord a => ArrayType a -> a # minimum :: Ord a => ArrayType a -> a # sum :: Num a => ArrayType a -> a # product :: Num a => ArrayType a -> a #
Traversable ArrayType Source #
Instance details Defined in Language.C.Types.Parse Methods traverse :: Applicative f => (a -> f b) -> ArrayType a -> f (ArrayType b) # sequenceA :: Applicative f => ArrayType (f a) -> f (ArrayType a) # mapM :: Monad m => (a -> m b) -> ArrayType a -> m (ArrayType b) # sequence :: Monad m => ArrayType (m a) -> m (ArrayType a) #
Functor ArrayType Source #
Instance details Defined in Language.C.Types.Parse Methods fmap :: (a -> b) -> ArrayType a -> ArrayType b # (<$) :: a -> ArrayType b -> ArrayType a #
Show i => Show (ArrayType i) Source #
Instance details Defined in Language.C.Types.Parse Methods showsPrec :: Int -> ArrayType i -> ShowS # show :: ArrayType i -> String # showList :: [ArrayType i] -> ShowS #
Eq i => Eq (ArrayType i) Source #
Instance details Defined in Language.C.Types.Parse Methods (==) :: ArrayType i -> ArrayType i -> Bool # (/=) :: ArrayType i -> ArrayType i -> Bool #
Pretty i => Pretty (ArrayType i) Source #
Instance details Defined in Language.C.Types.Parse Methods pretty :: ArrayType i -> Doc ann # prettyList :: [ArrayType i] -> Doc ann #

data Specifiers Source #

Constructors

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

Instances

Instances details

Monoid Specifiers Source #
Instance details Defined in Language.C.Types Methods mempty :: Specifiers # mappend :: Specifiers -> Specifiers -> Specifiers # mconcat :: [Specifiers] -> Specifiers #
Semigroup Specifiers Source #
Instance details Defined in Language.C.Types Methods (<>) :: Specifiers -> Specifiers -> Specifiers # sconcat :: NonEmpty Specifiers -> Specifiers # stimes :: Integral b => b -> Specifiers -> Specifiers #
Show Specifiers Source #
Instance details Defined in Language.C.Types Methods showsPrec :: Int -> Specifiers -> ShowS # show :: Specifiers -> String # showList :: [Specifiers] -> ShowS #
Eq Specifiers Source #
Instance details Defined in Language.C.Types Methods (==) :: Specifiers -> Specifiers -> Bool # (/=) :: Specifiers -> Specifiers -> Bool #

data Type i Source #

Constructors

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

Instances

Instances details

Foldable Type Source #
Instance details Defined in Language.C.Types Methods fold :: Monoid m => Type m -> m # foldMap :: Monoid m => (a -> m) -> Type a -> m # foldMap' :: Monoid m => (a -> m) -> Type a -> m # foldr :: (a -> b -> b) -> b -> Type a -> b # foldr' :: (a -> b -> b) -> b -> Type a -> b # foldl :: (b -> a -> b) -> b -> Type a -> b # foldl' :: (b -> a -> b) -> b -> Type a -> b # foldr1 :: (a -> a -> a) -> Type a -> a # foldl1 :: (a -> a -> a) -> Type a -> a # toList :: Type a -> [a] # null :: Type a -> Bool # length :: Type a -> Int # elem :: Eq a => a -> Type a -> Bool # maximum :: Ord a => Type a -> a # minimum :: Ord a => Type a -> a # sum :: Num a => Type a -> a # product :: Num a => Type a -> a #
Traversable Type Source #
Instance details Defined in Language.C.Types Methods traverse :: Applicative f => (a -> f b) -> Type a -> f (Type b) # sequenceA :: Applicative f => Type (f a) -> f (Type a) # mapM :: Monad m => (a -> m b) -> Type a -> m (Type b) # sequence :: Monad m => Type (m a) -> m (Type a) #
Functor Type Source #
Instance details Defined in Language.C.Types Methods fmap :: (a -> b) -> Type a -> Type b # (<$) :: a -> Type b -> Type a #
Show i => Show (Type i) Source #
Instance details Defined in Language.C.Types Methods showsPrec :: Int -> Type i -> ShowS # show :: Type i -> String # showList :: [Type i] -> ShowS #
Eq i => Eq (Type i) Source #
Instance details Defined in Language.C.Types Methods (==) :: Type i -> Type i -> Bool # (/=) :: Type i -> Type i -> Bool #
Pretty i => Pretty (Type i) Source #
Instance details Defined in Language.C.Types Methods pretty :: Type i -> Doc ann # prettyList :: [Type i] -> Doc ann #

data TypeSpecifier Source #

Instances

Instances details

Show TypeSpecifier Source #
Instance details Defined in Language.C.Types Methods showsPrec :: Int -> TypeSpecifier -> ShowS # show :: TypeSpecifier -> String # showList :: [TypeSpecifier] -> ShowS #
Eq TypeSpecifier Source #
Instance details Defined in Language.C.Types Methods (==) :: TypeSpecifier -> TypeSpecifier -> Bool # (/=) :: TypeSpecifier -> TypeSpecifier -> Bool #
Ord TypeSpecifier Source #
Instance details Defined in Language.C.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 #
Pretty TypeSpecifier Source #
Instance details Defined in Language.C.Types Methods pretty :: TypeSpecifier -> Doc ann # prettyList :: [TypeSpecifier] -> Doc ann #

data Sign Source #

Constructors

Signed
Unsigned

Instances

Instances details

Show Sign Source #
Instance details Defined in Language.C.Types Methods showsPrec :: Int -> Sign -> ShowS # show :: Sign -> String # showList :: [Sign] -> ShowS #
Eq Sign Source #
Instance details Defined in Language.C.Types Methods (==) :: Sign -> Sign -> Bool # (/=) :: Sign -> Sign -> Bool #
Ord Sign Source #
Instance details Defined in Language.C.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 #

data ParameterDeclaration i Source #

Constructors

ParameterDeclaration
Fields parameterDeclarationId :: Maybe i parameterDeclarationType :: Type i

Instances

Instances details

Foldable ParameterDeclaration Source #
Instance details Defined in Language.C.Types Methods fold :: Monoid m => ParameterDeclaration m -> m # foldMap :: Monoid m => (a -> m) -> ParameterDeclaration a -> m # foldMap' :: Monoid m => (a -> m) -> ParameterDeclaration a -> m # foldr :: (a -> b -> b) -> b -> ParameterDeclaration a -> b # foldr' :: (a -> b -> b) -> b -> ParameterDeclaration a -> b # foldl :: (b -> a -> b) -> b -> ParameterDeclaration a -> b # foldl' :: (b -> a -> b) -> b -> ParameterDeclaration a -> b # foldr1 :: (a -> a -> a) -> ParameterDeclaration a -> a # foldl1 :: (a -> a -> a) -> ParameterDeclaration a -> a # toList :: ParameterDeclaration a -> [a] # null :: ParameterDeclaration a -> Bool # length :: ParameterDeclaration a -> Int # elem :: Eq a => a -> ParameterDeclaration a -> Bool # maximum :: Ord a => ParameterDeclaration a -> a # minimum :: Ord a => ParameterDeclaration a -> a # sum :: Num a => ParameterDeclaration a -> a # product :: Num a => ParameterDeclaration a -> a #
Traversable ParameterDeclaration Source #
Instance details Defined in Language.C.Types Methods traverse :: Applicative f => (a -> f b) -> ParameterDeclaration a -> f (ParameterDeclaration b) # sequenceA :: Applicative f => ParameterDeclaration (f a) -> f (ParameterDeclaration a) # mapM :: Monad m => (a -> m b) -> ParameterDeclaration a -> m (ParameterDeclaration b) # sequence :: Monad m => ParameterDeclaration (m a) -> m (ParameterDeclaration a) #
Functor ParameterDeclaration Source #
Instance details Defined in Language.C.Types Methods fmap :: (a -> b) -> ParameterDeclaration a -> ParameterDeclaration b # (<$) :: a -> ParameterDeclaration b -> ParameterDeclaration a #
Show i => Show (ParameterDeclaration i) Source #
Instance details Defined in Language.C.Types Methods showsPrec :: Int -> ParameterDeclaration i -> ShowS # show :: ParameterDeclaration i -> String # showList :: [ParameterDeclaration i] -> ShowS #
Eq i => Eq (ParameterDeclaration i) Source #
Instance details Defined in Language.C.Types Methods (==) :: ParameterDeclaration i -> ParameterDeclaration i -> Bool # (/=) :: ParameterDeclaration i -> ParameterDeclaration i -> Bool #
Pretty i => Pretty (ParameterDeclaration i) Source #
Instance details Defined in Language.C.Types Methods pretty :: ParameterDeclaration i -> Doc ann # prettyList :: [ParameterDeclaration i] -> Doc ann #

Parsing

type TypeNames = HashSet CIdentifier Source #

A collection of named types (typedefs)

type CParser i m = (Monad m, Functor m, Applicative m, MonadPlus m, Parsing m, CharParsing m, TokenParsing m, LookAheadParsing m, MonadReader (CParserContext i) m, MonadFail m, Hashable i) Source #

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.

data CParserContext i Source #

cCParserContext :: Bool -> TypeNames -> CParserContext CIdentifier Source #

runCParser Source #

Arguments

:: 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.

quickCParser Source #

Arguments

:: 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.

quickCParser_ Source #

Arguments

:: 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.

parseParameterDeclaration :: (CParser i m, Pretty i) => m (ParameterDeclaration i) Source #

parseParameterList :: (CParser i m, Pretty i) => m [ParameterDeclaration i] Source #

parseIdentifier :: CParser i m => m i Source #

parseEnableCpp :: CParser i m => m Bool Source #

parseType :: (CParser i m, Pretty i) => m (Type i) Source #

Convert to and from high-level views

data UntangleErr Source #

Constructors

MultipleDataTypes [DeclarationSpecifier]
NoDataTypes [DeclarationSpecifier]
IllegalSpecifiers String [TypeSpecifier]

Instances

Instances details

Show UntangleErr Source #
Instance details Defined in Language.C.Types Methods showsPrec :: Int -> UntangleErr -> ShowS # show :: UntangleErr -> String # showList :: [UntangleErr] -> ShowS #
Eq UntangleErr Source #
Instance details Defined in Language.C.Types Methods (==) :: UntangleErr -> UntangleErr -> Bool # (/=) :: UntangleErr -> UntangleErr -> Bool #
Pretty UntangleErr Source #
Instance details Defined in Language.C.Types Methods pretty :: UntangleErr -> Doc ann # prettyList :: [UntangleErr] -> Doc ann #

untangleParameterDeclaration :: ParameterDeclaration i -> Either UntangleErr (ParameterDeclaration i) Source #

tangleParameterDeclaration :: forall i. ParameterDeclaration i -> ParameterDeclaration i Source #

To english

describeParameterDeclaration :: Pretty i => ParameterDeclaration i -> Doc ann Source #

describeType :: Pretty i => Type i -> Doc ann Source #

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