Mercurial > octave-nkf
annotate src/oct-hist.cc @ 10066:2cd940306a06
make unwind_protect frames local
| author | Jaroslav Hajek <highegg@gmail.com> |
|---|---|
| date | Wed, 06 Jan 2010 13:18:41 +0100 |
| parents | 610bf90fce2a |
| children | cd96d29c5efa |
| rev | line source |
|---|---|
| 1 | 1 /* |
| 2 | |
| 7017 | 3 Copyright (C) 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2002, 2003, |
| 8920 | 4 2005, 2006, 2007, 2008, 2009 John W. Eaton |
| 1 | 5 |
| 6 This file is part of Octave. | |
| 7 | |
| 8 Octave is free software; you can redistribute it and/or modify it | |
| 9 under the terms of the GNU General Public License as published by the | |
| 7016 | 10 Free Software Foundation; either version 3 of the License, or (at your |
| 11 option) any later version. | |
| 1 | 12 |
| 13 Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 16 for more details. | |
| 17 | |
| 18 You should have received a copy of the GNU General Public License | |
| 7016 | 19 along with Octave; see the file COPYING. If not, see |
| 20 <http://www.gnu.org/licenses/>. | |
| 1 | 21 |
| 2939 | 22 */ |
| 23 | |
| 24 /* | |
| 25 | |
| 1 | 26 The functions listed below were adapted from similar functions from |
| 27 GNU Bash, the Bourne Again SHell, copyright (C) 1987, 1989, 1991 Free | |
| 28 Software Foundation, Inc. | |
| 29 | |
| 30 do_history edit_history_readline | |
| 31 do_edit_history edit_history_add_hist | |
| 32 | |
| 33 */ | |
| 34 | |
| 240 | 35 #ifdef HAVE_CONFIG_H |
| 1192 | 36 #include <config.h> |
| 1 | 37 #endif |
| 38 | |
| 1343 | 39 #include <cstdlib> |
| 40 #include <cstring> | |
| 41 | |
| 1750 | 42 #include <string> |
| 43 | |
| 3503 | 44 #include <fstream> |
| 1350 | 45 |
| 46 #ifdef HAVE_UNISTD_H | |
| 2442 | 47 #ifdef HAVE_SYS_TYPES_H |
| 1 | 48 #include <sys/types.h> |
| 2442 | 49 #endif |
| 1 | 50 #include <unistd.h> |
| 51 #endif | |
| 1350 | 52 |
| 1799 | 53 #include "cmd-hist.h" |
| 1802 | 54 #include "file-ops.h" |
| 3016 | 55 #include "lo-mappers.h" |
| 2926 | 56 #include "oct-env.h" |
| 5305 | 57 #include "oct-time.h" |
| 1755 | 58 #include "str-vec.h" |
| 59 | |
| 2492 | 60 #include <defaults.h> |
| 1352 | 61 #include "defun.h" |
| 1 | 62 #include "error.h" |
| 3016 | 63 #include "gripes.h" |
| 1 | 64 #include "input.h" |
| 1742 | 65 #include "oct-hist.h" |
| 1750 | 66 #include "oct-obj.h" |
| 1352 | 67 #include "pager.h" |
| 3018 | 68 #include "parse.h" |
| 1352 | 69 #include "sighandlers.h" |
| 1690 | 70 #include "sysdep.h" |
| 1750 | 71 #include "toplev.h" |
| 1352 | 72 #include "unwind-prot.h" |
| 73 #include "utils.h" | |
| 2205 | 74 #include "variables.h" |
| 1 | 75 |
| 3018 | 76 // TRUE means input is coming from temporary history file. |
| 77 bool input_from_tmp_history_file = false; | |
| 168 | 78 |
| 5305 | 79 static std::string |
| 1 | 80 default_history_file (void) |
| 81 { | |
| 3523 | 82 std::string file; |
| 1 | 83 |
| 3523 | 84 std::string env_file = octave_env::getenv ("OCTAVE_HISTFILE"); |
| 1755 | 85 |
| 2926 | 86 if (! env_file.empty ()) |
| 6141 | 87 file = env_file; |
| 1 | 88 |
| 1755 | 89 if (file.empty ()) |
| 7272 | 90 file = file_ops::concat (octave_env::get_home_directory (), |
| 91 ".octave_hist"); | |
| 1 | 92 |
| 93 return file; | |
| 94 } | |
| 95 | |
| 5794 | 96 // Where history is saved. |
| 97 static std::string Vhistory_file = default_history_file (); | |
| 98 | |
| 5305 | 99 static int |
| 100 default_history_size (void) | |
| 101 { | |
| 102 int size = 1024; | |
| 103 | |
| 104 std::string env_size = octave_env::getenv ("OCTAVE_HISTSIZE"); | |
| 105 | |
| 106 if (! env_size.empty ()) | |
| 107 { | |
| 108 int val; | |
| 109 | |
| 110 if (sscanf (env_size.c_str (), "%d", &val) == 1) | |
| 111 size = val > 0 ? val : 0; | |
| 112 } | |
| 113 | |
| 114 return size; | |
| 115 } | |
| 116 | |
| 5794 | 117 // The number of lines to keep in the history file. |
| 118 static int Vhistory_size = default_history_size (); | |
| 119 | |
| 5305 | 120 static std::string |
| 121 default_history_timestamp_format (void) | |
| 122 { | |
| 123 return | |
| 124 std::string ("# Octave " OCTAVE_VERSION ", %a %b %d %H:%M:%S %Y %Z <") | |
| 125 + octave_env::get_user_name () | |
| 126 + std::string ("@") | |
| 127 + octave_env::get_host_name () | |
| 128 + std::string (">"); | |
| 129 } | |
| 130 | |
| 5794 | 131 // The format of the timestamp marker written to the history file when |
| 132 // Octave exits. | |
| 133 static std::string Vhistory_timestamp_format_string | |
| 134 = default_history_timestamp_format (); | |
| 135 | |
| 136 // TRUE if we are saving history. | |
| 137 bool Vsaving_history = true; | |
| 138 | |
| 581 | 139 // Display, save, or load history. Stolen and modified from bash. |
| 140 // | |
| 141 // Arg of -w FILENAME means write file, arg of -r FILENAME | |
| 142 // means read file, arg of -q means don't number lines. Arg of N | |
| 143 // means only display that many items. | |
| 144 | |
| 1755 | 145 static void |
| 146 do_history (int argc, const string_vector& argv) | |
| 1 | 147 { |
| 148 int numbered_output = 1; | |
| 149 | |
| 1755 | 150 int i; |
| 151 for (i = 1; i < argc; i++) | |
| 1 | 152 { |
| 3523 | 153 std::string option = argv[i]; |
| 2435 | 154 |
| 155 if (option == "-r" || option == "-w" || option == "-a" | |
| 156 || option == "-n") | |
| 1 | 157 { |
| 1755 | 158 if (i < argc - 1) |
| 5872 | 159 command_history::set_file (argv[i+1]); |
| 1 | 160 |
| 2435 | 161 if (option == "-a") |
| 162 // Append `new' lines to file. | |
| 2926 | 163 command_history::append (); |
| 2435 | 164 |
| 165 else if (option == "-w") | |
| 166 // Write entire history. | |
| 2926 | 167 command_history::write (); |
| 777 | 168 |
| 2435 | 169 else if (option == "-r") |
| 170 // Read entire file. | |
| 2926 | 171 command_history::read (); |
| 777 | 172 |
| 2435 | 173 else if (option == "-n") |
| 174 // Read `new' history from file. | |
| 2926 | 175 command_history::read_range (); |
| 777 | 176 |
| 2435 | 177 else |
| 178 panic_impossible (); | |
| 179 | |
| 1 | 180 return; |
| 181 } | |
| 1755 | 182 else if (argv[i] == "-q") |
| 1 | 183 numbered_output = 0; |
| 1755 | 184 else if (argv[i] == "--") |
| 1 | 185 { |
| 1755 | 186 i++; |
| 1 | 187 break; |
| 188 } | |
| 189 else | |
| 190 break; | |
| 191 } | |
| 192 | |
| 1799 | 193 int limit = -1; |
| 1 | 194 |
| 1755 | 195 if (i < argc) |
| 1 | 196 { |
| 1755 | 197 if (sscanf (argv[i].c_str (), "%d", &limit) != 1) |
| 1 | 198 { |
| 1755 | 199 if (argv[i][0] == '-') |
| 200 error ("history: unrecognized option `%s'", argv[i].c_str ()); | |
| 1 | 201 else |
| 1755 | 202 error ("history: bad non-numeric arg `%s'", argv[i].c_str ()); |
| 1799 | 203 |
| 1 | 204 return; |
| 205 } | |
| 206 | |
| 207 if (limit < 0) | |
| 208 limit = -limit; | |
| 1799 | 209 } |
| 1 | 210 |
| 2926 | 211 string_vector hlist = command_history::list (limit, numbered_output); |
| 1 | 212 |
| 1799 | 213 int len = hlist.length (); |
| 214 | |
| 2095 | 215 for (i = 0; i < len; i++) |
| 216 octave_stdout << hlist[i] << "\n"; | |
| 1 | 217 } |
| 218 | |
| 581 | 219 // Read the edited history lines from STREAM and return them |
| 220 // one at a time. This can read unlimited length lines. The | |
| 2434 | 221 // caller should free the storage. |
| 581 | 222 |
| 1 | 223 static char * |
| 3551 | 224 edit_history_readline (std::fstream& stream) |
| 1 | 225 { |
| 226 char c; | |
| 227 int line_len = 128; | |
| 228 int lindex = 0; | |
| 229 char *line = new char [line_len]; | |
| 230 line[0] = '\0'; | |
| 231 | |
| 232 while (stream.get (c)) | |
| 233 { | |
| 234 if (lindex + 2 >= line_len) | |
| 235 { | |
| 236 char *tmp_line = new char [line_len += 128]; | |
| 237 strcpy (tmp_line, line); | |
| 238 delete [] line; | |
| 239 line = tmp_line; | |
| 240 } | |
| 241 | |
| 242 if (c == '\n') | |
| 243 { | |
| 244 line[lindex++] = '\n'; | |
| 245 line[lindex++] = '\0'; | |
| 246 return line; | |
| 247 } | |
| 248 else | |
| 249 line[lindex++] = c; | |
| 250 } | |
| 251 | |
| 252 if (! lindex) | |
| 253 { | |
| 254 delete [] line; | |
| 529 | 255 return 0; |
| 1 | 256 } |
| 257 | |
| 258 if (lindex + 2 >= line_len) | |
| 259 { | |
| 260 char *tmp_line = new char [lindex+3]; | |
| 261 strcpy (tmp_line, line); | |
| 262 delete [] line; | |
| 263 line = tmp_line; | |
| 264 } | |
| 265 | |
| 1358 | 266 // Finish with newline if none in file. |
| 1 | 267 |
| 268 line[lindex++] = '\n'; | |
| 269 line[lindex++] = '\0'; | |
| 270 return line; | |
| 271 } | |
| 272 | |
| 581 | 273 // Use `command' to replace the last entry in the history list, which, |
| 274 // by this time, is `run_history blah...'. The intent is that the | |
| 1799 | 275 // new command becomes the history entry, and that `fc' should never |
| 581 | 276 // appear in the history list. This way you can do `run_history' to |
| 277 // your heart's content. | |
| 278 | |
| 64 | 279 static void |
| 3523 | 280 edit_history_repl_hist (const std::string& command) |
| 64 | 281 { |
| 1799 | 282 if (! command.empty ()) |
| 283 { | |
| 2926 | 284 string_vector hlist = command_history::list (); |
| 64 | 285 |
| 1799 | 286 int len = hlist.length (); |
| 64 | 287 |
| 1799 | 288 if (len > 0) |
| 289 { | |
| 290 int i = len - 1; | |
| 64 | 291 |
| 3523 | 292 std::string histent = command_history::get_entry (i); |
| 64 | 293 |
| 1799 | 294 if (! histent.empty ()) |
| 295 { | |
| 3523 | 296 std::string cmd = command; |
| 64 | 297 |
| 1799 | 298 int cmd_len = cmd.length (); |
| 64 | 299 |
| 1799 | 300 if (cmd[cmd_len - 1] == '\n') |
| 301 cmd.resize (cmd_len - 1); | |
| 64 | 302 |
| 1799 | 303 if (! cmd.empty ()) |
| 2926 | 304 command_history::replace_entry (i, cmd); |
| 1799 | 305 } |
| 64 | 306 } |
| 307 } | |
| 308 } | |
| 309 | |
| 1 | 310 static void |
| 3523 | 311 edit_history_add_hist (const std::string& line) |
| 1 | 312 { |
| 1799 | 313 if (! line.empty ()) |
| 1 | 314 { |
| 3523 | 315 std::string tmp = line; |
| 1 | 316 |
| 1799 | 317 int len = tmp.length (); |
| 318 | |
| 319 if (len > 0 && tmp[len-1] == '\n') | |
| 320 tmp.resize (len - 1); | |
| 321 | |
| 322 if (! tmp.empty ()) | |
| 2926 | 323 command_history::add (tmp); |
| 1 | 324 } |
| 325 } | |
| 326 | |
| 3536 | 327 static std::string |
| 1755 | 328 mk_tmp_hist_file (int argc, const string_vector& argv, |
| 2804 | 329 int insert_curr, const char *warn_for) |
| 1 | 330 { |
| 3523 | 331 std::string retval; |
| 1 | 332 |
| 2926 | 333 string_vector hlist = command_history::list (); |
| 1 | 334 |
| 1799 | 335 int hist_count = hlist.length (); |
| 1 | 336 |
| 1358 | 337 // The current command line is already part of the history list by |
| 338 // the time we get to this point. Delete it from the list. | |
| 1 | 339 |
| 340 hist_count -= 2; | |
| 1799 | 341 |
| 64 | 342 if (! insert_curr) |
| 2926 | 343 command_history::remove (hist_count); |
| 1799 | 344 |
| 1 | 345 hist_count--; |
| 346 | |
| 1358 | 347 // If no numbers have been specified, the default is to edit the |
| 348 // last command in the history list. | |
| 1 | 349 |
| 350 int hist_end = hist_count; | |
| 351 int hist_beg = hist_count; | |
| 352 int reverse = 0; | |
| 353 | |
| 1358 | 354 // Process options. |
| 1 | 355 |
| 356 int usage_error = 0; | |
| 357 if (argc == 3) | |
| 358 { | |
| 1755 | 359 if (sscanf (argv[1].c_str (), "%d", &hist_beg) != 1 |
| 360 || sscanf (argv[2].c_str (), "%d", &hist_end) != 1) | |
| 1 | 361 usage_error = 1; |
| 362 else | |
| 363 { | |
| 364 hist_beg--; | |
| 365 hist_end--; | |
| 366 } | |
| 367 } | |
| 368 else if (argc == 2) | |
| 369 { | |
| 1755 | 370 if (sscanf (argv[1].c_str (), "%d", &hist_beg) != 1) |
| 1 | 371 usage_error = 1; |
| 372 else | |
| 373 { | |
| 374 hist_beg--; | |
| 375 hist_end = hist_beg; | |
| 376 } | |
| 377 } | |
| 378 | |
| 379 if (hist_beg < 0 || hist_end < 0 || hist_beg > hist_count | |
| 380 || hist_end > hist_count) | |
| 381 { | |
| 64 | 382 error ("%s: history specification out of range", warn_for); |
| 1799 | 383 return retval; |
| 1 | 384 } |
| 385 | |
| 386 if (usage_error) | |
| 387 { | |
| 64 | 388 usage ("%s [first] [last]", warn_for); |
| 1799 | 389 return retval; |
| 1 | 390 } |
| 391 | |
| 392 if (hist_end < hist_beg) | |
| 393 { | |
| 394 int t = hist_end; | |
| 395 hist_end = hist_beg; | |
| 396 hist_beg = t; | |
| 397 reverse = 1; | |
| 398 } | |
| 399 | |
| 3523 | 400 std::string name = file_ops::tempnam ("", "oct-"); |
| 1 | 401 |
| 3551 | 402 std::fstream file (name.c_str (), std::ios::out); |
| 64 | 403 |
| 1 | 404 if (! file) |
| 405 { | |
| 1755 | 406 error ("%s: couldn't open temporary file `%s'", warn_for, |
| 407 name.c_str ()); | |
| 1799 | 408 return retval; |
| 1 | 409 } |
| 410 | |
| 411 if (reverse) | |
| 412 { | |
| 413 for (int i = hist_end; i >= hist_beg; i--) | |
| 1799 | 414 file << hlist[i] << "\n"; |
| 1 | 415 } |
| 416 else | |
| 417 { | |
| 418 for (int i = hist_beg; i <= hist_end; i++) | |
| 1799 | 419 file << hlist[i] << "\n"; |
| 1 | 420 } |
| 421 | |
| 422 file.close (); | |
| 423 | |
| 1755 | 424 return name; |
| 64 | 425 } |
| 426 | |
|
10066
2cd940306a06
make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents:
9377
diff
changeset
|
427 static void unlink_cleanup (const char *file) |
|
2cd940306a06
make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents:
9377
diff
changeset
|
428 { |
|
2cd940306a06
make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents:
9377
diff
changeset
|
429 unlink (file); |
|
2cd940306a06
make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents:
9377
diff
changeset
|
430 } |
|
2cd940306a06
make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents:
9377
diff
changeset
|
431 |
| 1755 | 432 static void |
| 433 do_edit_history (int argc, const string_vector& argv) | |
| 64 | 434 { |
| 3523 | 435 std::string name = mk_tmp_hist_file (argc, argv, 0, "edit_history"); |
| 64 | 436 |
| 1755 | 437 if (name.empty ()) |
| 64 | 438 return; |
| 439 | |
| 1358 | 440 // Call up our favorite editor on the file of commands. |
| 1 | 441 |
| 5794 | 442 std::string cmd = VEDITOR; |
| 4469 | 443 cmd.append (" \""); |
| 1799 | 444 cmd.append (name); |
| 4469 | 445 cmd.append ("\""); |
| 1 | 446 |
| 1358 | 447 // Ignore interrupts while we are off editing commands. Should we |
| 448 // maybe avoid using system()? | |
| 1 | 449 |
| 2705 | 450 volatile octave_interrupt_handler old_interrupt_handler |
| 2554 | 451 = octave_ignore_interrupts (); |
| 1443 | 452 |
| 1799 | 453 system (cmd.c_str ()); |
| 1443 | 454 |
| 2554 | 455 octave_set_interrupt_handler (old_interrupt_handler); |
| 1 | 456 |
|
7715
5b4d278ec828
parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents:
7272
diff
changeset
|
457 // Write the commands to the history file since source_file |
| 1358 | 458 // disables command line history while it executes. |
| 1 | 459 |
| 3551 | 460 std::fstream file (name.c_str (), std::ios::in); |
| 1 | 461 |
| 462 char *line; | |
| 64 | 463 int first = 1; |
| 529 | 464 while ((line = edit_history_readline (file)) != 0) |
| 1 | 465 { |
| 1358 | 466 // Skip blank lines. |
| 1 | 467 |
| 468 if (line[0] == '\n') | |
| 469 { | |
| 470 delete [] line; | |
| 471 continue; | |
| 472 } | |
| 473 | |
| 64 | 474 if (first) |
| 475 { | |
| 476 first = 0; | |
| 477 edit_history_repl_hist (line); | |
| 478 } | |
| 479 else | |
| 480 edit_history_add_hist (line); | |
| 1 | 481 } |
| 482 | |
| 483 file.close (); | |
| 484 | |
| 1358 | 485 // Turn on command echo, so the output from this will make better |
| 486 // sense. | |
| 1 | 487 |
|
10066
2cd940306a06
make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents:
9377
diff
changeset
|
488 unwind_protect frame; |
| 3018 | 489 |
|
10066
2cd940306a06
make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents:
9377
diff
changeset
|
490 frame.add_fcn (unlink_cleanup, name.c_str ()); |
|
2cd940306a06
make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents:
9377
diff
changeset
|
491 frame.protect_var (Vecho_executing_commands); |
|
2cd940306a06
make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents:
9377
diff
changeset
|
492 frame.protect_var (input_from_tmp_history_file); |
| 3018 | 493 |
| 2205 | 494 Vecho_executing_commands = ECHO_CMD_LINE; |
| 3018 | 495 input_from_tmp_history_file = true; |
| 1 | 496 |
|
7715
5b4d278ec828
parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents:
7272
diff
changeset
|
497 source_file (name); |
| 1 | 498 } |
| 499 | |
| 1755 | 500 static void |
| 501 do_run_history (int argc, const string_vector& argv) | |
| 64 | 502 { |
| 3523 | 503 std::string name = mk_tmp_hist_file (argc, argv, 1, "run_history"); |
| 64 | 504 |
| 1755 | 505 if (name.empty ()) |
| 64 | 506 return; |
| 507 | |
| 1799 | 508 // Turn on command echo so the output from this will make better |
| 1358 | 509 // sense. |
| 64 | 510 |
|
10066
2cd940306a06
make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents:
9377
diff
changeset
|
511 unwind_protect frame; |
| 3018 | 512 |
|
10066
2cd940306a06
make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents:
9377
diff
changeset
|
513 frame.add_fcn (unlink_cleanup, name.c_str ()); |
|
2cd940306a06
make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents:
9377
diff
changeset
|
514 frame.protect_var (Vecho_executing_commands); |
|
2cd940306a06
make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents:
9377
diff
changeset
|
515 frame.protect_var (input_from_tmp_history_file); |
| 3018 | 516 |
| 2205 | 517 Vecho_executing_commands = ECHO_CMD_LINE; |
| 3018 | 518 input_from_tmp_history_file = true; |
| 64 | 519 |
|
7715
5b4d278ec828
parse scripts completely before executing
John W. Eaton <jwe@octave.org>
parents:
7272
diff
changeset
|
520 source_file (name); |
| 64 | 521 } |
| 522 | |
| 5305 | 523 void |
|
8273
2c1ba965b486
skip reading history file with --no-history option
John W. Eaton <jwe@octave.org>
parents:
7715
diff
changeset
|
524 initialize_history (bool read_history_file) |
| 5794 | 525 { |
| 5872 | 526 command_history::set_file (Vhistory_file); |
| 5800 | 527 command_history::set_size (Vhistory_size); |
| 528 | |
|
8273
2c1ba965b486
skip reading history file with --no-history option
John W. Eaton <jwe@octave.org>
parents:
7715
diff
changeset
|
529 if (read_history_file) |
|
2c1ba965b486
skip reading history file with --no-history option
John W. Eaton <jwe@octave.org>
parents:
7715
diff
changeset
|
530 command_history::read (false); |
| 5794 | 531 } |
| 532 | |
| 533 void | |
| 5305 | 534 octave_history_write_timestamp (void) |
| 535 { | |
| 536 octave_localtime now; | |
| 537 | |
| 538 std::string timestamp = now.strftime (Vhistory_timestamp_format_string); | |
| 539 | |
| 540 if (! timestamp.empty ()) | |
| 541 command_history::add (timestamp); | |
| 542 } | |
| 543 | |
|
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8286
diff
changeset
|
544 DEFUN (edit_history, args, , |
| 3332 | 545 "-*- texinfo -*-\n\ |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
546 @deffn {Command} edit_history [@var{first}] [@var{last}]\n\ |
| 3332 | 547 If invoked with no arguments, @code{edit_history} allows you to edit the\n\ |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9035
diff
changeset
|
548 history list using the editor named by the variable @w{@code{EDITOR}}. The\n\ |
| 3332 | 549 commands to be edited are first copied to a temporary file. When you\n\ |
| 550 exit the editor, Octave executes the commands that remain in the file.\n\ | |
| 551 It is often more convenient to use @code{edit_history} to define functions \n\ | |
| 552 rather than attempting to enter them directly on the command line.\n\ | |
| 553 By default, the block of commands is executed as soon as you exit the\n\ | |
| 554 editor. To avoid executing any commands, simply delete all the lines\n\ | |
| 555 from the buffer before exiting the editor.\n\ | |
| 556 \n\ | |
| 557 The @code{edit_history} command takes two optional arguments specifying\n\ | |
| 558 the history numbers of first and last commands to edit. For example,\n\ | |
| 559 the command\n\ | |
| 529 | 560 \n\ |
| 3332 | 561 @example\n\ |
| 562 edit_history 13\n\ | |
| 563 @end example\n\ | |
| 564 \n\ | |
| 565 @noindent\n\ | |
| 566 extracts all the commands from the 13th through the last in the history\n\ | |
| 567 list. The command\n\ | |
| 568 \n\ | |
| 569 @example\n\ | |
| 570 edit_history 13 169\n\ | |
| 571 @end example\n\ | |
| 572 \n\ | |
| 573 @noindent\n\ | |
| 574 only extracts commands 13 through 169. Specifying a larger number for\n\ | |
| 575 the first command than the last command reverses the list of commands\n\ | |
| 576 before placing them in the buffer to be edited. If both arguments are\n\ | |
| 577 omitted, the previous command in the history list is used.\n\ | |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
578 @seealso{run_history}\n\ |
| 3333 | 579 @end deffn") |
| 529 | 580 { |
| 2086 | 581 octave_value_list retval; |
| 529 | 582 |
| 1755 | 583 int argc = args.length () + 1; |
| 584 | |
| 1968 | 585 string_vector argv = args.make_argv ("edit_history"); |
| 1755 | 586 |
| 587 if (error_state) | |
| 588 return retval; | |
| 529 | 589 |
| 590 do_edit_history (argc, argv); | |
| 591 | |
| 592 return retval; | |
| 593 } | |
| 594 | |
|
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8286
diff
changeset
|
595 DEFUN (history, args, , |
| 3332 | 596 "-*- texinfo -*-\n\ |
| 597 @deffn {Command} history options\n\ | |
| 598 If invoked with no arguments, @code{history} displays a list of commands\n\ | |
| 599 that you have executed. Valid options are:\n\ | |
| 600 \n\ | |
| 601 @table @code\n\ | |
| 602 @item -w @var{file}\n\ | |
| 603 Write the current history to the file @var{file}. If the name is\n\ | |
| 604 omitted, use the default history file (normally @file{~/.octave_hist}).\n\ | |
| 529 | 605 \n\ |
| 3332 | 606 @item -r @var{file}\n\ |
| 607 Read the file @var{file}, replacing the current history list with its\n\ | |
| 608 contents. If the name is omitted, use the default history file\n\ | |
| 609 (normally @file{~/.octave_hist}).\n\ | |
| 610 \n\ | |
| 3499 | 611 @item @var{n}\n\ |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
612 Display only the most recent @var{n} lines of history.\n\ |
| 3332 | 613 \n\ |
| 614 @item -q\n\ | |
| 615 Don't number the displayed lines of history. This is useful for cutting\n\ | |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
616 and pasting commands using the X Window System.\n\ |
| 3332 | 617 @end table\n\ |
| 618 \n\ | |
| 619 For example, to display the five most recent commands that you have\n\ | |
| 620 typed without displaying line numbers, use the command\n\ | |
| 621 @kbd{history -q 5}.\n\ | |
| 3333 | 622 @end deffn") |
| 529 | 623 { |
| 2086 | 624 octave_value_list retval; |
| 529 | 625 |
| 1755 | 626 int argc = args.length () + 1; |
| 627 | |
| 1968 | 628 string_vector argv = args.make_argv ("history"); |
| 1755 | 629 |
| 630 if (error_state) | |
| 631 return retval; | |
| 529 | 632 |
| 633 do_history (argc, argv); | |
| 634 | |
| 635 return retval; | |
| 636 } | |
| 637 | |
|
8746
5dd06f19e9be
handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents:
8286
diff
changeset
|
638 DEFUN (run_history, args, , |
| 3332 | 639 "-*- texinfo -*-\n\ |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
640 @deffn {Command} run_history [@var{first}] [@var{last}]\n\ |
| 3332 | 641 Similar to @code{edit_history}, except that the editor is not invoked,\n\ |
| 642 and the commands are simply executed as they appear in the history list.\n\ | |
|
9035
57649dcecb55
Documentation cleanup of basics.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
643 @seealso{edit_history}\n\ |
| 3333 | 644 @end deffn") |
| 529 | 645 { |
| 2086 | 646 octave_value_list retval; |
| 529 | 647 |
| 1755 | 648 int argc = args.length () + 1; |
| 649 | |
| 1968 | 650 string_vector argv = args.make_argv ("run_history"); |
| 1755 | 651 |
| 652 if (error_state) | |
| 653 return retval; | |
| 529 | 654 |
| 655 do_run_history (argc, argv); | |
| 656 | |
| 657 return retval; | |
| 658 } | |
| 659 | |
| 5794 | 660 DEFUN (history_size, args, nargout, |
| 661 "-*- texinfo -*-\n\ | |
| 662 @deftypefn {Built-in Function} {@var{val} =} history_size ()\n\ | |
| 663 @deftypefnx {Built-in Function} {@var{old_val} =} history_size (@var{new_val})\n\ | |
| 664 Query or set the internal variable that specifies how many entries\n\ | |
| 665 to store in the history file. The default value is @code{1024},\n\ | |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9035
diff
changeset
|
666 but may be overridden by the environment variable @w{@code{OCTAVE_HISTSIZE}}.\n\ |
|
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
8273
diff
changeset
|
667 @seealso{history_file, history_timestamp_format_string, saving_history}\n\ |
| 5794 | 668 @end deftypefn") |
| 3016 | 669 { |
| 5800 | 670 int saved_history_size = Vhistory_size; |
| 671 | |
| 672 octave_value retval | |
| 673 = SET_INTERNAL_VARIABLE_WITH_LIMITS (history_size, -1, INT_MAX); | |
| 674 | |
| 675 if (Vhistory_size != saved_history_size) | |
| 676 command_history::set_size (Vhistory_size); | |
| 677 | |
| 678 return retval; | |
| 3016 | 679 } |
| 680 | |
| 5794 | 681 DEFUN (history_file, args, nargout, |
| 682 "-*- texinfo -*-\n\ | |
| 683 @deftypefn {Built-in Function} {@var{val} =} history_file ()\n\ | |
| 684 @deftypefnx {Built-in Function} {@var{old_val} =} history_file (@var{new_val})\n\ | |
| 685 Query or set the internal variable that specifies the name of the\n\ | |
| 686 file used to store command history. The default value is\n\ | |
|
9134
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9035
diff
changeset
|
687 @file{~/.octave_hist}, but may be overridden by the environment\n\ |
|
a3739e27b017
Update section 2.4 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents:
9035
diff
changeset
|
688 variable @w{@code{OCTAVE_HISTFILE}}.\n\ |
| 5794 | 689 @seealso{history_size, saving_history, history_timestamp_format_string}\n\ |
| 690 @end deftypefn") | |
| 5305 | 691 { |
| 5794 | 692 std::string saved_history_file = Vhistory_file; |
| 5305 | 693 |
| 5794 | 694 octave_value retval = SET_INTERNAL_VARIABLE (history_file); |
| 5305 | 695 |
| 5794 | 696 if (Vhistory_file != saved_history_file) |
| 5872 | 697 command_history::set_file (Vhistory_file); |
| 5305 | 698 |
| 5800 | 699 return retval; |
| 3016 | 700 } |
| 701 | |
| 5794 | 702 DEFUN (history_timestamp_format_string, args, nargout, |
| 703 "-*- texinfo -*-\n\ | |
| 704 @deftypefn {Built-in Function} {@var{val} =} history_timestamp_format_string ()\n\ | |
| 705 @deftypefnx {Built-in Function} {@var{old_val} =} history_timestamp_format_string (@var{new_val})\n\ | |
| 6653 | 706 Query or set the internal variable that specifies the format string\n\ |
| 5794 | 707 for the comment line that is written to the history file when Octave\n\ |
| 708 exits. The format string is passed to @code{strftime}. The default\n\ | |
| 709 value is\n\ | |
| 5305 | 710 \n\ |
| 711 @example\n\ | |
| 712 \"# Octave VERSION, %a %b %d %H:%M:%S %Y %Z <USER@@HOST>\"\n\ | |
| 713 @end example\n\ | |
| 5794 | 714 @seealso{strftime, history_file, history_size, saving_history}\n\ |
| 715 @end deftypefn") | |
| 716 { | |
| 717 return SET_INTERNAL_VARIABLE (history_timestamp_format_string); | |
| 718 } | |
| 5305 | 719 |
| 5794 | 720 DEFUN (saving_history, args, nargout, |
| 721 "-*- texinfo -*-\n\ | |
| 722 @deftypefn {Built-in Function} {@var{val} =} saving_history ()\n\ | |
| 723 @deftypefnx {Built-in Function} {@var{old_val} =} saving_history (@var{new_val})\n\ | |
| 724 Query or set the internal variable that controls whether commands entered\n\ | |
| 725 on the command line are saved in the history file.\n\ | |
|
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
8273
diff
changeset
|
726 @seealso{history_file, history_size, history_timestamp_format_string}\n\ |
| 5794 | 727 @end deftypefn") |
| 728 { | |
| 729 octave_value retval = SET_INTERNAL_VARIABLE (saving_history); | |
| 730 | |
| 731 command_history::ignore_entries (! Vsaving_history); | |
| 732 | |
| 733 return retval; | |
| 3016 | 734 } |
| 735 | |
| 1 | 736 /* |
| 737 ;;; Local Variables: *** | |
| 738 ;;; mode: C++ *** | |
| 739 ;;; End: *** | |
| 740 */ |