helm/matita/matitaConsole.mli

   1 (* Copyright (C) 2004, 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 type callback = string -> MatitaTypes.command_outcome
  27
  28   (** @param evbox event box to which keyboard shortcuts are registered; no
  29   * shortcut will be registered if evbox is not given *)
  30 class console:
  31   ?prompt:string -> ?phrase_sep:string -> ?callback:callback ->
  32   ?evbox:GBin.event_box -> paned:GPack.paned -> Gtk.text_view Gtk.obj ->
  33   object
  34     inherit GText.view
  35
  36     method echo_prompt    : unit -> unit
  37     method echo_message   : string -> unit
  38     method echo_error     : string -> unit
  39     method clear          : unit -> unit
  40
  41       (* console visibility handling inside VPaned *)
  42
  43       (** @param msg if given, show the console with a prefeed input, cursor
  44       * just after it; defaults to the empty string *)
  45     method show           : ?msg:string -> unit -> unit
  46     method hide           : unit -> unit
  47     method toggle         : unit -> unit
  48
  49     method prompt         : string
  50     method set_prompt     : string -> unit
  51
  52     method phrase_sep     : string
  53     method set_phrase_sep : string -> unit
  54
  55       (** override previous callback definition *)
  56     method set_callback   : callback -> unit
  57
  58     method ignore_insert_text_signal: bool -> unit
  59
  60       (** execute a unit -> 'a function, if it raises exceptions shows them as
  61       * errors in the console.
  62       * @return Some of the returned value if the given function suceeds, None
  63       * otherwise *)
  64     method wrap_exn       : 'a. (unit -> 'a) -> 'a option
  65   end
  66
  67   (** @param prompt user prompt (default "# ")
  68    * @param phrase_sep phrase separator (default ".")
  69    * @param callback callback invoked upon reading of a phrase. Callback
  70    * may be invoked more than once if multiple phrases have been inserted before
  71    * hitting return (default: do nothing) *)
  72 val console :
  73   ?prompt:string ->
  74   ?phrase_sep:string ->
  75   ?callback:callback ->
  76   ?evbox:GBin.event_box ->
  77   paned:GPack.paned ->
  78
  79   ?buffer:GText.buffer ->
  80   ?editable:bool ->
  81   ?cursor_visible:bool ->
  82   ?justification:Gtk.Tags.justification ->
  83   ?wrap_mode:Gtk.Tags.wrap_mode ->
  84   ?border_width:int ->
  85   ?width:int ->
  86   ?height:int ->
  87   ?packing:(GObj.widget -> unit) -> ?show:bool -> unit -> console
  88