Foreign.Hoppy.Generator.Spec

The primary data types for specifying C++ interfaces.

Show instances in this module produce strings of the form "<TypeOfObject nameOfObject otherInfo...>". They can be used in error messages without specifying a noun separately, i.e. write show cls instead of "the class " ++ show cls.

Interfaces

data Interface

A complete specification of a C++ API. Generators for different languages, including the binding generator for C++, use these to produce their output.

Interface does not have a HandlesExceptions instance because modifyExceptionHandlers does not work for it (handled exceptions cannot be modified after an Interface is constructed).

Instances

Show Interface

Methods

showsPrec :: Int -> Interface -> ShowS

show :: Interface -> String

showList :: [Interface] -> ShowS

type ErrorMsg = String

Indicates strings that are error messages.

data InterfaceOptions

Optional parameters when constructing an Interface with interface.

Constructors

InterfaceOptions

Fields

• interfaceOptionsExceptionHandlers :: ExceptionHandlers

defaultInterfaceOptions :: InterfaceOptions

Options used by interface. This contains no exception handlers.

interface

Arguments

:: String

interfaceName

-> [Module]

interfaceModules

-> Either ErrorMsg Interface

Constructs an Interface from the required parts. Some validation is performed; if the resulting interface would be invalid, an error message is returned instead.

This function passes defaultInterfaceOptions to interface'.

interface'

Arguments

:: String

interfaceName

-> [Module]

interfaceModules

-> InterfaceOptions

-> Either ErrorMsg Interface

Same as interface, but accepts some optional arguments.

interfaceName :: Interface -> String

The textual name of the interface.

interfaceModules :: Interface -> Map String Module

All of the individual modules, by moduleName.

interfaceNamesToModules :: Interface -> Map ExtName Module

Maps each ExtName exported by some module to the module that exports the name.

interfaceHaskellModuleBase :: Interface -> [String]

The name of the parent Haskell module under which a Haskell module will be generated for a Hoppy Module. This is a list of Haskell module path components, in other words, intercalate "." on the list produces a Haskell module name. Defaults to interfaceDefaultHaskellModuleBase, and may be overridden with interfaceAddHaskellModuleBase.

interfaceDefaultHaskellModuleBase :: [String]

The default Haskell module under which Hoppy modules will be generated. This is Foreign.Hoppy.Generated, that is:

["Foreign", "Hoppy", "Generated"]

interfaceAddHaskellModuleBase :: [String] -> Interface -> Either String Interface

Sets an interface to generate all of its modules under the given Haskell module prefix. See interfaceHaskellModuleBase.

interfaceHaskellModuleImportNames :: Interface -> Map Module String

Short qualified module import names that generated modules use to refer to each other tersely.

interfaceExceptionHandlers :: Interface -> ExceptionHandlers

Exceptions that all functions in the interface may throw.

interfaceCallbacksThrow :: Interface -> Bool

Whether callbacks within the interface support throwing C++ exceptions from Haskell into C++ during their execution. This may be overridden by moduleCallbacksThrow and callbackThrows.

interfaceSetCallbacksThrow :: Bool -> Interface -> Interface

Changes callbackThrows for all callbacks in an interface that don't have it set explicitly at the module or callback level.

interfaceExceptionClassId :: Interface -> Class -> Maybe ExceptionId

Returns the the exception ID for a class in an interface, if it has one (i.e. if it's been marked as an exception class with classMakeException).

interfaceExceptionSupportModule :: Interface -> Maybe Module

When an interface uses C++ exceptions, then one module needs to manually be selected to contain some interface-specific runtime support. This is the selected module.

interfaceSetExceptionSupportModule :: Module -> Interface -> Interface

Sets an interface's exception support module, for interfaces that use exceptions.

interfaceSetSharedPtr :: String -> Reqs -> Interface -> Interface

Installs a custom std::shared_ptr implementation for use by an interface. Hoppy uses shared pointers for generated callback code. This function is useful for building code with compilers that don't provide a conforming std::shared_ptr implementation.

interfaceSetSharedPtr ident reqs iface modifies iface to use as a shared_ptr class the C++ identifier ident, which needs reqs in order to be accessed. ident should be the name of a template to which an arbitrary <T> can be appended, for example "std::shared_ptr".

A shared_ptr<T> implementation foo must at least provide the following interface:

foo();  // Initialization with a null pointer.
foo(T*);  // Initialization with a given pointer.
foo(const foo&);  // Copy-construction.
T& operator*() const;  // Dereferencing (when non-null).
T* operator->() const;  // Dereferencing and invocation (when non-null).
explicit operator bool() const;  // Is the target object null?

C++ includes

data Include

An #include directive in a C++ file.

Instances

Eq Include

Methods

(==) :: Include -> Include -> Bool

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

Ord Include

Methods

compare :: Include -> Include -> Ordering

(<) :: Include -> Include -> Bool

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

(>) :: Include -> Include -> Bool

(>=) :: Include -> Include -> Bool

max :: Include -> Include -> Include

min :: Include -> Include -> Include

Show Include

Methods

showsPrec :: Int -> Include -> ShowS

show :: Include -> String

showList :: [Include] -> ShowS

includeStd :: String -> Include

Creates an #include <...> directive.

includeLocal :: String -> Include

Creates an #include "..." directive.

includeToString :: Include -> String

Returns the complete #include ... line for an include, including trailing newline.

Modules

data Module

A portion of functionality in a C++ API. An Interface is composed of multiple modules. A module will generate a single compilation unit containing bindings for all of the module's exports. The C++ code for a generated module will #include everything necessary for what is written to the header and source files separately. You can declare include dependencies with e.g. addReqIncludes, either for individual exports or at the module level (via the HasReqs Module instance). Dependencies between modules are handled automatically, and circularity is supported to a certain extent. See the documentation for the individual language modules for further details.

Instances

Eq Module

Methods

(==) :: Module -> Module -> Bool

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

Ord Module

Methods

compare :: Module -> Module -> Ordering

(<) :: Module -> Module -> Bool

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

(>) :: Module -> Module -> Bool

(>=) :: Module -> Module -> Bool

max :: Module -> Module -> Module

min :: Module -> Module -> Module

Show Module

Methods

showsPrec :: Int -> Module -> ShowS

show :: Module -> String

showList :: [Module] -> ShowS

HasAddendum Module

Methods

getAddendum :: Module -> Addendum

setAddendum :: Addendum -> Module -> Module

modifyAddendum :: (Addendum -> Addendum) -> Module -> Module

HandlesExceptions Module

Methods

getExceptionHandlers :: Module -> ExceptionHandlers

modifyExceptionHandlers :: (ExceptionHandlers -> ExceptionHandlers) -> Module -> Module

HasReqs Module

Methods

getReqs :: Module -> Reqs

setReqs :: Reqs -> Module -> Module

modifyReqs :: (Reqs -> Reqs) -> Module -> Module

moduleName :: Module -> String

The module's name. A module name must identify a unique module within an Interface.

moduleHppPath :: Module -> String

A relative path under a C++ sources root to which the generator will write a header file for the module's C++ bindings.

moduleCppPath :: Module -> String

A relative path under a C++ sources root to which the generator will write a source file for the module's C++ bindings.

moduleExports :: Module -> Map ExtName Export

All of the exports in a module.

moduleReqs :: Module -> Reqs

Module-level requirements.

moduleExceptionHandlers :: Module -> ExceptionHandlers

Exceptions that all functions in the module may throw.

moduleCallbacksThrow :: Module -> Maybe Bool

Whether callbacks exported from the module support exceptions being thrown during their execution. When present, this overrides interfaceCallbacksThrow. This maybe overridden by callbackThrows.

moduleSetCallbacksThrow :: MonadState Module m => Maybe Bool -> m ()

Changes callbackThrows for all callbacks in a module that don't have it set explicitly.

moduleAddendum :: Module -> Addendum

The module's addendum.

moduleHaskellName :: Module -> Maybe [String]

The generated Haskell module name, underneath the interfaceHaskellModuleBase. If absent (by default), the moduleName is used. May be modified with moduleAddHaskellName.

makeModule

Arguments

:: String

moduleName

-> String

moduleHppPath

-> String

moduleCppPath

-> Module

Creates an empty module, ready to be configured with moduleModify.

moduleModify :: Module -> StateT Module (Either String) () -> Either ErrorMsg Module

Extends a module. To be used with the module state-monad actions in this package.

moduleModify' :: Module -> StateT Module (Either String) () -> Module

Same as moduleModify, but calls error in the case of failure, which is okay in for a generator which would abort in this case anyway.

moduleSetHppPath :: MonadState Module m => String -> m ()

Replaces a module's moduleHppPath.

moduleSetCppPath :: MonadState Module m => String -> m ()

Replaces a module's moduleCppPath.

moduleAddExports :: (MonadError String m, MonadState Module m) => [Export] -> m ()

Adds exports to a module. An export must only be added to any module at most once, and must not be added to multiple modules.

moduleAddHaskellName :: (MonadError String m, MonadState Module m) => [String] -> m ()

Changes a module's moduleHaskellName from the default. This can only be called once on a module.

Requirements

data Reqs

A set of requirements of needed to use an identifier in C++ (function, type, etc.), via a set of Includes. The monoid instance has mempty as an empty set of includes, and mappend unions two include sets.

Instances

Show Reqs

Methods

showsPrec :: Int -> Reqs -> ShowS

show :: Reqs -> String

showList :: [Reqs] -> ShowS

Monoid Reqs

Methods

mempty :: Reqs

mappend :: Reqs -> Reqs -> Reqs

mconcat :: [Reqs] -> Reqs

reqsIncludes :: Reqs -> Set Include

The includes specified by a Reqs.

reqInclude :: Include -> Reqs

Creates a Reqs that contains the given include.

class HasReqs a where

Contains the data types for bindings to C++ entities: Function, Class, etc. Use addReqs or addReqIncludes to specify requirements for these entities, e.g. header files that must be included in order to access the underlying entities that are being bound.

C++ types that have requirements in order to use them in generated bindings.

Minimal complete definition

getReqs, (setReqs | modifyReqs)

Methods

getReqs :: a -> Reqs

Returns an object's requirements.

setReqs :: Reqs -> a -> a

Replaces an object's requirements with new ones.

modifyReqs :: (Reqs -> Reqs) -> a -> a

Modifies an object's requirements.

Instances

HasReqs Callback

Methods

getReqs :: Callback -> Reqs

setReqs :: Reqs -> Callback -> Callback

modifyReqs :: (Reqs -> Reqs) -> Callback -> Callback

HasReqs Class

Methods

getReqs :: Class -> Reqs

setReqs :: Reqs -> Class -> Class

modifyReqs :: (Reqs -> Reqs) -> Class -> Class

HasReqs Function

Methods

getReqs :: Function -> Reqs

setReqs :: Reqs -> Function -> Function

modifyReqs :: (Reqs -> Reqs) -> Function -> Function

HasReqs Bitspace

Methods

getReqs :: Bitspace -> Reqs

setReqs :: Reqs -> Bitspace -> Bitspace

modifyReqs :: (Reqs -> Reqs) -> Bitspace -> Bitspace

HasReqs CppEnum

Methods

getReqs :: CppEnum -> Reqs

setReqs :: Reqs -> CppEnum -> CppEnum

modifyReqs :: (Reqs -> Reqs) -> CppEnum -> CppEnum

HasReqs Variable

Methods

getReqs :: Variable -> Reqs

setReqs :: Reqs -> Variable -> Variable

modifyReqs :: (Reqs -> Reqs) -> Variable -> Variable

HasReqs Module

Methods

getReqs :: Module -> Reqs

setReqs :: Reqs -> Module -> Module

modifyReqs :: (Reqs -> Reqs) -> Module -> Module

addReqs :: HasReqs a => Reqs -> a -> a

Adds to a object's requirements.

addReqIncludes :: HasReqs a => [Include] -> a -> a

Adds a list of includes to the requirements of an object.

Names and exports

data ExtName

An external name is a string that generated bindings use to uniquely identify an object at runtime. An external name must start with an alphabetic character, and may only contain alphanumeric characters and '_'. You are free to use whatever naming style you like; case conversions will be performed automatically when required. Hoppy does make use of some conventions though, for example with Operators and in the provided bindings for the C++ standard library.

External names must be unique within an interface. They may not be reused between modules. This assumption is used for symbol naming in compiled shared objects and to freely import modules in Haskell bindings.

Instances

Eq ExtName

Methods

(==) :: ExtName -> ExtName -> Bool

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

Ord ExtName

Methods

compare :: ExtName -> ExtName -> Ordering

(<) :: ExtName -> ExtName -> Bool

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

(>) :: ExtName -> ExtName -> Bool

(>=) :: ExtName -> ExtName -> Bool

max :: ExtName -> ExtName -> ExtName

min :: ExtName -> ExtName -> ExtName

Show ExtName

Methods

showsPrec :: Int -> ExtName -> ShowS

show :: ExtName -> String

showList :: [ExtName] -> ShowS

Monoid ExtName

Methods

mempty :: ExtName

mappend :: ExtName -> ExtName -> ExtName

mconcat :: [ExtName] -> ExtName

toExtName :: String -> ExtName

Creates an ExtName that contains the given string, erroring if the string is an invalid ExtName.

isValidExtName :: String -> Bool

Returns true if the given string is represents a valid ExtName.

fromExtName :: ExtName -> String

Returns the string an an ExtName contains.

class HasExtNames a where

Types that have an external name, and also optionally have nested entities with external names as well. See getAllExtNames.

Minimal complete definition

getPrimaryExtName

Methods

getPrimaryExtName :: a -> ExtName

Returns the external name by which a given entity is referenced.

getNestedExtNames :: a -> [ExtName]

Returns external names nested within the given entity. Does not include the primary external name.

Instances

HasExtNames Callback

Methods

getPrimaryExtName :: Callback -> ExtName

getNestedExtNames :: Callback -> [ExtName]

HasExtNames Class

Methods

getPrimaryExtName :: Class -> ExtName

getNestedExtNames :: Class -> [ExtName]

HasExtNames Function

Methods

getPrimaryExtName :: Function -> ExtName

getNestedExtNames :: Function -> [ExtName]

HasExtNames Bitspace

Methods

getPrimaryExtName :: Bitspace -> ExtName

getNestedExtNames :: Bitspace -> [ExtName]

HasExtNames CppEnum

Methods

getPrimaryExtName :: CppEnum -> ExtName

getNestedExtNames :: CppEnum -> [ExtName]

HasExtNames Variable

Methods

getPrimaryExtName :: Variable -> ExtName

getNestedExtNames :: Variable -> [ExtName]

HasExtNames Export

Methods

getPrimaryExtName :: Export -> ExtName

getNestedExtNames :: Export -> [ExtName]

getAllExtNames :: HasExtNames a => a -> [ExtName]

Returns a list of all of the external names an entity contains. This combines both getPrimaryExtName and getNestedExtNames.

data FnName name

The C++ name of a function or method.

Constructors

FnName name

A regular, "alphanumeric" name. The exact type depends on what kind of object is being named.

FnOp Operator

An operator name.

Instances

IsFnName t (FnName t)

Methods

toFnName :: FnName t -> FnName t

Eq name => Eq (FnName name)

Methods

(==) :: FnName name -> FnName name -> Bool

(/=) :: FnName name -> FnName name -> Bool

Ord name => Ord (FnName name)

Methods

compare :: FnName name -> FnName name -> Ordering

(<) :: FnName name -> FnName name -> Bool

(<=) :: FnName name -> FnName name -> Bool

(>) :: FnName name -> FnName name -> Bool

(>=) :: FnName name -> FnName name -> Bool

max :: FnName name -> FnName name -> FnName name

min :: FnName name -> FnName name -> FnName name

Show name => Show (FnName name)

Methods

showsPrec :: Int -> FnName name -> ShowS

show :: FnName name -> String

showList :: [FnName name] -> ShowS

class IsFnName t a where

Enables implementing automatic conversions to a FnName t.

Minimal complete definition

toFnName

Methods

toFnName :: a -> FnName t

Instances

IsFnName t Operator

Methods

toFnName :: Operator -> FnName t

IsFnName t t

Methods

toFnName :: t -> FnName t

IsFnName t (FnName t)

Methods

toFnName :: FnName t -> FnName t

data Operator

Overloadable C++ operators.

Constructors

OpCall

x(...)

OpComma

x, y

OpAssign

x = y

OpArray

x[y]

OpDeref

*x

OpAddress

&x

OpAdd

x + y

OpAddAssign

x += y

OpSubtract

x - y

OpSubtractAssign

x -= y

OpMultiply

x * y

OpMultiplyAssign

x *= y

OpDivide

x / y

OpDivideAssign

x /= y

OpModulo

x % y

OpModuloAssign

x %= y

OpPlus

+x

OpMinus

-x

OpIncPre

++x

OpIncPost

x++

OpDecPre

--x

OpDecPost

x--

OpEq

x == y

OpNe

x != y

OpLt

x < y

OpLe

x <= y

OpGt

x > y

OpGe

x >= y

OpNot

!x

OpAnd

x && y

OpOr

x || y

OpBitNot

~x

OpBitAnd

x & y

OpBitAndAssign

x &= y

OpBitOr

x | y

OpBitOrAssign

x |= y

OpBitXor

x ^ y

OpBitXorAssign

x ^= y

OpShl

x << y

OpShlAssign

x <<= y

OpShr

x >> y

OpShrAssign

x >>= y

Instances

Bounded Operator

Methods

minBound :: Operator

maxBound :: Operator

Enum Operator

Methods

succ :: Operator -> Operator

pred :: Operator -> Operator

toEnum :: Int -> Operator

fromEnum :: Operator -> Int

enumFrom :: Operator -> [Operator]

enumFromThen :: Operator -> Operator -> [Operator]

enumFromTo :: Operator -> Operator -> [Operator]

enumFromThenTo :: Operator -> Operator -> Operator -> [Operator]

Eq Operator

Methods

(==) :: Operator -> Operator -> Bool

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

Ord Operator

Methods

compare :: Operator -> Operator -> Ordering

(<) :: Operator -> Operator -> Bool

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

(>) :: Operator -> Operator -> Bool

(>=) :: Operator -> Operator -> Bool

max :: Operator -> Operator -> Operator

min :: Operator -> Operator -> Operator

Show Operator

Methods

showsPrec :: Int -> Operator -> ShowS

show :: Operator -> String

showList :: [Operator] -> ShowS

IsFnName t Operator

Methods

toFnName :: Operator -> FnName t

data OperatorType

The arity and syntax of an operator.

Constructors

UnaryPrefixOperator String

Prefix unary operators. Examples: !x, *x, ++x.

UnaryPostfixOperator String

Postfix unary operators. Examples: x--, x++.

BinaryOperator String

Infix binary operators. Examples: x * y, x >>= y.

CallOperator

x(...) with arbitrary arity.

ArrayOperator

x[y], a binary operator with non-infix syntax.

operatorPreferredExtName :: Operator -> ExtName

Returns a conventional string to use for the ExtName of an operator.

operatorPreferredExtName' :: Operator -> String

Returns a conventional name for an operator, as with operatorPreferredExtName, but as a string.

operatorType :: Operator -> OperatorType

Returns the type of an operator.

data Export

Specifies some C++ object (function or class) to give access to.

Constructors

ExportVariable Variable

Exports a variable.

ExportEnum CppEnum

Exports an enum.

ExportBitspace Bitspace

Exports a bitspace.

ExportFn Function

Exports a function.

ExportClass Class

Exports a class with all of its contents.

ExportCallback Callback

Exports a callback.

Instances

Show Export

Methods

showsPrec :: Int -> Export -> ShowS

show :: Export -> String

showList :: [Export] -> ShowS

HasExtNames Export

Methods

getPrimaryExtName :: Export -> ExtName

getNestedExtNames :: Export -> [ExtName]

exportAddendum :: Export -> Addendum

Returns the export's addendum. Export doesn't have a HasAddendum instance because you normally wouldn't want to modify the addendum of one.

data Identifier

A path to some C++ object, including namespaces. An identifier consists of multiple parts separated by "::". Each part has a name string followed by an optional template argument list, where each argument gets rendered from a Type (non-type arguments for template metaprogramming are not supported).

Instances

Eq Identifier

Methods

(==) :: Identifier -> Identifier -> Bool

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

Show Identifier

Methods

showsPrec :: Int -> Identifier -> ShowS

show :: Identifier -> String

showList :: [Identifier] -> ShowS

identifierParts :: Identifier -> [IdPart]

The separate parts of the identifier, between ::s.

data IdPart

A single component of an Identifier, between ::s.

Instances

Eq IdPart

Methods

(==) :: IdPart -> IdPart -> Bool

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

Show IdPart

Methods

showsPrec :: Int -> IdPart -> ShowS

show :: IdPart -> String

showList :: [IdPart] -> ShowS

idPartBase :: IdPart -> String

The name within the enclosing scope.

idPartArgs :: IdPart -> Maybe [Type]

Template arguments, if present.

ident :: String -> Identifier

Creates an identifier of the form a.

ident' :: [String] -> Identifier

Creates an identifier of the form a1::a2::...::aN.

ident1 :: String -> String -> Identifier

Creates an identifier of the form a::b.

ident2 :: String -> String -> String -> Identifier

Creates an identifier of the form a::b::c.

ident3 :: String -> String -> String -> String -> Identifier

Creates an identifier of the form a::b::c::d.

ident4 :: String -> String -> String -> String -> String -> Identifier

Creates an identifier of the form a::b::c::d::e.

ident5 :: String -> String -> String -> String -> String -> String -> Identifier

Creates an identifier of the form a::b::c::d::e::f.

identT :: String -> [Type] -> Identifier

Creates an identifier of the form a<...>.

identT' :: [(String, Maybe [Type])] -> Identifier

Creates an identifier with arbitrary many templated and non-templated parts.

ident1T :: String -> String -> [Type] -> Identifier

Creates an identifier of the form a::b<...>.

ident2T :: String -> String -> String -> [Type] -> Identifier

Creates an identifier of the form a::b::c<...>.

ident3T :: String -> String -> String -> String -> [Type] -> Identifier

Creates an identifier of the form a::b::c::d<...>.

ident4T :: String -> String -> String -> String -> String -> [Type] -> Identifier

Creates an identifier of the form a::b::c::d::e<...>.

ident5T :: String -> String -> String -> String -> String -> String -> [Type] -> Identifier

Creates an identifier of the form a::b::c::d::e::f<...>.

Basic types

data Type

A concrete C++ type. Use the bindings in Foreign.Hoppy.Generator.Types for values of this type; these data constructors are subject to change without notice.

Constructors

Internal_TVoid

Internal_TBool

Internal_TChar

Internal_TUChar

Internal_TShort

Internal_TUShort

Internal_TInt

Internal_TUInt

Internal_TLong

Internal_TULong

Internal_TLLong

Internal_TULLong

Internal_TFloat

Internal_TDouble

Internal_TInt8

Internal_TInt16

Internal_TInt32

Internal_TInt64

Internal_TWord8

Internal_TWord16

Internal_TWord32

Internal_TWord64

Internal_TPtrdiff

Internal_TSize

Internal_TSSize

Internal_TEnum CppEnum

Internal_TBitspace Bitspace

Internal_TPtr Type

Internal_TRef Type

Internal_TFn [Type] Type

Internal_TCallback Callback

Internal_TObj Class

Internal_TObjToHeap Class

Internal_TToGc Type

Internal_TConst Type

Instances

Eq Type

Methods

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

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

Show Type

Methods

showsPrec :: Int -> Type -> ShowS

show :: Type -> String

showList :: [Type] -> ShowS

normalizeType :: Type -> Type

Canonicalizes a Type without changing its meaning. Multiple nested Internal_TConsts are collapsed into a single one.

stripConst :: Type -> Type

Strips leading Internal_TConsts off of a type.

Variables

data Variable

A C++ variable.

Use this data type's HasReqs instance to make the variable accessible.

Instances

Eq Variable

Methods

(==) :: Variable -> Variable -> Bool

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

Show Variable

Methods

showsPrec :: Int -> Variable -> ShowS

show :: Variable -> String

showList :: [Variable] -> ShowS

HasAddendum Variable

Methods

getAddendum :: Variable -> Addendum

setAddendum :: Addendum -> Variable -> Variable

modifyAddendum :: (Addendum -> Addendum) -> Variable -> Variable

HasExtNames Variable

Methods

getPrimaryExtName :: Variable -> ExtName

getNestedExtNames :: Variable -> [ExtName]

HasReqs Variable

Methods

getReqs :: Variable -> Reqs

setReqs :: Reqs -> Variable -> Variable

modifyReqs :: (Reqs -> Reqs) -> Variable -> Variable

makeVariable :: Identifier -> Maybe ExtName -> Type -> Variable

Creates a binding for a C++ variable.

varIdentifier :: Variable -> Identifier

The identifier used to refer to the variable.

varExtName :: Variable -> ExtName

The variable's external name.

varType :: Variable -> Type

The variable's type. This may be constT to indicate that the variable is read-only.

varReqs :: Variable -> Reqs

Requirements for bindings to access this variable.

varIsConst :: Variable -> Bool

Returns whether the variable is constant, i.e. whether its type is constT ....

varGetterExtName :: Variable -> ExtName

Returns the external name of the getter function for the variable.

varSetterExtName :: Variable -> ExtName

Returns the external name of the setter function for the variable.

Enums

data CppEnum

A C++ enum declaration. An enum should actually be enumerable (in the sense of Haskell's Enum); if it's not, consider using a Bitspace instead.

Instances

Eq CppEnum

Methods

(==) :: CppEnum -> CppEnum -> Bool

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

Show CppEnum

Methods

showsPrec :: Int -> CppEnum -> ShowS

show :: CppEnum -> String

showList :: [CppEnum] -> ShowS

HasAddendum CppEnum

Methods

getAddendum :: CppEnum -> Addendum

setAddendum :: Addendum -> CppEnum -> CppEnum

modifyAddendum :: (Addendum -> Addendum) -> CppEnum -> CppEnum

HasExtNames CppEnum

Methods

getPrimaryExtName :: CppEnum -> ExtName

getNestedExtNames :: CppEnum -> [ExtName]

HasReqs CppEnum

Methods

getReqs :: CppEnum -> Reqs

setReqs :: Reqs -> CppEnum -> CppEnum

modifyReqs :: (Reqs -> Reqs) -> CppEnum -> CppEnum

makeEnum

Arguments

:: Identifier

enumIdentifier

-> Maybe ExtName

An optional external name; will be automatically derived from the identifier if absent.

-> [(Int, [String])]

enumValueNames

-> CppEnum

Creates a binding for a C++ enum.

enumIdentifier :: CppEnum -> Identifier

The identifier used to refer to the enum.

enumExtName :: CppEnum -> ExtName

The enum's external name.

enumValueNames :: CppEnum -> [(Int, [String])]

The numeric values and names of the enum values. A single value's name is broken up into words. How the words and ext name get combined to make a name in a particular foreign language depends on the language.

enumReqs :: CppEnum -> Reqs

Requirements for bindings to access this enum. Currently unused, but will be in the future.

enumValuePrefix :: CppEnum -> String

The prefix applied to value names (enumValueNames) when determining the names of values in foreign languages. This defaults to the external name of the enum, plus an underscore.

See enumSetValuePrefix.

enumSetValuePrefix :: String -> CppEnum -> CppEnum

Sets the prefix applied to the names of enum values' identifiers in foreign languages.

See enumValuePrefix.

Bitspaces

data Bitspace

A C++ numeric space with bitwise operations. This is similar to a CppEnum, but in addition to the extra operations, this differs in that these values aren't enumerable.

Additionally, as a kludge for Qtah, a bitspace may have a C++ type (bitspaceCppTypeIdentifier) separate from its numeric type (bitspaceType). Qt bitspaces aren't raw numbers but are instead type-safe QFlags objects that don't implicitly convert from integers, so we need a means to do so manually. Barring general ad-hoc argument and return value conversion support, we allow this as follows: when given a C++ type, then a bitspace may also have a conversion function between the numeric and C++ type, in each direction. If a conversion function is present, it will be used for conversions in its respective direction. The C++ type is not a full Type, but only an Identifier, since additional information is not needed. See bitspaceAddCppType.

Instances

Eq Bitspace

Methods

(==) :: Bitspace -> Bitspace -> Bool

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

Show Bitspace

Methods

showsPrec :: Int -> Bitspace -> ShowS

show :: Bitspace -> String

showList :: [Bitspace] -> ShowS

HasAddendum Bitspace

Methods

getAddendum :: Bitspace -> Addendum

setAddendum :: Addendum -> Bitspace -> Bitspace

modifyAddendum :: (Addendum -> Addendum) -> Bitspace -> Bitspace

HasExtNames Bitspace

Methods

getPrimaryExtName :: Bitspace -> ExtName

getNestedExtNames :: Bitspace -> [ExtName]

HasReqs Bitspace

Methods

getReqs :: Bitspace -> Reqs

setReqs :: Reqs -> Bitspace -> Bitspace

modifyReqs :: (Reqs -> Reqs) -> Bitspace -> Bitspace

makeBitspace

Arguments

:: ExtName

bitspaceExtName

-> Type

bitspaceType

-> [(Int, [String])]

bitspaceValueNames

-> Bitspace

Creates a binding for a C++ bitspace.

bitspaceExtName :: Bitspace -> ExtName

The bitspace's external name.

bitspaceType :: Bitspace -> Type

The C++ type used for bits values. This should be a primitive numeric type, usually intT.

bitspaceValueNames :: Bitspace -> [(Int, [String])]

The numeric values and names of the bitspace values. See enumValueNames.

bitspaceEnum :: Bitspace -> Maybe CppEnum

An associated enum, whose values may be converted to values in the bitspace.

bitspaceAddEnum :: CppEnum -> Bitspace -> Bitspace

Associates an enum with the bitspace. See bitspaceEnum.

bitspaceCppTypeIdentifier :: Bitspace -> Maybe Identifier

The optional C++ type for a bitspace.

bitspaceFromCppValueFn :: Bitspace -> Maybe String

The name of a C++ function to convert from the bitspace's C++ type to bitspaceType.

bitspaceToCppValueFn :: Bitspace -> Maybe String

The name of a C++ function to convert from bitspaceType to the bitspace's C++ type.

bitspaceAddCppType :: Identifier -> Maybe String -> Maybe String -> Bitspace -> Bitspace

bitspaceAddCppType cppTypeIdentifier toCppValueFn fromCppValueFn associates a C++ type (plus optional conversion functions) with a bitspace. At least one conversion should be specified, otherwise adding the C++ type will mean nothing. You should also add use requirements to the bitspace for all of these arguments; see HasReqs.

bitspaceReqs :: Bitspace -> Reqs

Requirements for emitting the bindings for a bitspace, i.e. what's necessary to reference bitspaceCppTypeIdentifier, bitspaceFromCppValueFn, and bitspaceToCppValueFn. bitspaceType can take some numeric types that require includes as well, but you don't need to list these here.

bitspaceValuePrefix :: Bitspace -> String

The prefix applied to value names (bitspaceValueNames) when determining the names of values in foreign languages. This defaults to the external name of the bitspace, plus an underscore.

See bitspaceSetValuePrefix.

bitspaceSetValuePrefix :: String -> Bitspace -> Bitspace

Sets the prefix applied to the names of enum values' identifiers in foreign languages.

See enumValuePrefix.

Functions

data Purity

Whether or not a function may cause side-effects.

Haskell bindings for pure functions will not be in IO, and calls to pure functions will be executed non-strictly. Calls to impure functions will execute in the IO monad.

Member functions for mutable classes should not be made pure, because it is difficult in general to control when the call will be made.

Constructors

Nonpure

Side-affects are possible.

Pure

Side-affects will not happen.

Instances

Eq Purity

Methods

(==) :: Purity -> Purity -> Bool

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

Show Purity

Methods

showsPrec :: Int -> Purity -> ShowS

show :: Purity -> String

showList :: [Purity] -> ShowS

data Function

A C++ function declaration.

Use this data type's HasReqs instance to make the function accessible. You do not need to add requirements for parameter or return types.

Instances

Show Function

Methods

showsPrec :: Int -> Function -> ShowS

show :: Function -> String

showList :: [Function] -> ShowS

HasAddendum Function

Methods

getAddendum :: Function -> Addendum

setAddendum :: Addendum -> Function -> Function

modifyAddendum :: (Addendum -> Addendum) -> Function -> Function

HandlesExceptions Function

Methods

getExceptionHandlers :: Function -> ExceptionHandlers

modifyExceptionHandlers :: (ExceptionHandlers -> ExceptionHandlers) -> Function -> Function

HasExtNames Function

Methods

getPrimaryExtName :: Function -> ExtName

getNestedExtNames :: Function -> [ExtName]

HasReqs Function

Methods

getReqs :: Function -> Reqs

setReqs :: Reqs -> Function -> Function

modifyReqs :: (Reqs -> Reqs) -> Function -> Function

makeFn

Arguments

:: IsFnName Identifier name

=> name

-> Maybe ExtName

An optional external name; will be automatically derived from the identifier if absent.

-> Purity

-> [Type]

Parameter types.

-> Type

Return type.

-> Function

Creates a binding for a C++ function.

fnCName :: Function -> FnName Identifier

The identifier used to call the function.

fnExtName :: Function -> ExtName

The function's external name.

fnPurity :: Function -> Purity

Whether the function is pure.

fnParams :: Function -> [Type]

The function's parameter types.

fnReturn :: Function -> Type

The function's return type.

fnReqs :: Function -> Reqs

Requirements for bindings to access this function.

fnExceptionHandlers :: Function -> ExceptionHandlers

Exceptions that the function might throw.

Classes

data Class

A C++ class declaration. See IsClassEntity for more information about the interaction between a class's names and the names of entities within the class.

Use this data type's HasReqs instance to make the class accessible. You do not need to add requirements for methods' parameter or return types.

Instances

Eq Class

Methods

(==) :: Class -> Class -> Bool

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

Ord 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

Methods

showsPrec :: Int -> Class -> ShowS

show :: Class -> String

showList :: [Class] -> ShowS

HasAddendum Class

Methods

getAddendum :: Class -> Addendum

setAddendum :: Addendum -> Class -> Class

modifyAddendum :: (Addendum -> Addendum) -> Class -> Class

HasExtNames Class

Methods

getPrimaryExtName :: Class -> ExtName

getNestedExtNames :: Class -> [ExtName]

HasReqs Class

Methods

getReqs :: Class -> Reqs

setReqs :: Reqs -> Class -> Class

modifyReqs :: (Reqs -> Reqs) -> Class -> Class

makeClass

Arguments

:: Identifier

-> Maybe ExtName

An optional external name; will be automatically derived from the identifier if absent by dropping leading namespaces, and taking the last component (sans template arguments).

-> [Class]

Superclasses.

-> [ClassEntity]

-> Class

Creates a binding for a C++ class and its contents.

classIdentifier :: Class -> Identifier

The identifier used to refer to the class.

classExtName :: Class -> ExtName

The class's external name.

classSuperclasses :: Class -> [Class]

The class's public superclasses.

classEntities :: Class -> [ClassEntity]

The class's entities.

classAddEntities :: [ClassEntity] -> Class -> Class

Adds constructors to a class.

classVariables :: Class -> [ClassVariable]

Returns all of the class's variables.

classCtors :: Class -> [Ctor]

Returns all of the class's constructors.

classMethods :: Class -> [Method]

Returns all of the class's methods, including methods generated from Props.

classDtorIsPublic :: Class -> Bool

The class's methods.

classSetDtorPrivate :: Class -> Class

Marks a class's destructor as private, so that a binding for it won't be generated.

classConversion :: Class -> ClassConversion

Behaviour for converting objects to and from foriegn values.

classReqs :: Class -> Reqs

Requirements for bindings to access this class.

classEntityPrefix :: Class -> String

The prefix applied to the external names of entities (methods, etc.) within this class when determining the names of foreign languages' corresponding bindings. This defaults to the external name of the class, plus an underscore. Changing this allows you to potentially have entities with the same foreign name in separate modules. This may be the empty string, in which case the foreign name will simply be the external name of the entity.

This does not affect the things' external names themselves; external names must still be unique in an interface. For instance, a method with external name bar in a class with external name Flab and prefix Flob_ will use the effective external name Flab_bar, but the generated name in say Haskell would be Flob_bar.

See IsClassEntity and classSetEntityPrefix.

classSetEntityPrefix :: String -> Class -> Class

Sets the prefix applied to foreign languages' entities generated from methods, etc. within the class.

See IsClassEntity and classEntityPrefix.

classIsMonomorphicSuperclass :: Class -> Bool

This is true for classes passed through classSetMonomorphicSuperclass.

classSetMonomorphicSuperclass :: Class -> Class

Explicitly marks a class as being monomorphic (i.e. not having any virtual methods or destructors). By default, Hoppy assumes that a class that is derived is also polymorphic, but it can happen that this is not the case. Downcasting with dynamic_cast from such classes is not available. See also classSetSubclassOfMonomorphic.

classIsSubclassOfMonomorphic :: Class -> Bool

This is true for classes passed through classSetSubclassOfMonomorphic.

classSetSubclassOfMonomorphic :: Class -> Class

Marks a class as being derived from some monomorphic superclass. This prevents any downcasting to this class. Generally it is better to use classSetMonomorphicSuperclass on the specific superclasses that are monomorphic, but in cases where this is not possible, this function can be applied to the subclass instead.

classIsException :: Class -> Bool

Whether to support using the class as a C++ exception.

classMakeException :: Class -> Class

Marks a class as being used as an exception. This makes the class throwable and catchable.

data ClassEntity

A C++ entity that belongs to a class.

Constructors

CEVar ClassVariable

CECtor Ctor

CEMethod Method

CEProp Prop

class IsClassEntity a where

Things that live inside of a class, and have the class's external name prepended to their own in generated code. With an external name of "bar" and a class with external name "foo", the resulting name will be "foo_bar".

See classEntityPrefix and classSetEntityPrefix.

Minimal complete definition

classEntityExtNameSuffix

Methods

classEntityExtNameSuffix :: a -> ExtName

Extracts the external name of the object, without the class name added.

Instances

IsClassEntity Method

Methods

classEntityExtNameSuffix :: Method -> ExtName

IsClassEntity Ctor

Methods

classEntityExtNameSuffix :: Ctor -> ExtName

IsClassEntity ClassVariable

Methods

classEntityExtNameSuffix :: ClassVariable -> ExtName

classEntityExtName :: IsClassEntity a => Class -> a -> ExtName

Computes the external name to use in generated code, containing both the class's and object's external names. This is the concatenation of the class's and entity's external names, separated by an underscore.

classEntityForeignName :: IsClassEntity a => Class -> a -> ExtName

Computes the name under which a class entity is to be exposed in foreign languages. This is the concatenation of a class's entity prefix, and the external name of the entity.

classEntityForeignName' :: Class -> ExtName -> ExtName

Computes the name under which a class entity is to be exposed in foreign languages, given a class and an entity's external name. The result is the concatenation of a class's entity prefix, and the external name of the entity.

data ClassVariable

A C++ member variable.

Instances

Show ClassVariable

Methods

showsPrec :: Int -> ClassVariable -> ShowS

show :: ClassVariable -> String

showList :: [ClassVariable] -> ShowS

IsClassEntity ClassVariable

Methods

classEntityExtNameSuffix :: ClassVariable -> ExtName

makeClassVariable :: String -> Maybe ExtName -> Type -> Staticness -> Bool -> ClassEntity

Creates a ClassVariable with full generality and manual name specification.

The result is wrapped in a CEVar. For an unwrapped value, use makeClassVariable_.

makeClassVariable_ :: String -> Maybe ExtName -> Type -> Staticness -> Bool -> ClassVariable

The unwrapped version of makeClassVariable.

mkClassVariable :: String -> Type -> ClassEntity

Creates a ClassVariable for a nonstatic class variable for class::varName whose external name is class_varName.

The result is wrapped in a CEVar. For an unwrapped value, use mkClassVariable_.

mkClassVariable_ :: String -> Type -> ClassVariable

The unwrapped version of mkClassVariable.

mkStaticClassVariable :: String -> Type -> ClassEntity

Same as mkClassVariable, but returns a static variable instead.

The result is wrapped in a CEVar. For an unwrapped value, use mkStaticClassVariable_.

mkStaticClassVariable_ :: String -> Type -> ClassVariable

The unwrapped version of mkStaticClassVariable.

classVarCName :: ClassVariable -> String

The variable's C++ name.

classVarExtName :: ClassVariable -> ExtName

The variable's external name.

classVarType :: ClassVariable -> Type

The variable's type. This may be constT to indicate that the variable is read-only.

classVarStatic :: ClassVariable -> Staticness

Whether the variable is static (i.e. whether it exists once in the class itself and not in each instance).

classVarGettable :: ClassVariable -> Bool

Whether the variable should have an accompanying getter. Note this exists only for disabling getters on callback variables - as there is currently no functionality to pass callbacks out of c++

classVarGetterExtName :: Class -> ClassVariable -> ExtName

Returns the external name of the getter function for the class variable.

classVarGetterForeignName :: Class -> ClassVariable -> ExtName

Returns the foreign name of the getter function for the class variable.

classVarSetterExtName :: Class -> ClassVariable -> ExtName

Returns the external name of the setter function for the class variable.

classVarSetterForeignName :: Class -> ClassVariable -> ExtName

Returns the foreign name of the setter function for the class variable.

data Ctor

A C++ class constructor declaration.

Instances

Show Ctor

Methods

showsPrec :: Int -> Ctor -> ShowS

show :: Ctor -> String

showList :: [Ctor] -> ShowS

HandlesExceptions Ctor

Methods

getExceptionHandlers :: Ctor -> ExceptionHandlers

modifyExceptionHandlers :: (ExceptionHandlers -> ExceptionHandlers) -> Ctor -> Ctor

IsClassEntity Ctor

Methods

classEntityExtNameSuffix :: Ctor -> ExtName

makeCtor

Arguments

:: ExtName

-> [Type]

Parameter types.

-> ClassEntity

Creates a Ctor with full generality.

The result is wrapped in a CECtor. For an unwrapped value, use makeCtor_.

makeCtor_ :: ExtName -> [Type] -> Ctor

The unwrapped version of makeCtor.

mkCtor

Arguments

:: String

-> [Type]

Parameter types.

-> ClassEntity

mkCtor name creates a Ctor whose external name is className_name.

The result is wrapped in a CECtor. For an unwrapped value, use makeCtor_.

mkCtor_ :: String -> [Type] -> Ctor

The unwrapped version of mkCtor.

ctorExtName :: Ctor -> ExtName

The constructor's external name.

ctorParams :: Ctor -> [Type]

The constructor's parameter types.

ctorExceptionHandlers :: Ctor -> ExceptionHandlers

Exceptions that the constructor may throw.

data Method

A C++ class method declaration.

Any operator function that can be written as a method may have its binding be written either as part of the associated class or as a separate entity, independently of how the function is declared in C++.

Instances

Show Method

Methods

showsPrec :: Int -> Method -> ShowS

show :: Method -> String

showList :: [Method] -> ShowS

HandlesExceptions Method

Methods

getExceptionHandlers :: Method -> ExceptionHandlers

modifyExceptionHandlers :: (ExceptionHandlers -> ExceptionHandlers) -> Method -> Method

IsClassEntity Method

Methods

classEntityExtNameSuffix :: Method -> ExtName

data MethodImpl

The C++ code to which a Method is bound.

Constructors

RealMethod (FnName String)

The Method is bound to an actual class method.

FnMethod (FnName Identifier)

The Method is bound to a wrapper function. When wrapping a method with another function, this is preferrable to just using a Function binding because a method will still appear to be part of the class in foreign bindings.

Instances

Eq MethodImpl

Methods

(==) :: MethodImpl -> MethodImpl -> Bool

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

Show MethodImpl

Methods

showsPrec :: Int -> MethodImpl -> ShowS

show :: MethodImpl -> String

showList :: [MethodImpl] -> ShowS

data MethodApplicability

How a method is associated to its class. A method may be static, const, or neither (a regular method).

Constructors

MNormal

MStatic

MConst

Instances

Bounded MethodApplicability

Methods

minBound :: MethodApplicability

maxBound :: MethodApplicability

Enum MethodApplicability

Methods

succ :: MethodApplicability -> MethodApplicability

pred :: MethodApplicability -> MethodApplicability

toEnum :: Int -> MethodApplicability

fromEnum :: MethodApplicability -> Int

enumFrom :: MethodApplicability -> [MethodApplicability]

enumFromThen :: MethodApplicability -> MethodApplicability -> [MethodApplicability]

enumFromTo :: MethodApplicability -> MethodApplicability -> [MethodApplicability]

enumFromThenTo :: MethodApplicability -> MethodApplicability -> MethodApplicability -> [MethodApplicability]

Eq MethodApplicability

Methods

(==) :: MethodApplicability -> MethodApplicability -> Bool

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

Show MethodApplicability

Methods

showsPrec :: Int -> MethodApplicability -> ShowS

show :: MethodApplicability -> String

showList :: [MethodApplicability] -> ShowS

data Constness

Whether or not a method is const.

Constructors

Nonconst

Const

Instances

Bounded Constness

Methods

minBound :: Constness

maxBound :: Constness

Enum Constness

Methods

succ :: Constness -> Constness

pred :: Constness -> Constness

toEnum :: Int -> Constness

fromEnum :: Constness -> Int

enumFrom :: Constness -> [Constness]

enumFromThen :: Constness -> Constness -> [Constness]

enumFromTo :: Constness -> Constness -> [Constness]

enumFromThenTo :: Constness -> Constness -> Constness -> [Constness]

Eq Constness

Methods

(==) :: Constness -> Constness -> Bool

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

Show Constness

Methods

showsPrec :: Int -> Constness -> ShowS

show :: Constness -> String

showList :: [Constness] -> ShowS

constNegate :: Constness -> Constness

Returns the opposite constness value.

data Staticness

Whether or not a method is static.

Constructors

Nonstatic

Static

Instances

Bounded Staticness

Methods

minBound :: Staticness

maxBound :: Staticness

Enum Staticness

Methods

succ :: Staticness -> Staticness

pred :: Staticness -> Staticness

toEnum :: Int -> Staticness

fromEnum :: Staticness -> Int

enumFrom :: Staticness -> [Staticness]

enumFromThen :: Staticness -> Staticness -> [Staticness]

enumFromTo :: Staticness -> Staticness -> [Staticness]

enumFromThenTo :: Staticness -> Staticness -> Staticness -> [Staticness]

Eq Staticness

Methods

(==) :: Staticness -> Staticness -> Bool

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

Show Staticness

Methods

showsPrec :: Int -> Staticness -> ShowS

show :: Staticness -> String

showList :: [Staticness] -> ShowS

makeMethod

Arguments

:: IsFnName String name

=> name

The C++ name of the method.

-> ExtName

The external name of the method.

-> MethodApplicability

-> Purity

-> [Type]

Parameter types.

-> Type

Return type.

-> ClassEntity

Creates a Method with full generality and manual name specification.

The result is wrapped in a CEMethod. For an unwrapped value, use makeMethod_.

makeMethod_ :: IsFnName String name => name -> ExtName -> MethodApplicability -> Purity -> [Type] -> Type -> Method

The unwrapped version of makeMethod.

makeFnMethod :: IsFnName Identifier name => name -> String -> MethodApplicability -> Purity -> [Type] -> Type -> ClassEntity

Creates a Method that is in fact backed by a C++ non-member function (a la makeFn), but appears to be a regular method. This is useful for wrapping a method on the C++ side when its arguments aren't right for binding directly.

A this pointer parameter is not automatically added to the parameter list for non-static methods created with makeFnMethod.

The result is wrapped in a CEMethod. For an unwrapped value, use makeFnMethod_.

makeFnMethod_ :: IsFnName Identifier name => name -> String -> MethodApplicability -> Purity -> [Type] -> Type -> Method

The unwrapped version of makeFnMethod.

mkMethod

Arguments

:: IsFnName String name

=> name

The C++ name of the method.

-> [Type]

Parameter types.

-> Type

Return type.

-> ClassEntity

Creates a nonconst, nonstatic Method for class::methodName and whose external name is class_methodName. If the name is an operator, then the operatorPreferredExtName will be used in the external name.

For creating multiple bindings to a method, see mkMethod'.

The result is wrapped in a CEMethod. For an unwrapped value, use mkMethod_.

mkMethod_ :: IsFnName String name => name -> [Type] -> Type -> Method

The unwrapped version of mkMethod.

mkMethod'

Arguments

:: IsFnName String name

=> name

The C++ name of the method.

-> String

A foreign name for the method.

-> [Type]

Parameter types.

-> Type

Return type.

-> ClassEntity

Creates a nonconst, nonstatic Method for method class::methodName and whose external name is class_methodName. This enables multiple Methods with different foreign names (and hence different external names) to bind to the same method, e.g. to make use of optional arguments or overloading. See mkMethod for a simpler form.

The result is wrapped in a CEMethod. For an unwrapped value, use mkMethod'_.

mkMethod'_ :: IsFnName String name => name -> String -> [Type] -> Type -> Method

The unwrapped version of mkMethod'.

mkConstMethod :: IsFnName String name => name -> [Type] -> Type -> ClassEntity

Same as mkMethod, but returns an MConst method.

The result is wrapped in a CEMethod. For an unwrapped value, use mkConstMethod_.

mkConstMethod_ :: IsFnName String name => name -> [Type] -> Type -> Method

The unwrapped version of mkConstMethod.

mkConstMethod' :: IsFnName String name => name -> String -> [Type] -> Type -> ClassEntity

Same as mkMethod', but returns an MConst method.

The result is wrapped in a CEMethod. For an unwrapped value, use mkConstMethod'_.

mkConstMethod'_ :: IsFnName String name => name -> String -> [Type] -> Type -> Method

The unwrapped version of mkConstMethod'.

mkStaticMethod :: IsFnName String name => name -> [Type] -> Type -> ClassEntity

Same as mkMethod, but returns an MStatic method.

The result is wrapped in a CEMethod. For an unwrapped value, use mkStaticMethod_.

mkStaticMethod_ :: IsFnName String name => name -> [Type] -> Type -> Method

The unwrapped version of mkStaticMethod.

mkStaticMethod' :: IsFnName String name => name -> String -> [Type] -> Type -> ClassEntity

Same as mkMethod', but returns an MStatic method.

The result is wrapped in a CEMethod. For an unwrapped value, use mkStaticMethod'_.

mkStaticMethod'_ :: IsFnName String name => name -> String -> [Type] -> Type -> Method

The unwrapped version of mkStaticMethod'.

data Prop

A "property" getter/setter pair.

mkProp :: String -> Type -> ClassEntity

Creates a getter/setter binding pair for methods:

T foo() const
void setFoo(T)

The result is wrapped in a CEProp. For an unwrapped value, use mkProp_.

mkProp_ :: String -> Type -> Prop

The unwrapped version of mkProp.

mkStaticProp :: String -> Type -> ClassEntity

Creates a getter/setter binding pair for static methods:

static T foo() const
static void setFoo(T)

mkStaticProp_ :: String -> Type -> Prop

The unwrapped version of mkStaticProp.

mkBoolIsProp :: String -> ClassEntity

Creates a getter/setter binding pair for boolean methods, where the getter is prefixed with is:

bool isFoo() const
void setFoo(bool)

The result is wrapped in a CEProp. For an unwrapped value, use mkBoolIsProp_.

mkBoolIsProp_ :: String -> Prop

The unwrapped version of mkBoolIsProp.

mkBoolHasProp :: String -> ClassEntity

Creates a getter/setter binding pair for boolean methods, where the getter is prefixed with has:

bool hasFoo() const
void setFoo(bool)

The result is wrapped in a CEProp. For an unwrapped value, use mkBoolHasProp_.

mkBoolHasProp_ :: String -> Prop

The unwrapped version of mkBoolHasProp.

methodImpl :: Method -> MethodImpl

The underlying code that the binding calls.

methodExtName :: Method -> ExtName

The method's external name.

methodApplicability :: Method -> MethodApplicability

How the method is associated to its class.

methodPurity :: Method -> Purity

Whether the method is pure.

methodParams :: Method -> [Type]

The method's parameter types.

methodReturn :: Method -> Type

The method's return type.

methodExceptionHandlers :: Method -> ExceptionHandlers

Exceptions that the method might throw.

methodConst :: Method -> Constness

Returns the constness of a method, based on its methodApplicability.

methodStatic :: Method -> Staticness

Returns the staticness of a method, based on its methodApplicability.

Conversion to and from foreign values

data ClassConversion

Separately from passing object handles between C++ and foreign languages, objects can also be made to implicitly convert to native values in foreign languages. A single such type may be associated with any C++ class for each foreign language. The foreign type and the conversion process in each direction are specified using this object. Converting a C++ object to a foreign value is also called decoding, and vice versa is called encoding. A class may be convertible in one direction and not the other.

To use these implicit conversions, instead of specifying an object handle type such as ptrT . objT or refT . objT, use objT directly.

The subfields in this object specify how to do conversions between C++ and foreign languages.

Constructors

ClassConversion

Fields

• classHaskellConversion :: ClassHaskellConversion

  Conversions to and from Haskell.

classConversionNone :: ClassConversion

Conversion behaviour for a class that is not convertible.

classModifyConversion :: (ClassConversion -> ClassConversion) -> Class -> Class

Modifies a class's ClassConversion structure with a given function.

classSetConversion :: ClassConversion -> Class -> Class

Replaces a class's ClassConversion structure.

data ClassHaskellConversion

Controls how conversions between C++ objects and Haskell values happen in Haskell bindings.

Constructors

ClassHaskellConversion

Fields

• classHaskellConversionType :: Maybe (Generator HsType)

  Produces the Haskell type that represents a value of the corresponding C++ class. This generator may add imports, but must not output code or add exports.

• classHaskellConversionToCppFn :: Maybe (Generator ())

  Produces a Haskell expression that evaluates to a function that takes an value of the type that classHaskellConversionType generates, and returns a non-const handle for a new C++ object in IO. The generator must output code and may add imports, but must not add exports.

  If this field is present, then classHaskellConversionType must also be present.

• classHaskellConversionFromCppFn :: Maybe (Generator ())

  Produces a Haskell expression that evaluates to a function that takes a const handle for a C++ object, and returns a value of the type that classHaskellConversionType generates, in IO. It should not delete the handle. The generator must output code and may add imports, but must not add exports.

  If this field is present, then classHaskellConversionType must also be present.

classHaskellConversionNone :: ClassHaskellConversion

Conversion behaviour for a class that is not convertible to or from Haskell.

classSetHaskellConversion :: ClassHaskellConversion -> Class -> Class

Replaces a class's classHaskellConversion with a given value.

Callbacks

data Callback

A non-C++ function that can be invoked via a C++ functor or function pointer.

Use this data type's HasReqs instance to add extra requirements, however manually adding requirements for parameter and return types is not necessary.

Instances

Eq Callback

Methods

(==) :: Callback -> Callback -> Bool

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

Show Callback

Methods

showsPrec :: Int -> Callback -> ShowS

show :: Callback -> String

showList :: [Callback] -> ShowS

HasAddendum Callback

Methods

getAddendum :: Callback -> Addendum

setAddendum :: Addendum -> Callback -> Callback

modifyAddendum :: (Addendum -> Addendum) -> Callback -> Callback

HasExtNames Callback

Methods

getPrimaryExtName :: Callback -> ExtName

getNestedExtNames :: Callback -> [ExtName]

HasReqs Callback

Methods

getReqs :: Callback -> Reqs

setReqs :: Reqs -> Callback -> Callback

modifyReqs :: (Reqs -> Reqs) -> Callback -> Callback

makeCallback

Arguments

:: ExtName

-> [Type]

Parameter types.

-> Type

Return type.

-> Callback

Creates a binding for constructing callbacks into foreign code.

callbackExtName :: Callback -> ExtName

The callback's external name.

callbackParams :: Callback -> [Type]

The callback's parameter types.

callbackReturn :: Callback -> Type

The callback's return type.

callbackThrows :: Callback -> Maybe Bool

Whether the callback supports throwing C++ exceptions from Haskell into C++ during its execution. When absent, the value is inherited from moduleCallbacksThrow and interfaceCallbacksThrow.

callbackReqs :: Callback -> Reqs

Extra requirements for the callback.

callbackSetThrows :: Bool -> Callback -> Callback

Sets whether a callback supports handling thrown C++ exceptions and passing them into C++.

Exceptions

newtype ExceptionId

Each exception class has a unique exception ID.

Constructors

ExceptionId

Fields

• getExceptionId :: Int

  Internal.

Instances

Eq ExceptionId

Methods

(==) :: ExceptionId -> ExceptionId -> Bool

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

Show ExceptionId

Methods

showsPrec :: Int -> ExceptionId -> ShowS

show :: ExceptionId -> String

showList :: [ExceptionId] -> ShowS

exceptionCatchAllId :: ExceptionId

The exception ID that represents the catch-all type.

data ExceptionHandler

Indicates the ability to handle a certain type of C++ exception.

Constructors

CatchClass Class

Indicates that instances of the given class are handled (including derived types).

CatchAll

Indicates that all C++ exceptions are handled, i.e. catch (...).

Instances

Eq ExceptionHandler

Methods

(==) :: ExceptionHandler -> ExceptionHandler -> Bool

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

Ord ExceptionHandler

Methods

compare :: ExceptionHandler -> ExceptionHandler -> Ordering

(<) :: ExceptionHandler -> ExceptionHandler -> Bool

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

(>) :: ExceptionHandler -> ExceptionHandler -> Bool

(>=) :: ExceptionHandler -> ExceptionHandler -> Bool

max :: ExceptionHandler -> ExceptionHandler -> ExceptionHandler

min :: ExceptionHandler -> ExceptionHandler -> ExceptionHandler

data ExceptionHandlers

Represents a list of exception handlers to be used for a body of code. Order is important; a CatchAll will prevent all subsequent handlers from being invoked.

Constructors

ExceptionHandlers

Fields

• exceptionHandlersList :: [ExceptionHandler]

  Extracts the list of exception handlers.

Instances

Monoid ExceptionHandlers

Methods

mempty :: ExceptionHandlers

mappend :: ExceptionHandlers -> ExceptionHandlers -> ExceptionHandlers

mconcat :: [ExceptionHandlers] -> ExceptionHandlers

class HandlesExceptions a where

Types that can handle exceptions.

Minimal complete definition

getExceptionHandlers, modifyExceptionHandlers

Methods

getExceptionHandlers :: a -> ExceptionHandlers

Extracts the exception handlers for an object.

Instances

HandlesExceptions Method

Methods

getExceptionHandlers :: Method -> ExceptionHandlers

modifyExceptionHandlers :: (ExceptionHandlers -> ExceptionHandlers) -> Method -> Method

HandlesExceptions Ctor

Methods

getExceptionHandlers :: Ctor -> ExceptionHandlers

modifyExceptionHandlers :: (ExceptionHandlers -> ExceptionHandlers) -> Ctor -> Ctor

HandlesExceptions Function

Methods

getExceptionHandlers :: Function -> ExceptionHandlers

modifyExceptionHandlers :: (ExceptionHandlers -> ExceptionHandlers) -> Function -> Function

HandlesExceptions Module

Methods

getExceptionHandlers :: Module -> ExceptionHandlers

modifyExceptionHandlers :: (ExceptionHandlers -> ExceptionHandlers) -> Module -> Module

handleExceptions :: HandlesExceptions a => [ExceptionHandler] -> a -> a

Appends additional exception handlers to an object.

Addenda

data Addendum

A literal piece of code that will be inserted into a generated source file after the regular binding glue. The Monoid instance concatenates code (actions).

Constructors

Addendum

Fields

• addendumHaskell :: Generator ()

  Code to be output into the Haskell binding. May also add imports and exports.

Instances

Monoid Addendum

Methods

mempty :: Addendum

mappend :: Addendum -> Addendum -> Addendum

mconcat :: [Addendum] -> Addendum

class HasAddendum a where

A typeclass for types that have an addendum.

Minimal complete definition

getAddendum, (setAddendum | modifyAddendum)

Methods

getAddendum :: a -> Addendum

Returns an object's addendum.

setAddendum :: Addendum -> a -> a

Replaces and object's addendum with another.

modifyAddendum :: (Addendum -> Addendum) -> a -> a

Modified an object's addendum.

Instances

HasAddendum Callback

Methods

getAddendum :: Callback -> Addendum

setAddendum :: Addendum -> Callback -> Callback

modifyAddendum :: (Addendum -> Addendum) -> Callback -> Callback

HasAddendum Class

Methods

getAddendum :: Class -> Addendum

setAddendum :: Addendum -> Class -> Class

modifyAddendum :: (Addendum -> Addendum) -> Class -> Class

HasAddendum Function

Methods

getAddendum :: Function -> Addendum

setAddendum :: Addendum -> Function -> Function

modifyAddendum :: (Addendum -> Addendum) -> Function -> Function

HasAddendum Bitspace

Methods

getAddendum :: Bitspace -> Addendum

setAddendum :: Addendum -> Bitspace -> Bitspace

modifyAddendum :: (Addendum -> Addendum) -> Bitspace -> Bitspace

HasAddendum CppEnum

Methods

getAddendum :: CppEnum -> Addendum

setAddendum :: Addendum -> CppEnum -> CppEnum

modifyAddendum :: (Addendum -> Addendum) -> CppEnum -> CppEnum

HasAddendum Variable

Methods

getAddendum :: Variable -> Addendum

setAddendum :: Addendum -> Variable -> Variable

modifyAddendum :: (Addendum -> Addendum) -> Variable -> Variable

HasAddendum Module

Methods

getAddendum :: Module -> Addendum

setAddendum :: Addendum -> Module -> Module

modifyAddendum :: (Addendum -> Addendum) -> Module -> Module

addAddendumHaskell :: HasAddendum a => Generator () -> a -> a

Adds a Haskell addendum to an object.

Haskell imports

type HsModuleName = String

A Haskell module name.

data HsImportSet

A collection of imports for a Haskell module. This is a monoid: import Statements are merged to give the union of imported bindings.

This structure supports two specific types of imports: - import Foo (...) - import qualified Foo as Bar Imports with as but without qualified, and qualified imports with a spec list, are not supported. This satisfies the needs of the code generator, and keeps the merging logic simple.

Instances

Show HsImportSet

Methods

showsPrec :: Int -> HsImportSet -> ShowS

show :: HsImportSet -> String

showList :: [HsImportSet] -> ShowS

Monoid HsImportSet

Methods

mempty :: HsImportSet

mappend :: HsImportSet -> HsImportSet -> HsImportSet

mconcat :: [HsImportSet] -> HsImportSet

data HsImportKey

References an occurrence of an import statement, under which bindings can be imported. Only imported specs under equal HsImportKeys may be merged.

Constructors

HsImportKey

Fields

• hsImportModule :: HsModuleName
• hsImportQualifiedName :: Maybe HsModuleName

Instances

Eq HsImportKey

Methods

(==) :: HsImportKey -> HsImportKey -> Bool

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

Ord HsImportKey

Methods

compare :: HsImportKey -> HsImportKey -> Ordering

(<) :: HsImportKey -> HsImportKey -> Bool

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

(>) :: HsImportKey -> HsImportKey -> Bool

(>=) :: HsImportKey -> HsImportKey -> Bool

max :: HsImportKey -> HsImportKey -> HsImportKey

min :: HsImportKey -> HsImportKey -> HsImportKey

Show HsImportKey

Methods

showsPrec :: Int -> HsImportKey -> ShowS

show :: HsImportKey -> String

showList :: [HsImportKey] -> ShowS

data HsImportSpecs

A specification of bindings to import from a module. If Nothing, then the entire module is imported. If Just empty, then only instances are imported.

Constructors

HsImportSpecs

Fields

• getHsImportSpecs :: Maybe (Map HsImportName HsImportVal)
• hsImportSource :: Bool

Instances

Show HsImportSpecs

Methods

showsPrec :: Int -> HsImportSpecs -> ShowS

show :: HsImportSpecs -> String

showList :: [HsImportSpecs] -> ShowS

type HsImportName = String

An identifier that can be imported from a module. Symbols may be used here when surrounded by parentheses. Examples are "fmap" and "(++)".

data HsImportVal

Specifies how a name is imported.

Constructors

HsImportVal

The name is imported, and nothing underneath it is.

HsImportValSome [HsImportName]

The name is imported, as are specific names underneath it. This is a X (a, b, c) import.

HsImportValAll

The name is imported, along with all names underneath it. This is a X (..) import.

Instances

Show HsImportVal

Methods

showsPrec :: Int -> HsImportVal -> ShowS

show :: HsImportVal -> String

showList :: [HsImportVal] -> ShowS

hsWholeModuleImport :: HsModuleName -> HsImportSet

An import for the entire contents of a Haskell module.

hsQualifiedImport :: HsModuleName -> HsModuleName -> HsImportSet

A qualified import of a Haskell module.

hsImport1 :: HsModuleName -> HsImportName -> HsImportSet

An import of a single name from a Haskell module.

hsImport1' :: HsModuleName -> HsImportName -> HsImportVal -> HsImportSet

A detailed import of a single name from a Haskell module.

hsImports :: HsModuleName -> [HsImportName] -> HsImportSet

An import of multiple names from a Haskell module.

hsImports' :: HsModuleName -> [(HsImportName, HsImportVal)] -> HsImportSet

A detailed import of multiple names from a Haskell module.

hsImportSetMakeSource :: HsImportSet -> HsImportSet

Sets all of the import specifications in an import set to be {--} imports.

Internal to Hoppy

interfaceAllExceptionClasses :: Interface -> [Class]

Returns all of the exception classes in an interface.

interfaceSharedPtr :: Interface -> (Reqs, String)

The name of the shared_ptr class to use, and the requirements to use it. This defaults to using std::shared_ptr from memory, but can be changed if necessary via interfaceSetSharedPtr.

classFindCopyCtor :: Class -> Maybe Ctor

Searches a class for a copy constructor, returning it if found.

Haskell imports

makeHsImportSet :: Map HsImportKey HsImportSpecs -> HsImportSet

Constructor for an import set.

getHsImportSet :: HsImportSet -> Map HsImportKey HsImportSpecs

Returns the import set's internal map from module names to imported bindings.

hsImportForBits :: HsImportSet

Imports Data.Bits qualified as HoppyDB.

hsImportForException :: HsImportSet

Imports Control.Exception qualified as HoppyCE.

hsImportForInt :: HsImportSet

Imports Data.Int qualified as HoppyDI.

hsImportForWord :: HsImportSet

Imports Data.Word qualified as HoppyDW.

hsImportForForeign :: HsImportSet

Imports Foreign qualified as HoppyF.

hsImportForForeignC :: HsImportSet

Imports Foreign.C qualified as HoppyFC.

hsImportForMap :: HsImportSet

Imports Data.Map qualified as HoppyDM.

hsImportForPrelude :: HsImportSet

Imports Prelude qualified as HoppyP.

hsImportForRuntime :: HsImportSet

Imports Foreign.Hoppy.Runtime qualified as HoppyFHR.

hsImportForSystemPosixTypes :: HsImportSet

Imports System.Posix.Types qualified as HoppySPT.

hsImportForTypeable :: HsImportSet

Imports Data.Typeable qualified as HoppyDT.

hsImportForUnsafeIO :: HsImportSet

Imports System.IO.Unsafe qualified as HoppySIU.

Error messages

objToHeapTWrongDirectionErrorMsg :: Maybe String -> Class -> String

Returns an error message indicating that objToHeapT is used where data is going from a foreign language into C++.

tToGcInvalidFormErrorMessage :: Maybe String -> Type -> String

Returns an error message indicating that objToHeapT is used where data is going from a foreign language into C++.

toGcTWrongDirectionErrorMsg :: Maybe String -> Type -> String

Returns an error message indicating that toGcT is used where data is going from a foreign language into C++.

Advanced class conversions

classSetConversionToHeap :: Class -> Class

Modifies a class's ClassConversion structure by setting all languages to use ClassConversionToHeap.

classSetConversionToGc :: Class -> Class

Modifies a class's ClassConversion structure by setting all languages that support garbage collection to use ClassConversionToGc.

module Foreign.Hoppy.Generator.Spec.ClassFeature