1 (* Copyright (C) 2004, HELM Team.
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.
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.
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.
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,
22 * For details, see the HELM World-Wide-Web page,
23 * http://helm.cs.unibo.it/
30 type callback = string -> command_outcome
32 (* let default_prompt = "# " *)
33 let default_prompt = ""
34 let default_phrase_sep = "."
35 let default_callback = fun (phrase: string) -> (true, true)
38 let message_props = [ `STYLE `ITALIC ]
39 let error_props = [ `WEIGHT `BOLD ]
40 let prompt_props = [ ]
42 let trailing_NL_RE = Pcre.regexp "\n\\s*$"
44 exception History_failure
46 (** shell like phrase history *)
48 let size = size + 1 in
49 let decr x = let x' = x - 1 in if x' < 0 then size + x' else x' in
50 let incr x = (x + 1) mod size in
52 val data = Array.create size ""
53 val mutable hd = 0 (* insertion point *)
54 val mutable tl = -1 (* oldest inserted item *)
55 val mutable cur = -1 (* current item for the history *)
58 if tl = -1 then tl <- hd;
60 if hd = tl then tl <- incr tl;
63 if cur = tl then raise History_failure;
67 if cur = hd then raise History_failure;
69 if cur = hd then "" else data.(cur)
73 ?(prompt = default_prompt) ?(phrase_sep = default_phrase_sep)
74 ?(callback = default_callback) ?evbox ~(paned:GPack.paned) obj
76 let console_height = 100 in (* pixels *)
78 inherit GText.view obj
80 val mutable _phrase_sep = phrase_sep
81 method phrase_sep = _phrase_sep
82 method set_phrase_sep sep = _phrase_sep <- sep
84 val mutable _prompt = prompt
85 method prompt = _prompt
86 method set_prompt prompt = _prompt <- prompt
88 val mutable _callback = callback
89 method set_callback f = _callback <- f
91 val mutable _ignore_insert_text_signal = false
92 method ignore_insert_text_signal ignore =
93 _ignore_insert_text_signal <- ignore
95 val history = new history BuildTimeConf.console_history_size
97 val mutable handle_position = 450
98 val mutable last_phrase = ""
101 let buf = self#buffer in
102 self#set_wrap_mode `CHAR;
104 (* create "USER_INPUT_START" mark. This mark will always point to the
105 * beginning of user input not yet processed *)
106 ignore (buf#create_mark ~name:"USER_INPUT_START"
107 ~left_gravity:true buf#start_iter);
108 ignore (buf#connect#after#insert_text (fun iter text ->
109 if (not _ignore_insert_text_signal) &&
110 (iter#compare buf#end_iter = 0) && (* insertion at end *)
111 (Pcre.pmatch ~rex:trailing_NL_RE text)
114 MatitaMisc.strip_trailing_blanks
116 ~start:(buf#get_iter_at_mark (`NAME "USER_INPUT_START"))
117 ~stop:buf#end_iter ())
119 let pat = (Pcre.quote _phrase_sep) ^ "\\s*$" in
120 if Pcre.pmatch ~pat inserted_text then begin (* complete phrase *)
122 last_phrase <- inserted_text;
123 self#invoke_callback inserted_text;
126 (match evbox with (* history key bindings *)
129 List.iter (fun (key, f) -> MatitaGtkMisc.add_key_binding key f evbox)
130 [ GdkKeysyms._p, (fun () -> self#previous_phrase);
131 GdkKeysyms._n, (fun () -> self#next_phrase);
133 ignore (self#connect#after#move_cursor
134 (* avoid cursor being placed at prompt's left *)
135 ~callback:(fun step count ~extend ->
136 let buf = self#buffer in
137 let cursor_iter = buf#get_iter_at_mark `INSERT in
138 let prompt_iter = buf#get_iter_at_mark (`NAME "USER_INPUT_START") in
139 if prompt_iter#compare cursor_iter = 1 then (* prompt > cursor *)
140 buf#place_cursor ~where:prompt_iter))
142 method private set_phrase phrase =
143 let buf = self#buffer in
145 ~start:(buf#get_iter_at_mark (`NAME "USER_INPUT_START"))
147 buf#insert ~iter:buf#end_iter phrase
149 method private invoke_callback phrase =
151 let (success, hide) = _callback phrase in
152 if hide then self#hide ()
155 let buf = self#buffer in
156 buf#delete ~start:buf#start_iter ~stop:buf#end_iter
158 (* lock old text and bump USER_INPUT_START mark *)
159 method private lock =
160 let buf = self#buffer in
161 let read_only = buf#create_tag [`EDITABLE false] in
162 buf#apply_tag read_only ~start:buf#start_iter ~stop:buf#end_iter;
163 buf#move_mark (`NAME "USER_INPUT_START") buf#end_iter
165 method echo_prompt () =
166 let buf = self#buffer in
167 self#ignore_insert_text_signal true;
168 buf#insert ~iter:buf#end_iter ~tags:[buf#create_tag prompt_props] prompt;
169 self#ignore_insert_text_signal false;
172 method echo_message msg =
174 let buf = self#buffer in
175 self#ignore_insert_text_signal true;
176 buf#insert ~iter:buf#end_iter ~tags:[buf#create_tag message_props]
178 self#ignore_insert_text_signal false;
181 method echo_error msg =
183 let buf = self#buffer in
184 self#ignore_insert_text_signal true;
185 buf#insert ~iter:buf#end_iter ~tags:[buf#create_tag error_props]
187 self#ignore_insert_text_signal false;
190 method private get_paned_prop s =
191 Gobject.get { Gobject.name = s; Gobject.conv = Gobject.Data.int }
193 method private get_position = self#get_paned_prop "position"
194 method private get_min_position = self#get_paned_prop "min-position"
195 method private get_max_position = self#get_paned_prop "max-position"
197 method show ?(msg = "") () =
198 self#buffer#insert msg;
199 paned#set_position (self#get_max_position - console_height);
200 self#misc#grab_focus ()
201 method hide () = (* ZACK still not sure about the gui, for the moment just
202 * keep the console persistent *)
204 (* paned#set_position self#get_max_position *)
206 let pos = self#get_position in
207 if pos > self#get_max_position - console_height then
212 (** navigation methods: history, cursor motion, ... *)
214 method private previous_phrase =
215 try self#set_phrase history#previous with History_failure -> ()
216 method private next_phrase =
217 try self#set_phrase history#next with History_failure -> ()
219 method wrap_exn: 'a. (unit -> 'a) -> 'a option =
224 (match exn with (* highlight parse errors in user input *)
225 | CicTextualParser2.Parse_error (floc, msg) ->
226 let buf = self#buffer in
227 let (x, y) = CicAst.loc_of_floc floc in
228 let red = buf#create_tag [`FOREGROUND "red"] in
229 let (start_error_pos, end_error_pos) =
230 buf#end_iter#backward_chars (String.length last_phrase - x),
231 buf#end_iter#backward_chars (String.length last_phrase - y)
233 if x - y = 0 then (* no region to highlight, let's add an hint
234 about where the error occured *)
235 buf#insert ~iter:end_error_pos ~tags:[red] bullet
236 else (* highlight the region where the error occured *)
237 buf#apply_tag red ~start:start_error_pos ~stop:end_error_pos;
239 self#echo_error (explain exn);
245 ?(prompt = default_prompt) ?(phrase_sep = default_phrase_sep)
246 ?(callback = default_callback) ?evbox ~paned
247 ?buffer ?editable ?cursor_visible ?justification ?wrap_mode ?border_width
248 ?width ?height ?packing ?show ()
252 ?buffer ?editable ?cursor_visible ?justification ?wrap_mode ?border_width
253 ?width ?height ?packing ?show ()
255 new console ~prompt ~phrase_sep ~callback ?evbox ~paned view#as_view
257 (* vim: set encoding=utf8: *)