Lorentz.Annotation

Type and field annotations for Lorentz types.

Documentation

data AnnOptions

Allow customization of field annotation generated for a type when declaring its HasAnnotation instance.

Constructors

AnnOptions

Fields

• fieldAnnModifier :: Text -> Text

defaultAnnOptions :: AnnOptions

dropPrefixThen :: (Text -> Text) -> Text -> Text

Drops the field name prefix from a field. We assume a convention of the prefix always being lower case, and the first letter of the actual field name being uppercase. It also accepts another function which will be applied directly after dropping the prefix.

appendTo :: Text -> [Text] -> Text -> Text

appendTo suffix fields field appends the given suffix to field if the field exists in the fields list.

toCamel :: Text -> Text

O(n) Convert casing to camelCasedPhrase. Subject to fusion.

toPascal :: Text -> Text

O(n) Convert casing to PascalCasePhrase. Subject to fusion.

toSnake :: Text -> Text

O(n) Convert casing to snake_cased_phrase. Subject to fusion.

ctorNameToAnnWithOptions :: forall ctor. (KnownSymbol ctor, HasCallStack) => AnnOptions -> FieldAnn

data FollowEntrypointFlag

Used in GHasAnnotation and HasAnnotation as a flag to track whether or not it directly follows an entrypoint to avoid introducing extra entrypoints.

Constructors

FollowEntrypoint

NotFollowEntrypoint

data GenerateFieldAnnFlag

Used in GHasAnnotation as a flag to track whether or not field/constructor annotations should be generated.

Constructors

GenerateFieldAnn

NotGenerateFieldAnn

class HasAnnotation a where

This class defines the type and field annotations for a given type. Right now the type annotations come from names in a named field, and field annotations are generated from the record fields.

Minimal complete definition

Nothing

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT a)

default getAnnotation :: (GHasAnnotation (Rep a), GValueType (Rep a) ~ ToT a) => FollowEntrypointFlag -> Notes (ToT a)

annOptions :: AnnOptions

default annOptions :: AnnOptions

Instances

HasAnnotation Bool

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT Bool)

annOptions :: AnnOptions

HasAnnotation Integer

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT Integer)

annOptions :: AnnOptions

HasAnnotation Natural

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT Natural)

annOptions :: AnnOptions

HasAnnotation ()

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT ())

annOptions :: AnnOptions

HasAnnotation ByteString

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT ByteString)

annOptions :: AnnOptions

HasAnnotation MText

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT MText)

annOptions :: AnnOptions

HasAnnotation Operation

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT Operation)

annOptions :: AnnOptions

HasAnnotation EpAddress

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT EpAddress)

annOptions :: AnnOptions

HasAnnotation Address

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT Address)

annOptions :: AnnOptions

HasAnnotation ChainId

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT ChainId)

annOptions :: AnnOptions

HasAnnotation KeyHash

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT KeyHash)

annOptions :: AnnOptions

HasAnnotation Mutez

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT Mutez)

annOptions :: AnnOptions

HasAnnotation PublicKey

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT PublicKey)

annOptions :: AnnOptions

HasAnnotation Signature

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT Signature)

annOptions :: AnnOptions

HasAnnotation Timestamp

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT Timestamp)

annOptions :: AnnOptions

HasAnnotation Empty

Defined in Lorentz.Empty

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT Empty)

annOptions :: AnnOptions

HasAnnotation a => HasAnnotation [a]

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT [a])

annOptions :: AnnOptions

HasAnnotation a => HasAnnotation (Maybe a)

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (Maybe a))

annOptions :: AnnOptions

KnownIsoT v => HasAnnotation (Set v)

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (Set v))

annOptions :: AnnOptions

HasAnnotation a => HasAnnotation (ContractRef a)

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (ContractRef a))

annOptions :: AnnOptions

HasAnnotation (FutureContract a)

Defined in Lorentz.Address

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (FutureContract a))

annOptions :: AnnOptions

HasAnnotation (UParam entries)

Defined in Lorentz.UParam

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (UParam entries))

annOptions :: AnnOptions

(HasAnnotation a, HasAnnotation b) => HasAnnotation (a, b)

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (a, b))

annOptions :: AnnOptions

(HasAnnotation k, HasAnnotation v) => HasAnnotation (Map k v)

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (Map k v))

annOptions :: AnnOptions

(HasAnnotation k, HasAnnotation v) => HasAnnotation (BigMap k v)

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (BigMap k v))

annOptions :: AnnOptions

(HasAnnotation (ZippedStack i), HasAnnotation (ZippedStack o)) => HasAnnotation (i :-> o)

Defined in Lorentz.Zip

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (i :-> o))

annOptions :: AnnOptions

HasAnnotation (TAddress p)

Defined in Lorentz.Address

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (TAddress p))

annOptions :: AnnOptions

(HasAnnotation a, HasAnnotation b) => HasAnnotation (Void_ a b)

Defined in Lorentz.Macro

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (Void_ a b))

annOptions :: AnnOptions

(HasAnnotation a, HasAnnotation r) => HasAnnotation (View a r)

Defined in Lorentz.Macro

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (View a r))

annOptions :: AnnOptions

HasAnnotation (Extensible x)

Defined in Lorentz.Extensible

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (Extensible x))

annOptions :: AnnOptions

(HasAnnotation a, HasAnnotation b, HasAnnotation c) => HasAnnotation (a, b, c)

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (a, b, c))

annOptions :: AnnOptions

(HasAnnotation (Maybe a), KnownSymbol name) => HasAnnotation (NamedF Maybe a name)

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (NamedF Maybe a name))

annOptions :: AnnOptions

(HasAnnotation a, KnownSymbol name) => HasAnnotation (NamedF Identity a name)

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (NamedF Identity a name))

annOptions :: AnnOptions

(HasAnnotation a, HasAnnotation b, HasAnnotation c, HasAnnotation d) => HasAnnotation (a, b, c, d)

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (a, b, c, d))

annOptions :: AnnOptions

(HasAnnotation a, HasAnnotation b, HasAnnotation c, HasAnnotation d, HasAnnotation e) => HasAnnotation (a, b, c, d, e)

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (a, b, c, d, e))

annOptions :: AnnOptions

(HasAnnotation a, HasAnnotation b, HasAnnotation c, HasAnnotation d, HasAnnotation e, HasAnnotation f) => HasAnnotation (a, b, c, d, e, f)

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (a, b, c, d, e, f))

annOptions :: AnnOptions

(HasAnnotation a, HasAnnotation b, HasAnnotation c, HasAnnotation d, HasAnnotation e, HasAnnotation f, HasAnnotation g) => HasAnnotation (a, b, c, d, e, f, g)

Defined in Lorentz.Annotation

Methods

getAnnotation :: FollowEntrypointFlag -> Notes (ToT (a, b, c, d, e, f, g))

annOptions :: AnnOptions

class GHasAnnotation a where

A Generic HasAnnotation implementation

Methods

gGetAnnotation :: AnnOptions -> FollowEntrypointFlag -> GenerateFieldAnnFlag -> (Notes (GValueType a), FieldAnn)

Instances

GHasAnnotation (U1 :: Type -> Type)

Defined in Lorentz.Annotation

Methods

gGetAnnotation :: AnnOptions -> FollowEntrypointFlag -> GenerateFieldAnnFlag -> (Notes (GValueType U1), FieldAnn)

HasAnnotation x => GHasAnnotation (Rec0 x)

Defined in Lorentz.Annotation

Methods

gGetAnnotation :: AnnOptions -> FollowEntrypointFlag -> GenerateFieldAnnFlag -> (Notes (GValueType (Rec0 x)), FieldAnn)

(GHasAnnotation x, GHasAnnotation y) => GHasAnnotation (x :+: y)

Defined in Lorentz.Annotation

Methods

gGetAnnotation :: AnnOptions -> FollowEntrypointFlag -> GenerateFieldAnnFlag -> (Notes (GValueType (x :+: y)), FieldAnn)

(GHasAnnotation x, GHasAnnotation y) => GHasAnnotation (x :*: y)

Defined in Lorentz.Annotation

Methods

gGetAnnotation :: AnnOptions -> FollowEntrypointFlag -> GenerateFieldAnnFlag -> (Notes (GValueType (x :*: y)), FieldAnn)

GHasAnnotation x => GHasAnnotation (M1 D i1 x)

Defined in Lorentz.Annotation

Methods

gGetAnnotation :: AnnOptions -> FollowEntrypointFlag -> GenerateFieldAnnFlag -> (Notes (GValueType (M1 D i1 x)), FieldAnn)

(GHasAnnotation x, KnownSymbol a) => GHasAnnotation (M1 C ('MetaCons a _p _f) x)

Defined in Lorentz.Annotation

Methods

gGetAnnotation :: AnnOptions -> FollowEntrypointFlag -> GenerateFieldAnnFlag -> (Notes (GValueType (M1 C ('MetaCons a _p _f) x)), FieldAnn)

GHasAnnotation x => GHasAnnotation (M1 S ('MetaSel ('Nothing :: Maybe Symbol) b c d) x)

Defined in Lorentz.Annotation

Methods

gGetAnnotation :: AnnOptions -> FollowEntrypointFlag -> GenerateFieldAnnFlag -> (Notes (GValueType (M1 S ('MetaSel 'Nothing b c d) x)), FieldAnn)

(GHasAnnotation x, KnownSymbol a) => GHasAnnotation (M1 S ('MetaSel ('Just a) b c d) x)

Defined in Lorentz.Annotation

Methods

gGetAnnotation :: AnnOptions -> FollowEntrypointFlag -> GenerateFieldAnnFlag -> (Notes (GValueType (M1 S ('MetaSel ('Just a) b c d) x)), FieldAnn)

gGetAnnotationNoField :: forall a. (GHasAnnotation (Rep a), GValueType (Rep a) ~ ToT a) => FollowEntrypointFlag -> Notes (ToT a)

Use this in the instance of HasAnnotation when field annotations should not be generated.

insertTypeAnn :: forall (b :: T). TypeAnn -> Notes b -> Notes b