Safe Haskell	None
Language	Haskell2010

FlatBuffers.Internal.Compiler.SemanticAnalysis

Synopsis

type ValidationCtx m = (MonadError Text m, MonadReader ValidationState m)
data ValidationState = ValidationState {
- validationStateCurrentContext :: !Ident
- validationStateAllAttributes :: !(Set AttributeDecl)
}
modifyContext :: ValidationCtx m => (Ident -> Ident) -> m a -> m a
data SymbolTable enum struct table union = SymbolTable {
- allEnums :: ![(Namespace, enum)]
- allStructs :: ![(Namespace, struct)]
- allTables :: ![(Namespace, table)]
- allUnions :: ![(Namespace, union)]
}
type Stage1 = SymbolTable EnumDecl StructDecl TableDecl UnionDecl
type Stage2 = SymbolTable EnumDecl StructDecl TableDecl UnionDecl
type Stage3 = SymbolTable EnumDecl StructDecl TableDecl UnionDecl
type Stage4 = SymbolTable EnumDecl StructDecl TableDecl UnionDecl
type ValidDecls = SymbolTable EnumDecl StructDecl TableDecl UnionDecl
createSymbolTables :: FileTree Schema -> FileTree Stage1
validateSchemas :: MonadError Text m => FileTree Schema -> m (FileTree ValidDecls)
data RootInfo = RootInfo {
- rootTableNamespace :: !Namespace
- rootTable :: !TableDecl
- rootFileIdent :: !(Maybe Text)
}
updateRootTable :: forall m. ValidationCtx m => Schema -> FileTree ValidDecls -> m (FileTree ValidDecls)
getRootInfo :: forall m. ValidationCtx m => Schema -> FileTree ValidDecls -> m (Maybe RootInfo)
knownAttributes :: [AttributeDecl]
idAttr :: Text
deprecatedAttr :: Text
requiredAttr :: Text
forceAlignAttr :: Text
bitFlagsAttr :: Text
otherKnownAttributes :: [AttributeDecl]
data Match enum struct table union
- = MatchE !(Namespace, enum)
- | MatchS !(Namespace, struct)
- | MatchT !(Namespace, table)
- | MatchU !(Namespace, union)
findDecl :: ValidationCtx m => (HasIdent e, HasIdent s, HasIdent t, HasIdent u) => Namespace -> FileTree (SymbolTable e s t u) -> TypeRef -> m (Match e s t u)
parentNamespaces :: Namespace -> NonEmpty Namespace
validateEnums :: forall m. ValidationCtx m => FileTree Stage1 -> m (FileTree Stage2)
validateEnum :: forall m. ValidationCtx m => (Namespace, EnumDecl) -> m EnumDecl
data TableFieldWithoutId = TableFieldWithoutId !Ident !TableFieldType !Bool
validateTables :: ValidationCtx m => FileTree Stage3 -> m (FileTree Stage4)
validateTable :: forall m. ValidationCtx m => FileTree Stage3 -> (Namespace, TableDecl) -> m TableDecl
checkNoRequired :: ValidationCtx m => Metadata -> m ()
checkNoDefault :: ValidationCtx m => Maybe DefaultVal -> m ()
isRequired :: Metadata -> Required
validateDefaultValAsInt :: forall m a. (ValidationCtx m, Integral a, Bounded a, Show a) => Maybe DefaultVal -> m (DefaultVal a)
validateDefaultValAsScientific :: ValidationCtx m => Maybe DefaultVal -> m (DefaultVal Scientific)
validateDefaultValAsBool :: ValidationCtx m => Maybe DefaultVal -> m (DefaultVal Bool)
validateDefaultAsEnum :: ValidationCtx m => Maybe DefaultVal -> EnumDecl -> m (DefaultVal Integer)
validateUnions :: ValidationCtx m => FileTree Stage4 -> m (FileTree ValidDecls)
validateUnion :: forall m. ValidationCtx m => FileTree Stage4 -> (Namespace, UnionDecl) -> m UnionDecl
validateStructs :: ValidationCtx m => FileTree Stage2 -> m (FileTree Stage3)
checkStructCycles :: forall m. ValidationCtx m => FileTree Stage2 -> (Namespace, StructDecl) -> m ()
data UnpaddedStructField = UnpaddedStructField {
- unpaddedStructFieldIdent :: !Ident
- unpaddedStructFieldType :: !StructFieldType
}
validateStruct :: forall m. (MonadState [(Namespace, StructDecl)] m, ValidationCtx m) => FileTree Stage2 -> (Namespace, StructDecl) -> m (Namespace, StructDecl)
structFieldAlignment :: UnpaddedStructField -> Alignment
enumAlignment :: EnumType -> Alignment
enumSize :: EnumType -> Word8
structFieldTypeSize :: StructFieldType -> InlineSize
checkDuplicateIdentifiers :: (ValidationCtx m, Foldable f, Functor f, HasIdent a) => f a -> m ()
checkUndeclaredAttributes :: (ValidationCtx m, HasMetadata a) => a -> m ()
hasAttribute :: Text -> Metadata -> Bool
findIntAttr :: ValidationCtx m => Text -> Metadata -> m (Maybe Integer)
findStringAttr :: ValidationCtx m => Text -> Metadata -> m (Maybe Text)
throwErrorMsg :: ValidationCtx m => Text -> m a

Documentation

type ValidationCtx m = (MonadError Text m, MonadReader ValidationState m) Source #

data ValidationState Source #

Constructors

ValidationState
Fields validationStateCurrentContext :: !Ident The thing being validated (e.g. a fully-qualified struct name, or a table field name). validationStateAllAttributes :: !(Set AttributeDecl) All the attributes declared in all the schemas (including imported ones).

modifyContext :: ValidationCtx m => (Ident -> Ident) -> m a -> m a Source #

data SymbolTable enum struct table union Source #

Constructors

SymbolTable
Fields allEnums :: ![(Namespace, enum)] allStructs :: ![(Namespace, struct)] allTables :: ![(Namespace, table)] allUnions :: ![(Namespace, union)]

Instances

(Eq enum, Eq struct, Eq table, Eq union) => Eq (SymbolTable enum struct table union) Source #
Instance details Defined in FlatBuffers.Internal.Compiler.SemanticAnalysis Methods (==) :: SymbolTable enum struct table union -> SymbolTable enum struct table union -> Bool # (/=) :: SymbolTable enum struct table union -> SymbolTable enum struct table union -> Bool #
(Show enum, Show struct, Show table, Show union) => Show (SymbolTable enum struct table union) Source #
Instance details Defined in FlatBuffers.Internal.Compiler.SemanticAnalysis Methods showsPrec :: Int -> SymbolTable enum struct table union -> ShowS # show :: SymbolTable enum struct table union -> String # showList :: [SymbolTable enum struct table union] -> ShowS #
Semigroup (SymbolTable e s t u) Source #
Instance details Defined in FlatBuffers.Internal.Compiler.SemanticAnalysis Methods (<>) :: SymbolTable e s t u -> SymbolTable e s t u -> SymbolTable e s t u # sconcat :: NonEmpty (SymbolTable e s t u) -> SymbolTable e s t u # stimes :: Integral b => b -> SymbolTable e s t u -> SymbolTable e s t u #
Monoid (SymbolTable e s t u) Source #
Instance details Defined in FlatBuffers.Internal.Compiler.SemanticAnalysis Methods mempty :: SymbolTable e s t u # mappend :: SymbolTable e s t u -> SymbolTable e s t u -> SymbolTable e s t u # mconcat :: [SymbolTable e s t u] -> SymbolTable e s t u #

type Stage1 = SymbolTable EnumDecl StructDecl TableDecl UnionDecl Source #

type Stage2 = SymbolTable EnumDecl StructDecl TableDecl UnionDecl Source #

type Stage3 = SymbolTable EnumDecl StructDecl TableDecl UnionDecl Source #

type Stage4 = SymbolTable EnumDecl StructDecl TableDecl UnionDecl Source #

type ValidDecls = SymbolTable EnumDecl StructDecl TableDecl UnionDecl Source #

createSymbolTables :: FileTree Schema -> FileTree Stage1 Source #

Takes a collection of schemas, and pairs each type declaration with its corresponding namespace

validateSchemas :: MonadError Text m => FileTree Schema -> m (FileTree ValidDecls) Source #

data RootInfo Source #

Constructors

RootInfo
Fields rootTableNamespace :: !Namespace rootTable :: !TableDecl rootFileIdent :: !(Maybe Text)

updateRootTable :: forall m. ValidationCtx m => Schema -> FileTree ValidDecls -> m (FileTree ValidDecls) Source #

Finds the root table (if any) and sets the tableIsRoot flag accordingly. We only care about root_type declarations in the root schema. Imported schemas are not scanned for root_types. The root type declaration can point to a table in any schema (root or imported).

getRootInfo :: forall m. ValidationCtx m => Schema -> FileTree ValidDecls -> m (Maybe RootInfo) Source #

knownAttributes :: [AttributeDecl] Source #

idAttr :: Text Source #

deprecatedAttr :: Text Source #

requiredAttr :: Text Source #

forceAlignAttr :: Text Source #

bitFlagsAttr :: Text Source #

otherKnownAttributes :: [AttributeDecl] Source #

data Match enum struct table union Source #

Constructors

MatchE !(Namespace, enum)
MatchS !(Namespace, struct)
MatchT !(Namespace, table)
MatchU !(Namespace, union)

findDecl :: ValidationCtx m => (HasIdent e, HasIdent s, HasIdent t, HasIdent u) => Namespace -> FileTree (SymbolTable e s t u) -> TypeRef -> m (Match e s t u) Source #

Looks for a type reference in a set of type declarations. If none is found, the list of namespaces in which the type reference was searched for is returned.

parentNamespaces :: Namespace -> NonEmpty Namespace Source #

Returns a list of all the namespaces "between" the current namespace and the root namespace, in that order. See: https://github.com/google/flatbuffers/issues/5234#issuecomment-471680403

parentNamespaces "A.B.C" == ["A.B.C", "A.B", "A", ""]

validateEnums :: forall m. ValidationCtx m => FileTree Stage1 -> m (FileTree Stage2) Source #

validateEnum :: forall m. ValidationCtx m => (Namespace, EnumDecl) -> m EnumDecl Source #

data TableFieldWithoutId Source #

Constructors

TableFieldWithoutId !Ident !TableFieldType !Bool

validateTables :: ValidationCtx m => FileTree Stage3 -> m (FileTree Stage4) Source #

validateTable :: forall m. ValidationCtx m => FileTree Stage3 -> (Namespace, TableDecl) -> m TableDecl Source #

checkNoRequired :: ValidationCtx m => Metadata -> m () Source #

checkNoDefault :: ValidationCtx m => Maybe DefaultVal -> m () Source #

isRequired :: Metadata -> Required Source #

validateDefaultValAsInt :: forall m a. (ValidationCtx m, Integral a, Bounded a, Show a) => Maybe DefaultVal -> m (DefaultVal a) Source #

validateDefaultValAsScientific :: ValidationCtx m => Maybe DefaultVal -> m (DefaultVal Scientific) Source #

validateDefaultValAsBool :: ValidationCtx m => Maybe DefaultVal -> m (DefaultVal Bool) Source #

validateDefaultAsEnum :: ValidationCtx m => Maybe DefaultVal -> EnumDecl -> m (DefaultVal Integer) Source #

validateUnions :: ValidationCtx m => FileTree Stage4 -> m (FileTree ValidDecls) Source #

validateUnion :: forall m. ValidationCtx m => FileTree Stage4 -> (Namespace, UnionDecl) -> m UnionDecl Source #

validateStructs :: ValidationCtx m => FileTree Stage2 -> m (FileTree Stage3) Source #

checkStructCycles :: forall m. ValidationCtx m => FileTree Stage2 -> (Namespace, StructDecl) -> m () Source #

data UnpaddedStructField Source #

Constructors

UnpaddedStructField
Fields unpaddedStructFieldIdent :: !Ident unpaddedStructFieldType :: !StructFieldType

Instances

Eq UnpaddedStructField Source #
Instance details Defined in FlatBuffers.Internal.Compiler.SemanticAnalysis Methods (==) :: UnpaddedStructField -> UnpaddedStructField -> Bool # (/=) :: UnpaddedStructField -> UnpaddedStructField -> Bool #
Show UnpaddedStructField Source #
Instance details Defined in FlatBuffers.Internal.Compiler.SemanticAnalysis Methods showsPrec :: Int -> UnpaddedStructField -> ShowS # show :: UnpaddedStructField -> String # showList :: [UnpaddedStructField] -> ShowS #

validateStruct :: forall m. (MonadState [(Namespace, StructDecl)] m, ValidationCtx m) => FileTree Stage2 -> (Namespace, StructDecl) -> m (Namespace, StructDecl) Source #

structFieldAlignment :: UnpaddedStructField -> Alignment Source #

enumAlignment :: EnumType -> Alignment Source #

enumSize :: EnumType -> Word8 Source #

The size of an enum is either 1, 2, 4 or 8 bytes, so its size fits in a Word8

structFieldTypeSize :: StructFieldType -> InlineSize Source #

checkDuplicateIdentifiers :: (ValidationCtx m, Foldable f, Functor f, HasIdent a) => f a -> m () Source #

checkUndeclaredAttributes :: (ValidationCtx m, HasMetadata a) => a -> m () Source #

hasAttribute :: Text -> Metadata -> Bool Source #

findIntAttr :: ValidationCtx m => Text -> Metadata -> m (Maybe Integer) Source #

findStringAttr :: ValidationCtx m => Text -> Metadata -> m (Maybe Text) Source #

throwErrorMsg :: ValidationCtx m => Text -> m a Source #