FlatBuffers.Internal.Compiler.TH

Documentation

(~>) :: Type -> Type -> Type infixr 1

Helper method to create function types. ConT ''Int ~> ConT ''String === Int -> String

data Options

Options to control how/which flatbuffers constructors/accessor should be generated.

Options can be set using record syntax on defaultOptions with the fields below.

defaultOptions { compileAllSchemas = True }

Constructors

Options

Fields

• includeDirectories :: [FilePath]

  Directories to search for includes (same as flatc -I option).

• compileAllSchemas :: Bool

  Generate code not just for the root schema, but for all schemas it includes as well (same as flatc --gen-all option).

Instances

Eq Options

Defined in FlatBuffers.Internal.Compiler.TH

Methods

(==) :: Options -> Options -> Bool

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

Show Options

Defined in FlatBuffers.Internal.Compiler.TH

Methods

showsPrec :: Int -> Options -> ShowS

show :: Options -> String

showList :: [Options] -> ShowS

defaultOptions :: Options

Default flatbuffers options:

Options
  { includeDirectories = []
  , compileAllSchemas = False
  }

mkFlatBuffers :: FilePath -> Options -> Q [Dec]

Generates constructors and accessors for all data types declared in the given flatbuffers schema whose namespace matches the current module.

namespace Data.Game;

table Monster {}

{-# LANGUAGE TemplateHaskell #-}

module Data.Game where

import FlatBuffers

$(mkFlatBuffers "schemas/game.fbs" defaultOptions)

compileSymbolTable :: ValidDecls -> Q [Dec]

mkEnum :: (Namespace, EnumDecl) -> Q [Dec]

mkEnumDataDec :: Name -> NonEmpty Name -> Dec

mkToEnum :: Name -> EnumDecl -> NonEmpty (EnumVal, Name) -> Q [Dec]

mkFromEnum :: Name -> EnumDecl -> NonEmpty (EnumVal, Name) -> Q [Dec]

mkStruct :: (Namespace, StructDecl) -> Q [Dec]

mkIsStructInstance :: Name -> StructDecl -> Q [Dec]

mkStructConstructor :: Name -> StructDecl -> Q (Dec, Dec)

mkStructConstructorArg :: StructField -> Q (Type, Pat, NonEmpty Exp)

mkStructFieldGetter :: Name -> StructDecl -> StructField -> [Dec]

mkTable :: (Namespace, TableDecl) -> Q [Dec]

mkTableFileIdentifier :: Name -> IsRoot -> [Dec]

mkTableConstructor :: Name -> TableDecl -> Q (Dec, Dec)

mkTableContructorArg :: TableField -> Q ([Type], [Pat], [Exp])

mkTableFieldGetter :: Name -> TableDecl -> TableField -> [Dec]

mkUnion :: (Namespace, UnionDecl) -> Q [Dec]

mkUnionDataDec :: Name -> NonEmpty (UnionVal, Name) -> Dec

mkUnionConstructors :: Name -> UnionDecl -> Q [Dec]

mkReadUnionFun :: Name -> NonEmpty Name -> UnionDecl -> Q [Dec]

enumTypeToType :: EnumType -> Type

enumTypeToTableFieldType :: Integral a => EnumType -> DefaultVal a -> TableFieldType

enumTypeToStructFieldType :: EnumType -> StructFieldType

enumTypeToVectorElementType :: EnumType -> VectorElementType

structFieldTypeToWriteType :: StructFieldType -> Type

structFieldTypeToReadType :: StructFieldType -> Type

tableFieldTypeToWriteType :: TableFieldType -> Type

tableFieldTypeToReadType :: TableFieldType -> Type

vectorElementTypeToWriteType :: VectorElementType -> Type

vectorElementTypeToReadType :: VectorElementType -> Type

typeRefToType :: TypeRef -> Type

requiredType :: Required -> Type -> Type

mkName' :: Text -> Name

newName' :: Text -> Q Name

intLitP :: Integral i => i -> Pat

intLitE :: Integral i => i -> Exp

realLitE :: Real i => i -> Exp

textLitE :: Text -> Exp

stringLitE :: Text -> Exp

app :: [Exp] -> Exp

Applies a function to multiple arguments. Assumes the list is not empty.

compose :: [Exp] -> Exp