helm/ocaml/cic_omdoc/content.mli

   1 (* Copyright (C) 2000, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://cs.unibo.it/helm/.
  24  *)
  25
  26 type id = string;;
  27 type joint_recursion_kind =
  28  [ `Recursive of int list (* decreasing arguments *)
  29  | `CoRecursive
  30  | `Inductive of int    (* paramsno *)
  31  | `CoInductive of int  (* paramsno *)
  32  ]
  33 ;;
  34
  35 type var_or_const = Var | Const;;
  36
  37 type 'term declaration =
  38        { dec_name : string option;
  39          dec_id : id ;
  40          dec_inductive : bool;
  41          dec_aref : string;
  42          dec_type : 'term
  43        }
  44 ;;
  45
  46 type 'term definition =
  47        { def_name : string option;
  48          def_id : id ;
  49          def_aref : string ;
  50          def_term : 'term
  51        }
  52 ;;
  53
  54 type 'term inductive =
  55        { inductive_id : id ;
  56          inductive_name : string;
  57          inductive_kind : bool;
  58          inductive_type : 'term;
  59          inductive_constructors : 'term declaration list
  60        }
  61 ;;
  62
  63 type 'term decl_context_element =
  64        [ `Declaration of 'term declaration
  65        | `Hypothesis of 'term declaration
  66        ]
  67 ;;
  68
  69 type ('term,'proof) def_context_element =
  70        [ `Proof of 'proof
  71        | `Definition of 'term definition
  72        ]
  73 ;;
  74
  75 type ('term,'proof) in_joint_context_element =
  76        [ `Inductive of 'term inductive
  77        | 'term decl_context_element
  78        | ('term,'proof) def_context_element
  79        ]
  80 ;;
  81
  82 type ('term,'proof) joint =
  83        { joint_id : id ;
  84          joint_kind : joint_recursion_kind ;
  85          joint_defs : ('term,'proof) in_joint_context_element list
  86        }
  87 ;;
  88
  89 type ('term,'proof) joint_context_element =
  90        [ `Joint of ('term,'proof) joint ]
  91 ;;
  92
  93 type 'term proof =
  94       { proof_name : string option;
  95         proof_id   : id ;
  96         proof_context : 'term in_proof_context_element list ;
  97         proof_apply_context: 'term proof list;
  98         proof_conclude : 'term conclude_item
  99       }
 100
 101 and 'term in_proof_context_element =
 102        [ 'term decl_context_element
 103        | ('term,'term proof) def_context_element
 104        | ('term,'term proof) joint_context_element
 105        ]
 106
 107 and 'term conclude_item =
 108        { conclude_id : id;
 109          conclude_aref : string;
 110          conclude_method : string;
 111          conclude_args : ('term arg) list ;
 112          conclude_conclusion : 'term option
 113        }
 114
 115 and 'term arg =
 116          Aux of string
 117        | Premise of premise
 118        | Lemma of lemma
 119        | Term of 'term
 120        | ArgProof of 'term proof
 121        | ArgMethod of string (* ???? *)
 122
 123 and premise =
 124        { premise_id: id;
 125          premise_xref : string ;
 126          premise_binder : string option;
 127          premise_n : int option;
 128        }
 129
 130 and lemma =
 131        { lemma_id: id;
 132          lemma_name : string;
 133          lemma_uri: string
 134        }
 135 ;;
 136
 137 type 'term conjecture = id * int * 'term context * 'term
 138
 139 and 'term context = 'term hypothesis list
 140
 141 and 'term hypothesis =
 142  ['term decl_context_element | ('term,'term proof) def_context_element ] option
 143 ;;
 144
 145 type 'term in_object_context_element =
 146        [ `Decl of var_or_const * 'term decl_context_element
 147        | `Def of var_or_const * 'term * ('term,'term proof) def_context_element
 148        | ('term,'term proof) joint_context_element
 149        ]
 150 ;;
 151
 152 type 'term cobj  =
 153         id *                            (* id *)
 154         UriManager.uri list *           (* params *)
 155         'term conjecture list option *  (* optional metasenv *)
 156         'term in_object_context_element (* actual object *)
 157 ;;