Foreign.Hoppy.Generator.Hook

Hooks for controlling various parts of generators.

Documentation

data Hooks

These hooks can be used to customize the behaviour of a Hoppy generator.

Constructors

Hooks

Fields

• hookEvaluateEnums :: EnumEvaluator

  This hook is invoked once for an interface when the generator needs information about some enums beyond what's been baked into the interface (for example, to compute the enum's numeric type or entry values, see EvaluatedEnumData). This will be called at most once per interface per invocation of the generator.

defaultHooks :: Hooks

The default set of hooks associated with an interface. This sets hookEvaluateEnums to evaluateEnumsWithDefaultCompiler.

Enum evaluation

type EnumEvaluator = EnumEvaluatorArgs -> IO (Maybe EnumEvaluatorResult)

A function that answers with representation information about an enum (e.g. entries' numeric values) for a given request. On success, it returns the requested data. On failure, it prints a message to standard error and returns Nothing.

data EnumEvaluatorArgs

Inputs to the process of automatically evaluting enums.

Constructors

EnumEvaluatorArgs

Fields

• enumEvaluatorArgsInterface :: Interface

  The interface that enum values are being calculated for.

• enumEvaluatorArgsPrependedIncludeDirs :: [FilePath]

  Additional paths to prepend to the C++ include path during compilation.

• enumEvaluatorArgsReqs :: Reqs

  Requirements (includes, etc.) needed to reference the enum identifiers being evaluated.

• enumEvaluatorArgsSizeofIdentifiers :: [Identifier]

  The list of identifiers that we need to compute sizeof() for.

• enumEvaluatorArgsEntries :: [EnumEvaluatorEntry]

  The list of entries to calculate values for.

• enumEvaluatorArgsKeepOutputsOnFailure :: Bool

  Whether to leave temporary build inputs and outputs on disk in case the calculation fails. If failure does occur and this is true, then the calculation should print to standard error the location of these files (this is taken care of by the calculateEnumValues* functions here.)

data EnumEvaluatorEntry

An entry in an enumeration. This also tracks whether the entry came from a scoped enum, for assertion reasons.

Constructors

EnumEvaluatorEntry

Fields

• enumEvaluatorEntryScoped :: Scoped

  Whether the entry comes from a scoped enum.

• enumEvaluatorEntryIdentifier :: Identifier

  The identifier referring to the entry.

Instances

Eq EnumEvaluatorEntry

Defined in Foreign.Hoppy.Generator.Hook

Methods

(==) :: EnumEvaluatorEntry -> EnumEvaluatorEntry -> Bool

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

Ord EnumEvaluatorEntry

Defined in Foreign.Hoppy.Generator.Hook

Methods

compare :: EnumEvaluatorEntry -> EnumEvaluatorEntry -> Ordering

(<) :: EnumEvaluatorEntry -> EnumEvaluatorEntry -> Bool

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

(>) :: EnumEvaluatorEntry -> EnumEvaluatorEntry -> Bool

(>=) :: EnumEvaluatorEntry -> EnumEvaluatorEntry -> Bool

max :: EnumEvaluatorEntry -> EnumEvaluatorEntry -> EnumEvaluatorEntry

min :: EnumEvaluatorEntry -> EnumEvaluatorEntry -> EnumEvaluatorEntry

data EnumEvaluatorResult

Raw outputs parsed from the output of an enum evaluator.

Constructors

EnumEvaluatorResult

Fields

• enumEvaluatorResultSizes :: ![Int]

  The sizeof() for each identifier in enumEvaluatorArgsSizeofIdentifiers. The lengths of these two lists must match.

• enumEvaluatorResultValues :: ![Integer]

  The numeric value for each identifier in enumEvaluatorArgsEntries. The lengths of these two lists must match.

Instances

Show EnumEvaluatorResult

Defined in Foreign.Hoppy.Generator.Hook

Methods

showsPrec :: Int -> EnumEvaluatorResult -> ShowS

show :: EnumEvaluatorResult -> String

showList :: [EnumEvaluatorResult] -> ShowS

evaluateEnumsWithCompiler :: Compiler a => a -> EnumEvaluator

Evaluate enums using a specified compiler.

evaluateEnumsWithDefaultCompiler :: EnumEvaluator

Calculates enum values using an interface's compiler.

makeCppSourceToEvaluateEnums :: EnumEvaluatorArgs -> ByteString

Constructs the C++ source program to evaluate enums.

interpretOutputToEvaluateEnums :: EnumEvaluatorArgs -> String -> Either String EnumEvaluatorResult

Interprets the output of a program generated by makeCppSourceToEvaluateEnums, returning parsed values if successful, and an error string otherwise.

Internal

data NumericTypeInfo

Bound information about numeric types.

Instances

Read NumericTypeInfo

Defined in Foreign.Hoppy.Generator.Spec.Computed

Methods

readsPrec :: Int -> ReadS NumericTypeInfo

readList :: ReadS [NumericTypeInfo]

readPrec :: ReadPrec NumericTypeInfo

readListPrec :: ReadPrec [NumericTypeInfo]

Show NumericTypeInfo

Defined in Foreign.Hoppy.Generator.Spec.Computed

Methods

showsPrec :: Int -> NumericTypeInfo -> ShowS

show :: NumericTypeInfo -> String

showList :: [NumericTypeInfo] -> ShowS

pickNumericType :: Int -> Integer -> Integer -> Maybe NumericTypeInfo

Selects the preferred numeric type for holding numeric values in the given range.

internalEvaluateEnumsForInterface

Arguments

:: Interface

-> Maybe FilePath

A optional directory to add to the compiler's header search path. This is meant to be the directory holding C++ files included in the C++ package.

-> Bool

-> IO (Map ExtName EvaluatedEnumData)

Collects all of the enum values that need calculating in an interface, runs the hook to evaluate them, and stores the result in the interface. This won't recalculate enum data if it's already been calculated.