Mercurial > hg > octave-lyh

comparison src/input.cc @ 10840:89f4d7e294cc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Grammarcheck .cc files
author Rik <octave@nomad.inbox5.com>
date Sat, 31 Jul 2010 11:18:11 -0700
parents bbe99b2a5ba7
children 795c97ace02c
comparison
equal deleted inserted replaced
10839:65bc065bec95 10840:89f4d7e294cc
841 return retval; 841 return retval;
842 } 842 }
843 843
844 DEFUN (input, args, nargout, 844 DEFUN (input, args, nargout,
845 "-*- texinfo -*-\n\ 845 "-*- texinfo -*-\n\
846 @deftypefn {Built-in Function} {} input (@var{prompt})\n\ 846 @deftypefn {Built-in Function} {} input (@var{prompt})\n\
847 @deftypefnx {Built-in Function} {} input (@var{prompt}, \"s\")\n\ 847 @deftypefnx {Built-in Function} {} input (@var{prompt}, \"s\")\n\
848 Print a prompt and wait for user input. For example,\n\ 848 Print a prompt and wait for user input. For example,\n\
849 \n\ 849 \n\
850 @example\n\ 850 @example\n\
851 input (\"Pick a number, any number! \")\n\ 851 input (\"Pick a number, any number! \")\n\
1275 "-*- texinfo -*-\n\ 1275 "-*- texinfo -*-\n\
1276 @deftypefn {Built-in Function} {} add_input_event_hook (@var{fcn}, @var{data})\n\ 1276 @deftypefn {Built-in Function} {} add_input_event_hook (@var{fcn}, @var{data})\n\
1277 Add the named function @var{fcn} to the list of functions to call\n\ 1277 Add the named function @var{fcn} to the list of functions to call\n\
1278 periodically when Octave is waiting for input. The function should\n\ 1278 periodically when Octave is waiting for input. The function should\n\
1279 have the form\n\ 1279 have the form\n\
1280 \n\
1280 @example\n\ 1281 @example\n\
1281 @var{fcn} (@var{data})\n\ 1282 @var{fcn} (@var{data})\n\
1282 @end example\n\ 1283 @end example\n\
1283 \n\ 1284 \n\
1284 If @var{data} is omitted, Octave calls the function without any\n\ 1285 If @var{data} is omitted, Octave calls the function without any\n\
1353 return retval; 1354 return retval;
1354 } 1355 }
1355 1356
1356 DEFUN (PS1, args, nargout, 1357 DEFUN (PS1, args, nargout,
1357 "-*- texinfo -*-\n\ 1358 "-*- texinfo -*-\n\
1358 @deftypefn {Built-in Function} {@var{val} =} PS1 ()\n\ 1359 @deftypefn {Built-in Function} {@var{val} =} PS1 ()\n\
1359 @deftypefnx {Built-in Function} {@var{old_val} =} PS1 (@var{new_val})\n\ 1360 @deftypefnx {Built-in Function} {@var{old_val} =} PS1 (@var{new_val})\n\
1360 Query or set the primary prompt string. When executing interactively,\n\ 1361 Query or set the primary prompt string. When executing interactively,\n\
1361 Octave displays the primary prompt when it is ready to read a command.\n\ 1362 Octave displays the primary prompt when it is ready to read a command.\n\
1362 \n\ 1363 \n\
1363 The default value of the primary prompt string is @code{\"\\s:\\#> \"}.\n\ 1364 The default value of the primary prompt string is @code{\"\\s:\\#> \"}.\n\
1379 return SET_INTERNAL_VARIABLE (PS1); 1380 return SET_INTERNAL_VARIABLE (PS1);
1380 } 1381 }
1381 1382
1382 DEFUN (PS2, args, nargout, 1383 DEFUN (PS2, args, nargout,
1383 "-*- texinfo -*-\n\ 1384 "-*- texinfo -*-\n\
1384 @deftypefn {Built-in Function} {@var{val} =} PS2 ()\n\ 1385 @deftypefn {Built-in Function} {@var{val} =} PS2 ()\n\
1385 @deftypefnx {Built-in Function} {@var{old_val} =} PS2 (@var{new_val})\n\ 1386 @deftypefnx {Built-in Function} {@var{old_val} =} PS2 (@var{new_val})\n\
1386 Query or set the secondary prompt string. The secondary prompt is\n\ 1387 Query or set the secondary prompt string. The secondary prompt is\n\
1387 printed when Octave is expecting additional input to complete a\n\ 1388 printed when Octave is expecting additional input to complete a\n\
1388 command. For example, if you are typing a @code{for} loop that spans several\n\ 1389 command. For example, if you are typing a @code{for} loop that spans several\n\
1389 lines, Octave will print the secondary prompt at the beginning of\n\ 1390 lines, Octave will print the secondary prompt at the beginning of\n\
1395 return SET_INTERNAL_VARIABLE (PS2); 1396 return SET_INTERNAL_VARIABLE (PS2);
1396 } 1397 }
1397 1398
1398 DEFUN (PS4, args, nargout, 1399 DEFUN (PS4, args, nargout,
1399 "-*- texinfo -*-\n\ 1400 "-*- texinfo -*-\n\
1400 @deftypefn {Built-in Function} {@var{val} =} PS4 ()\n\ 1401 @deftypefn {Built-in Function} {@var{val} =} PS4 ()\n\
1401 @deftypefnx {Built-in Function} {@var{old_val} =} PS4 (@var{new_val})\n\ 1402 @deftypefnx {Built-in Function} {@var{old_val} =} PS4 (@var{new_val})\n\
1402 Query or set the character string used to prefix output produced\n\ 1403 Query or set the character string used to prefix output produced\n\
1403 when echoing commands is enabled.\n\ 1404 when echoing commands is enabled.\n\
1404 The default value is @code{\"+ \"}.\n\ 1405 The default value is @code{\"+ \"}.\n\
1405 @xref{Diary and Echo Commands}, for a description of echoing commands.\n\ 1406 @xref{Diary and Echo Commands}, for a description of echoing commands.\n\
1409 return SET_INTERNAL_VARIABLE (PS4); 1410 return SET_INTERNAL_VARIABLE (PS4);
1410 } 1411 }
1411 1412
1412 DEFUN (completion_append_char, args, nargout, 1413 DEFUN (completion_append_char, args, nargout,
1413 "-*- texinfo -*-\n\ 1414 "-*- texinfo -*-\n\
1414 @deftypefn {Built-in Function} {@var{val} =} completion_append_char ()\n\ 1415 @deftypefn {Built-in Function} {@var{val} =} completion_append_char ()\n\
1415 @deftypefnx {Built-in Function} {@var{old_val} =} completion_append_char (@var{new_val})\n\ 1416 @deftypefnx {Built-in Function} {@var{old_val} =} completion_append_char (@var{new_val})\n\
1416 Query or set the internal character variable that is appended to\n\ 1417 Query or set the internal character variable that is appended to\n\
1417 successful command-line completion attempts. The default\n\ 1418 successful command-line completion attempts. The default\n\
1418 value is @code{\" \"} (a single space).\n\ 1419 value is @code{\" \"} (a single space).\n\
1419 @end deftypefn") 1420 @end deftypefn")
1421 return SET_INTERNAL_VARIABLE (completion_append_char); 1422 return SET_INTERNAL_VARIABLE (completion_append_char);
1422 } 1423 }
1423 1424
1424 DEFUN (echo_executing_commands, args, nargout, 1425 DEFUN (echo_executing_commands, args, nargout,
1425 "-*- texinfo -*-\n\ 1426 "-*- texinfo -*-\n\
1426 @deftypefn {Built-in Function} {@var{val} =} echo_executing_commands ()\n\ 1427 @deftypefn {Built-in Function} {@var{val} =} echo_executing_commands ()\n\
1427 @deftypefnx {Built-in Function} {@var{old_val} =} echo_executing_commands (@var{new_val})\n\ 1428 @deftypefnx {Built-in Function} {@var{old_val} =} echo_executing_commands (@var{new_val})\n\
1428 Query or set the internal variable that controls the echo state.\n\ 1429 Query or set the internal variable that controls the echo state.\n\
1429 It may be the sum of the following values:\n\ 1430 It may be the sum of the following values:\n\
1430 \n\ 1431 \n\
1431 @table @asis\n\ 1432 @table @asis\n\
1441 \n\ 1442 \n\
1442 More than one state can be active at once. For example, a value of 3 is\n\ 1443 More than one state can be active at once. For example, a value of 3 is\n\
1443 equivalent to the command @kbd{echo on all}.\n\ 1444 equivalent to the command @kbd{echo on all}.\n\
1444 \n\ 1445 \n\
1445 The value of @code{echo_executing_commands} may be set by the @kbd{echo}\n\ 1446 The value of @code{echo_executing_commands} may be set by the @kbd{echo}\n\
1446 command or the command line option @code{--echo-commands}.\n\ 1447 command or the command line option @option{--echo-commands}.\n\
1447 @end deftypefn") 1448 @end deftypefn")
1448 { 1449 {
1449 return SET_INTERNAL_VARIABLE (echo_executing_commands); 1450 return SET_INTERNAL_VARIABLE (echo_executing_commands);
1450 } 1451 }
1451 1452
1452 DEFUN (__request_drawnow__, args, , 1453 DEFUN (__request_drawnow__, args, ,
1453 "-*- texinfo -*-\n\ 1454 "-*- texinfo -*-\n\
1454 @deftypefn {Built-in Function} {} __request_drawnow__ ()\n\ 1455 @deftypefn {Built-in Function} {} __request_drawnow__ ()\n\
1455 @deftypefnx {Built-in Function} {} __request_drawnow__ (@var{flag})\n\ 1456 @deftypefnx {Built-in Function} {} __request_drawnow__ (@var{flag})\n\
1456 Undocumented internal function.\n\ 1457 Undocumented internal function.\n\
1457 @end deftypefn") 1458 @end deftypefn")
1458 { 1459 {
1459 octave_value retval; 1460 octave_value retval;
1493 DEFUN (filemarker, args, nargout, 1494 DEFUN (filemarker, args, nargout,
1494 "-*- texinfo -*-\n\ 1495 "-*- texinfo -*-\n\
1495 @deftypefn {Built-in Function} {} filemarker ()\n\ 1496 @deftypefn {Built-in Function} {} filemarker ()\n\
1496 Returns or sets the character used to separate filename from the\n\ 1497 Returns or sets the character used to separate filename from the\n\
1497 the subfunction names contained within the file. This can be used in\n\ 1498 the subfunction names contained within the file. This can be used in\n\
1498 a generic manner to interact with subfunctions. For example\n\ 1499 a generic manner to interact with subfunctions. For example,\n\
1499 \n\ 1500 \n\
1500 @example\n\ 1501 @example\n\
1501 help ([\"myfunc\", filemarker, \"mysubfunc\"])\n\ 1502 help ([\"myfunc\", filemarker, \"mysubfunc\"])\n\
1502 @end example\n\ 1503 @end example\n\
1503 \n\ 1504 \n\
1504 @noindent\n\ 1505 @noindent\n\
1505 returns the help string associated with the sub-function @code{mysubfunc}\n\ 1506 returns the help string associated with the sub-function @code{mysubfunc}\n\
1506 of the function @code{myfunc}. Another use of @code{filemarker} is when\n\ 1507 of the function @code{myfunc}. Another use of @code{filemarker} is when\n\
1507 debugging it allows easier placement of breakpoints within sub-functions.\n\ 1508 debugging it allows easier placement of breakpoints within sub-functions.\n\
1508 For example\n\ 1509 For example,\n\
1509 \n\ 1510 \n\
1510 @example\n\ 1511 @example\n\
1511 dbstop ([\"myfunc\", filemarker, \"mysubfunc\"])\n\ 1512 dbstop ([\"myfunc\", filemarker, \"mysubfunc\"])\n\
1512 @end example\n\ 1513 @end example\n\
1513 \n\ 1514 \n\