helm/matita/matitaTypes.ml

   1 (* Copyright (C) 2004, 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://helm.cs.unibo.it/
  24  *)
  25
  26 exception Not_implemented of string
  27 let not_implemented feature = raise (Not_implemented feature)
  28
  29   (** exceptions whose content should be presented to the user *)
  30 exception Failure of string
  31 let error s = raise (Failure s)
  32 let warning s = prerr_endline ("MATITA WARNING:\t" ^ s)
  33 let debug_print s =
  34   if BuildTimeConf.debug then prerr_endline ("MATITA DEBUG:\t" ^ s)
  35
  36 exception No_proof  (** no current proof is available *)
  37
  38 exception Cancel
  39 exception Unbound_identifier of string
  40
  41 (*
  42 let untitled_con_uri = UriManager.uri_of_string "cic:/untitled.con"
  43 let untitled_def_uri = UriManager.uri_of_string "cic:/untitled.ind"
  44
  45 let unopt_uri ?(kind = `Con) = function
  46   | Some uri -> uri
  47   | None ->
  48       (match kind with `Con -> untitled_con_uri | `Def -> untitled_def_uri)
  49 *)
  50 let unopt_uri = function Some uri -> uri | None -> assert false
  51
  52 class type parserr =  (* "parser" is a keyword :-( *)
  53   object
  54     method parseTerm:     char Stream.t -> DisambiguateTypes.term
  55     method parseTactical: char Stream.t -> DisambiguateTypes.tactical
  56   end
  57
  58 class type disambiguator =
  59   object
  60     method parserr: parserr
  61     method setParserr: parserr -> unit
  62
  63     method env: DisambiguateTypes.environment
  64     method setEnv: DisambiguateTypes.environment -> unit
  65
  66       (* TODO Zack: as long as matita doesn't support MDI inteface,
  67       * disambiguateTerm will return a single term *)
  68       (** @param env disambiguation environment. If this parameter is given the
  69       * disambiguator act statelessly, that is internal disambiguation status
  70       * want be changed but only returned. If this parameter is not given the
  71       * internal one will be used and updated with the disambiguation status
  72       * resulting from the disambiguation *)
  73     method disambiguateTerm:
  74       ?context:Cic.context -> ?metasenv:Cic.metasenv ->
  75       ?env:DisambiguateTypes.environment ->
  76         char Stream.t ->
  77           (DisambiguateTypes.environment * Cic.metasenv * Cic.term * CicUniv.universe_graph)
  78       (** @param env @see disambiguateTerm above *)
  79     method disambiguateTermAst:
  80       ?context:Cic.context -> ?metasenv:Cic.metasenv ->
  81       ?env:DisambiguateTypes.environment ->
  82         DisambiguateTypes.term ->
  83           (DisambiguateTypes.environment * Cic.metasenv * Cic.term * CicUniv.universe_graph)
  84   end
  85
  86 (*
  87 type sequents_metadata =
  88   (int *                                  (** sequent (meta) index *)
  89     (Cic.annconjecture *                    (** annotated conjecture *)
  90     (Cic.id, Cic.term) Hashtbl.t *          (** ids_to_terms *)
  91     (Cic.id, Cic.id option) Hashtbl.t *     (** ids_to_father_ids *)
  92     (Cic.id, string) Hashtbl.t *            (** ids_to_inner_sorts *)
  93     (Cic.id, Cic.hypothesis) Hashtbl.t))    (** ids_to_hypotheses *)
  94       list
  95 type proof_metadata =
  96   Cic.annobj *                             (** annotated object    *)
  97   (Cic.id, Cic.term) Hashtbl.t *            (** ids_to_terms        *)
  98   (Cic.id, Cic.id option) Hashtbl.t *       (** ids_to_father_ids   *)
  99   (Cic.id, string) Hashtbl.t *              (** ids_to_inner_sorts  *)
 100   (Cic.id, Cic2acic.anntypes) Hashtbl.t *   (** ids_to_inner_types  *)
 101   (Cic.id, Cic.conjecture) Hashtbl.t *      (** ids_to_conjectures  *)
 102   (Cic.id, Cic.hypothesis) Hashtbl.t        (** ids_to_hypotheses   *)
 103 type hist_metadata = proof_metadata * sequents_metadata
 104 *)
 105
 106 class type proof =
 107   object
 108     inherit [unit] StatefulProofEngine.status
 109
 110     (** return a pair of "xml" (as defined in Xml module) representing the *
 111      * current proof type and body, respectively *)
 112     method toXml: Xml.token Stream.t * Xml.token Stream.t
 113     method toString: string
 114   end
 115
 116 type proof_handler =
 117   { get_proof: unit -> proof; (* return current proof or fail *)
 118     set_proof: proof option -> unit;
 119     abort_proof: unit -> unit;(* abort current proof, cleaning up garbage *)
 120     has_proof: unit -> bool;  (* check if a current proof is available or not *)
 121     new_proof: proof -> unit; (* as a set_proof but takes care also to register
 122                               observers *)
 123     quit: unit -> unit
 124   }
 125
 126   (** interpreter for toplevel phrases given via console *)
 127 class type interpreter =
 128   object
 129     method reset: unit  (** return the interpreter to the initial state *)
 130
 131       (** parse a single phrase contained in the input string. Additional
 132       * garbage at the end of the phrase is ignored
 133       * @return true if no exception has been raised by the evaluation, false
 134       * otherwise
 135       *)
 136     method evalPhrase: string -> bool
 137
 138       (** as above, evaluating a command/tactics AST *)
 139     method evalAst: DisambiguateTypes.tactical -> bool
 140
 141       (** offset from the starting of the last string parser by evalPhrase where
 142       * parsing stop.
 143       * @raise Failure when no offset has been recorded *)
 144     method endOffset: int
 145
 146   end
 147
 148 (** {2 MathML widgets} *)
 149
 150 type mml_of_cic_sequent =
 151   Cic.metasenv -> Cic.conjecture ->
 152     Gdome.document *
 153     ((Cic.id, Cic.term) Hashtbl.t *
 154     (Cic.id, Cic.id option) Hashtbl.t *
 155     (string, Cic.hypothesis) Hashtbl.t)
 156
 157 type mml_of_cic_object =
 158   explode_all:bool -> UriManager.uri -> Cic.annobj ->
 159   (string, string) Hashtbl.t -> (string, Cic2acic.anntypes) Hashtbl.t ->
 160     Gdome.document
 161
 162 class type proof_viewer =
 163   object
 164     inherit GMathViewAux.single_selection_math_view
 165
 166     method load_proof: StatefulProofEngine.proof_status -> unit
 167   end
 168
 169 class type sequent_viewer =
 170   object
 171     inherit GMathViewAux.multi_selection_math_view
 172
 173       (** @return the list of selected terms. Selections which are not terms are
 174       * ignored *)
 175     method get_selected_terms: Cic.term list
 176
 177       (** @return the list of selected hypothese. Selections which are not
 178       * hypotheses are ignored *)
 179     method get_selected_hypotheses: Cic.hypothesis list
 180
 181       (** load a sequent and render it into parent widget *)
 182     method load_sequent: Cic.metasenv -> int -> unit
 183   end
 184
 185 class type sequents_viewer =
 186   object
 187     method reset: unit
 188     method load_sequents: Cic.metasenv -> unit
 189     method goto_sequent: int -> unit  (* to be called _after_ load_sequents *)
 190   end
 191
 192 (** {2 shorthands} *)
 193
 194 type namer = ProofEngineTypes.mk_fresh_name_type
 195
 196 type choose_uris_callback =
 197   selection_mode:[`MULTIPLE|`SINGLE] ->
 198   ?title:string -> ?msg:string -> ?nonvars_button:bool ->
 199   string list ->
 200     string list
 201
 202 type choose_interp_callback = (string * string) list list -> int list
 203