Copyright	(c) 2011-2018 Ian-Woo Kim
License	BSD3
Maintainer	Ian-Woo Kim <ianwookim@gmail.com>
Stability	experimental
Portability	GHC
Safe Haskell	None
Language	Haskell98

FFICXX.Generate.Type.Class

Description

Synopsis

data CTypes
- = CTString
- | CTChar
- | CTInt
- | CTUInt
- | CTLong
- | CTULong
- | CTDouble
- | CTBool
- | CTDoubleStar
- | CTVoidStar
- | CTIntStar
- | CTCharStarStar
- | 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_tparam :: 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
type Args = [(Types, String)]
data Function
- = Constructor {
  - func_args :: Args
  - func_alias :: Maybe String
  }
- | Virtual {
  - func_ret :: Types
  - func_name :: String
  - func_args :: Args
  - func_alias :: Maybe String
  }
- | NonVirtual {
  - func_ret :: Types
  - func_name :: String
  - func_args :: Args
  - func_alias :: Maybe String
  }
- | Static {
  - func_ret :: Types
  - func_name :: String
  - func_args :: Args
  - func_alias :: Maybe String
  }
- | Destructor {
  - func_alias :: Maybe String
  }
data Variable = Variable {
- var_type :: Types
- var_name :: String
}
data TemplateMemberFunction = TemplateMemberFunction {
- tmf_param :: String
- tmf_ret :: Types
- tmf_name :: String
- tmf_args :: Args
- tmf_alias :: Maybe String
}
data TopLevelFunction
- = TopLevelFunction {
  - toplevelfunc_ret :: Types
  - toplevelfunc_name :: String
  - toplevelfunc_args :: Args
  - toplevelfunc_alias :: Maybe String
  }
- | TopLevelVariable {
  - toplevelvar_ret :: Types
  - toplevelvar_name :: String
  - toplevelvar_alias :: Maybe String
  }
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]
  }
- | 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 TemplateFunction
- = TFun {
  - tfun_ret :: Types
  - tfun_name :: String
  - tfun_oname :: String
  - tfun_args :: Args
  - tfun_alias :: Maybe String
  }
- | TFunNew {
  - tfun_new_args :: Args
  - tfun_new_alias :: Maybe String
  }
- | TFunDelete
data TemplateClass = TmplCls {
- tclass_cabal :: Cabal
- tclass_name :: String
- tclass_oname :: String
- tclass_param :: String
- tclass_funcs :: [TemplateFunction]
}
data ClassGlobal = ClassGlobal {
- cgDaughterSelfMap :: DaughterMap
- cgDaughterMap :: DaughterMap
}
data Selfness
- = Self
- | NoSelf
isAbstractClass :: Class -> Bool
type DaughterMap = Map String [Class]
data Accessor
- = Getter
- | Setter

Documentation

data CTypes Source #

C types

Constructors

CTString
CTChar
CTInt
CTUInt
CTLong
CTULong
CTDouble
CTBool
CTDoubleStar
CTVoidStar
CTIntStar
CTCharStarStar
CPointer CTypes
CRef CTypes

Instances

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

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

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

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_tparam :: TemplateArgType tapp_CppTypeForParam :: String

Instances

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 #

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

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

type Args = [(Types, String)] Source #

data Function Source #

Constructors

Constructor
Fields func_args :: Args func_alias :: Maybe String
Virtual
Fields func_ret :: Types func_name :: String func_args :: Args func_alias :: Maybe String
NonVirtual
Fields func_ret :: Types func_name :: String func_args :: Args func_alias :: Maybe String
Static
Fields func_ret :: Types func_name :: String func_args :: Args func_alias :: Maybe String
Destructor
Fields func_alias :: Maybe String

Instances

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

data Variable Source #

Constructors

Variable
Fields var_type :: Types var_name :: String

Instances

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 #

Constructors

TemplateMemberFunction
Fields tmf_param :: String tmf_ret :: Types tmf_name :: String tmf_args :: Args tmf_alias :: Maybe String

Instances

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

data TopLevelFunction Source #

Constructors

TopLevelFunction
Fields toplevelfunc_ret :: Types toplevelfunc_name :: String toplevelfunc_args :: Args toplevelfunc_alias :: Maybe String
TopLevelVariable
Fields toplevelvar_ret :: Types toplevelvar_name :: String toplevelvar_alias :: Maybe String

Instances

Show TopLevelFunction Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods showsPrec :: Int -> TopLevelFunction -> ShowS # show :: TopLevelFunction -> String # showList :: [TopLevelFunction] -> 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

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 #
Monoid ProtectedMethod Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods mempty :: ProtectedMethod # mappend :: ProtectedMethod -> ProtectedMethod -> ProtectedMethod # mconcat :: [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]
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

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 #
Show Class Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods showsPrec :: Int -> Class -> ShowS # show :: Class -> String # showList :: [Class] -> ShowS #

data TemplateFunction Source #

Constructors

TFun
Fields tfun_ret :: Types tfun_name :: String tfun_oname :: String tfun_args :: Args tfun_alias :: Maybe String
TFunNew
Fields tfun_new_args :: Args tfun_new_alias :: Maybe String
TFunDelete

data TemplateClass Source #

Constructors

TmplCls
Fields tclass_cabal :: Cabal tclass_name :: String tclass_oname :: String tclass_param :: String tclass_funcs :: [TemplateFunction]

Instances

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 #
Show TemplateClass Source #
Instance details Defined in FFICXX.Generate.Type.Class Methods showsPrec :: Int -> TemplateClass -> ShowS # show :: TemplateClass -> String # showList :: [TemplateClass] -> ShowS #

data ClassGlobal Source #

Constructors

ClassGlobal
Fields cgDaughterSelfMap :: DaughterMap cgDaughterMap :: DaughterMap

data Selfness Source #

Constructors

Self
NoSelf

isAbstractClass :: Class -> Bool Source #

Check abstract class

type DaughterMap = Map String [Class] Source #

data Accessor Source #

Constructors

Getter
Setter

Instances

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