File: input.m

package info (click to toggle)
octave-kernel 0.36.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 572 kB
  • sloc: python: 444; makefile: 27
file content (44 lines) | stat: -rw-r--r-- 1,484 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
## -*- texinfo -*-
## @deftypefn  {Built-in Function} {@var{ans} =} input (@var{prompt})
## @deftypefnx {Built-in Function} {@var{ans} =} input (@var{prompt}, "s")
## Print @var{prompt} and wait for user input.
## 
## For example,
## 
## @example
## input ("Pick a number, any number! ")
## @end example
## 
## @noindent
## prints the prompt
## 
## @example
## Pick a number, any number!
## @end example
## 
## @noindent
## and waits for the user to enter a value.  The string entered by the user
## is evaluated as an expression, so it may be a literal constant, a variable
## name, or any other valid Octave code.
## 
## The number of return arguments, their size, and their class depend on the
## expression entered.
## 
## If you are only interested in getting a literal string value, you can call
## @code{input} with the character string @qcode{"s"} as the second argument.
## This tells Octave to return the string entered by the user directly, without
## evaluating it first.
## 
## Because there may be output waiting to be displayed by the pager, it is a
## good idea to always call @code{fflush (stdout)} before calling @code{input}.
##  This will ensure that all pending output is written to the screen before
## your prompt.
## @seealso{yes_or_no, kbhit, pause, menu, listdlg}
## @end deftypefn

function ans = input(varargin)
    if (nargin > 0)
        varargin{1} = strcat(varargin{1}, '__stdin_prompt>');
    end
    ans = builtin('input', varargin{:});
endfunction;