Mercurial > octave-nkf
annotate liboctave/cmd-edit.h @ 11523:fd0a3ac60b0e
update copyright notices
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Fri, 14 Jan 2011 05:47:45 -0500 |
| parents | 4c0cdbe0acca |
| children | 12df7854fa7c |
| rev | line source |
|---|---|
| 2926 | 1 /* |
| 2 | |
| 11523 | 3 Copyright (C) 1996-2011 John W. Eaton |
| 2926 | 4 |
| 5 This file is part of Octave. | |
| 6 | |
| 7 Octave is free software; you can redistribute it and/or modify it | |
| 8 under the terms of the GNU General Public License as published by the | |
| 7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
| 10 option) any later version. | |
| 2926 | 11 |
| 12 Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 15 for more details. | |
| 16 | |
| 17 You should have received a copy of the GNU General Public License | |
| 7016 | 18 along with Octave; see the file COPYING. If not, see |
| 19 <http://www.gnu.org/licenses/>. | |
| 2926 | 20 |
| 21 */ | |
| 22 | |
| 23 #if !defined (octave_cmd_edit_h) | |
| 24 #define octave_cmd_edit_h 1 | |
| 25 | |
| 26 #include <cstdio> | |
| 27 | |
| 6913 | 28 #include <set> |
| 2926 | 29 #include <string> |
| 30 | |
| 4604 | 31 #include "str-vec.h" |
| 32 | |
| 2926 | 33 class |
| 6108 | 34 OCTAVE_API |
| 2926 | 35 command_editor |
| 36 { | |
| 37 protected: | |
| 38 | |
| 39 command_editor (void) | |
| 40 : command_number (0) { } | |
| 41 | |
| 42 public: | |
| 43 | |
| 4802 | 44 typedef int (*startup_hook_fcn) (void); |
| 3519 | 45 |
| 4802 | 46 typedef int (*event_hook_fcn) (void); |
| 2926 | 47 |
| 3504 | 48 typedef std::string (*completion_fcn) (const std::string&, int); |
| 2941 | 49 |
| 6979 | 50 typedef std::string (*quoting_fcn) (const std::string&, int, char); |
| 51 | |
| 52 typedef std::string (*dequoting_fcn) (const std::string&, int); | |
| 53 | |
| 54 typedef int (*char_is_quoted_fcn) (const std::string&, int); | |
| 55 | |
| 56 typedef void (*user_accept_line_fcn) (const std::string&); | |
| 57 | |
| 2926 | 58 virtual ~command_editor (void) { } |
| 59 | |
| 3504 | 60 static void set_name (const std::string& n); |
| 2926 | 61 |
| 3504 | 62 static std::string readline (const std::string& prompt); |
| 2926 | 63 |
| 3504 | 64 static std::string readline (const std::string& prompt, bool& eof); |
| 3219 | 65 |
| 2926 | 66 static void set_input_stream (FILE *f); |
| 67 | |
| 68 static FILE *get_input_stream (void); | |
| 69 | |
| 70 static void set_output_stream (FILE *f); | |
| 71 | |
| 72 static FILE *get_output_stream (void); | |
| 73 | |
| 74 static int terminal_rows (void); | |
| 75 | |
| 76 static int terminal_cols (void); | |
| 77 | |
| 78 static void clear_screen (void); | |
| 79 | |
| 3281 | 80 static void resize_terminal (void); |
| 81 | |
| 3504 | 82 static std::string decode_prompt_string (const std::string& s); |
| 2926 | 83 |
| 84 static void restore_terminal_state (void); | |
| 85 | |
| 86 static void blink_matching_paren (bool flag); | |
| 87 | |
| 4055 | 88 static void set_basic_word_break_characters (const std::string& s); |
| 3933 | 89 |
| 4055 | 90 static void set_completer_word_break_characters (const std::string& s); |
| 3933 | 91 |
| 3504 | 92 static void set_basic_quote_characters (const std::string& s); |
| 2926 | 93 |
| 6979 | 94 static void set_filename_quote_characters (const std::string& s); |
| 95 | |
| 96 static void set_completer_quote_characters (const std::string& s); | |
| 97 | |
| 2926 | 98 static void set_completion_append_character (char c); |
| 99 | |
| 2941 | 100 static void set_completion_function (completion_fcn f); |
| 101 | |
| 6979 | 102 static void set_quoting_function (quoting_fcn f); |
| 103 | |
| 104 static void set_dequoting_function (dequoting_fcn f); | |
| 105 | |
| 106 static void set_char_is_quoted_function (char_is_quoted_fcn f); | |
| 107 | |
| 108 static void set_user_accept_line_function (user_accept_line_fcn f); | |
| 109 | |
| 2941 | 110 static completion_fcn get_completion_function (void); |
| 2926 | 111 |
| 6979 | 112 static quoting_fcn get_quoting_function (void); |
| 113 | |
| 114 static dequoting_fcn get_dequoting_function (void); | |
| 115 | |
| 116 static char_is_quoted_fcn get_char_is_quoted_function (void); | |
| 117 | |
| 118 static user_accept_line_fcn get_user_accept_line_function (void); | |
| 119 | |
| 4604 | 120 static string_vector generate_filename_completions (const std::string& text); |
| 121 | |
|
9485
3cee58bf4acf
selectively complete filenames in some cases
John W. Eaton <jwe@octave.org>
parents:
9321
diff
changeset
|
122 static std::string get_line_buffer (void); |
|
3cee58bf4acf
selectively complete filenames in some cases
John W. Eaton <jwe@octave.org>
parents:
9321
diff
changeset
|
123 |
| 3504 | 124 static void insert_text (const std::string& text); |
| 2926 | 125 |
| 126 static void newline (void); | |
| 127 | |
| 6979 | 128 static void accept_line (void); |
| 129 | |
| 2926 | 130 static void clear_undo_list (void); |
| 131 | |
| 6913 | 132 static void add_startup_hook (startup_hook_fcn f); |
| 2926 | 133 |
| 6913 | 134 static void remove_startup_hook (startup_hook_fcn f); |
| 2926 | 135 |
| 6913 | 136 static void add_event_hook (event_hook_fcn f); |
| 3215 | 137 |
| 6913 | 138 static void remove_event_hook (event_hook_fcn f); |
| 3215 | 139 |
| 3504 | 140 static void read_init_file (const std::string& file = std::string ()); |
| 3189 | 141 |
|
7758
8e14a01ffe9f
input.cc (Fre_read_readline_init_file): new function
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
142 static void re_read_init_file (void); |
|
8e14a01ffe9f
input.cc (Fre_read_readline_init_file): new function
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
143 |
| 4143 | 144 static bool filename_completion_desired (bool); |
| 145 | |
| 6979 | 146 static bool filename_quoting_desired (bool); |
| 147 | |
| 2926 | 148 static int current_command_number (void); |
| 149 | |
| 150 static void reset_current_command_number (int n); | |
| 151 | |
| 2967 | 152 static void increment_current_command_number (void); |
| 153 | |
|
9321
9b87aeb24ea9
avoid using readline at all when line editing suppressed or interpreter embedded
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
154 static void force_default_editor (void); |
|
9b87aeb24ea9
avoid using readline at all when line editing suppressed or interpreter embedded
Jaroslav Hajek <highegg@gmail.com>
parents:
8920
diff
changeset
|
155 |
| 2926 | 156 private: |
| 157 | |
| 158 // No copying! | |
| 159 | |
| 160 command_editor (const command_editor&); | |
| 161 | |
| 162 command_editor& operator = (const command_editor&); | |
| 163 | |
| 164 static bool instance_ok (void); | |
| 165 | |
| 166 static void make_command_editor (void); | |
| 167 | |
| 6913 | 168 static int startup_handler (void); |
| 169 | |
| 170 static int event_handler (void); | |
| 171 | |
| 172 static std::set<startup_hook_fcn> startup_hook_set; | |
| 173 | |
| 174 static std::set<event_hook_fcn> event_hook_set; | |
| 175 | |
| 176 typedef std::set<startup_hook_fcn>::iterator startup_hook_set_iterator; | |
| 177 typedef std::set<startup_hook_fcn>::const_iterator startup_hook_set_const_iterator; | |
| 178 | |
| 179 typedef std::set<event_hook_fcn>::iterator event_hook_set_iterator; | |
| 180 typedef std::set<event_hook_fcn>::const_iterator event_hook_set_const_iterator; | |
| 181 | |
| 2926 | 182 // The real thing. |
| 183 static command_editor *instance; | |
| 184 | |
| 185 protected: | |
| 186 | |
| 187 // To use something other than the GNU readline library, derive a new | |
| 188 // class from command_editor, overload these functions as | |
| 189 // necessary, and make instance point to the new class. | |
| 190 | |
| 3504 | 191 virtual void do_set_name (const std::string&) { } |
| 2926 | 192 |
| 3504 | 193 std::string do_readline (const std::string& prompt) |
| 3219 | 194 { |
| 195 bool eof; | |
| 196 | |
| 197 return do_readline (prompt, eof); | |
| 198 } | |
| 199 | |
| 3504 | 200 virtual std::string do_readline (const std::string&, bool&) = 0; |
| 2926 | 201 |
| 202 virtual void do_set_input_stream (FILE *) = 0; | |
| 203 | |
| 204 virtual FILE *do_get_input_stream (void) = 0; | |
| 205 | |
| 206 virtual void do_set_output_stream (FILE *) = 0; | |
| 207 | |
| 208 virtual FILE *do_get_output_stream (void) = 0; | |
| 209 | |
| 210 virtual int do_terminal_rows (void) { return 24; } | |
| 211 | |
| 212 virtual int do_terminal_cols (void) { return 80; } | |
| 213 | |
| 214 virtual void do_clear_screen (void) { } | |
| 215 | |
| 3281 | 216 virtual void do_resize_terminal (void) { } |
| 217 | |
| 3504 | 218 virtual std::string do_decode_prompt_string (const std::string&); |
| 2926 | 219 |
| 3504 | 220 virtual std::string newline_chars (void) { return "\n"; } |
| 2926 | 221 |
| 222 virtual void do_restore_terminal_state (void) { } | |
| 223 | |
| 224 virtual void do_blink_matching_paren (bool) { } | |
| 225 | |
| 3933 | 226 virtual void do_set_basic_word_break_characters (const std::string&) { } |
| 227 | |
| 228 virtual void do_set_completer_word_break_characters (const std::string&) { } | |
| 229 | |
| 3504 | 230 virtual void do_set_basic_quote_characters (const std::string&) { } |
| 2926 | 231 |
| 6979 | 232 virtual void do_set_filename_quote_characters (const std::string&) { } |
| 233 | |
| 234 virtual void do_set_completer_quote_characters (const std::string&) { } | |
| 235 | |
| 2926 | 236 virtual void do_set_completion_append_character (char) { } |
| 237 | |
| 2941 | 238 virtual void do_set_completion_function (completion_fcn) { } |
| 239 | |
| 6979 | 240 virtual void do_set_quoting_function (quoting_fcn) { } |
| 241 | |
| 242 virtual void do_set_dequoting_function (dequoting_fcn) { } | |
| 243 | |
| 244 virtual void do_set_char_is_quoted_function (char_is_quoted_fcn) { } | |
| 245 | |
| 246 virtual void do_set_user_accept_line_function (user_accept_line_fcn) { } | |
| 247 | |
| 2941 | 248 virtual completion_fcn do_get_completion_function (void) const { return 0; } |
| 2926 | 249 |
| 6979 | 250 virtual quoting_fcn do_get_quoting_function (void) const { return 0; } |
| 251 | |
| 252 virtual dequoting_fcn do_get_dequoting_function (void) const { return 0; } | |
| 253 | |
| 254 virtual char_is_quoted_fcn do_get_char_is_quoted_function (void) const { return 0; } | |
| 255 | |
| 256 virtual user_accept_line_fcn do_get_user_accept_line_function (void) const { return 0; } | |
| 257 | |
| 4604 | 258 virtual string_vector do_generate_filename_completions (const std::string& text) = 0; |
| 259 | |
|
9485
3cee58bf4acf
selectively complete filenames in some cases
John W. Eaton <jwe@octave.org>
parents:
9321
diff
changeset
|
260 virtual std::string do_get_line_buffer (void) const = 0; |
|
3cee58bf4acf
selectively complete filenames in some cases
John W. Eaton <jwe@octave.org>
parents:
9321
diff
changeset
|
261 |
| 3504 | 262 virtual void do_insert_text (const std::string&) = 0; |
| 2926 | 263 |
| 264 virtual void do_newline (void) = 0; | |
| 265 | |
| 6979 | 266 virtual void do_accept_line (void) = 0; |
| 267 | |
| 2926 | 268 virtual void do_clear_undo_list (void) { } |
| 269 | |
| 6913 | 270 virtual void set_startup_hook (startup_hook_fcn) { } |
| 2926 | 271 |
| 6913 | 272 virtual void restore_startup_hook (void) { } |
| 2926 | 273 |
| 6913 | 274 virtual void set_event_hook (startup_hook_fcn) { } |
| 3215 | 275 |
| 6913 | 276 virtual void restore_event_hook (void) { } |
| 3215 | 277 |
| 3504 | 278 virtual void do_read_init_file (const std::string&) { } |
| 3189 | 279 |
|
7758
8e14a01ffe9f
input.cc (Fre_read_readline_init_file): new function
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
280 virtual void do_re_read_init_file (void) { } |
|
8e14a01ffe9f
input.cc (Fre_read_readline_init_file): new function
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
281 |
| 4143 | 282 virtual bool do_filename_completion_desired (bool) { return false; } |
| 283 | |
| 6979 | 284 virtual bool do_filename_quoting_desired (bool) { return false; } |
| 285 | |
| 3504 | 286 int read_octal (const std::string& s); |
| 2926 | 287 |
| 288 void error (int); | |
| 289 | |
| 3504 | 290 void error (const std::string&); |
| 2926 | 291 |
| 292 // The current command number. | |
| 293 int command_number; | |
| 294 }; | |
| 295 | |
| 296 #endif |