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

AnnotationUnsafe

Fields

• unAnnotation :: Text

Instances

Semigroup VarAnn

Defined in Michelson.Untyped.Annotation

Methods

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

sconcat :: NonEmpty VarAnn -> VarAnn

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

Monoid VarAnn

Defined in Michelson.Untyped.Annotation

Methods

mempty :: VarAnn

mappend :: VarAnn -> VarAnn -> VarAnn

mconcat :: [VarAnn] -> VarAnn

Functor (Annotation :: Type -> Type)

Defined in Michelson.Untyped.Annotation

Methods

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

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

Eq (Annotation tag)

Defined in Michelson.Untyped.Annotation

Methods

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

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

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

Defined in 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)

KnownAnnTag tag => Show (Annotation tag)

Defined in Michelson.Untyped.Annotation

Methods

showsPrec :: Int -> Annotation tag -> ShowS

show :: Annotation tag -> String

showList :: [Annotation tag] -> ShowS

IsString (Annotation tag)

Defined in Michelson.Untyped.Annotation

Methods

fromString :: String -> Annotation tag

Generic (Annotation tag)

Defined in 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

Lift (Annotation tag)

Defined in Michelson.Untyped.Annotation

Methods

lift :: Annotation tag -> Q Exp

ToJSON (Annotation tag)

Defined in 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 Michelson.Untyped.Annotation

Methods

parseJSON :: Value -> Parser (Annotation tag)

parseJSONList :: Value -> Parser [Annotation tag]

NFData (Annotation tag)

Defined in Michelson.Untyped.Annotation

Methods

rnf :: Annotation tag -> ()

Default (Annotation tag)

Defined in Michelson.Untyped.Annotation

Methods

def :: Annotation tag

KnownAnnTag tag => Buildable (Annotation tag)

Defined in Michelson.Untyped.Annotation

Methods

build :: Annotation tag -> Builder

KnownAnnTag tag => RenderDoc (Annotation tag)

Defined in Michelson.Untyped.Annotation

Methods

renderDoc :: RenderContext -> Annotation tag -> Doc

isRenderable :: Annotation tag -> Bool

type Rep (Annotation tag)

Defined in Michelson.Untyped.Annotation

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

pattern Annotation :: Text -> Annotation tag

pattern WithAnn :: Annotation tag -> Annotation tag

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 ann, they are omitted - if one or more noAnn precede a non-empty ann, they are kept - every non-empty ann is obviously kept This is why order for each group is important as well as separation of different groups of Annotations.

Instances

Eq AnnotationSet

Defined in Michelson.Untyped.Annotation

Methods

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

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

Show AnnotationSet

Defined in Michelson.Untyped.Annotation

Methods

showsPrec :: Int -> AnnotationSet -> ShowS

show :: AnnotationSet -> String

showList :: [AnnotationSet] -> ShowS

Semigroup AnnotationSet

Defined in Michelson.Untyped.Annotation

Methods

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

sconcat :: NonEmpty AnnotationSet -> AnnotationSet

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

Monoid AnnotationSet

Defined in Michelson.Untyped.Annotation

Methods

mempty :: AnnotationSet

mappend :: AnnotationSet -> AnnotationSet -> AnnotationSet

mconcat :: [AnnotationSet] -> AnnotationSet

Buildable AnnotationSet

Defined in Michelson.Untyped.Annotation

Methods

build :: AnnotationSet -> Builder

RenderDoc AnnotationSet

Defined in Michelson.Untyped.Annotation

Methods

renderDoc :: RenderContext -> AnnotationSet -> Doc

isRenderable :: AnnotationSet -> Bool

emptyAnnSet :: AnnotationSet

An AnnotationSet without any Annotation.

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.

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.

Rendering

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

Methods

annPrefix :: Text

Instances

KnownAnnTag VarTag

Defined in Michelson.Untyped.Annotation

Methods

annPrefix :: Text

KnownAnnTag FieldTag

Defined in Michelson.Untyped.Annotation

Methods

annPrefix :: Text

KnownAnnTag TypeTag

Defined in Michelson.Untyped.Annotation

Methods

annPrefix :: Text

type TypeAnn = Annotation TypeTag

type FieldAnn = Annotation FieldTag

type VarAnn = Annotation VarTag

type SomeAnn = Annotation SomeTag

type RootAnn = Annotation FieldTag

Field annotation for the entire parameter.

data TypeTag

Instances

KnownAnnTag TypeTag

Defined in Michelson.Untyped.Annotation

Methods

annPrefix :: Text

data FieldTag

Instances

KnownAnnTag FieldTag

Defined in Michelson.Untyped.Annotation

Methods

annPrefix :: Text

data VarTag

Instances

Semigroup VarAnn

Defined in Michelson.Untyped.Annotation

Methods

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

sconcat :: NonEmpty VarAnn -> VarAnn

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

Monoid VarAnn

Defined in Michelson.Untyped.Annotation

Methods

mempty :: VarAnn

mappend :: VarAnn -> VarAnn -> VarAnn

mconcat :: [VarAnn] -> VarAnn

KnownAnnTag VarTag

Defined in Michelson.Untyped.Annotation

Methods

annPrefix :: Text

Creation and conversions

noAnn :: Annotation a

ann :: HasCallStack => Text -> Annotation a

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

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

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

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

disjoinVn :: VarAnn -> (VarAnn, VarAnn)

convAnn :: Annotation tag1 -> Annotation tag2