FlatBuffers.Internal.Compiler.SemanticAnalysis

Documentation

newtype Validation a

A monad that allows short-circuiting when a validation error is found.

It keeps track of which item is currently being validated, so that when an error happens, we can show the user a better error message with contextual information.

Constructors

Validation

Fields

• runValidation :: ReaderT ValidationState (Either String) a

Instances

Monad Validation

Defined in FlatBuffers.Internal.Compiler.SemanticAnalysis

Methods

(>>=) :: Validation a -> (a -> Validation b) -> Validation b

(>>) :: Validation a -> Validation b -> Validation b

return :: a -> Validation a

Functor Validation

Defined in FlatBuffers.Internal.Compiler.SemanticAnalysis

Methods

fmap :: (a -> b) -> Validation a -> Validation b

(<$) :: a -> Validation b -> Validation a

Applicative Validation

Defined in FlatBuffers.Internal.Compiler.SemanticAnalysis

Methods

pure :: a -> Validation a

(<*>) :: Validation (a -> b) -> Validation a -> Validation b

liftA2 :: (a -> b -> c) -> Validation a -> Validation b -> Validation c

(*>) :: Validation a -> Validation b -> Validation b

(<*) :: Validation a -> Validation b -> Validation a

MonadValidation Validation

Defined in FlatBuffers.Internal.Compiler.SemanticAnalysis

Methods

validating :: HasIdent a => a -> Validation b -> Validation b

resetContext :: Validation a -> Validation a

getContext :: Validation [Ident]

getDeclaredAttributes :: Validation (Set AttributeDecl)

throwErrorMsg :: String -> Validation a

data ValidationState

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).

class Monad m => MonadValidation m where

Methods

validating :: HasIdent a => a -> m b -> m b

Start validating an item a

resetContext :: m a -> m a

Clear validation context, i.e. forget which item is currently being validated, if any.

getContext :: m [Ident]

Get the path to the item currently being validated

getDeclaredAttributes :: m (Set AttributeDecl)

Get a list of all the attributes declared in every loaded schema

throwErrorMsg :: String -> m a

Fail validation with a message

Instances

MonadValidation Validation

Defined in FlatBuffers.Internal.Compiler.SemanticAnalysis

Methods

validating :: HasIdent a => a -> Validation b -> Validation b

resetContext :: Validation a -> Validation a

getContext :: Validation [Ident]

getDeclaredAttributes :: Validation (Set AttributeDecl)

throwErrorMsg :: String -> Validation a

MonadValidation m => MonadValidation (StateT s m)

Defined in FlatBuffers.Internal.Compiler.SemanticAnalysis

Methods

validating :: HasIdent a => a -> StateT s m b -> StateT s m b

resetContext :: StateT s m a -> StateT s m a

getContext :: StateT s m [Ident]

getDeclaredAttributes :: StateT s m (Set AttributeDecl)

throwErrorMsg :: String -> StateT s m a

data SymbolTable enum struct table union

Constructors

SymbolTable

Fields

• allEnums :: !(Map (Namespace, Ident) enum)
• allStructs :: !(Map (Namespace, Ident) struct)
• allTables :: !(Map (Namespace, Ident) table)
• allUnions :: !(Map (Namespace, Ident) union)

Instances

(Eq enum, Eq struct, Eq table, Eq union) => Eq (SymbolTable enum struct table union)

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)

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)

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)

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

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

validateSchemas :: FileTree Schema -> Either String (FileTree ValidDecls)

createSymbolTables :: FileTree Schema -> Validation (FileTree Stage1)

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

insertSymbol :: HasIdent a => Namespace -> a -> Map (Namespace, Ident) a -> Validation (Map (Namespace, Ident) a)

Fails if the key is already present in the map.

updateRootTable :: Schema -> FileTree ValidDecls -> Validation (FileTree ValidDecls)

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).

data RootInfo

Constructors

RootInfo

Fields

• rootTableNamespace :: !Namespace
• rootTable :: !TableDecl
• rootFileIdent :: !(Maybe Text)

getRootInfo :: Schema -> FileTree ValidDecls -> Validation (Maybe RootInfo)

Finds the root_type declaration (if any), and what table it's pointing to.

knownAttributes :: [AttributeDecl]

idAttr :: Text

deprecatedAttr :: Text

requiredAttr :: Text

forceAlignAttr :: Text

bitFlagsAttr :: Text

otherKnownAttributes :: [AttributeDecl]

data Match enum struct table union

Constructors

MatchE !Namespace !enum

MatchS !Namespace !struct

MatchT !Namespace !table

MatchU !Namespace !union

findDecl :: MonadValidation m => Namespace -> FileTree (SymbolTable e s t u) -> TypeRef -> m (Match e s t u)

Looks for a type reference in a set of type declarations.

parentNamespaces :: Namespace -> NonEmpty Namespace

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 :: FileTree Stage1 -> Validation (FileTree Stage2)

validateEnum :: (Namespace, Ident) -> EnumDecl -> Validation EnumDecl

data TableFieldWithoutId

Constructors

TableFieldWithoutId !Ident !TableFieldType !Bool

validateTables :: FileTree Stage3 -> Validation (FileTree Stage4)

validateTable :: FileTree Stage3 -> (Namespace, Ident) -> TableDecl -> Validation TableDecl

checkNoRequired :: Metadata -> Validation ()

checkNoDefault :: Maybe DefaultVal -> Validation ()

isRequired :: Metadata -> Required

validateDefaultValAsInt :: forall a. (Integral a, Bounded a, Display a) => Maybe DefaultVal -> Validation (DefaultVal Integer)

validateDefaultValAsScientific :: Maybe DefaultVal -> Validation (DefaultVal Scientific)

validateDefaultValAsBool :: Maybe DefaultVal -> Validation (DefaultVal Bool)

validateDefaultAsEnum :: Maybe DefaultVal -> EnumDecl -> Validation (DefaultVal Integer)

scientificToInteger :: forall a. (Integral a, Bounded a, Display a) => Scientific -> String -> Validation (DefaultVal Integer)

validateUnions :: FileTree Stage4 -> Validation (FileTree ValidDecls)

validateUnion :: FileTree Stage4 -> (Namespace, Ident) -> UnionDecl -> Validation UnionDecl

type ValidatedStructs = Map (Namespace, Ident) StructDecl

Cache of already validated structs.

When we're validating a struct A, it may contain an inner struct B which also needs validating. B needs to be fully validated before we can consider A valid.

If we've validated B in a previous iteration, we will find it in this Map and therefore avoid re-validating it.

validateStructs :: FileTree Stage2 -> Validation (FileTree Stage3)

checkStructCycles :: forall m. MonadValidation m => FileTree Stage2 -> (Namespace, StructDecl) -> m ()

data UnpaddedStructField

Constructors

UnpaddedStructField

Fields

• unpaddedStructFieldIdent :: !Ident
• unpaddedStructFieldType :: !StructFieldType

Instances

Eq UnpaddedStructField

Defined in FlatBuffers.Internal.Compiler.SemanticAnalysis

Methods

(==) :: UnpaddedStructField -> UnpaddedStructField -> Bool

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

Show UnpaddedStructField

Defined in FlatBuffers.Internal.Compiler.SemanticAnalysis

Methods

showsPrec :: Int -> UnpaddedStructField -> ShowS

show :: UnpaddedStructField -> String

showList :: [UnpaddedStructField] -> ShowS

validateStruct :: forall m. (MonadState ValidatedStructs m, MonadValidation m) => FileTree Stage2 -> Namespace -> StructDecl -> m StructDecl

structFieldAlignment :: UnpaddedStructField -> Alignment

enumAlignment :: EnumType -> Alignment

enumSize :: EnumType -> Word8

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

structFieldTypeSize :: StructFieldType -> InlineSize

checkDuplicateIdentifiers :: (MonadValidation m, Foldable f, Functor f, HasIdent a) => f a -> m ()

checkUndeclaredAttributes :: (MonadValidation m, HasMetadata a) => a -> m ()

hasAttribute :: Text -> Metadata -> Bool

findIntAttr :: MonadValidation m => Text -> Metadata -> m (Maybe Integer)

findStringAttr :: Text -> Metadata -> Validation (Maybe Text)

isPowerOfTwo :: (Num a, Bits a) => a -> Bool

roundUpToNearestMultipleOf :: Integral n => n -> n -> n