helm/matita/matitaTypes.ml

   1 (* Copyright (C) 2004-2005, 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 open Printf
  27
  28   (** user hit the cancel button *)
  29 exception Cancel
  30
  31   (** statement invoked in the wrong context (e.g. tactic with no ongoing proof)
  32    *)
  33 exception Statement_error of string
  34 let statement_error msg = raise (Statement_error msg)
  35
  36 exception Command_error of string
  37 let command_error msg = raise (Command_error msg)
  38
  39   (** parameters are: option name, error message *)
  40 exception Option_error of string * string
  41
  42 exception Unbound_identifier of string
  43
  44 type incomplete_proof = {
  45   proof: ProofEngineTypes.proof;
  46   stack: Continuationals.Stack.t;
  47 }
  48
  49 type proof_status =
  50   | No_proof
  51   | Incomplete_proof of incomplete_proof
  52   | Proof of ProofEngineTypes.proof
  53   | Intermediate of Cic.metasenv
  54       (* Status in which the proof could be while it is being processed by the
  55       * engine. No status entering/exiting the engine could be in it. *)
  56
  57 module StringMap = Map.Make (String)
  58
  59 type option_value =
  60   | String of string
  61   | Int of int
  62 type options = option_value StringMap.t
  63 let no_options = StringMap.empty
  64
  65 type ast_command = (CicNotationPt.term, GrafiteAst.obj) GrafiteAst.command
  66 type moo = ast_command list * GrafiteAst.metadata list
  67
  68 type status = {
  69   aliases: DisambiguateTypes.environment;
  70   multi_aliases: DisambiguateTypes.multiple_environment;
  71   moo_content_rev: moo;
  72   proof_status: proof_status;
  73   options: options;
  74   objects: (UriManager.uri * string) list;
  75   coercions: UriManager.uri list;
  76   notation_ids: CicNotation.notation_id list;
  77 }
  78
  79 let set_metasenv metasenv status =
  80   let proof_status =
  81     match status.proof_status with
  82     | No_proof -> Intermediate metasenv
  83     | Incomplete_proof ({ proof = (uri, _, proof, ty) } as incomplete_proof) ->
  84         Incomplete_proof
  85           { incomplete_proof with proof = (uri, metasenv, proof, ty) }
  86     | Intermediate _ -> Intermediate metasenv
  87     | Proof _ -> assert false
  88   in
  89   { status with proof_status = proof_status }
  90
  91 let dump_status status =
  92   MatitaLog.message "status.aliases:\n";
  93   MatitaLog.message "status.proof_status:";
  94   MatitaLog.message
  95     (match status.proof_status with
  96     | No_proof -> "no proof\n"
  97     | Incomplete_proof _ -> "incomplete proof\n"
  98     | Proof _ -> "proof\n"
  99     | Intermediate _ -> "Intermediate\n");
 100   MatitaLog.message "status.options\n";
 101   StringMap.iter (fun k v ->
 102     let v =
 103       match v with
 104       | String s -> s
 105       | Int i -> string_of_int i
 106     in
 107     MatitaLog.message (k ^ "::=" ^ v)) status.options;
 108   MatitaLog.message "status.coercions\n";
 109   MatitaLog.message "status.objects:\n";
 110   List.iter
 111     (fun (u,_) ->
 112       MatitaLog.message (UriManager.string_of_uri u)) status.objects
 113
 114 let get_option status name =
 115   try
 116     StringMap.find name status.options
 117   with Not_found -> raise (Option_error (name, "not found"))
 118
 119 let get_string_option status name =
 120   match get_option status name with
 121   | String s -> s
 122   | _ -> raise (Option_error (name, "not a string value"))
 123
 124 let set_option status name value =
 125   let mangle_dir s =
 126     let s = Str.global_replace (Str.regexp "//+") "/" s in
 127     let s = Str.global_replace (Str.regexp "/$") "" s in
 128     s
 129   in
 130   let types =
 131     [ "baseuri", (`String, mangle_dir);
 132       "basedir", (`String, mangle_dir);
 133     ]
 134   in
 135   let ty_and_mangler =
 136     try
 137       List.assoc name types
 138     with Not_found -> command_error (sprintf "Unknown option \"%s\"" name)
 139   in
 140   let value =
 141     match ty_and_mangler with
 142     | `String, f -> String (f value)
 143     | `Int, f ->
 144         (try
 145           Int (int_of_string (f value))
 146         with Failure _ ->
 147           command_error (sprintf "Not an integer value \"%s\"" value))
 148   in
 149   if StringMap.mem name status.options && name = "baseuri" then
 150     command_error "Redefinition of 'baseuri' is forbidden."
 151   else
 152     { status with options = StringMap.add name value status.options }
 153
 154 let add_moo_content cmds status =
 155   let content, metadata = status.moo_content_rev in
 156   let content' =
 157     List.fold_right
 158       (fun cmd acc ->
 159 (*         prerr_endline ("adding to moo command: " ^ GrafiteAstPp.pp_command cmd); *)
 160         match cmd with
 161         | GrafiteAst.Interpretation _
 162         | GrafiteAst.Default _ ->
 163             if List.mem cmd content then acc
 164             else cmd :: acc
 165         | GrafiteAst.Alias _ -> (* move Alias as the last inserted one *)
 166             cmd :: (List.filter ((<>) cmd) acc)
 167         | _ -> cmd :: acc)
 168       cmds content
 169   in
 170 (*   prerr_endline ("new moo content: " ^ String.concat " " (List.map
 171     GrafiteAstPp.pp_command content')); *)
 172   { status with moo_content_rev = content', metadata }
 173
 174 let add_moo_metadata new_metadata status =
 175   let content, metadata = status.moo_content_rev in
 176   let metadata' =
 177     List.fold_left
 178       (fun acc m ->
 179         match m with
 180         | GrafiteAst.Dependency buri ->
 181             let is_self = (* self dependency *)
 182               try
 183                 get_string_option status "baseuri" = buri
 184               with Option_error _ -> false  (* baseuri not yet set *)
 185             in
 186             if is_self
 187               || List.exists (GrafiteAst.eq_metadata m) metadata (* duplicate *)
 188             then acc
 189             else m :: acc
 190         | _ -> m :: acc)
 191       metadata new_metadata
 192   in
 193   { status with moo_content_rev = content, metadata' }
 194
 195   (* subset of MatitaConsole.console methods needed by MatitaInterpreter *)
 196 class type console =
 197   object
 198     method clear : unit -> unit
 199     method echo_error : string -> unit
 200     method echo_message : string -> unit
 201     method wrap_exn : 'a. (unit -> 'a) -> 'a option
 202     method choose_uri : string list -> string
 203     method show : ?msg:string -> unit -> unit
 204   end
 205
 206 type abouts =
 207   [ `Blank
 208   | `Current_proof
 209   | `Us
 210   ]
 211
 212 type mathViewer_entry =
 213   [ `About of abouts  (* current proof *)
 214   | `Check of string (* term *)
 215   | `Cic of Cic.term * Cic.metasenv
 216   | `Dir of string (* "directory" in cic uris namespace *)
 217   | `Uri of UriManager.uri (* cic object uri *)
 218   | `Whelp of string * UriManager.uri list (* query and results *)
 219   ]
 220
 221 let string_of_entry = function
 222   | `About `Blank -> "about:blank"
 223   | `About `Current_proof -> "about:proof"
 224   | `About `Us -> "about:us"
 225   | `Check _ -> "check:"
 226   | `Cic (_, _) -> "term:"
 227   | `Dir uri -> uri
 228   | `Uri uri -> UriManager.string_of_uri uri
 229   | `Whelp (query, _) -> query
 230
 231 let entry_of_string = function
 232   | "about:blank" -> `About `Blank
 233   | "about:proof" -> `About `Current_proof
 234   | "about:us"    -> `About `Us
 235   | _ ->  (* only about entries supported ATM *)
 236       raise (Invalid_argument "entry_of_string")
 237
 238 class type mathViewer =
 239   object
 240     (** @param reuse if set reused last opened cic browser otherwise
 241      *  opens a new one. default is false
 242      *)
 243     method show_entry: ?reuse:bool -> mathViewer_entry -> unit
 244     method show_uri_list:
 245       ?reuse:bool -> entry:mathViewer_entry -> UriManager.uri list -> unit
 246   end
 247
 248 let qualify status name = get_string_option status "baseuri" ^ "/" ^ name
 249
 250 let get_current_proof status =
 251   match status.proof_status with
 252   | Incomplete_proof { proof = p } -> p
 253   | _ -> statement_error "no ongoing proof"
 254
 255 let get_proof_metasenv status =
 256   match status.proof_status with
 257   | No_proof -> []
 258   | Proof (_, metasenv, _, _)
 259   | Incomplete_proof { proof = (_, metasenv, _, _) }
 260   | Intermediate metasenv ->
 261       metasenv
 262
 263 let get_proof_context status goal =
 264   match status.proof_status with
 265   | Incomplete_proof { proof = (_, metasenv, _, _) } ->
 266       let (_, context, _) = CicUtil.lookup_meta goal metasenv in
 267       context
 268   | _ -> []
 269
 270 let get_proof_conclusion status goal =
 271   match status.proof_status with
 272   | Incomplete_proof { proof = (_, metasenv, _, _) } ->
 273       let (_, _, conclusion) = CicUtil.lookup_meta goal metasenv in
 274       conclusion
 275   | _ -> statement_error "no ongoing proof"
 276
 277 let get_stack status =
 278   match status.proof_status with
 279   | Incomplete_proof p -> p.stack
 280   | Proof _ -> Continuationals.Stack.empty
 281   | _ -> assert false
 282
 283 let set_stack stack status =
 284   match status.proof_status with
 285   | Incomplete_proof p ->
 286       { status with proof_status = Incomplete_proof { p with stack = stack } }
 287   | Proof _ ->
 288       assert (Continuationals.Stack.is_empty stack);
 289       status
 290   | _ -> assert false
 291