helm/matita/matitaMisc.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 open MatitaTypes
  28
  29 (** Functions "imported" from Http_getter_misc *)
  30
  31 let strip_trailing_slash = Http_getter_misc.strip_trailing_slash
  32 let normalize_dir = Http_getter_misc.normalize_dir
  33 let strip_suffix = Http_getter_misc.strip_suffix
  34
  35 let baseuri_of_baseuri_decl st =
  36   match st with
  37   | GrafiteAst.Executable (_, GrafiteAst.Command (_, GrafiteAst.Set (_, "baseuri", buri))) ->
  38       Some buri
  39   | _ -> None
  40
  41 let baseuri_of_file file =
  42   let uri = ref None in
  43   let ic = open_in file in
  44   let istream = Stream.of_channel ic in
  45   (try
  46     while true do
  47       try
  48         let stm = GrafiteParser.parse_statement istream in
  49         match baseuri_of_baseuri_decl stm with
  50         | Some buri ->
  51             let u = strip_trailing_slash buri in
  52             if String.length u < 5 || String.sub u 0 5 <> "cic:/" then
  53               MatitaLog.error (file ^ " sets an incorrect baseuri: " ^ buri);
  54             (try
  55               ignore(Http_getter.resolve u)
  56             with
  57             | Http_getter_types.Unresolvable_URI _ ->
  58                 MatitaLog.error (file ^ " sets an unresolvable baseuri: "^buri)
  59             | Http_getter_types.Key_not_found _ -> ());
  60             uri := Some u;
  61             raise End_of_file
  62         | None -> ()
  63       with
  64         CicNotationParser.Parse_error _ as exn ->
  65           prerr_endline ("Unable to parse: " ^ file);
  66           prerr_endline (MatitaExcPp.to_string exn);
  67           ()
  68     done
  69   with End_of_file -> close_in ic);
  70   match !uri with
  71   | Some uri -> uri
  72   | None -> failwith ("No baseuri defined in " ^ file)
  73
  74 let is_empty buri =
  75  List.for_all
  76   (function
  77       Http_getter_types.Ls_section _ -> true
  78     | Http_getter_types.Ls_object _ -> false)
  79   (Http_getter.ls (Http_getter_misc.strip_trailing_slash buri ^ "/"))
  80
  81 let safe_remove fname = if Sys.file_exists fname then Sys.remove fname
  82
  83 let is_dir fname =
  84   try
  85     (Unix.stat fname).Unix.st_kind = Unix.S_DIR
  86   with Unix.Unix_error _ -> false
  87
  88 let is_regular fname =
  89   try
  90     (Unix.stat fname).Unix.st_kind = Unix.S_REG
  91   with Unix.Unix_error _ -> false
  92
  93 let input_file fname =
  94   let size = (Unix.stat fname).Unix.st_size in
  95   let buf = Buffer.create size in
  96   let ic = open_in fname in
  97   Buffer.add_channel buf ic size;
  98   close_in ic;
  99   Buffer.contents buf
 100
 101 let output_file data file =
 102   let oc = open_out file in
 103   output_string oc data;
 104   close_out oc
 105
 106
 107 let absolute_path file =
 108   if file.[0] = '/' then file else Unix.getcwd () ^ "/" ^ file
 109
 110 let is_proof_script fname = true  (** TODO Zack *)
 111 let is_proof_object fname = true  (** TODO Zack *)
 112
 113 let append_phrase_sep s =
 114   if not (Pcre.pmatch ~pat:(sprintf "%s$" BuildTimeConf.phrase_sep) s) then
 115     s ^ BuildTimeConf.phrase_sep
 116   else
 117     s
 118
 119 let mkdir path =
 120   let components = Str.split (Str.regexp "/") path in
 121   let rec aux where = function
 122     | [] -> ()
 123     | piece::tl ->
 124         let path = where ^ "/" ^ piece in
 125         (try
 126           Unix.mkdir path 0o755
 127         with
 128         | Unix.Unix_error (Unix.EEXIST,_,_) -> ()
 129         | Unix.Unix_error (e,_,_) -> raise (Failure (Unix.error_message e)));
 130         aux path tl
 131   in
 132   aux "" components
 133
 134 let trim_blanks =
 135   let rex = Pcre.regexp "^\\s*(.*?)\\s*$" in
 136   fun s -> (Pcre.extract ~rex s).(1)
 137
 138 let split ?(char = ' ') s =
 139   let pieces = ref [] in
 140   let rec aux idx =
 141     match (try Some (String.index_from s idx char) with Not_found -> None) with
 142     | Some pos ->
 143         pieces := String.sub s idx (pos - idx) :: !pieces;
 144         aux (pos + 1)
 145     | None -> pieces := String.sub s idx (String.length s - idx) :: !pieces
 146   in
 147   aux 0;
 148   List.rev !pieces
 149
 150 let empty_mathml () =
 151   DomMisc.domImpl#createDocument ~namespaceURI:(Some DomMisc.mathml_ns)
 152     ~qualifiedName:(Gdome.domString "math") ~doctype:None
 153
 154 let empty_boxml () =
 155   DomMisc.domImpl#createDocument ~namespaceURI:(Some DomMisc.boxml_ns)
 156     ~qualifiedName:(Gdome.domString "box") ~doctype:None
 157
 158 exception History_failure
 159
 160 type 'a memento = 'a array * int * int * int  (* data, hd, tl, cur *)
 161
 162 class type ['a] history =
 163   object
 164     method add : 'a -> unit
 165     method next : 'a
 166     method previous : 'a
 167     method load: 'a memento -> unit
 168     method save: 'a memento
 169     method is_begin: bool
 170     method is_end: bool
 171   end
 172
 173 class basic_history (head, tail, cur) =
 174   object
 175     val mutable hd = head  (* insertion point *)
 176     val mutable tl = tail (* oldest inserted item *)
 177     val mutable cur = cur  (* current item for the history *)
 178
 179     method is_begin = cur <= tl
 180     method is_end = cur >= hd
 181   end
 182
 183
 184 class shell_history size =
 185   let size = size + 1 in
 186   let decr x = let x' = x - 1 in if x' < 0 then size + x' else x' in
 187   let incr x = (x + 1) mod size in
 188   object (self)
 189     val data = Array.create size ""
 190
 191     inherit basic_history (0, -1 , -1)
 192
 193     method add s =
 194       data.(hd) <- s;
 195       if tl = -1 then tl <- hd;
 196       hd <- incr hd;
 197       if hd = tl then tl <- incr tl;
 198       cur <- hd
 199     method previous =
 200       if cur = tl then raise History_failure;
 201       cur <- decr cur;
 202       data.(cur)
 203     method next =
 204       if cur = hd then raise History_failure;
 205       cur <- incr cur;
 206       if cur = hd then "" else data.(cur)
 207     method load (data', hd', tl', cur') =
 208       assert (Array.length data = Array.length data');
 209       hd <- hd'; tl <- tl'; cur <- cur';
 210       Array.blit data' 0 data 0 (Array.length data')
 211     method save = (Array.copy data, hd, tl, cur)
 212   end
 213
 214 class ['a] browser_history ?memento size init =
 215   object (self)
 216     initializer match memento with Some m -> self#load m | _ -> ()
 217     val data = Array.create size init
 218
 219     inherit basic_history (0, 0, 0)
 220
 221     method previous =
 222       if cur = tl then raise History_failure;
 223       cur <- cur - 1;
 224       if cur = ~-1 then cur <- size - 1;
 225       data.(cur)
 226     method next =
 227       if cur = hd then raise History_failure;
 228       cur <- cur + 1;
 229       if cur = size then cur <- 0;
 230       data.(cur)
 231     method add (e:'a) =
 232       if e <> data.(cur) then
 233         begin
 234           cur <- cur + 1;
 235           if cur = size then cur <- 0;
 236           if cur = tl then tl <- tl + 1;
 237           if tl = size then tl <- 0;
 238           hd <- cur;
 239           data.(cur) <- e
 240         end
 241     method load (data', hd', tl', cur') =
 242       assert (Array.length data = Array.length data');
 243       hd <- hd'; tl <- tl'; cur <- cur';
 244       Array.blit data' 0 data 0 (Array.length data')
 245     method save = (Array.copy data, hd, tl, cur)
 246   end
 247
 248 let singleton f =
 249   let instance = lazy (f ()) in
 250   fun () -> Lazy.force instance
 251
 252 let get_proof_status status =
 253   match status.proof_status with
 254   | Incomplete_proof s -> s
 255   | _ -> statement_error "no ongoing proof"
 256
 257 let get_proof_metasenv status =
 258   match status.proof_status with
 259   | No_proof -> []
 260   | Incomplete_proof ((_, metasenv, _, _), _) -> metasenv
 261   | Proof (_, metasenv, _, _) -> metasenv
 262   | Intermediate m -> m
 263
 264 let get_proof_context status =
 265   match status.proof_status with
 266   | Incomplete_proof ((_, metasenv, _, _), goal) ->
 267       let (_, context, _) = CicUtil.lookup_meta goal metasenv in
 268       context
 269   | _ -> []
 270
 271 let get_proof_conclusion status =
 272   match status.proof_status with
 273   | Incomplete_proof ((_, metasenv, _, _), goal) ->
 274       let (_, _, conclusion) = CicUtil.lookup_meta goal metasenv in
 275       conclusion
 276   | _ -> statement_error "no ongoing proof"
 277
 278 let get_proof_aliases status = status.aliases
 279
 280 let qualify status name = get_string_option status "baseuri" ^ "/" ^ name
 281
 282 let unopt = function None -> failwith "unopt: None" | Some v -> v
 283
 284 let image_path n = sprintf "%s/%s" BuildTimeConf.images_dir n
 285
 286 let end_ma_RE = Pcre.regexp "\\.ma$"
 287
 288 let obj_file_of_baseuri baseuri =
 289  let path =
 290   Helm_registry.get "matita.basedir" ^ "/xml" ^
 291    Pcre.replace ~pat:"^cic:" ~templ:"" baseuri
 292  in
 293   path ^ ".moo"
 294
 295 let obj_file_of_script f =
 296  if f = "coq.ma" then BuildTimeConf.coq_notation_script else
 297   let baseuri = baseuri_of_file f in
 298    obj_file_of_baseuri baseuri
 299
 300 let rec list_uniq = function
 301   | [] -> []
 302   | h::[] -> [h]
 303   | h1::h2::tl when h1 = h2 -> list_uniq (h2 :: tl)
 304   | h1::tl (* when h1 <> h2 *) -> h1 :: list_uniq tl
 305
 306 let list_tl_at ?(equality=(==)) e l =
 307   let rec aux =
 308     function
 309     | [] -> raise Not_found
 310     | hd :: tl as l when equality hd e -> l
 311     | hd :: tl -> aux tl
 312   in
 313   aux l
 314
 315 let debug_wrap name f =
 316   prerr_endline (sprintf "debug_wrap: ==>> %s" name);
 317   let res = f () in
 318   prerr_endline (sprintf "debug_wrap: <<== %s" name);
 319   res
 320