bump version to -rc2
[supercollider.git] / Help / Core / Kernel / FunctionDef.html
blob284bd08bf2c0c40b6f33fe41d3fdf2499014212a
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <meta http-equiv="Content-Style-Type" content="text/css">
6 <title></title>
7 <meta name="Generator" content="Cocoa HTML Writer">
8 <meta name="CocoaVersion" content="949.54">
9 <style type="text/css">
10 p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 18.0px Helvetica}
11 p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
12 p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
13 p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px Helvetica}
14 p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco}
15 p.p6 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; min-height: 12.0px}
16 p.p7 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #000000}
17 span.s1 {color: #0000bf}
18 span.s2 {text-decoration: underline}
19 span.s3 {color: #0000bf}
20 </style>
21 </head>
22 <body>
23 <p class="p1"><b>FunctionDef</b></p>
24 <p class="p2"><br></p>
25 <p class="p3"><b>superclass: </b><a href="../Object.html"><span class="s1"><b>Object</b></span></a></p>
26 <p class="p2"><br></p>
27 <p class="p3">FunctionDefs contain code which can be executed from a <a href="Function.html"><span class="s1">Function</span></a>.</p>
28 <p class="p2"><br></p>
29 <p class="p4"><b><span class="s2">Accessing</span></b></p>
30 <p class="p2"><br></p>
31 <p class="p3">Even though it is possible to change the values in the various arrays that define the FunctionDef,</p>
32 <p class="p3">you should not do it, unless you like to crash.</p>
33 <p class="p2"><br></p>
34 <p class="p3"><b>code</b></p>
35 <p class="p2"><br></p>
36 <p class="p3">Get the byte code array.</p>
37 <p class="p2"><br></p>
38 <p class="p5">{ <span class="s3">|a = 9, b = 10, c|</span> a + b }.def.code;</p>
39 <p class="p6"><br></p>
40 <p class="p3"><b>sourceCode</b></p>
41 <p class="p2"><br></p>
42 <p class="p3">Get the source code string.</p>
43 <p class="p2"><br></p>
44 <p class="p5">{ <span class="s3">|a = 9, b = 10, c|</span> a + b }.def.sourceCode.postcs;</p>
45 <p class="p2"><br></p>
46 <p class="p3"><b>context</b></p>
47 <p class="p2"><br></p>
48 <p class="p3">Get the enclosing FunctionDef or Method.</p>
49 <p class="p2"><br></p>
50 <p class="p3"><b>findReferences(aSymbol)</b></p>
51 <p class="p2"><br></p>
52 <p class="p3">return a list of all references to a given symbol.</p>
53 <p class="p2"><br></p>
54 <p class="p3"><b>argNames</b></p>
55 <p class="p2"><br></p>
56 <p class="p3">Get the Array of Symbols of the argument names.</p>
57 <p class="p2"><br></p>
58 <p class="p5">{ <span class="s3">|a = 9, b = 10, c|</span> a + b }.def.argNames;</p>
59 <p class="p2"><br></p>
60 <p class="p3"><b>prototypeFrame</b></p>
61 <p class="p2"><br></p>
62 <p class="p3">Get the array of default values for argument and temporary variables.</p>
63 <p class="p2"><br></p>
64 <p class="p5">{ <span class="s3">|a = 9, b = 10, c|</span> a + b }.def.prototypeFrame;</p>
65 <p class="p2"><br></p>
66 <p class="p3"><b>varNames</b></p>
67 <p class="p2"><br></p>
68 <p class="p3">Get the Array of Symbols of the local variable names.</p>
69 <p class="p2"><br></p>
70 <p class="p5">{ <span class="s3">|a = 9, b = 10, c|</span> var x = 9; a + b + x }.def.varNames;</p>
71 <p class="p2"><br></p>
72 <p class="p2"><br></p>
73 <p class="p3"><b>argumentString</b></p>
74 <p class="p2"><br></p>
75 <p class="p3">Return a string that contains<span class="Apple-converted-space">  </span>arguments and their default values for embedding in a string</p>
76 <p class="p2"><br></p>
77 <p class="p7">{ <span class="s3">|a = 9, b = 10, c|</span> a + b }.def.argumentString;</p>
78 <p class="p2"><br></p>
79 <p class="p3"><b>makeEnvirFromArgs</b></p>
80 <p class="p2"><br></p>
81 <p class="p3">Get the Array of Symbols of the local variable names.</p>
82 <p class="p2"><br></p>
83 <p class="p5">{ <span class="s3">|a = 9, b = 10, c|</span> a + b }.def.makeEnvirFromArgs;</p>
84 <p class="p2"><br></p>
85 <p class="p2"><br></p>
86 <p class="p4"><b><span class="s2">Utilities</span></b></p>
87 <p class="p2"><br></p>
88 <p class="p3"><b>dumpByteCodes</b></p>
89 <p class="p2"><br></p>
90 <p class="p3">"Disassemble" and post the FunctionDef's byte code instructions to the text window.<span class="Apple-converted-space"> </span></p>
91 <p class="p2"><br></p>
92 <p class="p2"><br></p>
93 </body>
94 </html>