syntax/defs.ml

   1
   2 open Type
   3 open Camlp4.PreCast
   4
   5 type context = {
   6   (* mapping from type parameters to functor arguments *)
   7   argmap : Type.name Type.NameMap.t;
   8   (* ordered list of type parameters *)
   9   params : Type.param list;
  10   (* type names *)
  11   tnames : Type.NameSet.t;
  12   (* For class dependencies, e.g. Pickle. *)
  13   toplevel : (Type.name * Type.expr) option
  14 }
  15
  16 module type Loc = sig
  17   val _loc : Loc.t (* location of the type definition being derived *)
  18 end
  19
  20 type dependency = {
  21     d_classname: string;
  22     d_generate_expr: context -> Type.expr -> Ast.module_expr;
  23   }
  24
  25 module type ClassDescription = sig
  26   val classname: name
  27   val runtimename: name
  28   val default_module: name option
  29   val allow_private: bool
  30   val predefs: (Type.qname * Type.name) list
  31   val depends:  (Loc.t -> dependency) list
  32 end
  33
  34 module type Class = sig
  35   val generate: Type.decl list -> Ast.str_item
  36   val generate_sigs: Type.decl list -> Ast.sig_item
  37   val generate_expr: context -> Type.expr -> Ast.module_expr
  38 end
  39
  40 class type virtual generator = object
  41
  42       method rhs: context -> Type.decl -> Ast.module_expr
  43       method expr: context -> Type.expr -> Ast.module_expr
  44
  45       method mapply: context -> Ast.module_expr -> Type.expr list -> Ast.module_expr
  46
  47       method constr: context -> Type.qname * Type.expr list -> Ast.module_expr
  48       method param: context -> Type.param -> Ast.module_expr
  49
  50       method wrap: context -> Type.expr -> Ast.str_item list -> Ast.module_expr
  51
  52       method call_expr: context -> Type.expr -> string -> Ast.expr
  53
  54       method virtual sum:
  55           ?eq:Type.expr -> context ->
  56             Type.name -> Type.param list -> Type.constraint_ list ->
  57               Type.summand list -> Ast.str_item list
  58       method virtual tuple: context -> Type.expr list -> Ast.str_item list
  59       method virtual variant:
  60           context ->
  61             Type.name -> Type.param list -> Type.constraint_ list ->
  62               Type.variant -> Ast.str_item list
  63       method virtual record:
  64           ?eq:Type.expr -> context ->
  65             Type.name -> Type.param list -> Type.constraint_ list ->
  66               Type.field list -> Ast.str_item list
  67
  68       method class_: context -> [ `NYI ] -> Ast.str_item list
  69       method function_: context -> Type.expr * Type.expr -> Ast.str_item list
  70       method label:
  71           context ->
  72             [ `NonOptional | `Optional ] * Type.name * Type.expr * Type.expr ->
  73               Ast.str_item list
  74       method object_: context -> [ `NYI ] -> Ast.str_item list
  75
  76     end
  77
  78 module type ClassHelpers = sig
  79
  80   include Loc
  81   module Untranslate : Type.Untranslate
  82
  83   val seq: Ast.expr -> Ast.expr -> Ast.expr
  84   val seq_list: Ast.expr list -> Ast.expr
  85
  86   val record_pattern: ?prefix:string -> Type.field list -> Ast.patt
  87   val record_expr: (string * Ast.expr) list -> Ast.expr
  88   val record_expression: ?prefix:string -> Type.field list -> Ast.expr
  89
  90   val expr_list: Ast.expr list -> Ast.expr
  91   val patt_list: Ast.patt list -> Ast.patt
  92
  93   val tuple_expr: Ast.expr list -> Ast.expr
  94   val tuple: ?param:string -> int -> string list * Ast.patt * Ast.expr
  95
  96   val cast_pattern:
  97       Type.name Type.NameMap.t -> ?param:string ->
  98         Type.expr -> Ast.patt * Ast.expr * Ast.expr
  99
 100   (* For Functor only *)
 101   val modname_from_qname:  qname:string list -> classname:string -> Ast.ident
 102   val substitute: Type.name Type.NameMap.t -> Type.expr -> Type.expr
 103   val setup_context: Type.decl list -> context
 104
 105   (* For Pickle only *)
 106   val instantiate_modargs_repr: Type.name Type.NameMap.t -> Type.repr -> Type.repr
 107
 108   class virtual make_module_expr : generator
 109   val make_module_sig: context -> Type.decl -> Ast.module_type
 110   val make_module_type: context -> Type.decl -> Ast.module_type
 111
 112   val default_generate:
 113       make_module_expr:(context -> Type.decl -> Ast.module_expr) ->
 114       make_module_type:(context -> Type.decl -> Ast.module_type) ->
 115         Type.decl list -> Ast.str_item
 116   val default_generate_sigs:
 117       make_module_sig:(context -> Type.decl -> Ast.module_type) ->
 118         Type.decl list -> Ast.sig_item
 119
 120 end