helm/matita/matitaMisc.mli

   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 val baseuri_of_baseuri_decl:
  27   ('a, 'b, 'c, 'd, 'e) GrafiteAst.statement -> string option
  28
  29   (** check whether no objects are defined below a given baseuri *)
  30 val is_empty: string -> bool
  31
  32 (** removes a file if it exists *)
  33 val safe_remove: string -> unit
  34 (** removes a dir if it exists and is empty *)
  35 val safe_rmdir: string -> unit
  36 (** checks if the dir is empty *)
  37 val is_dir_empty: string -> bool
  38 (** removes a directory and recursively the father (if empty) *)
  39 val rmdir_descend: string -> unit
  40
  41 val absolute_path: string -> string
  42
  43   (** @return true if file is a (textual) proof script *)
  44 val is_proof_script: string -> bool
  45
  46   (** @return true if file is a (binary) proof object *)
  47 val is_proof_object: string -> bool
  48
  49   (** given a phrase, if it doesn't end with BuildTimeConf.phrase_sep, append
  50   * it *)
  51 val append_phrase_sep: string -> string
  52
  53 val strip_trailing_slash: string -> string
  54 val normalize_dir: string -> string (** add trailing "/" if missing *)
  55 val strip_suffix: suffix:string -> string -> string
  56
  57   (** @return tl tail of a list starting at a given element
  58    * @param eq equality to be used, defaults to physical equality (==)
  59    * @raise Not_found *)
  60 val list_tl_at: ?equality:('a -> 'a -> bool) -> 'a -> 'a list -> 'a list
  61
  62 exception History_failure
  63
  64 type 'a memento
  65
  66 class type ['a] history =
  67   object ('b)
  68     method add : 'a -> unit
  69     method next : 'a        (** @raise History_failure *)
  70     method previous : 'a    (** @raise History_failure *)
  71     method load: 'a memento -> unit
  72     method save: 'a memento
  73     method is_begin: bool
  74     method is_end: bool
  75   end
  76
  77   (** shell like history: new items added at the end of the history
  78   * @param size maximum history size *)
  79 class shell_history : int -> [string] history
  80
  81   (** browser like history: new items added at the current point of the history
  82   * @param size maximum history size
  83   * @param first element in history (this history is never empty) *)
  84 class ['a] browser_history: ?memento:'a memento -> int -> 'a -> ['a] history
  85
  86   (** create a singleton from a given function. Given function is invoked the
  87   * first time it gets called. Next invocation will return first value *)
  88 val singleton: (unit -> 'a) -> (unit -> 'a)
  89
  90   (** given the base name of an image, returns its full path *)
  91 val image_path: string -> string
  92 val obj_file_of_baseuri: string -> string
  93