File: Parser.html

package info (click to toggle)
octave 10.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 145,388 kB
  • sloc: cpp: 335,976; ansic: 82,241; fortran: 20,963; objc: 9,402; sh: 8,756; yacc: 4,392; lex: 4,333; perl: 1,544; java: 1,366; awk: 1,259; makefile: 659; xml: 192
file content (124 lines) | stat: -rw-r--r-- 7,504 bytes parent folder | download | duplicates (2)
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Parser (GNU Octave (version 10.3.0))</title>

<meta name="description" content="Parser (GNU Octave (version 10.3.0))">
<meta name="keywords" content="Parser (GNU Octave (version 10.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">

<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Grammar-and-Parser.html" rel="up" title="Grammar and Parser">
<link href="Keywords.html" rel="prev" title="Keywords">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">


</head>

<body lang="en">
<div class="section-level-extent" id="Parser">
<div class="nav-panel">
<p>
Previous: <a href="Keywords.html" accesskey="p" rel="prev">Keywords</a>, Up: <a href="Grammar-and-Parser.html" accesskey="u" rel="up">Grammar and Parser</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h3 class="section" id="Parser-1"><span>F.2 Parser<a class="copiable-link" href="#Parser-1"> &para;</a></span></h3>
<a class="index-entry-id" id="index-parser"></a>

<p>The parser has a number of variables that affect its internal operation.
These variables are generally documented in the manual alongside the code that
they affect.
</p>
<p>In addition, there are three non-specific parser customization functions.
<code class="code">add_input_event_hook</code> can be used to schedule a user function for
periodic evaluation.  <code class="code">remove_input_event_hook</code> will stop a user function
from being evaluated periodically.
</p>
<a class="anchor" id="XREFadd_005finput_005fevent_005fhook"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-add_005finput_005fevent_005fhook"><span><code class="def-type"><var class="var">id</var> =</code> <strong class="def-name">add_input_event_hook</strong> <code class="def-code-arguments">(<var class="var">fcn</var>)</code><a class="copiable-link" href="#index-add_005finput_005fevent_005fhook"> &para;</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-add_005finput_005fevent_005fhook-1"><span><code class="def-type"><var class="var">id</var> =</code> <strong class="def-name">add_input_event_hook</strong> <code class="def-code-arguments">(<var class="var">fcn</var>, <var class="var">data</var>)</code><a class="copiable-link" href="#index-add_005finput_005fevent_005fhook-1"> &para;</a></span></dt>
<dd><p>Add the named function or function handle <var class="var">fcn</var> to the list of functions
to call periodically when Octave is waiting for input.
</p>
<p>The function should have the form
</p>
<div class="example">
<pre class="example-preformatted"><var class="var">fcn</var> (<var class="var">data</var>)
</pre></div>

<p>If <var class="var">data</var> is omitted, Octave calls the function without any arguments.
</p>
<p>The returned identifier may be used to remove the function handle from the
list of input hook functions.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFremove_005finput_005fevent_005fhook">remove_input_event_hook</a>.
</p></dd></dl>


<a class="anchor" id="XREFremove_005finput_005fevent_005fhook"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-remove_005finput_005fevent_005fhook"><span><strong class="def-name">remove_input_event_hook</strong> <code class="def-code-arguments">(<var class="var">name</var>)</code><a class="copiable-link" href="#index-remove_005finput_005fevent_005fhook"> &para;</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-remove_005finput_005fevent_005fhook-1"><span><strong class="def-name">remove_input_event_hook</strong> <code class="def-code-arguments">(<var class="var">fcn_id</var>)</code><a class="copiable-link" href="#index-remove_005finput_005fevent_005fhook-1"> &para;</a></span></dt>
<dd><p>Remove the named function or function handle with the given identifier
from the list of functions to call periodically when Octave is waiting
for input.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFadd_005finput_005fevent_005fhook">add_input_event_hook</a>.
</p></dd></dl>


<p>Finally, when the parser cannot identify an input token it calls a particular
function to handle this.  By default, this is the internal function
<code class="code">&quot;__unimplemented__&quot;</code> which makes suggestions about possible Octave
substitutes for <small class="sc">MATLAB</small> functions.
</p>
<a class="anchor" id="XREFmissing_005ffunction_005fhook"></a><span style="display:block; margin-top:-4.5ex;">&nbsp;</span>


<dl class="first-deftypefn">
<dt class="deftypefn" id="index-missing_005ffunction_005fhook"><span><code class="def-type"><var class="var">val</var> =</code> <strong class="def-name">missing_function_hook</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href="#index-missing_005ffunction_005fhook"> &para;</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-missing_005ffunction_005fhook-1"><span><code class="def-type"><var class="var">old_val</var> =</code> <strong class="def-name">missing_function_hook</strong> <code class="def-code-arguments">(<var class="var">new_val</var>)</code><a class="copiable-link" href="#index-missing_005ffunction_005fhook-1"> &para;</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-missing_005ffunction_005fhook-2"><span><code class="def-type"><var class="var">old_val</var> =</code> <strong class="def-name">missing_function_hook</strong> <code class="def-code-arguments">(<var class="var">new_val</var>, &quot;local&quot;)</code><a class="copiable-link" href="#index-missing_005ffunction_005fhook-2"> &para;</a></span></dt>
<dd><p>Query or set the internal variable that specifies the function to call
to provide extra information when an unknown identifier is referenced.
</p>
<p>When called from inside a function with the <code class="code">&quot;local&quot;</code> option, the
variable is changed locally for the function and any subroutines it calls.
The original variable value is restored when exiting the function.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="Missing-Components.html#XREFmissing_005fcomponent_005fhook">missing_component_hook</a>.
</p></dd></dl>



</div>
<hr>
<div class="nav-panel">
<p>
Previous: <a href="Keywords.html">Keywords</a>, Up: <a href="Grammar-and-Parser.html">Grammar and Parser</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>