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
125
126
127
128
129
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>FreeMat: KEYBOARD Initiate Interactive Debug Session</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FreeMat
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('flow_keyboard.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">KEYBOARD Initiate Interactive Debug Session </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_flow.html">Flow Control</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>The <code>keyboard</code> statement is used to initiate an interactive session at a specific point in a function. The general syntax for the <code>keyboard</code> statement is </p>
<pre class="fragment"> keyboard
</pre><p> A <code>keyboard</code> statement can be issued in a <code>script</code>, in a <code>function</code>, or from within another <code>keyboard</code> session. The result of a <code>keyboard</code> statement is that execution of the program is halted, and you are given a prompt of the form: </p>
<pre class="fragment"> [scope,n] -->
</pre><p> where <code>scope</code> is the current scope of execution (either the name of the function we are executing, or <code>base</code> otherwise). And <code>n</code> is the depth of the <code>keyboard</code> session. If, for example, we are in a <code>keyboard</code> session, and we call a function that issues another <code>keyboard</code> session, the depth of that second session will be one higher. Put another way, <code>n</code> is the number of <code>return</code> statements you have to issue to get back to the base workspace. Incidentally, a <code>return</code> is how you exit the <code>keyboard</code> session and resume execution of the program from where it left off. A <code>retall</code> can be used to shortcut execution and return to the base workspace.</p>
<p>The <code>keyboard</code> statement is an excellent tool for debugging FreeMat code, and along with <code>eval</code> provide a unique set of capabilities not usually found in compiled environments. Indeed, the <code>keyboard</code> statement is equivalent to a debugger breakpoint in more traditional environments, but with significantly more inspection power. </p>
<h1><a class="anchor" id="Example"></a>
Example</h1>
<p>Here we demonstrate a two-level <code>keyboard</code> situation. We have a simple function that calls <code>keyboard</code> internally:</p>
<pre class="fragment"> key_one.m
</pre><pre class="fragment">function c = key_one(a,b)
c = a + b;
keyboard
</pre><p>Now, we execute the function from the base workspace, and at the <code>keyboard</code> prompt, we call it again. This action puts us at depth 2. We can confirm that we are in the second invocation of the function by examining the arguments. We then issue two <code>return</code> statements to return to the base workspace.</p>
<pre class="fragment">--> key_one(1,2)
[key_one,3]--> key_one(5,7)
[key_one,3]--> a
ans =
5
[key_one,3]--> b
ans =
7
[key_one,3]--> c
ans =
12
[key_one,3]--> return
ans =
12
[key_one,3]--> a
ans =
1
[key_one,3]--> b
ans =
2
[key_one,3]--> c
ans =
3
[key_one,3]--> return
ans =
3
</pre> </div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="index.html">FreeMat Documentation</a></li><li class="navelem"><a class="el" href="sec_flow.html">Flow Control</a></li>
<li class="footer">Generated on Thu Jul 25 2013 18:58:17 for FreeMat by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
</ul>
</div>
</body>
</html>
|
