Safe Haskell	None
Language	Haskell2010

Lorentz.EntryPoints.Doc

Description

Utilities for declaring and documenting entry points.

Synopsis

data DEntryPoint (kind :: Type) = DEntryPoint {
- depName :: Text
- depSub :: SubDoc
}
class EntryArrow kind name body where
- (#->) :: (Label name, Proxy kind) -> body -> body
data PlainEntryPointsKind
diEntryPointToMarkdown :: HeaderLevel -> DEntryPoint level -> Markdown
data DEntryPointArg = DEntryPointArg {
- epaArg :: Maybe DType
- epaHasAnnotation :: Bool
- epaBuilding :: [ParamBuildingStep]
- epaType :: Type
}
data DType where
- DType :: TypeHasDoc a => Proxy a -> DType
class KnownSymbol con => DeriveCtorFieldDoc con (cf :: CtorField) where
- deriveCtorFieldDoc :: DEntryPointArg
data ParamBuildingStep = ParamBuildingStep {
- pbsEnglish :: Markdown
- pbsHaskell :: CurrentParam -> Markdown
- pbsMichelson :: CurrentParam -> Markdown
}
clarifyParamBuildingSteps :: ParamBuildingStep -> (inp :-> out) -> inp :-> out
constructDEpArg :: forall arg. (TypeHasDoc arg, HasTypeAnn arg, KnownValue arg) => Bool -> DEntryPointArg
emptyDEpArg :: Bool -> DEntryPointArg
mkUType :: Sing x -> Notes x -> Type
mkDEpUType :: forall t. (KnownValue t, HasTypeAnn t) => Type
mkDEntryPointArgSimple :: forall t. (KnownValue t, HasTypeAnn t, TypeHasDoc t) => DEntryPointArg
type DocumentEntryPoints kind a = (Generic a, GDocumentEntryPoints kind (Rep a))
documentEntryPoint :: forall kind epName param s out. (KnownSymbol epName, DocItem (DEntryPoint kind), TypeHasDoc param, HasTypeAnn param, KnownValue param) => ((param & s) :-> out) -> (param & s) :-> out
entryCase :: forall dt entryPointKind out inp clauses. (CaseTC dt out inp clauses, DocumentEntryPoints entryPointKind dt) => Proxy entryPointKind -> IsoRecTuple clauses -> (dt & inp) :-> out
entryCase_ :: forall dt entryPointKind out inp. (InstrCaseC dt inp out, RMap (CaseClauses dt), DocumentEntryPoints entryPointKind dt) => Proxy entryPointKind -> Rec (CaseClauseL inp out) (CaseClauses dt) -> (dt & inp) :-> out

Documentation

data DEntryPoint (kind :: Type) Source #

Gathers information about single entrypoint.

We assume that entry points might be of different kinds, which is designated by phantom type parameter. For instance, you may want to have several groups of entry points corresponding to various parts of a contract - specifying different kind type argument for each of those groups will allow you defining different DocItem instances with appropriate custom descriptions for them.

Constructors

DEntryPoint
Fields depName :: Text depSub :: SubDoc

Instances

DocItem (DEntryPoint PlainEntryPointsKind) Source #
Instance details Defined in Lorentz.EntryPoints.Doc Associated Types type DocItemPosition (DEntryPoint PlainEntryPointsKind) = (pos :: Nat) Source # type DocItemPlacement (DEntryPoint PlainEntryPointsKind) :: DocItemPlacementKind Source # Methods docItemSectionName :: Maybe Text Source # docItemSectionDescription :: Maybe Markdown Source # docItemSectionNameStyle :: DocSectionNameStyle Source # docItemRef :: DEntryPoint PlainEntryPointsKind -> DocItemRef (DocItemPlacement (DEntryPoint PlainEntryPointsKind)) Source # docItemToMarkdown :: HeaderLevel -> DEntryPoint PlainEntryPointsKind -> Markdown Source # docItemDependencies :: DEntryPoint PlainEntryPointsKind -> [SomeDocDefinitionItem] Source # docItemsOrder :: [DEntryPoint PlainEntryPointsKind] -> [DEntryPoint PlainEntryPointsKind] Source #
type DocItemPosition (DEntryPoint PlainEntryPointsKind) Source #
Instance details Defined in Lorentz.EntryPoints.Doc type DocItemPosition (DEntryPoint PlainEntryPointsKind) = 1000
type DocItemPlacement (DEntryPoint PlainEntryPointsKind) Source #
Instance details Defined in Lorentz.EntryPoints.Doc type DocItemPlacement (DEntryPoint PlainEntryPointsKind) = DocItemInlined

class EntryArrow kind name body where Source #

Provides arror for convenient entrypoint documentation

Methods

(#->) :: (Label name, Proxy kind) -> body -> body Source #

Lift entrypoint implementation.

Entrypoint names should go with "e" prefix.

Instances

(name ~ AppendSymbol "e" epName, body ~ ((param & s) :-> out), KnownSymbol epName, DocItem (DEntryPoint kind), TypeHasDoc param, HasTypeAnn param, KnownValue param) => EntryArrow (kind :: Type) name body Source #
Instance details Defined in Lorentz.EntryPoints.Doc Methods (#->) :: (Label name, Proxy kind) -> body -> body Source #

data PlainEntryPointsKind Source #

Default value for DEntryPoint type argument.

Instances

DocItem (DEntryPoint PlainEntryPointsKind) Source #
Instance details Defined in Lorentz.EntryPoints.Doc Associated Types type DocItemPosition (DEntryPoint PlainEntryPointsKind) = (pos :: Nat) Source # type DocItemPlacement (DEntryPoint PlainEntryPointsKind) :: DocItemPlacementKind Source # Methods docItemSectionName :: Maybe Text Source # docItemSectionDescription :: Maybe Markdown Source # docItemSectionNameStyle :: DocSectionNameStyle Source # docItemRef :: DEntryPoint PlainEntryPointsKind -> DocItemRef (DocItemPlacement (DEntryPoint PlainEntryPointsKind)) Source # docItemToMarkdown :: HeaderLevel -> DEntryPoint PlainEntryPointsKind -> Markdown Source # docItemDependencies :: DEntryPoint PlainEntryPointsKind -> [SomeDocDefinitionItem] Source # docItemsOrder :: [DEntryPoint PlainEntryPointsKind] -> [DEntryPoint PlainEntryPointsKind] Source #
type DocItemPosition (DEntryPoint PlainEntryPointsKind) Source #
Instance details Defined in Lorentz.EntryPoints.Doc type DocItemPosition (DEntryPoint PlainEntryPointsKind) = 1000
type DocItemPlacement (DEntryPoint PlainEntryPointsKind) Source #
Instance details Defined in Lorentz.EntryPoints.Doc type DocItemPlacement (DEntryPoint PlainEntryPointsKind) = DocItemInlined

diEntryPointToMarkdown :: HeaderLevel -> DEntryPoint level -> Markdown Source #

Default implementation of docItemToMarkdown for entry points.

data DEntryPointArg Source #

Describes argument of an entrypoint.

Constructors

DEntryPointArg

Fields

epaArg :: Maybe DType
Argument of the entrypoint. Pass Nothing if no argument is required.
epaHasAnnotation :: Bool
Whether this entrypoint has a field annotation (and thus is callable using the standard "lightweigth entrypoints" mechanism) or is a virtual entrypoint which requires constructing a value of the full parameter type.
epaBuilding :: [ParamBuildingStep]
Describes a way to lift an entrypoint argument into full parameter which can be passed to the contract.
Steps are supposed to be applied in the order in which they are given. E.g. suppose that an entrypoint is called as Run (Service1 arg); then the first step should describe wrapping into Service1 constructor, and the second step should be about wrapping into Run constructor.
epaType :: Type
Untyped representation of entrypoint, used for printing its michelson type representation.

Instances

DocItem DEntryPointArg Source #
Instance details Defined in Lorentz.EntryPoints.Doc Associated Types type DocItemPosition DEntryPointArg = (pos :: Nat) Source # type DocItemPlacement DEntryPointArg :: DocItemPlacementKind Source # Methods docItemSectionName :: Maybe Text Source # docItemSectionDescription :: Maybe Markdown Source # docItemSectionNameStyle :: DocSectionNameStyle Source # docItemRef :: DEntryPointArg -> DocItemRef (DocItemPlacement DEntryPointArg) Source # docItemToMarkdown :: HeaderLevel -> DEntryPointArg -> Markdown Source # docItemDependencies :: DEntryPointArg -> [SomeDocDefinitionItem] Source # docItemsOrder :: [DEntryPointArg] -> [DEntryPointArg] Source #
type DocItemPosition DEntryPointArg Source #
Instance details Defined in Lorentz.EntryPoints.Doc type DocItemPosition DEntryPointArg = 20
type DocItemPlacement DEntryPointArg Source #
Instance details Defined in Lorentz.EntryPoints.Doc type DocItemPlacement DEntryPointArg = DocItemInlined

data DType where Source #

Doc element with description of a type.

Constructors

DType :: TypeHasDoc a => Proxy a -> DType

Instances

Eq DType Source #
Instance details Defined in Michelson.Typed.Haskell.Doc Methods (==) :: DType -> DType -> Bool # (/=) :: DType -> DType -> Bool #
Ord DType Source #
Instance details Defined in Michelson.Typed.Haskell.Doc Methods compare :: DType -> DType -> Ordering # (<) :: DType -> DType -> Bool # (<=) :: DType -> DType -> Bool # (>) :: DType -> DType -> Bool # (>=) :: DType -> DType -> Bool # max :: DType -> DType -> DType # min :: DType -> DType -> DType #
Show DType Source #
Instance details Defined in Michelson.Typed.Haskell.Doc Methods showsPrec :: Int -> DType -> ShowS # show :: DType -> String # showList :: [DType] -> ShowS #
DocItem DType Source #
Instance details Defined in Michelson.Typed.Haskell.Doc Associated Types type DocItemPosition DType = (pos :: Nat) Source # type DocItemPlacement DType :: DocItemPlacementKind Source # Methods docItemSectionName :: Maybe Text Source # docItemSectionDescription :: Maybe Markdown Source # docItemSectionNameStyle :: DocSectionNameStyle Source # docItemRef :: DType -> DocItemRef (DocItemPlacement DType) Source # docItemToMarkdown :: HeaderLevel -> DType -> Markdown Source # docItemDependencies :: DType -> [SomeDocDefinitionItem] Source # docItemsOrder :: [DType] -> [DType] Source #
type DocItemPosition DType Source #
Instance details Defined in Michelson.Typed.Haskell.Doc type DocItemPosition DType = 5000
type DocItemPlacement DType Source #
Instance details Defined in Michelson.Typed.Haskell.Doc type DocItemPlacement DType = DocItemInDefinitions

class KnownSymbol con => DeriveCtorFieldDoc con (cf :: CtorField) where Source #

Pick a type documentation from CtorField.

Methods

deriveCtorFieldDoc :: DEntryPointArg Source #

Instances

KnownSymbol con => DeriveCtorFieldDoc con NoFields Source #
Instance details Defined in Lorentz.EntryPoints.Doc Methods deriveCtorFieldDoc :: DEntryPointArg Source #
(TypeHasDoc ty, HasTypeAnn ty, KnownValue ty, KnownSymbol con) => DeriveCtorFieldDoc con (OneField ty) Source #
Instance details Defined in Lorentz.EntryPoints.Doc Methods deriveCtorFieldDoc :: DEntryPointArg Source #

data ParamBuildingStep Source #

Describes a parameter building step.

This can be wrapping into (Haskell) constructor, or a more complex transformation.

Constructors

ParamBuildingStep
Fields pbsEnglish :: Markdown Plain english description of this step. pbsHaskell :: CurrentParam -> Markdown How to construct parameter in Haskell code. pbsMichelson :: CurrentParam -> Markdown How to construct parameter working on raw Michelson.

clarifyParamBuildingSteps :: ParamBuildingStep -> (inp :-> out) -> inp :-> out Source #

Go over contract code and update every occurrence of DEntryPointArg documentation item, adding the given step to its "how to build parameter" description.

constructDEpArg :: forall arg. (TypeHasDoc arg, HasTypeAnn arg, KnownValue arg) => Bool -> DEntryPointArg Source #

emptyDEpArg :: Bool -> DEntryPointArg Source #

mkUType :: Sing x -> Notes x -> Type Source #

mkDEpUType :: forall t. (KnownValue t, HasTypeAnn t) => Type Source #

mkDEntryPointArgSimple :: forall t. (KnownValue t, HasTypeAnn t, TypeHasDoc t) => DEntryPointArg Source #

type DocumentEntryPoints kind a = (Generic a, GDocumentEntryPoints kind (Rep a)) Source #

Constraint for documentEntryPoints.

documentEntryPoint :: forall kind epName param s out. (KnownSymbol epName, DocItem (DEntryPoint kind), TypeHasDoc param, HasTypeAnn param, KnownValue param) => ((param & s) :-> out) -> (param & s) :-> out Source #

Wrapper for documenting single entrypoint which parameter isn't going to be unwrapped from some datatype.

entryCase unwraps a datatype, however, sometimes we want to have entrypoint parameter to be not wrapped into some datatype.

entryCase :: forall dt entryPointKind out inp clauses. (CaseTC dt out inp clauses, DocumentEntryPoints entryPointKind dt) => Proxy entryPointKind -> IsoRecTuple clauses -> (dt & inp) :-> out Source #

Version of entryCase_ for tuples.

entryCase_ :: forall dt entryPointKind out inp. (InstrCaseC dt inp out, RMap (CaseClauses dt), DocumentEntryPoints entryPointKind dt) => Proxy entryPointKind -> Rec (CaseClauseL inp out) (CaseClauses dt) -> (dt & inp) :-> out Source #

Like case_, to be used for pattern-matching on parameter.

Modifies documentation accordingly. Including description of entrypoints' arguments, thus for them you will need to supply TypeHasDoc instance.