Morley.Michelson.Untyped.Annotation

Michelson annotations in untyped model.

Documentation

newtype Annotation tag

Generic TypeFieldVariable Annotation

As per Michelson documentation, this type has an invariant: (except for the first character, here parametrized in the type tag) the allowed character set is the one matching the following regexp: %|%%|%|[:%][_0-9a-zA-Z][_0-9a-zA-Z.%@]*

Constructors

UnsafeAnnotation

Fields

• unAnnotation :: Text

Instances

Semigroup VarAnn

Defined in Morley.Michelson.Untyped.Annotation

Methods

(<>) :: VarAnn -> VarAnn -> VarAnn

sconcat :: NonEmpty VarAnn -> VarAnn

stimes :: Integral b => b -> VarAnn -> VarAnn

Monoid VarAnn

Defined in Morley.Michelson.Untyped.Annotation

Methods

mempty :: VarAnn

mappend :: VarAnn -> VarAnn -> VarAnn

mconcat :: [VarAnn] -> VarAnn

Lift (Annotation tag :: Type)

Defined in Morley.Michelson.Untyped.Annotation

Methods

lift :: Annotation tag -> Q Exp

liftTyped :: Annotation tag -> Q (TExp (Annotation tag))

Functor (Annotation :: Type -> Type)

Defined in Morley.Michelson.Untyped.Annotation

Methods

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

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

Eq (Annotation tag)

Defined in Morley.Michelson.Untyped.Annotation

Methods

(==) :: Annotation tag -> Annotation tag -> Bool

(/=) :: Annotation tag -> Annotation tag -> Bool

(Typeable tag, Typeable k) => Data (Annotation tag)

Defined in Morley.Michelson.Untyped.Annotation

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Annotation tag -> c (Annotation tag)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Annotation tag)

toConstr :: Annotation tag -> Constr

dataTypeOf :: Annotation tag -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Annotation tag))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Annotation tag))

gmapT :: (forall b. Data b => b -> b) -> Annotation tag -> Annotation tag

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Annotation tag -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Annotation tag -> r

gmapQ :: (forall d. Data d => d -> u) -> Annotation tag -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Annotation tag -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Annotation tag -> m (Annotation tag)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Annotation tag -> m (Annotation tag)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Annotation tag -> m (Annotation tag)

Typeable tag => Show (Annotation tag)

Defined in Morley.Michelson.Untyped.Annotation

Methods

showsPrec :: Int -> Annotation tag -> ShowS

show :: Annotation tag -> String

showList :: [Annotation tag] -> ShowS

Generic (Annotation tag)

Defined in Morley.Michelson.Untyped.Annotation

Associated Types

type Rep (Annotation tag) :: Type -> Type

Methods

from :: Annotation tag -> Rep (Annotation tag) x

to :: Rep (Annotation tag) x -> Annotation tag

NFData (Annotation tag)

Defined in Morley.Michelson.Untyped.Annotation

Methods

rnf :: Annotation tag -> ()

ToJSON (Annotation tag)

Defined in Morley.Michelson.Untyped.Annotation

Methods

toJSON :: Annotation tag -> Value

toEncoding :: Annotation tag -> Encoding

toJSONList :: [Annotation tag] -> Value

toEncodingList :: [Annotation tag] -> Encoding

FromJSON (Annotation tag)

Defined in Morley.Michelson.Untyped.Annotation

Methods

parseJSON :: Value -> Parser (Annotation tag)

parseJSONList :: Value -> Parser [Annotation tag]

Default (Annotation tag)

Defined in Morley.Michelson.Untyped.Annotation

Methods

def :: Annotation tag

KnownAnnTag tag => Buildable (Annotation tag)

Defined in Morley.Michelson.Untyped.Annotation

Methods

build :: Annotation tag -> Builder

KnownAnnTag tag => RenderDoc (Annotation tag)

Defined in Morley.Michelson.Untyped.Annotation

Methods

renderDoc :: RenderContext -> Annotation tag -> Doc

isRenderable :: Annotation tag -> Bool

type Rep (Annotation tag)

Defined in Morley.Michelson.Untyped.Annotation

type Rep (Annotation tag) = D1 ('MetaData "Annotation" "Morley.Michelson.Untyped.Annotation" "morley-1.16.3-inplace" 'True) (C1 ('MetaCons "UnsafeAnnotation" 'PrefixI 'True) (S1 ('MetaSel ('Just "unAnnotation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data VarAnns

Either one or two variable annotations

Constructors

OneVarAnn VarAnn

TwoVarAnns VarAnn VarAnn

Instances

Show VarAnns

Defined in Morley.Michelson.Untyped.Annotation

Methods

showsPrec :: Int -> VarAnns -> ShowS

show :: VarAnns -> String

showList :: [VarAnns] -> ShowS

Generic VarAnns

Defined in Morley.Michelson.Untyped.Annotation

Associated Types

type Rep VarAnns :: Type -> Type

Methods

from :: VarAnns -> Rep VarAnns x

to :: Rep VarAnns x -> VarAnns

NFData VarAnns

Defined in Morley.Michelson.Untyped.Annotation

Methods

rnf :: VarAnns -> ()

type Rep VarAnns

Defined in Morley.Michelson.Untyped.Annotation

type Rep VarAnns = D1 ('MetaData "VarAnns" "Morley.Michelson.Untyped.Annotation" "morley-1.16.3-inplace" 'False) (C1 ('MetaCons "OneVarAnn" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VarAnn)) :+: C1 ('MetaCons "TwoVarAnns" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VarAnn) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VarAnn)))

pattern Annotation :: Text -> Annotation tag

Unidirectional pattern synonym used to pattern-match on Annotation without invoking UnsafeAnnotation

pattern WithAnn :: Annotation tag -> Annotation tag

Unidirectional pattern synonym matching only non-empty annotations

Annotation Set

data AnnotationSet

An AnnotationSet contains all the typefieldvariable Annotations , with each group in order, associated with an entity. Note that in its rendering/show instances the unnecessary annotations will be omitted, as well as in some of the functions operating with it. Necessary Annotations are the ones strictly required for a consistent representation. In particular, for each group (tfv): - if all annotations are noAnn they are all omitted - if one or more noAnn follow a non-empty Annotation, they are omitted - if one or more noAnn precede a non-empty Annotation, they are kept - every non-empty Annotation is obviously kept This is why order for each group is important as well as separation of different groups of Annotations.

Constructors

AnnotationSet

Fields

• asTypes :: [TypeAnn]
• asFields :: [FieldAnn]
• asVars :: [VarAnn]

Instances

Eq AnnotationSet

Defined in Morley.Michelson.Untyped.Annotation

Methods

(==) :: AnnotationSet -> AnnotationSet -> Bool

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

Show AnnotationSet

Defined in Morley.Michelson.Untyped.Annotation

Methods

showsPrec :: Int -> AnnotationSet -> ShowS

show :: AnnotationSet -> String

showList :: [AnnotationSet] -> ShowS

Semigroup AnnotationSet

Defined in Morley.Michelson.Untyped.Annotation

Methods

(<>) :: AnnotationSet -> AnnotationSet -> AnnotationSet

sconcat :: NonEmpty AnnotationSet -> AnnotationSet

stimes :: Integral b => b -> AnnotationSet -> AnnotationSet

Monoid AnnotationSet

Defined in Morley.Michelson.Untyped.Annotation

Methods

mempty :: AnnotationSet

mappend :: AnnotationSet -> AnnotationSet -> AnnotationSet

mconcat :: [AnnotationSet] -> AnnotationSet

Buildable AnnotationSet

Defined in Morley.Michelson.Untyped.Annotation

Methods

build :: AnnotationSet -> Builder

RenderDoc AnnotationSet

Defined in Morley.Michelson.Untyped.Annotation

Methods

renderDoc :: RenderContext -> AnnotationSet -> Doc

isRenderable :: AnnotationSet -> Bool

annsCount :: AnnotationSet -> (Int, Int, Int)

Returns the number of annotations in AnnotationSet for each type.

emptyAnnSet :: AnnotationSet

An AnnotationSet without any Annotation.

firstAnn :: KnownAnnTag tag => AnnotationSet -> Annotation tag

Returns the first annotation in a list of annotations of a specific type in AnnotationSet, or noAnn if this list is empty.

fullAnnSet :: [TypeAnn] -> [FieldAnn] -> [VarAnn] -> AnnotationSet

An AnnotationSet built from all 3 kinds of Annotation.

isNoAnnSet :: AnnotationSet -> Bool

Returns True if all Annotations in the Set are unnecessaryemptynoAnn. False otherwise.

minAnnSetSize :: AnnotationSet -> Int

Returns the amount of Annotations that are necessary for a consistent representation. See AnnotationSet.

secondAnn :: KnownAnnTag tag => AnnotationSet -> Annotation tag

Returns the second annotation in a list of annotations of a specific type in AnnotationSet, or noAnn if this list contains less than 2 elements.

singleAnnSet :: forall tag. KnownAnnTag tag => Annotation tag -> AnnotationSet

An AnnotationSet with only a single Annotation (of any kind).

singleGroupAnnSet :: forall tag. KnownAnnTag tag => [Annotation tag] -> AnnotationSet

An AnnotationSet with several Annotations of the same kind.

minimizeAnnSet :: AnnotationSet -> AnnotationSet

Removes all unnecessary Annotations. See AnnotationSet.

Rendering

class Typeable (tag :: Type) => KnownAnnTag tag where

A constraint representing that type-level annotation tag is known at compile-time

Methods

annPrefix :: Text

What prefix is used for the given annotation type (identified by tag) in Michelson code, i.e. % for field annotations, @ for variable annotations, : for type annotations

Instances

KnownAnnTag VarTag

Defined in Morley.Michelson.Untyped.Annotation

Methods

annPrefix :: Text

KnownAnnTag FieldTag

Defined in Morley.Michelson.Untyped.Annotation

Methods

annPrefix :: Text

KnownAnnTag TypeTag

Defined in Morley.Michelson.Untyped.Annotation

Methods

annPrefix :: Text

type TypeAnn = Annotation TypeTag

A convenience synonym for type Annotation

type FieldAnn = Annotation FieldTag

A convenience synonym for field Annotation

type VarAnn = Annotation VarTag

A convenience synonym for variable Annotation

type SomeAnn = Annotation SomeTag

A convenience synonym for "some" Annotation, i.e. its type is unknown at compile-time

type RootAnn = Annotation FieldTag

Field annotation for the entire parameter.

data TypeTag

Type-level tag for type annotations

Instances

KnownAnnTag TypeTag

Defined in Morley.Michelson.Untyped.Annotation

Methods

annPrefix :: Text

data FieldTag

Type-level tag for field annotations

Instances

KnownAnnTag FieldTag

Defined in Morley.Michelson.Untyped.Annotation

Methods

annPrefix :: Text

data VarTag

Type-level tag for variable annotations

Instances

Semigroup VarAnn

Defined in Morley.Michelson.Untyped.Annotation

Methods

(<>) :: VarAnn -> VarAnn -> VarAnn

sconcat :: NonEmpty VarAnn -> VarAnn

stimes :: Integral b => b -> VarAnn -> VarAnn

Monoid VarAnn

Defined in Morley.Michelson.Untyped.Annotation

Methods

mempty :: VarAnn

mappend :: VarAnn -> VarAnn -> VarAnn

mconcat :: [VarAnn] -> VarAnn

KnownAnnTag VarTag

Defined in Morley.Michelson.Untyped.Annotation

Methods

annPrefix :: Text

Creation and conversions

noAnn :: Annotation a

Empty Annotation, i.e. no annotation

annQ :: QuasiQuoter

>>> :t [annQ||]
... :: forall k (tag :: k). Annotation tag

>>> :t [annQ|abc|]
... :: forall k (tag :: k). Annotation tag

varAnnQ :: QuasiQuoter

>>> :t [varAnnQ||]
... :: VarAnn

>>> :t [varAnnQ|abc|]
... :: VarAnn

fieldAnnQ :: QuasiQuoter

>>> :t [fieldAnnQ||]
... :: FieldAnn

>>> :t [fieldAnnQ|abc|]
... :: FieldAnn

typeAnnQ :: QuasiQuoter

>>> :t [typeAnnQ||]
... :: TypeAnn

>>> :t [typeAnnQ|abc|]
... :: TypeAnn

mkAnnotation :: Text -> Either Text (Annotation a)

Makes an Annotation from its textual value, prefix (%@:) excluded Returns a Text error message if the given Text contains invalid characters

specialVarAnns :: [Text]

List of all the special Variable Annotations, only allowed in CAR and CDR instructions, prefix (@) excluded. These do not respect the rules of isValidAnnStart and isValidAnnBodyChar.

specialFieldAnn :: Text

The only special Field Annotation, only allowed in PAIR, LEFT and RIGHT instructions, prefix (%) excluded. This does not respect the rules of isValidAnnStart and isValidAnnBodyChar.

isValidAnnStart :: Char -> Bool

Checks if a Char is valid to be the first of an annotation, prefix (%@:) excluded, the ones following should be checked with isValidAnnBodyChar instead. Note that this does not check Special Annotations, see specialVarAnns and specialFieldAnn

isValidAnnBodyChar :: Char -> Bool

Checks if a Char is valid to be part of an annotation, following a valid first character (see isValidAnnStart) and the prefix (%@:). Note that this does not check Special Annotations, see specialVarAnns and specialFieldAnn

orAnn :: Annotation t -> Annotation t -> Annotation t

Returns the first annotation if it's not empty, or the second one otherwise.

"a" `orAnn` "b" == "a"
"a" `orAnn` ""  == "a"
""  `orAnn` "b" == "b"
""  `orAnn` ""  == ""

unifyAnn :: Annotation tag -> Annotation tag -> Maybe (Annotation tag)

Given two type or field annotations, attempt to converge them by joining these annotations with the following rule: 1. If either annotation is empty, an empty annotation is returned; 2. If both annotations are equal, return this annotation; 3. Otherwise, returns Nothing.

This function is used primarily for type-checking and attempts to imitate the reference implementation's observed behavior with annotations.

unifyPairFieldAnn :: FieldAnn -> FieldAnn -> Maybe FieldAnn

Given two field annotations where one of them is used in CAR or CDR, attempt to converge them by joining these annotations with the following rule: 1. If either annotation is empty, return the non-empty one (or empty if both are empty); 2. If both annotations are equal, return this annotation; 3. Otherwise, returns Nothing.

This function is used primarily for type-checking and attempts to imitate the reference implementation's observed behavior with field annotations when CAR and CDR are used with pairs.

convergeVarAnns :: VarAnn -> VarAnn -> VarAnn

Keeps an annotation if and only if the two of them are equal and returns an empty annotation otherwise.

ifAnnUnified :: Annotation tag -> Annotation tag -> Bool

convAnn :: Annotation tag1 -> Annotation tag2

Convert annotation from one type to another