matita/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 grafite_status: GrafiteTypes.status
  38
  39   (** {2 Observers} *)
  40
  41   method addObserver : (GrafiteTypes.status -> unit) -> unit
  42
  43   (** {2 Unicode handling} *)
  44   method nextSimilarSymbol: unit
  45
  46   (** {2 Undo/redo} *)
  47
  48   method safe_undo: unit
  49   method safe_redo: unit
  50
  51   (** {2 History} *)
  52
  53   method advance : ?statement:string -> unit -> unit
  54   method retract : unit -> unit
  55   method goto: [`Top | `Bottom | `Cursor] -> unit -> unit
  56   method reset: unit -> unit
  57   method template: unit -> unit
  58
  59     (** {2 Selections / clipboards handling} *)
  60
  61   method markupSelected: bool
  62   method canCopy: bool
  63   method canCut: bool
  64   method canDelete: bool
  65   (*CSC: WRONG CODE: we should look in the clipboard instead! *)
  66   method canPaste: bool
  67   method canPastePattern: bool
  68
  69   method copy:         unit -> unit
  70   method cut:          unit -> unit
  71   method delete:       unit -> unit
  72   method paste:        unit -> unit
  73   method pastePattern: unit -> unit
  74
  75   (** {2 Load/save} *)
  76
  77   method has_name: bool
  78   (* alwais return a name, use has_name to check if it is the default one *)
  79   method filename: string
  80   method buri_of_current_file: string
  81   method include_paths: string list
  82   method assignFileName : string option -> unit (* to the current active file *)
  83   method loadFromFile : string -> unit
  84   method loadFromString : string -> unit
  85   method saveToFile : unit -> unit
  86
  87   (** {2 Current proof} (if any) *)
  88
  89   method stack: Continuationals.Stack.t       (** @raise Statement_error *)
  90
  91   method setGoal: int option -> unit
  92   method goal: int option
  93
  94   (** end of script, true if the whole script has been executed *)
  95   method eos: bool
  96   method bos: bool
  97
  98   (** misc *)
  99   method clean_dirty_lock: unit
 100   method set_star: bool -> unit
 101   method source_view: GSourceView2.source_view
 102   method has_parent: GObj.widget -> bool
 103
 104   (* debug *)
 105   method dump : unit -> unit
 106   method expandAllVirtuals : unit
 107
 108 end
 109
 110 val script:
 111   urichooser: (GSourceView2.source_view -> NReference.reference list -> NReference.reference list) ->
 112   ask_confirmation:
 113     (title:string -> message:string -> [`YES | `NO | `CANCEL]) ->
 114   parent:GBin.scrolled_window ->
 115   tab_label:GMisc.label ->
 116   unit ->
 117     script
 118
 119 val current: unit -> script
 120 val iter_scripts: (script -> unit) -> unit