package archetype

  1. Overview
  2. Docs
module L = Location
module PT = ParseTree
module M = Ast
module Type : sig ... end
type opsig = {
  1. osl_sig : M.ptyp list;
  2. osl_ret : M.ptyp;
}
type error_desc =
  1. | AlienPattern
  2. | AssetExpected
  3. | AssetWithoutFields
  4. | BeforeMeaningless
  5. | BindingInExpr
  6. | CannotInferAnonRecord
  7. | CannotInferCollectionType
  8. | CollectionExpected
  9. | DivergentExpr
  10. | DuplicatedContractEntryName of Ident.ident
  11. | DuplicatedCtorName of Ident.ident
  12. | DuplicatedFieldInAssetDecl of Ident.ident
  13. | DuplicatedFieldInRecordLiteral of Ident.ident
  14. | DuplicatedInitMarkForCtor
  15. | DuplicatedPKey
  16. | DuplicatedVarDecl of Ident.ident
  17. | AnonymousFieldInEffect
  18. | EmptyEnumDecl
  19. | ExpressionExpected
  20. | ForeignState of Ident.ident option * Ident.ident option
  21. | FormulaExpected
  22. | IncompatibleTypes of M.ptyp * M.ptyp
  23. | InvalidActionDescription
  24. | InvalidActionExpression
  25. | InvalidArcheTypeDecl
  26. | InvalidAssetCollectionExpr of M.ptyp
  27. | InvalidAssetExpression
  28. | InvalidCallByExpression
  29. | InvalidExpressionForEffect
  30. | InvalidExpression
  31. | InvalidFieldsCountInRecordLiteral
  32. | InvalidLValue
  33. | InvalidFormula
  34. | InvalidInstruction
  35. | InvalidNumberOfArguments of int * int
  36. | InvalidRoleExpression
  37. | InvalidSecurityAction
  38. | InvalidSecurityRole
  39. | InvalidSortingExpression
  40. | InvalidStateExpression
  41. | InvalidTypeForVarWithFromTo
  42. | LetInElseInInstruction
  43. | LetInElseOnNonOption
  44. | MissingFieldInRecordLiteral of Ident.ident
  45. | MixedAnonInRecordLiteral
  46. | MixedFieldNamesInRecordLiteral of Ident.ident list
  47. | MoreThanOneInitState of Ident.ident list
  48. | MultipleAssetStateDeclaration
  49. | MultipleInitialMarker
  50. | MultipleMatchingOperator of PT.operator * M.ptyp list * opsig list
  51. | MultipleFromToInVarDecl
  52. | MultipleStateDeclaration
  53. | NameIsAlreadyBound of Ident.ident
  54. | NoMatchingOperator of PT.operator * M.ptyp list
  55. | NoSuchMethod of Ident.ident
  56. | NoSuchSecurityPredicate of Ident.ident
  57. | NonLoopLabel of Ident.ident
  58. | NotAKeyOfType
  59. | NotAnAssetType
  60. | NotAnEnumType
  61. | NotAPrimitiveType
  62. | NotARole of Ident.ident
  63. | NumericExpressionExpected
  64. | OpInRecordLiteral
  65. | OrphanedLabel of Ident.ident
  66. | PartialMatch of Ident.ident list
  67. | ReadOnlyGlobal of Ident.ident
  68. | SecurityInExpr
  69. | SpecOperatorInExpr
  70. | UninitializedVar
  71. | UnknownAction of Ident.ident
  72. | UnknownAsset of Ident.ident
  73. | UnknowContractEntryPoint of Ident.ident * Ident.ident
  74. | UnknownEnum of Ident.ident
  75. | UnknownField of Ident.ident * Ident.ident
  76. | UnknownFieldName of Ident.ident
  77. | UnknownLabel of Ident.ident
  78. | UnknownLocalOrVariable of Ident.ident
  79. | UnknownProcedure of Ident.ident
  80. | UnknownState of Ident.ident
  81. | UnknownTypeName of Ident.ident
  82. | UnpureInFormula
  83. | UselessPattern
  84. | VoidMethodInExpr
  85. | AssetPartitionnedby of Ident.ident * Ident.ident list
val show_error_desc : error_desc -> Ppx_deriving_runtime.string
type error = L.t * error_desc
val pp_operator : Core.Format.formatter -> PT.operator -> unit
type argtype = [
  1. | `Type of M.type_
  2. | `Effect of Ident.ident
]
val eqtypes : M.vtyp list
val cmptypes : M.vtyp list
val grptypes : M.vtyp list
val rgtypes : M.vtyp list
val cmpsigs : (PT.operator * (M.vtyp list * M.vtyp)) list
val opsigs : (PT.operator * opsig) list
type acttx = [
  1. | `Action of PT.action_decl
  2. | `Transition of PT.transition_decl
]
type groups = {
  1. gr_archetypes : (PT.lident * PT.exts) Location.loced list;
  2. gr_states : PT.enum_decl Location.loced list;
  3. gr_enums : (PT.lident * PT.enum_decl) Location.loced list;
  4. gr_assets : PT.asset_decl Location.loced list;
  5. gr_vars : PT.variable_decl Location.loced list;
  6. gr_funs : PT.s_function Location.loced list;
  7. gr_acttxs : acttx Location.loced list;
  8. gr_specs : PT.specification Location.loced list;
  9. gr_secs : PT.security Location.loced list;
  10. gr_externals : PT.contract_decl Location.loced list;
}
val globals : (string * M.const * M.ptyp) list
type method_ = {
  1. mth_name : M.const;
  2. mth_purity : [ `Pure | `Effect ];
  3. mth_totality : [ `Total | `Partial ];
  4. mth_sig : mthtyp list * mthtyp option;
}
and mthtyp = [
  1. | `T of M.ptyp
  2. | `The
  3. | `Pk
  4. | `Effect
  5. | `Asset
  6. | `SubColl
  7. | `Cmp
  8. | `Pred
  9. | `RExpr
  10. | `Ref of int
]
val methods : method_ Ident.Mid.t
type assetdecl = {
  1. as_name : M.lident;
  2. as_fields : (M.lident * M.ptyp) list;
  3. as_pk : M.lident;
  4. as_sortk : M.lident list;
  5. as_invs : (M.lident option * M.pterm) list;
  6. as_state : M.lident option;
}
type vardecl = {
  1. vr_name : M.lident;
  2. vr_type : M.ptyp;
  3. vr_kind : [ `Constant | `Variable | `Ghost | `Enum ];
  4. vr_def : (M.pterm * [ `Inline | `Std ]) option;
  5. vr_tgt : M.lident option * M.lident option;
  6. vr_core : M.const option;
}
type 'env ispecification = [
  1. | `Predicate of M.lident * (M.lident * M.ptyp) list * M.pterm
  2. | `Definition of M.lident * (M.lident * M.ptyp) option * M.pterm
  3. | `Lemma of M.lident * M.pterm
  4. | `Theorem of M.lident * M.pterm
  5. | `Variable of M.lident * M.pterm option
  6. | `Assert of M.lident * M.pterm * (M.lident * M.pterm list) list * M.lident list
  7. | `Effect of 'env * M.instruction
  8. | `Postcondition of M.lident * M.pterm * (M.lident * M.pterm list) list * M.lident list
]
type 'env fundecl = {
  1. fs_name : M.lident;
  2. fs_args : (M.lident * M.ptyp) list;
  3. fs_retty : M.ptyp;
  4. fs_body : M.instruction;
  5. fs_spec : 'env ispecification list option;
}
type txeffect = {
  1. tx_state : M.lident;
  2. tx_when : M.pterm option;
  3. tx_effect : M.instruction option;
}
type 'env tactiondecl = {
  1. ad_name : M.lident;
  2. ad_args : (M.lident * M.ptyp) list;
  3. ad_callby : M.lident list;
  4. ad_effect : [ `Raw of M.instruction | `Tx of M.lident * txeffect list ] option;
  5. ad_funs : 'env fundecl option list;
  6. ad_reqs : (M.lident option * M.pterm) list;
  7. ad_fais : (M.lident option * M.pterm) list;
  8. ad_spec : 'env ispecification list;
  9. ad_actfs : bool;
}
type statedecl = {
  1. sd_name : M.lident option;
  2. sd_ctors : ctordecl list;
  3. sd_init : Ident.ident;
}
and ctordecl = M.lident * (M.lident option * M.pterm) list
type contractdecl = {
  1. ct_name : M.lident;
  2. ct_entries : (M.lident * M.ptyp list) list;
}
val pterm_arg_as_pterm : 'a M.term_arg -> 'a M.term_gen option
val core_types : (string * M.ptyp) list
module Env : sig ... end
type env = Env.t
val empty : env
val check_and_emit_name_free : env -> M.lident -> bool
val select_operator : Env.t -> L.t -> (PT.operator * M.ptyp list) -> opsig option
val for_container : env -> PT.container -> M.container
val for_assignment_operator : PT.assignment_operator -> M.assignment_operator
val tt_logical_operator : PT.logical_operator -> M.logical_operator
exception InvalidType
val for_type_exn : env -> PT.type_t -> M.ptyp
val for_type : env -> PT.type_t -> M.ptyp option
val for_asset_type : env -> PT.type_t -> M.lident option
val for_asset_keyof_type : env -> PT.type_t -> M.lident option
val for_literal : env -> PT.literal Location.loced -> M.bval
type emode_t = [
  1. | `Expr
  2. | `Formula
]
val for_xexpr : emode_t -> env -> ?ety:M.ptyp -> PT.expr -> PT.lident M.term_node M.struct_poly
val for_gen_matchwith : emode_t -> env -> Location.t -> PT.expr -> PT.branch list -> (statedecl * Tools.Mstr.key Location.loced M.term_gen * (int option * int option Tools.Mstr.t) * PT.expr list) option
val for_asset_expr : emode_t -> env -> PT.expr -> PT.lident M.term_node M.struct_poly * assetdecl option
val for_asset_collection_expr : emode_t -> env -> [< `Parsed of PT.expr | `Typed of PT.lident M.term_node M.struct_poly Parsed ] -> PT.lident M.term_gen * (assetdecl * M.container) option
val for_gen_method_call : emode_t -> env -> Location.t -> ([< `Parsed of PT.expr | `Typed of PT.lident M.term_node M.struct_poly Parsed ] * PT.lident * PT.expr list) -> (PT.lident M.term_gen * assetdecl * method_ * PT.lident M.term_arg list * M.ptyp Tools.Mint.t) option
val for_arg_effect : emode_t -> env -> assetdecl -> PT.expr -> (PT.lident * M.operator * PT.lident M.term_gen) list option
val for_formula : env -> PT.expr -> M.pterm
val for_action_description : env -> PT.security_arg -> M.action_description
val for_security_action : env -> PT.security_arg -> M.security_action
val for_security_role : env -> PT.security_arg -> M.security_role list
val for_role : env -> PT.lident -> M.security_role option
val for_expr : env -> ?ety:M.type_ -> PT.expr -> M.pterm
val for_lbl_expr : env -> PT.label_expr -> env * (M.lident option * M.pterm)
val for_lbls_expr : env -> PT.label_exprs -> env * (M.lident option * M.pterm) list
val for_lbl_formula : env -> PT.label_expr -> env * (M.lident option * M.pterm)
val for_xlbls_formula : env -> PT.label_exprs -> env * (M.lident option * M.pterm) list
val for_lbls_formula : env -> PT.label_exprs -> env * (M.lident option * M.pterm) list
val for_arg_decl : env -> PT.lident_typ -> env * (PT.lident * M.ptyp) option
val for_args_decl : env -> PT.args -> env * (PT.lident * M.ptyp) option list
val for_lvalue : env -> PT.expr -> (M.lvalue * M.ptyp) option
val for_instruction : env -> PT.expr -> env * M.instruction
val for_specification_item : env -> PT.specification_item -> env * env ispecification
module SecurityPred : sig ... end
val for_security_item : env -> PT.security_item -> (env * M.security_item) option
val for_specification : env -> PT.specification -> env * env ispecification list
val for_security : env -> PT.security -> env * M.security
val for_named_state : ?enum:Ident.ident -> env -> PT.lident -> Ident.ident Location.loced
val for_state : ?enum:Ident.ident -> env -> PT.expr -> M.lident
val for_function : env -> PT.s_function Location.loced -> Env.t * env fundecl option
val for_callby : env -> PT.expr -> PT.lident list
val for_action_properties : env -> PT.action_properties -> env * (PT.lident list option * (M.lident option * M.pterm) list option * (M.lident option * M.pterm) list option * env ispecification list option * env fundecl option list)
val for_effect : env -> PT.expr -> env * M.instruction
val for_transition : ?enum:Ident.ident -> env -> (PT.lident * (PT.expr * 'a) option * (PT.expr * 'b) option) -> env * txeffect
type enum_core = (PT.lident * PT.enum_option list) list
val for_core_enum_decl : env -> enum_core Location.loced -> env * (Ident.ident * (PT.lident * (M.lident option * M.pterm) list) list) option
val for_enum_decl : env -> (PT.lident * PT.enum_decl) Location.loced -> env * statedecl option
val for_enums_decl : env -> (PT.lident * PT.enum_decl) Location.loced list -> env * statedecl option list
val for_var_decl : env -> PT.variable_decl Location.loced -> env * vardecl option
val for_vars_decl : env -> PT.variable_decl Location.loced list -> env * vardecl option list
val for_fun_decl : env -> PT.s_function Location.loced -> Env.t * env fundecl option
val for_funs_decl : env -> PT.s_function Location.loced list -> env * env fundecl option list
val for_asset_decl : ?force:bool -> env -> PT.asset_decl Location.loced -> env * assetdecl option
val for_assets_decl : env -> PT.asset_decl Location.loced list -> env * assetdecl option list
val for_contract_decl : env -> PT.contract_decl Location.loced -> env * contractdecl option
val for_contracts_decl : env -> PT.contract_decl Location.loced list -> env * contractdecl option list
val for_acttx_decl : env -> acttx Location.loced -> Env.t * env tactiondecl
val for_acttxs_decl : env -> acttx Location.loced list -> env * env tactiondecl list
val for_specs_decl : env -> PT.specification Location.loced list -> env * env ispecification list list
val for_secs_decl : env -> PT.security Location.loced list -> env * M.security list
val group_declarations : PT.declaration list -> groups
type decls = {
  1. state : statedecl option;
  2. contracts : contractdecl option list;
  3. variables : vardecl option list;
  4. enums : statedecl option list;
  5. assets : assetdecl option list;
  6. functions : env fundecl option list;
  7. acttxs : env tactiondecl list;
  8. specs : env ispecification list list;
  9. secspecs : M.security list;
}
val for_grouped_declarations : env -> (L.t * groups) -> env * decls
val enums_of_statedecl : statedecl list -> M.enum list
val assets_of_adecls : assetdecl option list -> M.lident M.asset_struct list
val variables_of_vdecls : vardecl option list -> M.lident M.variable list
val contracts_of_cdecls : contractdecl option list -> M.lident M.contract_struct list
val specifications_of_ispecifications : env ispecification list -> M.lident M.specification
val functions_of_fdecls : env fundecl option list -> M.lident M.function_struct list
val transactions_of_tdecls : env tactiondecl list -> M.lident M.transaction_struct list
val for_declarations : env -> PT.declaration list Location.loced -> M.model
val typing : env -> PT.archetype -> M.model
OCaml

Innovation. Community. Security.