Modulecuddle-1.8.1.0GHC2021

Codec.CBOR.Cuddle.CDDL.Resolve

Module containing tools for resolving CDDL

Resolving the CDDL is a process of simplifying the representation to make further operations, such as CBOR generation or validation, easier. We operate with a number of passes:

First, we deal with any rule extensions and create a single map from identifiers to (potentially parametrised) entities.
Second, we flatten the structure to a CTree, which discards a lot of the extrenuous information.
Then we resolve identifiers. Specifically, we do three things: - Resolve identifiers that map to the postlude. - Differentiate between generic args and references to top-level rules. - Validate that all references exist. Note that we cannot resolve all references since they may be circular.
Finally, we monomorphise, synthesizing instances of rules with their generic arguments bound.

Synopsis

value buildResolvedCTree
value buildRefCTree
value asMap
value buildMonoCTree
value fullResolveCDDL
data NameResolutionFailure
data MonoReferenced
data MonoSimplePhase
value showSimple
data family XXCTree
constructor GenGenerator
constructor GenRef
constructor VRuleRef
constructor VValidator
constructor DGOrRef
constructor DGenerator
constructor DHRef
constructor DRef
constructor DValidator
constructor MGenerator
constructor MRuleRef
constructor MSimpleRef
constructor MValidator
constructor OGenerator
constructor OValidator
constructor OrRef

Packagecuddle-1.8.1.0
Exports26
LanguageGHC2021
LicenceApache-2.0
SourceResolve.hs

valuebuildResolvedCTree

:: PartialCTreeRoot OrReferenced
-> Either NameResolutionFailure (PartialCTreeRoot DistReferenced)

valuebuildRefCTree :: CDDLMap -> PartialCTreeRoot OrReferenced

Source#

Build a CTree incorporating references.

This translation cannot fail.

valueasMap :: CDDL CTreePhase -> CDDLMap

valuebuildMonoCTree

:: PartialCTreeRoot DistReferenced
-> Either NameResolutionFailure (CTreeRoot MonoReferenced)

Source#

Monomorphise the CTree

Concretely, for each reference in the tree to a generic rule, we synthesize a new monomorphic instance of that rule at top-level with the correct parameters applied.

valuefullResolveCDDL

:: CDDL CTreePhase
-> Either NameResolutionFailure (CTreeRoot MonoReferenced)

datadata NameResolutionFailure

Constructors

UnboundReference Name
MismatchingArgs Name [Name]
ArgsToPostlude PTerm [CTree OrReferencedSimple]

Instances3Eq, Show, HasThrow

Eq NameResolutionFailureDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
Show NameResolutionFailureDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
HasThrow "nameResolution" NameResolutionFailure MonoMDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve

datadata MonoReferenced

Instances12HasState, HasSink, IndexMappable, HasReader, HasSource, XXCTree, …

HasSource "synth" MonoState MonoMDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
HasState "synth" MonoState MonoMDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
HasSink "synth" MonoState MonoMDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
IndexMappable CTree MonoReferenced GenPhaseDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
IndexMappable CTree MonoReferenced ValidatorPhaseDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
IndexMappable CTree MonoReferenced MonoSimplePhaseDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
IndexMappable CTreeRoot MonoReferenced GenPhaseDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
IndexMappable CTreeRoot MonoReferenced ValidatorPhaseDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
IndexMappable CTreeRoot MonoReferenced MonoSimplePhaseDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
HasReader "local" (Map Name (CTree MonoReferenced)) MonoMDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
HasSource "local" (Map Name (CTree MonoReferenced)) MonoMDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
data XXCTree MonoReferenced
- MRuleRef Name
- MGenerator (CBORGen RuleTerm) (CTree MonoReferenced)
- MValidator TermValidator (CTree MonoReferenced)
Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve

datadata MonoSimplePhase

Source#

A simplified phase reachable from any of the function-bearing post-mono phases (MonoReferenced, GenPhase, ValidatorPhase). It strips the generator/validator extensions so the tree can be Shown, Eq-compared, and pretty-printed for debug output.

Instances12IndexMappable, Eq, Show, Generic, Pretty, Rep, …

IndexMappable CTree GenPhase MonoSimplePhaseDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
IndexMappable CTree ValidatorPhase MonoSimplePhaseDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
IndexMappable CTree MonoReferenced MonoSimplePhaseDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
IndexMappable CTreeRoot GenPhase MonoSimplePhaseDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
IndexMappable CTreeRoot ValidatorPhase MonoSimplePhaseDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
IndexMappable CTreeRoot MonoReferenced MonoSimplePhaseDefined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
Eq (XXCTree MonoSimplePhase)Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
Show (XXCTree MonoSimplePhase)Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
Generic (XXCTree MonoSimplePhase)Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
Pretty (XXCTree MonoSimplePhase)Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
type Rep (XXCTree MonoSimplePhase) = D1 ('MetaData "XXCTree" "Codec.CBOR.Cuddle.CDDL.Resolve" "cuddle-1.8.1.0-1n67ahaIhMs3FQkr3b5WBN" 'True) (C1 ('MetaCons "MSimpleRef" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Name)))Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
data XXCTree MonoSimplePhase
- MSimpleRef Name
Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve

valueshowSimple

:: (IndexMappable a phase MonoSimplePhase, Show (a MonoSimplePhase))
=> a phase
-> String

Source#

Project any phase that maps to MonoSimplePhase down to a Showable representation. Used for debug output by Gen, Validator, etc.

data familydata family XXCTree i

Instances19Eq, Show, Generic, Pretty, Hashable, Rep, …

Eq (XXCTree DistReferencedNoGen)Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
Eq (XXCTree MonoSimplePhase)Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
Eq (XXCTree OrReferencedSimple)Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
Show (XXCTree DistReferencedNoGen)Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
Show (XXCTree MonoSimplePhase)Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
Show (XXCTree OrReferencedSimple)Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
Generic (XXCTree MonoSimplePhase)Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
Pretty (XXCTree DistReferencedNoGen)Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
Pretty (XXCTree MonoSimplePhase)Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
Hashable (XXCTree DistReferencedNoGen)Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
type Rep (XXCTree MonoSimplePhase) = D1 ('MetaData "XXCTree" "Codec.CBOR.Cuddle.CDDL.Resolve" "cuddle-1.8.1.0-1n67ahaIhMs3FQkr3b5WBN" 'True) (C1 ('MetaCons "MSimpleRef" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Name)))Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
data XXCTree GenPhase
- GenRef Name
- GenGenerator (CBORGen RuleTerm) (CTree GenPhase)
Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Custom.Generator
data XXCTree ValidatorPhase
- VRuleRef Name
- VValidator TermValidator (CTree ValidatorPhase)
Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Custom.Validator
data XXCTree DistReferenced
- DRef (DistRef DistReferenced)
- DGenerator (CBORGen RuleTerm) (CTree DistReferenced)
- DValidator TermValidator (CTree DistReferenced)
Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
data XXCTree DistReferencedNoGen
- DHRef (DistRef DistReferencedNoGen)
Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
data XXCTree MonoReferenced
- MRuleRef Name
- MGenerator (CBORGen RuleTerm) (CTree MonoReferenced)
- MValidator TermValidator (CTree MonoReferenced)
Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
data XXCTree MonoSimplePhase
- MSimpleRef Name
Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
data XXCTree OrReferenced
- OrRef Name [CTree OrReferenced]
- OGenerator (CBORGen RuleTerm) (CTree OrReferenced)
- OValidator TermValidator (CTree OrReferenced)
Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve
data XXCTree OrReferencedSimple
- DGOrRef Name [CTree OrReferencedSimple]
Defined in cuddle-1.8.1.0 · Codec.CBOR.Cuddle.CDDL.Resolve

constructorGenGenerator (CBORGen RuleTerm) (CTree GenPhase)

constructorGenRef Name

constructorVRuleRef Name

constructorVValidator TermValidator (CTree ValidatorPhase)

constructorDGOrRef Name [CTree OrReferencedSimple]

constructorDGenerator (CBORGen RuleTerm) (CTree DistReferenced)

constructorDHRef (DistRef DistReferencedNoGen)

constructorDRef (DistRef DistReferenced)

constructorDValidator TermValidator (CTree DistReferenced)

constructorMGenerator (CBORGen RuleTerm) (CTree MonoReferenced)

constructorMRuleRef Name

constructorMSimpleRef Name

constructorMValidator TermValidator (CTree MonoReferenced)

constructorOGenerator (CBORGen RuleTerm) (CTree OrReferenced)

constructorOValidator TermValidator (CTree OrReferenced)

constructorOrRef Name [CTree OrReferenced]

Source#

Reference to another node with possible generic arguments supplied