Foreign.Hoppy.Generator.Spec.Computed

Module for computed data for an interface.

Documentation

data ComputedInterfaceData

Holds "computed data" for an interface. This is data that is calculated by Hoppy, beyond what is directly specified in the interface.

Constructors

ComputedInterfaceData

Fields

• computedInterfaceName :: String

  The name of the interface.

• evaluatedEnumMap :: Map ExtName EvaluatedEnumData

  Evaluated numeric types and values for all enums in the interface.

data EvaluatedEnumData

Information about the enum that has been completed beyond what the interface definition provides, possibly by building actual C++ code.

Constructors

EvaluatedEnumData

Fields

• evaluatedEnumNumericType :: NumericTypeInfo

  The numeric type that C++ uses to hold the enum's values, or an equivalently-sized type.

• evaluatedEnumValueMap :: EvaluatedEnumValueMap

  Calculated values for all of the enum's entries.

Instances

Read EvaluatedEnumData

Defined in Foreign.Hoppy.Generator.Spec.Computed

Methods

readsPrec :: Int -> ReadS EvaluatedEnumData

readList :: ReadS [EvaluatedEnumData]

readPrec :: ReadPrec EvaluatedEnumData

readListPrec :: ReadPrec [EvaluatedEnumData]

Show EvaluatedEnumData

Defined in Foreign.Hoppy.Generator.Spec.Computed

Methods

showsPrec :: Int -> EvaluatedEnumData -> ShowS

show :: EvaluatedEnumData -> String

showList :: [EvaluatedEnumData] -> ShowS

type EvaluatedEnumValueMap = Map [String] Integer

Contains the numeric values for each of the entries in a C++ enum.

getEvaluatedEnumData :: HasCallStack => ComputedInterfaceData -> ExtName -> EvaluatedEnumData

Returns the map containing the calculated values for all entries in the enum with the given ExtName. This requires hooks to have been run.

Numeric types

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

numType :: NumericTypeInfo -> Type

The numeric data type described by the record.

numBytes :: NumericTypeInfo -> Int

The number of bytes in a value of the type.

numMinBound :: NumericTypeInfo -> Integer

The lowest (most negative) value representable by the type.

numMaxBound :: NumericTypeInfo -> Integer

The highest (most positive) value representable by the type.

findNumericTypeInfo :: Type -> Maybe NumericTypeInfo

Searches the list of known numeric types usable for enum values, and returns the record for the given type.

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

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