Safe Haskell	Safe-Inferred
Language	Haskell2010

FFICXX.Generate.Type.Class

Synopsis

data CTypes
- = CTBool
- | CTChar
- | CTClock
- | CTDouble
- | CTFile
- | CTFloat
- | CTFpos
- | CTInt
- | CTIntMax
- | CTIntPtr
- | CTJmpBuf
- | CTLLong
- | CTLong
- | CTPtrdiff
- | CTSChar
- | CTSUSeconds
- | CTShort
- | CTSigAtomic
- | CTSize
- | CTTime
- | CTUChar
- | CTUInt
- | CTUIntMax
- | CTUIntPtr
- | CTULLong
- | CTULong
- | CTUSeconds
- | CTUShort
- | CTWchar
- | CTInt8
- | CTInt16
- | CTInt32
- | CTInt64
- | CTUInt8
- | CTUInt16
- | CTUInt32
- | CTUInt64
- | CTVoidStar
- | CTString
- | CEnum CTypes String
- | CPointer CTypes
- | CRef CTypes
data CPPTypes
- = CPTClass Class
- | CPTClassRef Class
- | CPTClassCopy Class
- | CPTClassMove Class
data IsConst
- = Const
- | NoConst
data TemplateArgType
- = TArg_Class Class
- | TArg_TypeParam String
- | TArg_Other String
data TemplateAppInfo = TemplateAppInfo {
- tapp_tclass :: TemplateClass
- tapp_tparams :: [TemplateArgType]
- tapp_CppTypeForParam :: String
}
data Types
- = Void
- | SelfType
- | CT CTypes IsConst
- | CPT CPPTypes IsConst
- | TemplateApp TemplateAppInfo
- | TemplateAppRef TemplateAppInfo
- | TemplateAppMove TemplateAppInfo
- | TemplateType TemplateClass
- | TemplateParam String
- | TemplateParamPointer String
data Arg = Arg {
- arg_type :: Types
- arg_name :: String
}
data Function
- = Constructor {
  - func_args :: [Arg]
  - func_alias :: Maybe String
  }
- | Virtual {
  - func_ret :: Types
  - func_name :: String
  - func_args :: [Arg]
  - func_alias :: Maybe String
  }
- | NonVirtual {
  - func_ret :: Types
  - func_name :: String
  - func_args :: [Arg]
  - func_alias :: Maybe String
  }
- | Static {
  - func_ret :: Types
  - func_name :: String
  - func_args :: [Arg]
  - func_alias :: Maybe String
  }
- | Destructor {
  - func_alias :: Maybe String
  }
newtype Variable = Variable {
- unVariable :: Arg
}
data TemplateMemberFunction = TemplateMemberFunction {
- tmf_params :: [String]
- tmf_ret :: Types
- tmf_name :: String
- tmf_args :: [Arg]
- tmf_alias :: Maybe String
}
data TopLevel
- = TLOrdinary TLOrdinary
- | TLTemplate TLTemplate
filterTLOrdinary :: [TopLevel] -> [TLOrdinary]
filterTLTemplate :: [TopLevel] -> [TLTemplate]
data TLOrdinary
- = TopLevelFunction {
  - toplevelfunc_ret :: Types
  - toplevelfunc_name :: String
  - toplevelfunc_args :: [Arg]
  - toplevelfunc_alias :: Maybe String
  }
- | TopLevelVariable {
  - toplevelvar_ret :: Types
  - toplevelvar_name :: String
  - toplevelvar_alias :: Maybe String
  }
data TLTemplate = TopLevelTemplateFunction {
- topleveltfunc_params :: [String]
- topleveltfunc_ret :: Types
- topleveltfunc_name :: String
- topleveltfunc_oname :: String
- topleveltfunc_args :: [Arg]
}
isNewFunc :: Function -> Bool
isDeleteFunc :: Function -> Bool
isVirtualFunc :: Function -> Bool
isNonVirtualFunc :: Function -> Bool
isStaticFunc :: Function -> Bool
virtualFuncs :: [Function] -> [Function]
constructorFuncs :: [Function] -> [Function]
nonVirtualNotNewFuncs :: [Function] -> [Function]
staticFuncs :: [Function] -> [Function]
newtype ProtectedMethod = Protected {
- unProtected :: [String]
}
data ClassAlias = ClassAlias {
- caHaskellName :: String
- caFFIName :: String
}
data Class
- = Class {
  - class_cabal :: Cabal
  - class_name :: String
  - class_parents :: [Class]
  - class_protected :: ProtectedMethod
  - class_alias :: Maybe ClassAlias
  - class_funcs :: [Function]
  - class_vars :: [Variable]
  - class_tmpl_funcs :: [TemplateMemberFunction]
  - class_has_proxy :: Bool
  }
- | AbstractClass {
  - class_cabal :: Cabal
  - class_name :: String
  - class_parents :: [Class]
  - class_protected :: ProtectedMethod
  - class_alias :: Maybe ClassAlias
  - class_funcs :: [Function]
  - class_vars :: [Variable]
  - class_tmpl_funcs :: [TemplateMemberFunction]
  }
data OpExp
- = OpStar
- | OpFPPlus
data TemplateFunction
- = TFun {
  - tfun_ret :: Types
  - tfun_name :: String
  - tfun_oname :: String
  - tfun_args :: [Arg]
  }
- | TFunNew {
  - tfun_new_args :: [Arg]
  - tfun_new_alias :: Maybe String
  }
- | TFunDelete
- | TFunOp {
  - tfun_ret :: Types
  - tfun_name :: String
  - tfun_opexp :: OpExp
  }
argsFromOpExp :: OpExp -> [Arg]
opSymbol :: OpExp -> String
data Form
- = FormSimple String
- | FormNested String String
data TemplateClass = TmplCls {
- tclass_cabal :: Cabal
- tclass_name :: String
- tclass_cxxform :: Form
- tclass_params :: [String]
- tclass_funcs :: [TemplateFunction]
- tclass_vars :: [Variable]
}
data ClassGlobal = ClassGlobal {
- cgDaughterSelfMap :: DaughterMap
- cgDaughterMap :: DaughterMap
}
data Selfness
- = Self
- | NoSelf
isAbstractClass :: Class -> Bool
hasProxy :: Class -> Bool
type DaughterMap = Map String [Class]
data Accessor
- = Getter
- | Setter

Documentation

data CTypes Source #

C types

Instances

Instances details

Show CTypes Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods showsPrec :: Int -> CTypes -> ShowS # show :: CTypes -> String # showList :: [CTypes] -> ShowS #

data CPPTypes Source #

C++ types

Constructors

CPTClass Class
CPTClassRef Class
CPTClassCopy Class
CPTClassMove Class

Instances

Instances details

Show CPPTypes Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods showsPrec :: Int -> CPPTypes -> ShowS # show :: CPPTypes -> String # showList :: [CPPTypes] -> ShowS #

data IsConst Source #

const flag

Constructors

Const
NoConst

Instances

Instances details

Show IsConst Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods showsPrec :: Int -> IsConst -> ShowS # show :: IsConst -> String # showList :: [IsConst] -> ShowS #

data TemplateArgType Source #

Argument type which can be used as an template argument like float in vectorfloat. For now, this distinguishes Class and non-Class.

Constructors

TArg_Class Class
TArg_TypeParam String
TArg_Other String

Instances

Instances details

Show TemplateArgType Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods showsPrec :: Int -> TemplateArgType -> ShowS # show :: TemplateArgType -> String # showList :: [TemplateArgType] -> ShowS #

data TemplateAppInfo Source #

Constructors

TemplateAppInfo
Fields tapp_tclass :: TemplateClass tapp_tparams :: [TemplateArgType] tapp_CppTypeForParam :: String

Instances

Instances details

Show TemplateAppInfo Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods showsPrec :: Int -> TemplateAppInfo -> ShowS # show :: TemplateAppInfo -> String # showList :: [TemplateAppInfo] -> ShowS #

data Types Source #

Supported C++ types.

Constructors

Void
SelfType
CT CTypes IsConst
CPT CPPTypes IsConst
TemplateApp TemplateAppInfo	like vectorfloat*
TemplateAppRef TemplateAppInfo	like vectorfloat&
TemplateAppMove TemplateAppInfo	like unique_ptrfloat (using std::move)
TemplateType TemplateClass	template self? TODO: clarify this.
TemplateParam String
TemplateParamPointer String	this is A* with templateA

Instances

Instances details

Show Types Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods showsPrec :: Int -> Types -> ShowS # show :: Types -> String # showList :: [Types] -> ShowS #

data Arg Source #

Function argument, type and variable name.

Constructors

Arg
Fields arg_type :: Types arg_name :: String

Instances

Instances details

Show Arg Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods showsPrec :: Int -> Arg -> ShowS # show :: Arg -> String # showList :: [Arg] -> ShowS #

data Function Source #

Regular member functions in a ordinary class

Constructors

Constructor
Fields func_args :: [Arg] func_alias :: Maybe String
Virtual
Fields func_ret :: Types func_name :: String func_args :: [Arg] func_alias :: Maybe String
NonVirtual
Fields func_ret :: Types func_name :: String func_args :: [Arg] func_alias :: Maybe String
Static
Fields func_ret :: Types func_name :: String func_args :: [Arg] func_alias :: Maybe String
Destructor
Fields func_alias :: Maybe String

Instances

Instances details

Show Function Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods showsPrec :: Int -> Function -> ShowS # show :: Function -> String # showList :: [Function] -> ShowS #

newtype Variable Source #

Member variable. Isomorphic to Arg

Constructors

Variable
Fields unVariable :: Arg

Instances

Instances details

Show Variable Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods showsPrec :: Int -> Variable -> ShowS # show :: Variable -> String # showList :: [Variable] -> ShowS #

data TemplateMemberFunction Source #

Member functions of a template class.

Constructors

TemplateMemberFunction
Fields tmf_params :: [String] tmf_ret :: Types tmf_name :: String tmf_args :: [Arg] tmf_alias :: Maybe String

Instances

Instances details

Show TemplateMemberFunction Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods showsPrec :: Int -> TemplateMemberFunction -> ShowS # show :: TemplateMemberFunction -> String # showList :: [TemplateMemberFunction] -> ShowS #

data TopLevel Source #

Function defined at top level like ordinary C functions, i.e. no owning class.

Constructors

TLOrdinary TLOrdinary
TLTemplate TLTemplate

Instances

Instances details

Show TopLevel Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods showsPrec :: Int -> TopLevel -> ShowS # show :: TopLevel -> String # showList :: [TopLevel] -> ShowS #

filterTLOrdinary :: [TopLevel] -> [TLOrdinary] Source #

filterTLTemplate :: [TopLevel] -> [TLTemplate] Source #

data TLOrdinary Source #

Constructors

TopLevelFunction
Fields toplevelfunc_ret :: Types toplevelfunc_name :: String toplevelfunc_args :: [Arg] toplevelfunc_alias :: Maybe String
TopLevelVariable
Fields toplevelvar_ret :: Types toplevelvar_name :: String toplevelvar_alias :: Maybe String

Instances

Instances details

Show TLOrdinary Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods showsPrec :: Int -> TLOrdinary -> ShowS # show :: TLOrdinary -> String # showList :: [TLOrdinary] -> ShowS #

data TLTemplate Source #

Constructors

TopLevelTemplateFunction
Fields topleveltfunc_params :: [String] topleveltfunc_ret :: Types topleveltfunc_name :: String topleveltfunc_oname :: String topleveltfunc_args :: [Arg]

Instances

Instances details

Show TLTemplate Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods showsPrec :: Int -> TLTemplate -> ShowS # show :: TLTemplate -> String # showList :: [TLTemplate] -> ShowS #

isNewFunc :: Function -> Bool Source #

isDeleteFunc :: Function -> Bool Source #

isVirtualFunc :: Function -> Bool Source #

isNonVirtualFunc :: Function -> Bool Source #

isStaticFunc :: Function -> Bool Source #

virtualFuncs :: [Function] -> [Function] Source #

constructorFuncs :: [Function] -> [Function] Source #

nonVirtualNotNewFuncs :: [Function] -> [Function] Source #

staticFuncs :: [Function] -> [Function] Source #

newtype ProtectedMethod Source #

Constructors

Protected
Fields unProtected :: [String]

Instances

Instances details

Monoid ProtectedMethod Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods mempty :: ProtectedMethod # mappend :: ProtectedMethod -> ProtectedMethod -> ProtectedMethod # mconcat :: [ProtectedMethod] -> ProtectedMethod #
Semigroup ProtectedMethod Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods (<>) :: ProtectedMethod -> ProtectedMethod -> ProtectedMethod # sconcat :: NonEmpty ProtectedMethod -> ProtectedMethod # stimes :: Integral b => b -> ProtectedMethod -> ProtectedMethod #

data ClassAlias Source #

Constructors

ClassAlias
Fields caHaskellName :: String caFFIName :: String

data Class Source #

Constructors

Class
Fields class_cabal :: Cabal class_name :: String class_parents :: [Class] class_protected :: ProtectedMethod class_alias :: Maybe ClassAlias class_funcs :: [Function] class_vars :: [Variable] class_tmpl_funcs :: [TemplateMemberFunction] class_has_proxy :: Bool
AbstractClass
Fields class_cabal :: Cabal class_name :: String class_parents :: [Class] class_protected :: ProtectedMethod class_alias :: Maybe ClassAlias class_funcs :: [Function] class_vars :: [Variable] class_tmpl_funcs :: [TemplateMemberFunction]

Instances

Instances details

Show Class Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods showsPrec :: Int -> Class -> ShowS # show :: Class -> String # showList :: [Class] -> ShowS #
Eq Class Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods (==) :: Class -> Class -> Bool # (/=) :: Class -> Class -> Bool #
Ord Class Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods compare :: Class -> Class -> Ordering # (<) :: Class -> Class -> Bool # (<=) :: Class -> Class -> Bool # (>) :: Class -> Class -> Bool # (>=) :: Class -> Class -> Bool # max :: Class -> Class -> Class # min :: Class -> Class -> Class #

data OpExp Source #

Constructors

OpStar	unary * (deRef) operator
OpFPPlus	unary prefix ++ operator \| OpAdd Arg Arg \| OpMul Arg Arg

data TemplateFunction Source #

Constructors

TFun
Fields tfun_ret :: Types tfun_name :: String haskell alias for the operator tfun_oname :: String tfun_args :: [Arg]
TFunNew
Fields tfun_new_args :: [Arg] tfun_new_alias :: Maybe String
TFunDelete
TFunOp
Fields tfun_ret :: Types tfun_name :: String haskell alias for the operator tfun_opexp :: OpExp

argsFromOpExp :: OpExp -> [Arg] Source #

opSymbol :: OpExp -> String Source #

data Form Source #

Positional string interpolation form. For example, "std::mapK,V::iterator" is FormNested "std::map" "iterator"].

Constructors

FormSimple String
FormNested String String

data TemplateClass Source #

Constructors

TmplCls
Fields tclass_cabal :: Cabal tclass_name :: String tclass_cxxform :: Form tclass_params :: [String] tclass_funcs :: [TemplateFunction] tclass_vars :: [Variable]

Instances

Instances details

Show TemplateClass Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods showsPrec :: Int -> TemplateClass -> ShowS # show :: TemplateClass -> String # showList :: [TemplateClass] -> ShowS #
Eq TemplateClass Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods (==) :: TemplateClass -> TemplateClass -> Bool # (/=) :: TemplateClass -> TemplateClass -> Bool #
Ord TemplateClass Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods compare :: TemplateClass -> TemplateClass -> Ordering # (<) :: TemplateClass -> TemplateClass -> Bool # (<=) :: TemplateClass -> TemplateClass -> Bool # (>) :: TemplateClass -> TemplateClass -> Bool # (>=) :: TemplateClass -> TemplateClass -> Bool # max :: TemplateClass -> TemplateClass -> TemplateClass # min :: TemplateClass -> TemplateClass -> TemplateClass #

data ClassGlobal Source #

Constructors

ClassGlobal
Fields cgDaughterSelfMap :: DaughterMap cgDaughterMap :: DaughterMap

data Selfness Source #

Constructors

Self
NoSelf

isAbstractClass :: Class -> Bool Source #

Check abstract class

hasProxy :: Class -> Bool Source #

Check having Proxy

type DaughterMap = Map String [Class] Source #

data Accessor Source #

Constructors

Getter
Setter

Instances

Instances details

Show Accessor Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods showsPrec :: Int -> Accessor -> ShowS # show :: Accessor -> String # showList :: [Accessor] -> ShowS #
Eq Accessor Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods (==) :: Accessor -> Accessor -> Bool # (/=) :: Accessor -> Accessor -> Bool #

CTBool
CTChar
CTClock
CTDouble
CTFile
CTFloat
CTFpos
CTInt
CTIntMax
CTIntPtr
CTJmpBuf
CTLLong
CTLong
CTPtrdiff
CTSChar
CTSUSeconds
CTShort
CTSigAtomic
CTSize
CTTime
CTUChar
CTUInt
CTUIntMax
CTUIntPtr
CTULLong
CTULong
CTUSeconds
CTUShort
CTWchar
CTInt8
CTInt16
CTInt32
CTInt64
CTUInt8
CTUInt16
CTUInt32
CTUInt64
CTVoidStar
CTString
CEnum CTypes String
CPointer CTypes
CRef CTypes