helm/software/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 exception NoUnfinishedProof
  27 exception ActionCancelled of string
  28
  29 class type script =
  30 object
  31
  32   method locked_mark : Gtk.text_mark
  33   method locked_tag : GText.tag
  34   method error_tag : GText.tag
  35
  36     (** @return current status *)
  37   method lexicon_status: LexiconEngine.status
  38   method grafite_status: GrafiteTypes.status
  39
  40   (** {2 Observers} *)
  41
  42   method addObserver :
  43    (LexiconEngine.status -> GrafiteTypes.status -> unit) -> unit
  44
  45   (** {2 History} *)
  46
  47   method advance : ?statement:string -> unit -> unit
  48   method retract : unit -> unit
  49   method goto: [`Top | `Bottom | `Cursor] -> unit -> unit
  50   method reset: unit -> unit
  51   method template: unit -> unit
  52
  53   (** {2 Load/save} *)
  54
  55   method has_name: bool
  56   (* alwais return a name, use has_name to check if it is the default one *)
  57   method filename: string
  58   method buri_of_current_file: string
  59   method include_paths: string list
  60   method assignFileName : string option -> unit (* to the current active file *)
  61   method loadFromFile : string -> unit
  62   method loadFromString : string -> unit
  63   method saveToFile : unit -> unit
  64   method filename : string
  65
  66   (** {2 Current proof} (if any) *)
  67
  68   (** @return true if there is an ongoing proof, false otherise *)
  69   method onGoingProof: unit -> bool
  70
  71   method proofMetasenv: Cic.metasenv          (** @raise Statement_error *)
  72   method proofContext: Cic.context            (** @raise Statement_error *)
  73   method proofConclusion: Cic.term            (** @raise Statement_error *)
  74   method stack: Continuationals.Stack.t       (** @raise Statement_error *)
  75
  76   method setGoal: int option -> unit
  77   method goal: int option
  78
  79   (** end of script, true if the whole script has been executed *)
  80   method eos: bool
  81   method bos: bool
  82
  83   (** misc *)
  84   method clean_dirty_lock: unit
  85
  86   (* debug *)
  87   method dump : unit -> unit
  88
  89 end
  90
  91   (** @param set_star callback used to set the modified symbol (usually a star
  92    * "*") on the side of a script name *)
  93 val script:
  94   source_view:GSourceView.source_view ->
  95   mathviewer: MatitaTypes.mathViewer->
  96   urichooser: (UriManager.uri list -> UriManager.uri list) ->
  97   ask_confirmation:
  98     (title:string -> message:string -> [`YES | `NO | `CANCEL]) ->
  99   set_star: (bool -> unit) ->
 100   unit ->
 101     script
 102
 103 (* each time script above is called an internal ref is set, instance will return
 104  * the value of this ref *)
 105 (* TODO Zack: orrible solution until we found a better one for having a single
 106  * access point for the script *)
 107 val current: unit -> script
 108