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/
26 let default_prompt = "# "
27 let default_phrase_sep = "."
28 let default_callback = fun (phrase: string) -> ()
30 let message_props = [ `STYLE `ITALIC ]
31 let error_props = [ `WEIGHT `BOLD ]
32 let prompt_props = [ ]
34 let trailing_NL_RE = Pcre.regexp "\n\\s*$"
36 exception History_failure
38 (** shell like phrase history *)
40 let size = size + 1 in
41 let decr x = let x' = x - 1 in if x' < 0 then size + x' else x' in
42 let incr x = (x + 1) mod size in
44 val data = Array.create size ""
45 val mutable hd = 0 (* insertion point *)
46 val mutable tl = -1 (* oldest inserted item *)
47 val mutable cur = -1 (* current item for the history *)
50 if tl = -1 then tl <- hd;
52 if hd = tl then tl <- incr tl;
55 if cur = tl then raise History_failure;
59 if cur = hd then raise History_failure;
61 if cur = hd then "" else data.(cur)
65 ?(prompt = default_prompt) ?(phrase_sep = default_phrase_sep)
66 ?(callback = default_callback) ?evbox obj
69 inherit GText.view obj
71 val mutable _phrase_sep = phrase_sep
72 method phrase_sep = _phrase_sep
73 method set_phrase_sep sep = _phrase_sep <- sep
75 val mutable _prompt = prompt
76 method prompt = _prompt
77 method set_prompt prompt = _prompt <- prompt
79 val mutable _callback = callback
80 method set_callback f = _callback <- f
82 val mutable _ignore_insert_text_signal = false
83 method ignore_insert_text_signal ignore =
84 _ignore_insert_text_signal <- ignore
86 val history = new history BuildTimeConf.console_history_size
89 let buf = self#buffer in
90 self#set_wrap_mode `CHAR;
91 (* create "USER_INPUT_START" mark. This mark will always point to the
92 * beginning of user input not yet processed *)
93 ignore (buf#create_mark ~name:"USER_INPUT_START"
94 ~left_gravity:true buf#start_iter);
95 ignore (buf#connect#after#insert_text (fun iter text ->
96 if (not _ignore_insert_text_signal) &&
97 (iter#compare buf#end_iter = 0) && (* insertion at end *)
98 (Pcre.pmatch ~rex:trailing_NL_RE text)
102 ~start:(buf#get_iter_at_mark (`NAME "USER_INPUT_START"))
103 ~stop:buf#end_iter ()
105 let pat = (Pcre.quote _phrase_sep) ^ "\\s*$" in
106 if Pcre.pmatch ~pat inserted_text then begin (* complete phrase *)
108 self#invoke_callback inserted_text;
111 (match evbox with (* history key bindings *)
114 List.iter (fun (key, f) -> MatitaGtkMisc.add_key_binding key f evbox)
115 [ GdkKeysyms._p, (fun () -> self#previous_phrase);
116 GdkKeysyms._n, (fun () -> self#next_phrase);
118 ignore (self#connect#after#move_cursor
119 (* avoid cursor being placed at prompt's left *)
120 ~callback:(fun step count ~extend ->
121 let buf = self#buffer in
122 let cursor_iter = buf#get_iter_at_mark `INSERT in
123 let prompt_iter = buf#get_iter_at_mark (`NAME "USER_INPUT_START") in
124 if prompt_iter#compare cursor_iter = 1 then (* prompt > cursor *)
125 buf#place_cursor ~where:prompt_iter))
127 method private set_phrase phrase =
128 let buf = self#buffer in
130 ~start:(buf#get_iter_at_mark (`NAME "USER_INPUT_START"))
132 buf#insert ~iter:buf#end_iter phrase
134 method private invoke_callback phrase =
135 history#add (* do not push trailing phrase separator *)
137 (String.length phrase - String.length _phrase_sep));
140 (* lock old text and bump USER_INPUT_START mark *)
141 method private lock =
142 let buf = self#buffer in
143 let read_only = buf#create_tag [`EDITABLE false] in
144 buf#apply_tag read_only ~start:buf#start_iter ~stop:buf#end_iter;
145 buf#move_mark (`NAME "USER_INPUT_START") buf#end_iter
147 method echo_prompt () =
148 let buf = self#buffer in
149 self#ignore_insert_text_signal true;
150 buf#insert ~iter:buf#end_iter ~tags:[buf#create_tag prompt_props] prompt;
151 self#ignore_insert_text_signal false;
154 method echo_message msg =
155 let buf = self#buffer in
156 self#ignore_insert_text_signal true;
157 buf#insert ~iter:buf#end_iter ~tags:[buf#create_tag message_props]
159 self#ignore_insert_text_signal false;
162 method echo_error msg =
163 let buf = self#buffer in
164 self#ignore_insert_text_signal true;
165 buf#insert ~iter:buf#end_iter ~tags:[buf#create_tag error_props]
167 self#ignore_insert_text_signal false;
171 (** navigation methods: history, cursor motion, ... *)
173 method private previous_phrase =
174 try self#set_phrase history#previous with History_failure -> ()
175 method private next_phrase =
176 try self#set_phrase history#next with History_failure -> ()
181 ?(prompt = default_prompt) ?(phrase_sep = default_phrase_sep)
182 ?(callback = default_callback) ?evbox
183 ?buffer ?editable ?cursor_visible ?justification ?wrap_mode ?border_width
184 ?width ?height ?packing ?show ()
188 ?buffer ?editable ?cursor_visible ?justification ?wrap_mode ?border_width
189 ?width ?height ?packing ?show ()
191 new console ~prompt ~phrase_sep ~callback ?evbox view#as_view