package archetype

  1. Overview
  2. Docs
Archetype language compiler

Install

Dune Dependency

archetype-lang.org Readme Changelog Edit opam file Versions (47)

Authors

  1. B
    Benoit Rognier <benoit.rognier@edukera.com>
  2. G
    Guillaume Duhamel <guillaume.duhamel@edukera.com>
  3. P
    Pierre-Yves Strub <pierre-yves.strub@polytechnique.edu>

Maintainers

  1. T
    The Archetype development team <archetype-dev@edukera.com>

Sources

1.4.3.tar.gz
md5=056be0abf0b3855e73a7a63264ccfa86
sha512=82a146f1390808f5409ee97b31c4faad39e87eefc77f29f00e2a17fc267394e6d53e8c790e9cdde749d5acc402c53f56f0b595c40285b87d0998fbddbefdaa5d

doc/archetype/Archetype/Ast/index.html

Module Archetype.AstSource

Sourcetype namespace = lident
Sourcetype longident = namespace * lident
Sourceval unloc_longident : longident -> Ident.ident * Ident.ident
Sourceval cmp_longident : longident -> longident -> bool
Sourceval pp_ident : Format.formatter -> string -> unit
Sourceval pp_lident : Format.formatter -> string Location.loced -> unit
Sourcetype container =
  1. | Collection
  2. | Aggregate
  3. | Partition
  4. | AssetContainer
  5. | AssetKey
  6. | AssetValue
  7. | AssetView
Sourcetype currency =
  1. | Utz
Sourcetype vtyp =
  1. | VTunit
  2. | VTbool
  3. | VTnat
  4. | VTint
  5. | VTrational
  6. | VTdate
  7. | VTduration
  8. | VTstring
  9. | VTaddress
  10. | VTcurrency
  11. | VTkey
  12. | VTkeyhash
  13. | VTsignature
  14. | VTbytes
  15. | VTchainid
  16. | VTbls12_381_fr
  17. | VTbls12_381_g1
  18. | VTbls12_381_g2
  19. | VTnever
  20. | VTchest
  21. | VTchest_key
Sourcetype ptyp =
  1. | Tnamed of int
  2. | Tasset of longident
  3. | Trecord of longident
  4. | Tevent of longident
  5. | Tenum of longident
  6. | Tbuiltin of vtyp
  7. | Tcontainer of type_ * container
  8. | Tset of type_
  9. | Tlist of type_
  10. | Tmap of type_ * type_
  11. | Tbig_map of type_ * type_
  12. | Titerable_big_map of type_ * type_
  13. | Tor of type_ * type_
  14. | Tlambda of type_ * type_
  15. | Ttuple of type_ list
  16. | Toption of type_
  17. | Toperation
  18. | Tcontract of type_
  19. | Tticket of type_
  20. | Tsapling_state of int
  21. | Tsapling_transaction of int
Sourceand type_ = ptyp
Sourceval pp_type_ : Ppx_deriving_runtime.Format.formatter -> type_ -> Ppx_deriving_runtime.unit
Sourceval show_type_ : type_ -> Ppx_deriving_runtime.string
Sourcetype logical_operator =
  1. | And
  2. | Or
  3. | Xor
Sourcetype comparison_operator =
  1. | Equal
  2. | Nequal
  3. | Gt
  4. | Ge
  5. | Lt
  6. | Le
Sourceval show_comparison_operator : comparison_operator -> Ppx_deriving_runtime.string
Sourcetype assignment_operator =
  1. | ValueAssign
  2. | PlusAssign
  3. | MinusAssign
  4. | MultAssign
  5. | DivAssign
  6. | AndAssign
  7. | OrAssign
Sourceval show_assignment_operator : assignment_operator -> Ppx_deriving_runtime.string
Sourcetype arithmetic_operator =
  1. | Plus
  2. | Minus
  3. | Mult
  4. | DivRat
  5. | DivEuc
  6. | Modulo
  7. | DivMod
  8. | ThreeWayCmp
  9. | ShiftLeft
  10. | ShiftRight
Sourceval show_arithmetic_operator : arithmetic_operator -> Ppx_deriving_runtime.string
Sourcetype unary_arithmetic_operator =
  1. | Uminus
Sourceval show_unary_arithmetic_operator : unary_arithmetic_operator -> Ppx_deriving_runtime.string
Sourcetype operator = [
  1. | `Logical of logical_operator
  2. | `Cmp of comparison_operator
  3. | `Arith of arithmetic_operator
  4. | `Unary of unary_arithmetic_operator
  5. | `Assign of assignment_operator
]
Sourcetype const =
  1. | Cstate
  2. | Cnow
  3. | Ctransferred
  4. | Ccaller
  5. | Cfail
  6. | Cbalance
  7. | Csource
  8. | Cselfaddress
  9. | Cselfchainid
  10. | Coperations
  11. | Cmetadata
  12. | Clevel
  13. | Cadd
  14. | Cput
  15. | Caddupdate
  16. | Cceil
  17. | Cclear
  18. | Cconcat
  19. | Ccontains
  20. | Ccount
  21. | Cfloor
  22. | Cget
  23. | Cgetopt
  24. | Cisnone
  25. | Cissome
  26. | Cinttonat
  27. | Clength
  28. | Cmax
  29. | Cmin
  30. | Cnth
  31. | Cpack
  32. | Cremove
  33. | Cremoveall
  34. | Cremoveif
  35. | Cselect
  36. | Cslice
  37. | Csort
  38. | Csum
  39. | Cunpack
  40. | Cupdate
  41. | Cupdateall
  42. | Cmakeoperation
  43. | Cmakeevent
  44. | Cnattostring
  45. | Cbytestonat
  46. | Cnattobytes
  47. | Cbytestoint
  48. | Cinttobytes
  49. | Cexec
  50. | Capply
  51. | Cinttodate
  52. | CmutezToNat
  53. | Csetdelegate
  54. | Ckeyhashtocontract
  55. | Csubnat
  56. | Csubmutez
  57. | Cgreedyand
  58. | Cgreedyor
  59. | CmakeAsset
  60. | CtoContainer
  61. | CputRemove
  62. | CgetEntrypoint
  63. | CrequireEntrypoint
  64. | CcallView
  65. | CimportCallView
  66. | CselfCallView
  67. | Csimplifyrational
  68. | Cgetnumerator
  69. | Cgetdenominator
  70. | Cglobalconstant
  71. | Cexphorner
  72. | Csadd
  73. | Csremove
  74. | Csupdate
  75. | Cscontains
  76. | Cslength
  77. | Chead
  78. | Ctail
  79. | Cabs
  80. | Cprepend
  81. | Creverse
  82. | Cmput
  83. | Cmremove
  84. | Cmupdate
  85. | Cmget
  86. | Cmgetopt
  87. | Cmcontains
  88. | Cmlength
  89. | Cblake2b
  90. | Csha256
  91. | Csha512
  92. | Csha3
  93. | Ckeccak
  94. | Cchecksignature
  95. | Ckeytokeyhash
  96. | Ccontracttoaddress
  97. | Caddresstocontract
  98. | Ckeytoaddress
  99. | Cisimplicitaddress
  100. | Ctotalvotingpower
  101. | Cvotingpower
  102. | Cminblocktime
  103. | Ccreateticket
  104. | Creadticket
  105. | Csplitticket
  106. | Cjointickets
  107. | Csapling_empty_state
  108. | Csapling_verify_update
  109. | Cpairing_check
  110. | Copen_chest
  111. | Cemit
Sourcetype 'node struct_poly = {
  1. node : 'node;
  2. type_ : type_ option;
  3. label : Ident.ident option;
  4. loc : Location.t;
}
Sourceand qualid_node =
  1. | Qident of lident
  2. | Qdot of qualid * lident
Sourceand sexpr_node =
  1. | Sref of lident
  2. | Sor of sexpr * sexpr
  3. | Sany
Sourceand bval_node =
  1. | BVint of Core.big_int
  2. | BVnat of Core.big_int
  3. | BVbool of bool
  4. | BVrational of Core.big_int * Core.big_int
  5. | BVdate of Core.date
  6. | BVstring of string
  7. | BVcurrency of currency * Core.big_int
  8. | BVaddress of string
  9. | BVduration of Core.duration
  10. | BVbytes of string
  11. | BVunit
  12. | BVbls12_381_num_fr of Core.big_int
  13. | BVbls12_381_byt_fr of string
  14. | BVbls12_381_g1 of string
  15. | BVbls12_381_g2 of string
Sourceand pattern_node =
  1. | Mwild
  2. | Mconst of lident * lident list
Sourcetype call_kind =
  1. | Cid of longident
  2. | Cconst of const
Sourcetype michelson_struct = {
  1. ms_content : Michelson.obj_micheline;
}
Sourceand pterm_node =
  1. | Pif of pterm * pterm * pterm
  2. | Pmatchwith of pterm * (pattern * pterm) list
  3. | Pmatchoption of pterm * lident * pterm * pterm
  4. | Pmatchor of pterm * lident * pterm * lident * pterm
  5. | Pmatchlist of pterm * lident * lident * pterm * pterm
  6. | Pfold of pterm * lident * pterm
  7. | Pmap of pterm * lident * pterm
  8. | Pcall of pterm option * call_kind * type_ list * pterm_arg list
  9. | Plogical of logical_operator * pterm * pterm
  10. | Pnot of pterm
  11. | Pmulticomp of pterm * (comparison_operator * pterm) list
  12. | Pcomp of comparison_operator * pterm * pterm
  13. | Parith of arithmetic_operator * pterm * pterm
  14. | Puarith of unary_arithmetic_operator * pterm
  15. | Precord of pterm list
  16. | Precupdate of pterm * (lident * pterm) list
  17. | Pletin of lident * pterm * type_ option * pterm * pterm option
  18. | Pdeclvar of lident * type_ option * pterm * bool
  19. | Pvar of longident
  20. | Parray of pterm list
  21. | Plit of bval
  22. | Pdot of pterm * lident
  23. | Pquestiondot of pterm * lident
  24. | Pconst of const
  25. | Ptuple of pterm list
  26. | Ptupleaccess of pterm * Core.big_int
  27. | Pnone
  28. | Psome of pterm
  29. | Pleft of type_ * pterm
  30. | Pright of type_ * pterm
  31. | Plambda of type_ * lident * type_ * pterm
  32. | Plambda_michelson of type_ * type_ * Michelson.obj_micheline
  33. | Pcast of type_ * type_ * pterm
  34. | Pself of lident
  35. | Pternary of pterm * pterm * pterm
  36. | Pcreatecontract of pterm * pterm * create_contract_type
  37. | Ptz_expr of string
  38. | Pmicheline_expr of type_ * Michelson.obj_micheline * pterm list
Sourceand pterm_arg =
  1. | AExpr of pterm
  2. | AFun of lident * type_ * (lident * type_ * pterm) list * pterm
  3. | AEffect of (lident * operator * pterm) list
  4. | ASorting of bool * lident
  5. | AIdent of lident
Sourceand create_contract_type =
  1. | CCTz of michelson_struct * pterm
  2. | CCArl of Ident.ident * (Ident.ident * pterm) list
Sourceval show_create_contract_type : create_contract_type -> Ppx_deriving_runtime.string
Sourcetype instruction = {
  1. node : instruction_node;
  2. label : string option;
  3. loc : Location.t;
}
Sourceand transfer_t =
  1. | TTsimple of pterm * pterm
  2. | TTcontract of pterm * pterm * lident * type_ * pterm
  3. | TTentry of pterm * pterm * pterm
  4. | TTgen of pterm * Ident.ident * Ident.ident * type_ * pterm * pterm
  5. | TTself of pterm * lident * (lident * pterm) list
  6. | TToperation of pterm
Sourceand detach_kind =
  1. | DK_option of type_ * Ident.ident
  2. | DK_map of type_ * Ident.ident * pterm
Sourceand instruction_node =
  1. | Iif of pterm * instruction * instruction
  2. | Ifor of for_ident * pterm * instruction
  3. | Iiter of lident * pterm * pterm * instruction
  4. | Iwhile of pterm * instruction
  5. | Iletin of lident * pterm * instruction
  6. | Ideclvar of lident * pterm * bool
  7. | Ideclvaropt of lident * pterm * pterm option * bool
  8. | Iseq of instruction list
  9. | Imatchwith of pterm * (pattern * instruction) list
  10. | Imatchoption of pterm * lident * instruction * instruction
  11. | Imatchor of pterm * lident * instruction * lident * instruction
  12. | Imatchlist of pterm * lident * lident * instruction * instruction
  13. | Iassign of assignment_operator * type_ * lvalue * pterm * pterm option
  14. | Irequire of bool * pterm * pterm
  15. | Itransfer of transfer_t
  16. | Iemit of longident * pterm
  17. | Icall of pterm option * call_kind * pterm_arg list
  18. | Ireturn of pterm
  19. | Ifail of pterm
  20. | Ifailsome of pterm
  21. | Idetach of lident * detach_kind * type_ * pterm
  22. | Imicheline of Michelson.obj_micheline
Sourceand for_ident =
  1. | FIsimple of lident
  2. | FIdouble of lident * lident
Sourceand lvalue = [
  1. | `Var of lident
  2. | `Field of longident * pterm * lident
  3. | `Asset of longident * pterm * lident
  4. | `Tuple of pterm * int * int
]
Sourcetype 'a decl_gen = {
  1. name : 'a;
  2. typ : type_ option;
  3. default : pterm option;
  4. shadow : bool;
  5. loc : Location.t;
}
Sourcetype label_term = {
  1. label : lident option;
  2. term : pterm;
  3. error : pterm option;
  4. loc : Location.t;
}
Sourcetype variable_kind =
  1. | VKconstant
  2. | VKvariable
Sourcetype variable = {
  1. decl : longident decl_gen;
  2. kind : variable_kind;
  3. loc : Location.t;
}
Sourcetype parameter = {
  1. name : lident;
  2. typ : type_;
  3. default : pterm option;
  4. value : pterm option;
  5. const : bool;
  6. loc : Location.t;
}
Sourcetype entry_description =
  1. | ADAny
  2. | ADOp of string * lident
Sourceval pp_entry_description : Ppx_deriving_runtime.Format.formatter -> entry_description -> Ppx_deriving_runtime.unit
Sourceval show_entry_description : entry_description -> Ppx_deriving_runtime.string
Sourcetype security_role = lident
Sourcetype security_entry =
  1. | Sany
  2. | Sentry of lident list
Sourceval pp_security_entry : Ppx_deriving_runtime.Format.formatter -> security_entry -> Ppx_deriving_runtime.unit
Sourceval show_security_entry : security_entry -> Ppx_deriving_runtime.string
Sourcetype view_visibility =
  1. | VVonchain
  2. | VVonoffchain
  3. | VVoffchain
Sourcetype fun_kind =
  1. | FKfunction
  2. | FKview of view_visibility
Sourcetype returned_fun_type =
  1. | Typed of ptyp
  2. | Void
Sourcetype function_ = {
  1. name : longident;
  2. kind : fun_kind;
  3. args : lident decl_gen list;
  4. body : instruction;
  5. return : returned_fun_type;
  6. side_effect : bool;
  7. storage_usage : bool;
  8. loc : Location.t;
}
Sourceval pp_function_ : Ppx_deriving_runtime.Format.formatter -> function_ -> Ppx_deriving_runtime.unit
Sourceval show_function_ : function_ -> Ppx_deriving_runtime.string
Sourceand rexpr_node =
  1. | Rany
  2. | Rasset of longident
  3. | Rexpr of pterm
  4. | Ror of rexpr * rexpr
Sourcetype transition = {
  1. from : sexpr;
  2. trs : (lident * pterm option * instruction option) list;
}
Sourcetype tr_kind =
  1. | Entry
  2. | Getter of ptyp
Sourcetype transaction = {
  1. kind : tr_kind;
  2. name : lident;
  3. args : lident decl_gen list;
  4. sourcedby : (rexpr * pterm option) option;
  5. calledby : (rexpr * pterm option) option;
  6. state_is : (lident * pterm option) option;
  7. accept_transfer : bool * pterm option;
  8. constants : label_term list option;
  9. require : label_term list option;
  10. failif : label_term list option;
  11. transition : transition option;
  12. functions : function_ list;
  13. effect : instruction option;
  14. loc : Location.t;
}
Sourcetype enum_item_struct = {
  1. name : lident;
  2. initial : bool;
  3. invariants : label_term list;
  4. args : ptyp list;
  5. loc : Location.t;
}
Sourcetype enum_kind =
  1. | EKenum of longident
  2. | EKstate of namespace
Sourcetype enum = {
  1. kind : enum_kind;
  2. items : enum_item_struct list;
  3. loc : Location.t;
}
Sourcetype map_kind =
  1. | MKMap
  2. | MKBigMap
  3. | MKIterableBigMap
Sourcetype asset = {
  1. name : longident;
  2. fields : lident decl_gen list;
  3. keys : lident list;
  4. sort : lident list;
  5. map_kind : map_kind;
  6. init : pterm list list;
  7. specs : label_term list;
  8. loc : Location.t;
}
Sourcetype position =
  1. | Pleaf of lident
  2. | Pnode of position list
Sourcetype record = {
  1. name : longident;
  2. fields : lident decl_gen list;
  3. pos : position;
  4. loc : Location.t;
}
Sourcetype decl_ =
  1. | Dvariable of variable
  2. | Dasset of asset
  3. | Drecord of record
  4. | Denum of enum
  5. | Devent of record
Sourceval pp_decl_ : Ppx_deriving_runtime.Format.formatter -> decl_ -> Ppx_deriving_runtime.unit
Sourceval show_decl_ : decl_ -> Ppx_deriving_runtime.string
Sourcetype fun_ =
  1. | Ffunction of function_
  2. | Ftransaction of transaction
Sourceval pp_fun_ : Ppx_deriving_runtime.Format.formatter -> fun_ -> Ppx_deriving_runtime.unit
Sourceval show_fun_ : fun_ -> Ppx_deriving_runtime.string
Sourcetype metadata_kind =
  1. | MKuri of string Location.loced
  2. | MKjson of string Location.loced
Sourcetype import_kind_node =
  1. | INMichelson of michelson_struct
  2. | INArchetype
Sourcetype ast = {
  1. name : lident;
  2. parameters : parameter list;
  3. metadata : metadata_kind option;
  4. decls : decl_ list;
  5. funs : fun_ list;
  6. loc : Location.t;
}
Sourceval vtaddress : ptyp
Sourceval vtbls12_381_fr : ptyp
Sourceval vtbls12_381_g1 : ptyp
Sourceval vtbls12_381_g2 : ptyp
Sourceval vtbool : ptyp
Sourceval vtbytes : ptyp
Sourceval vtchainid : ptyp
Sourceval vtcurrency : ptyp
Sourceval vtdate : ptyp
Sourceval vtduration : ptyp
Sourceval vtint : ptyp
Sourceval vtkey : ptyp
Sourceval vtkeyhash : ptyp
Sourceval vtnat : ptyp
Sourceval vtrational : ptyp
Sourceval vtsignature : ptyp
Sourceval vtstring : ptyp
Sourceval vtunit : ptyp
Sourceval vtnever : ptyp
Sourceval vtchest : ptyp
Sourceval vtchest_key : ptyp
Sourceval vts : ptyp list
Sourceval mk_sp : ?label:Ident.ident -> ?loc:Location.t -> ?type_:type_ -> 'a -> 'a struct_poly
Sourceval mk_instr : ?label:string -> ?loc:Location.t -> instruction_node -> instruction
Sourceval mk_label_term : ?label:lident -> ?error:pterm -> ?loc:Location.t -> pterm -> label_term
Sourceval mk_variable : ?loc:Location.t -> longident decl_gen -> variable_kind -> variable
Sourceval mk_function_struct : ?args:lident decl_gen list -> ?loc:Location.t -> longident -> fun_kind -> instruction -> returned_fun_type -> bool -> bool -> function_
Sourceval mk_transition : ?trs:(lident * pterm option * instruction option) list -> sexpr -> transition
Sourceval mk_transaction_struct : ?args:lident decl_gen list -> ?sourcedby:(rexpr * pterm option) -> ?calledby:(rexpr * pterm option) -> ?state_is:(lident * pterm option) -> ?accept_transfer:(bool * pterm option) -> ?constants:label_term list -> ?require:label_term list -> ?failif:label_term list -> ?transition:transition -> ?functions:function_ list -> ?effect:instruction -> ?loc:Location.t -> tr_kind -> lident -> transaction
Sourceval mk_enum_item : ?initial:bool -> ?args:ptyp list -> ?invariants:label_term list -> ?loc:Location.t -> lident -> enum_item_struct
Sourceval mk_enum : ?items:enum_item_struct list -> ?loc:Location.t -> enum_kind -> enum
Sourceval mk_decl : ?typ:type_ -> ?default:pterm -> ?shadow:bool -> ?loc:Location.t -> 'a -> 'a decl_gen
Sourceval mk_asset : ?fields:lident decl_gen list -> ?keys:lident list -> ?sort:lident list -> ?map_kind:map_kind -> ?init:pterm list list -> ?specs:label_term list -> ?loc:Location.t -> longident -> asset
Sourceval mk_model : ?parameters:parameter list -> ?metadata:metadata_kind -> ?decls:decl_ list -> ?funs:fun_ list -> ?loc:Location.t -> lident -> ast
Sourceval mk_id : type_ -> lident -> qualid
Sourceval map_ptyp : (type_ -> type_) -> ptyp -> ptyp
Sourcemodule Utils : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct