helm/matita/matitaScript.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 class type script =
  27 object
  28
  29   (** @return current status *)
  30   method status: MatitaTypes.status
  31
  32   (** {2 Observers} *)
  33
  34   method addObserver : (MatitaTypes.status -> unit) -> unit
  35
  36   (** {2 History} *)
  37
  38   method advance : ?statement:string -> unit -> unit
  39   method retract : unit -> unit
  40   method goto: [`Top | `Bottom | `Cursor] -> unit -> unit
  41   method reset: unit -> unit
  42   method template: unit -> unit
  43
  44   (** {2 Load/save} *)
  45
  46   method assignFileName : string -> unit (* to the current active file *)
  47   method loadFromFile : unit -> unit
  48   method saveToFile : unit -> unit
  49
  50   (** {2 Current proof} (if any) *)
  51
  52   (** @return true if there is an ongoing proof, false otherise *)
  53   method onGoingProof: unit -> bool
  54
  55   method proofStatus: ProofEngineTypes.status (** @raise Statement_error *)
  56   method proofMetasenv: Cic.metasenv          (** @raise Statement_error *)
  57   method proofContext: Cic.context            (** @raise Statement_error *)
  58
  59   method setGoal: int -> unit
  60
  61   (** end of script, true if the whole script has been executed *)
  62   method eos: bool
  63
  64   (** misc *)
  65   method clean_dirty_lock: unit
  66
  67   (* debug *)
  68   method dump : unit -> unit
  69
  70 end
  71
  72   (** @param set_star callback used to set the modified symbol (usually a star
  73    * "*") on the side of a script name *)
  74 val script:
  75   buffer:GText.buffer ->
  76   init:MatitaTypes.status ->
  77   mathviewer: MatitaTypes.mathViewer->
  78   urichooser: (UriManager.uri list -> UriManager.uri list) ->
  79   ask_confirmation:
  80     (title:string -> message:string -> [`YES | `NO | `CANCEL]) ->
  81   set_star: (string -> bool -> unit) ->
  82   unit ->
  83     script
  84
  85 (* each time script above is called an internal ref is set, instance will return
  86  * the value of this ref *)
  87 (* TODO Zack: orrible solution until we found a better one for having a single
  88  * access point for the script *)
  89 val instance: unit -> script
  90