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