-
Notifications
You must be signed in to change notification settings - Fork 2
/
usage.html
610 lines (427 loc) · 15.7 KB
/
usage.html
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>Usage</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta content="37.444542, -122.161050" name="ICBM" />
<link media="all" href="/stylesheets/nu.css" type ="text/css" rel="stylesheet" />
</head>
<body>
<div id="container">
<div id="header">
<div style="float:left; margin-right:10px">
<img src="/files/recycle-s.png" height="50" alt="recycling symbol" />
</div>
<div style="float:left">
<h1><a href="/">Programming Nu</a></h1>
<h3><a href="https://github.com/programming-nu">github.com/programming-nu</a></h3>
</div>
</div>
<div id="content">
<div class="atomentry">
<div class="content" style="margin-bottom:10px">
<h1>Using Nu</h1>
<p>Here are some of the ways that you can use Nu.</p>
</div>
<div class="extended">
<h2>Scripting and interacting with nush, the Nu shell</h2>
<p>A simple way to use Nu is to write programs that run in nush, the Nu shell.</p>
<p><strong>nush command-line options</strong></p>
<table style="background:#eee">
<tr>
<td width="40%">
-f <em>framework</em>
</td>
<td>
Loads the named framework. This option may be specified multiple times.
</td>
</tr>
<tr>
<td>
-e <em>expression</em>
</td>
<td>
Evaluates the specified Nu expression.
This option may be specified multiple times.
</td>
</tr>
<tr>
<td>
-i
</td>
<td>
Runs the interpreter interactively at the console.
This need not be specified if no filename is given
as an argument.
</td>
</tr>
<tr>
<td>
<em>filename</em>
</td>
<td>
Loads and evaluates the named file.
</td>
</tr>
</table>
<p>Running nush interactively is a great way to explore and test
Objective-C components.</p>
<p>You can write executable scripts in Nu if you begin them with a
"shebang" line that identifies nush as the shell. For example,</p>
<pre>
#!/usr/bin/env nush
(puts "Everything old is Nu again.")
</pre>
<h2>Building Cocoa Applications</h2>
<p>Another way to use Nu is to use it to write Cocoa applications.</p>
<h3>Option 1: No compilation needed</h3>
<p>If you don't need to compile any Objective-C code into your application
then you can build a Cocoa application by simply copying nush into the
<code>Contents/MacOS</code> directory of your application bundle and renaming it to your application's name. Upon startup, the resulting application will load and evaluate a file named <strong>main.nu</strong>
from its <code>Contents/Resource</code> directory. <br />
To see examples of this, see the <a href="/randomapp">RandomApp</a>,
<a href="/currencyconverter">Currency Converter</a>,
and <a href="/nurocks">NuRocks</a> example applications.
Each example contains a Nukefile that lets you use nuke to do all the work.
In each example directory, just type "nuke run" and nuke will build and run the example.</p>
<p>Here is a simple main.nu, taken from the RandomApp example:</p>
<pre>
;; main.nu
;; Entry point for a Nu program.
;;
;; Copyright (c) 2007 Tim Burks, Neon Design Technology, Inc.
(load "Nu:nu") ;; basics
(load "Nu:cocoa") ;; cocoa definitions
(load "Nu:menu") ;; menu generation
(load "randomapp") ;; Aaron Hillegass' famous example
;; define the application delegate class
(class ApplicationDelegate is NSObject
(imethod (void) applicationDidFinishLaunching: (id) sender is
(build-menu default-application-menu "RandomApp")
(set $random ((RandomAppWindowController alloc) init))))
;; install the delegate and keep a reference to it since
;; the application won't retain it.
((NSApplication sharedApplication) setDelegate:
(set delegate ((ApplicationDelegate alloc) init)))
;; this makes the application window take focus when
;; we've started it from the terminal
((NSApplication sharedApplication) activateIgnoringOtherApps:YES)
;; run the main Cocoa event loop
(NSApplicationMain 0 nil)
</pre>
<p>If you have Objective-C code to compile into your application, you could
compile it into a framework and load it from Nu, making it unnecessary to ever use anything but nush as the main program of your application.</p>
<h3>Option 2: Compile and use the Nu main function</h3>
<p>If you want to compile your Objective-C code directly into your application, you can make your application start with Nu by having it use the following <code>main()</code> function:</p>
<pre>
extern int NuMain(int argc, const char *argv[]);
int main(int argc, const char *argv[])
{
return NuMain(argc, argv);
}
</pre>
<p>This also will look for a <strong>main.nu</strong> file in your application's <code>Contents/Resource</code> directory upon
startup. <br />
See the <a href="/benwanu">Benwanu</a> sample program for an example that compiles Objective-C code and the <strong>NuMain()</strong> function directly into an application.</p>
<h3>Option 3: Load and use the Nu parser at runtime</h3>
<p>If you don't want to modify your <code>main()</code> function, you can also use Nu
by loading the Nu framework into your application and using the Nu
class to get a parser.</p>
<pre>
id parser = [Nu parser];
</pre>
<p>You can then use this parser to parse and evaluate Nu expressions,
which you can load from a file or provide inline.</p>
<pre>
id code = [parser parse:@"(+ 2 2)"];
id result = [parser eval:code];
</pre>
<p>In this case, the result of the evaluation will be an NSNumber with
an integer value of 4.</p>
<h2>Building Cocoa Frameworks</h2>
<p>A third way to use Nu is to use it in a Cocoa framework that you write.
There are nuke tasks to help you with this; they require that you compile
at least a small amount of C code for your framework, but in practice,
interesting frameworks will probably be a combination of Nu and Objective-C.</p>
<p>One important C function that your framework should include is an initialization
function. This function will load the equivalent of "main.nu" for your
framework. Here's an example:</p>
<pre>
void NunjaInit()
{
static initialized = 0;
if (!initialized) {
initialized = 1;
[Nu loadNuFile:@"nunja" fromBundleWithIdentifier:@"nu.programming.nunja" withContext:nil];
}
}
</pre>
<p>The function that it calls loads a Nu file (in this case, named
"nunja.nu") from a named bundle. That Nu file should load any
other needed Nu files from the bundle using the "load" operator.</p>
<p>Note that it is important to correctly specify the framework identifier.
You can do this in a Nukefile with the following line:</p>
<pre>
(set @framework_identifier "nu.programming.nunja")
</pre>
<p>You also need to specify the name of your framework initialization
function. You can also do this in a Nukefile:</p>
<pre>
(set @framework_initializer "ProspectInit")
</pre>
<div style="border:medium solid gray; padding:1em; margin:1em">
<strong>Update:</strong>
Setting the framework initializer as shown above replaces
the shared library's default initialization function
with a new one that is called when the framework's
shared library is loaded.
But for systems using the GNU Objective-C
runtime (mainly Linux), the default
initializer must be called to register a library's classes
with the runtime. For simplicity, it seems better
to instead call custom initializers from a class <tt>+load</tt>
method, as illustrated below:
<pre>
@implementation Nunja
+ (void) load
{
NunjaInit();
}
...
</pre>
If you do this, you should not set the <tt>@framework_initializer</tt> in your Nukefile.
</div>
<p>The appropriate build tasks are created when your Nukefile includes the
following command:</p>
<pre>
(framework-tasks)
</pre>
<p>With an initialization function, you can create frameworks containing
classes written in Nu that can be used directly by Objective-C clients.
Those clients need not know anything about Nu; to them, they are simply
interacting with classes and objects using Objective-C conventions.
It is also possible to use Nu in frameworks without including an
initialization function, but for these frameworks, a client application
must load their Nu code explicitly using the "load" operator. For
example,</p>
<pre>
(load "FigLeaf:server")
</pre>
<p>loads the "server.nu" file from the "FigLeaf" framework.</p>
</div>
</div> <!-- atomentry -->
</div> <!-- content -->
<div id="sidebar">
<div class="sidebar-node">
<h2><a href="/about">About Nu</a></h2>
</div>
<div class="sidebar-node">
<h2><a href="http://groups.google.com/group/programming-nu/topics">Google Group:<br/>Programming Nu</a></h2>
</div>
<div class="sidebar-node">
<h2><a href="/downloads">Download Nu</a></h2>
</div>
<div class="sidebar-node">
<h2>Git Repositories</h2>
<ul>
<li><a href="http://github.com/programming-nu/nu">nu</a></li>
<li><a href="http://github.com/programming-nu/programming-nu">programming-nu</a></li>
</ul>
</div>
<div class="sidebar-node">
<h2><a href="/documentation">Documentation</a></h2>
<ul>
<li><a href="/installing">Installing Nu</a></li>
<li><a href="/usage">Using Nu</a></li>
<li><a href="/embedding">Embedding Nu</a></li>
<li><a href="/reference">Nu Reference</a></li>
<li><a href="/syntax">- Syntax</a></li>
<li><a href="/operators">- Operators</a></li>
<li><a href="/types">- Types</a></li>
<li><a href="/doc/index.html">- Class Reference</a></li>
<li><a href="/help">Getting and Providing Help</a></li>
<li><a href="/debugging">Debugging Nu Programs</a></li>
<li><a href="/textmate">A Bundle for TextMate Users</a></li>
</ul>
</div>
<div class="sidebar-node">
<h2><a href="/examples">Examples</a></h2>
<ul>
<li><a href="/randomapp">RandomApp</a></li>
<li><a href="/randomappwithnibfile">RandomAppWithNibFile</a></li>
<li><a href="/currencyconverter">Currency Converter</a></li>
<li><a href="/nurocks">NuRocks</a></li>
<li><a href="/console">Console</a></li>
<li><a href="/growler">Growler</a></li>
<li><a href="/benwanu">Benwanu</a></li>
<li><a href="/screensaver">Screen Saver</a></li>
<li><a href="/maildemo">MailDemo</a></li>
<li><a href="/nuanywhere">NuAnywhere</a></li>
</ul>
</div>
<div class="sidebar-node">
<h2><a href="/tools">Tools</a></h2>
<ul>
<li><a href="/nuke">nuke, a make utility</a></li>
<li><a href="/nubile">nubile, a code formatter</a></li>
<li><a href="/nutest">nutest, a testing tool</a></li>
<li><a href="/nudoc">nudoc, a documentation generator</a></li>
<li><a href="/nutemplate">nutemplate, a templating tool</a></li>
<li><a href="/nubake">nubake, a code generation tool</a></li>
</ul>
</div>
<div class="sidebar-node">
<h2><a href="/">Archives</a></h2>
<ul>
<li style="font-weight:bold; font-size:smaller; background:#eee; line-height:100%">July 2019</li>
<li>
<a href="/posts/2019/07/25/programming-nu-on-github">
Programming Nu on GitHub</a>
</li>
<li style="font-weight:bold; font-size:smaller; background:#eee; line-height:100%">April 2013</li>
<li>
<a href="/posts/2013/04/14/Nu-2.1.0">
Nu-2.1.0</a>
</li>
<li style="font-weight:bold; font-size:smaller; background:#eee; line-height:100%">September 2011</li>
<li>
<a href="/posts/2011/09/02/Nu-2.0.1">
Nu-2.0.1</a>
</li>
<li style="font-weight:bold; font-size:smaller; background:#eee; line-height:100%">August 2011</li>
<li>
<a href="/posts/2011/08/25/Nu-2.0.0">
Nu-2.0.0</a>
</li>
<li style="font-weight:bold; font-size:smaller; background:#eee; line-height:100%">December 2009</li>
<li>
<a href="/posts/2009/12/09/stability">
Nu Seems Stable (by Jason Grossman)</a>
</li>
<li style="font-weight:bold; font-size:smaller; background:#eee; line-height:100%">November 2009</li>
<li>
<a href="/posts/2009/11/22/vi">
vi tips for Nu</a>
</li>
<li>
<a href="/posts/2009/11/17/Nu-0.4.0">
Nu-0.4.0</a>
</li>
<li style="font-weight:bold; font-size:smaller; background:#eee; line-height:100%">January 2009</li>
<li>
<a href="/posts/2009/01/02/macros">
Macros</a>
</li>
<li style="font-weight:bold; font-size:smaller; background:#eee; line-height:100%">December 2008</li>
<li>
<a href="/posts/2008/12/03/Nu-0.3.3">
Nu-0.3.3</a>
</li>
<li style="font-weight:bold; font-size:smaller; background:#eee; line-height:100%">June 2008</li>
<li>
<a href="/posts/2008/06/08/Nu-0.3.2">
Nu-0.3.2</a>
</li>
<li style="font-weight:bold; font-size:smaller; background:#eee; line-height:100%">May 2008</li>
<li>
<a href="/posts/2008/05/23/cocoa-programming-with-nu">
Cocoa Programming with Nu</a>
</li>
<li style="font-weight:bold; font-size:smaller; background:#eee; line-height:100%">March 2008</li>
<li>
<a href="/posts/2008/03/24/Nu-0.3.1">
Nu-0.3.1</a>
</li>
<li>
<a href="/posts/2008/03/21/announcing-nu">
Announcing Nu: The Video</a>
</li>
<li>
<a href="/posts/2008/03/18/nu-on-github">
Nu on github</a>
</li>
<li>
<a href="/posts/2008/03/14/new-platforms">
Linux and the iPhone</a>
</li>
<li>
<a href="/posts/2008/03/12/new-license">
Apache License, v. 2.0</a>
</li>
<li style="font-weight:bold; font-size:smaller; background:#eee; line-height:100%">February 2008</li>
<li>
<a href="/posts/2008/02/13/Nu-0.3.0">
Nu-0.3.0</a>
</li>
<li style="font-weight:bold; font-size:smaller; background:#eee; line-height:100%">December 2007</li>
<li>
<a href="/posts/2007/12/12/nupagepacker">
NuPagePacker</a>
</li>
<li>
<a href="/posts/2007/12/12/Nu-0.2.4">
Nu-0.2.4</a>
</li>
<li>
<a href="/posts/2007/12/07/Nu-0.2.3">
Nu-0.2.3</a>
</li>
<li style="font-weight:bold; font-size:smaller; background:#eee; line-height:100%">November 2007</li>
<li>
<a href="/posts/2007/11/26/Nu-0.2.2">
Nu-0.2.2</a>
</li>
<li>
<a href="/posts/2007/11/25/a-delicious-nu-screencast">
A Delicious Nu Screencast</a>
</li>
<li>
<a href="/posts/2007/11/12/Nu-0.2.1">
Nu-0.2.1</a>
</li>
<li style="font-weight:bold; font-size:smaller; background:#eee; line-height:100%">October 2007</li>
<li>
<a href="/posts/2007/10/17/new-literal-forms-in-nu">
New Literal Forms in Nu</a>
</li>
<li>
<a href="/posts/2007/10/17/escape-sequences-in-nu-strings">
Escape Sequences in Nu Strings</a>
</li>
<li>
<a href="/posts/2007/10/17/closures-in-nu">
Closures in Nu</a>
</li>
<li>
<a href="/posts/2007/10/17/Nu-0.2.0">
Nu-0.2.0</a>
</li>
<li>
<a href="/posts/2007/10/11/screen-savers-and-plugins">
Screen Savers and Plugins</a>
</li>
<li>
<a href="/posts/2007/10/10/markdown-in-nu">
Markdown in Nu</a>
</li>
<li>
<a href="/posts/2007/10/05/functional-nu">
Functional Aspects of Nu</a>
</li>
<li>
<a href="/posts/2007/10/04/randomapp-with-nibfile">
New Example: Nib Files</a>
</li>
<li>
<a href="/posts/2007/10/01/welcome">
Welcome</a>
</li>
</ul>
</div>
<div class="sidebar-node">
<h2><a href="/legal">Legal Details</a></h2>
</div>
</div> <!-- sidebar -->
</div><!-- container -->
</body>
</html>