/
manual.lyx
21579 lines (16486 loc) · 335 KB
/
manual.lyx
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
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#LyX 2.1 created this file. For more info see http://www.lyx.org/
\lyxformat 474
\begin_document
\begin_header
\textclass article
\begin_preamble
% Added by lyx2lyx
% for proper underlining
\PassOptionsToPackage{normalem}{ulem}
\usepackage{ulem}
\let\cite@rig\cite
\newcommand{\b@xcite}[2][\%]{\def\def@pt{\%}\def\pas@pt{#1}
\mbox{\ifx\def@pt\pas@pt\cite@rig{#2}\else\cite@rig[#1]{#2}\fi}}
\renewcommand{\underbar}[1]{{\let\cite\b@xcite\uline{#1}}}
\end_preamble
\use_default_options false
\maintain_unincluded_children false
\language english
\language_package default
\inputencoding auto
\fontencoding global
\font_roman default
\font_sans default
\font_typewriter default
\font_math auto
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100
\font_tt_scale 100
\graphics default
\default_output_format default
\output_sync 0
\bibtex_command default
\index_command default
\paperfontsize default
\use_hyperref false
\papersize default
\use_geometry false
\use_package amsmath 1
\use_package amssymb 1
\use_package cancel 1
\use_package esint 1
\use_package mathdots 1
\use_package mathtools 1
\use_package mhchem 1
\use_package stackrel 1
\use_package stmaryrd 1
\use_package undertilde 1
\cite_engine basic
\cite_engine_type default
\biblio_style plain
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
\justification true
\use_refstyle 0
\index Index
\shortcut idx
\color #008000
\end_index
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\paragraph_indentation default
\quotes_language english
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes false
\html_math_output 0
\html_css_as_file 0
\html_be_strict false
\author -198912657 "birchb"
\end_header
\begin_body
\begin_layout Title
Genyris User Manual
\end_layout
\begin_layout Standard
\align center
Version @GENYRIS-SPECIFICATION-VERSION@
\end_layout
\begin_layout Standard
\align center
Build @GENYRIS-IMPLEMENTATION-VERSION@
\end_layout
\begin_layout Standard
\align center
Peter William Birch
\end_layout
\begin_layout Standard
\noindent
\align center
birchb1024@gmail.com
\end_layout
\begin_layout Abstract
This document is the user manual for the Genyris scripting language, the
language that provides multi-class objects and support for semantic programs.
\end_layout
\begin_layout Standard
\begin_inset Newpage newpage
\end_inset
\end_layout
\begin_layout Standard
\begin_inset CommandInset toc
LatexCommand tableofcontents
\end_inset
\end_layout
\begin_layout Subsubsection*
Conventions used in this document:
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
\emph on
italicized
\emph default
Snippets of Genyris programs
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
\family typewriter
fixed-font
\family default
Larger programs are in a fixed font.
Interactive sessions are show with the
\family typewriter
>
\family default
prompt of the command-line interpreter and the results printed underneath.
\end_layout
\begin_layout Standard
\begin_inset Newpage newpage
\end_inset
\end_layout
\begin_layout Part
Quick Start
\end_layout
\begin_layout Subsection*
Getting Genyris
\end_layout
\begin_layout Standard
The Genyris project is hosted on Google Code here:
\emph on
http://code.google.com/p/genyris/.
\emph default
In the
\emph on
Downloads
\emph default
tab, look for the latest binary file which has the form
\emph on
genyris-binary-NNN-XXXXXXXXXXXX.BB.zip.
\emph default
The release number is the
\emph on
NNN
\emph default
, choose the file with the largest release number.
\end_layout
\begin_layout Subsection*
Installation
\end_layout
\begin_layout Standard
Genyris is available as a
\emph on
ZIP
\emph default
file.
This file needs to be unpacked into an empty directory such as
\begin_inset Quotes eld
\end_inset
genyris
\begin_inset Quotes erd
\end_inset
.
This becomes the home directory for Genyris.
\end_layout
\begin_layout Standard
Genyris is developed in Java hence needs a Java runtime.
You don't need to understand Java to use Genyris.
However you will need the Oracle Java 1.6 JRE
\begin_inset Index idx
status open
\begin_layout Plain Layout
JRE
\end_layout
\end_inset
or later to run the Genyris interpreter.
Java can be downloaded from Oracle.
Check your JRE version with this command:
\end_layout
\begin_layout LyX-Code
$
\series bold
java -version
\end_layout
\begin_layout Standard
First change directory to the genyris home, then you can start the Genyris
command-line interpreter with this Unix command:
\end_layout
\begin_layout LyX-Code
$
\series bold
java -jar dist/genyris-bin-*.jar
\end_layout
\begin_layout Standard
Or in Windows cmd.exe:
\end_layout
\begin_layout LyX-Code
C:
\backslash
>
\series bold
java -jar dist
\backslash
genyris-bin-*.jar
\end_layout
\begin_layout Standard
You will see a prompt indicating the interpreter is ready for your input:
\end_layout
\begin_layout LyX-Code
*** Welcome ...
Genyris ...
is listening...
\end_layout
\begin_layout LyX-Code
>
\end_layout
\begin_layout Standard
Refer to section
\begin_inset CommandInset ref
LatexCommand eqref
reference "sec:Running-Genyris"
\end_inset
for details on how to simplify running Genyris using PATH settings.
\end_layout
\begin_layout Subsection*
Executing Expressions
\end_layout
\begin_layout Standard
Genyris commands can now be typed at the prompt, use two carriage returns
(
\begin_inset Formula $\hookleftarrow$
\end_inset
) to terminate a statement.
For example to add two numbers type:
\end_layout
\begin_layout LyX-Code
>
\series bold
+ 42 37
\begin_inset Formula $\hookleftarrow$
\end_inset
\end_layout
\begin_layout LyX-Code
\series bold
\begin_inset Formula $\hookleftarrow$
\end_inset
\end_layout
\begin_layout Standard
Genyris responds with the answer and a comment about the result:
\end_layout
\begin_layout LyX-Code
~ 79 # Bignum
\end_layout
\begin_layout Subsection*
Verifying the Install
\end_layout
\begin_layout Standard
To test the installation change to the genyris home directory and run the
self test suite with the following command:
\end_layout
\begin_layout LyX-Code
>
\series bold
sys:self-test
\begin_inset Index idx
status open
\begin_layout Plain Layout
\series bold
sys:self-test
\end_layout
\end_inset
\begin_inset Formula $\hookleftarrow$
\end_inset
\end_layout
\begin_layout LyX-Code
\series bold
\begin_inset Formula $\hookleftarrow$
\end_inset
\end_layout
\begin_layout Standard
All being well, it will print the number of tests passed.
\end_layout
\begin_layout Subsection*
Running Examples
\end_layout
\begin_layout Standard
The release binary file includes some examples in the
\emph on
examples
\emph default
\begin_inset Index idx
status open
\begin_layout Plain Layout
examples
\end_layout
\end_inset
folder.
The files can be edited with your favourite text editor and run with the
\emph on
include
\emph default
\begin_inset Index idx
status open
\begin_layout Plain Layout
include
\end_layout
\end_inset
function.
For example, to load an run the
\begin_inset Quotes eld
\end_inset
Eight Queens
\begin_inset Quotes erd
\end_inset
example do:
\end_layout
\begin_layout LyX-Code
>
\series bold
include 'examples/queens.g'
\begin_inset Formula $\hookleftarrow$
\end_inset
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout LyX-Code
~ 'file:/home/birchb/workspace/Genyris/examples/queens.g' # String
\end_layout
\begin_layout LyX-Code
>
\series bold
run-queens 8
\begin_inset Formula $\hookleftarrow$
\end_inset
\end_layout
\begin_layout LyX-Code
\series bold
\begin_inset Formula $\hookleftarrow$
\end_inset
\end_layout
\begin_layout Part
Language Manual
\end_layout
\begin_layout Section
Introduction
\end_layout
\begin_layout Subsection
\begin_inset CommandInset label
LatexCommand label
name "sub:Syntax"
\end_inset
Syntax
\end_layout
\begin_layout Standard
The syntax of Genyris uses indentation to convey program structure.
This is in common with other languages such as Python.
However Genyris preserves the
\begin_inset Quotes eld
\end_inset
prefix
\begin_inset Quotes erd
\end_inset
notation of Lisp and Scheme.
Here is an example of some code defining a function:
\end_layout
\begin_layout LyX-Code
def threat (i j a b)
\end_layout
\begin_layout LyX-Code
or
\end_layout
\begin_layout LyX-Code
equal? i a
\end_layout
\begin_layout LyX-Code
equal? j b
\end_layout
\begin_layout LyX-Code
equal? (- i j) (- a b)
\end_layout
\begin_layout LyX-Code
equal? (+ i j) (+ a b)
\end_layout
\begin_layout Standard
Instead of curly braces or
\emph on
begin
\emph default
and
\emph on
end
\emph default
tokens, the indentation defines the blocks of code.
Genyris reads lines one-by-one until it reaches the end of an expression.
An expression ends when there are no more indented lines.
The interactive command-line ends an expression whenever two blank lines
are read.
Within a line, tokens are separated by white-space.
Genyris recognizes the following syntactic elements:
\end_layout
\begin_layout Itemize
Comments
\end_layout
\begin_layout Itemize
Numbers
\end_layout
\begin_layout Itemize
Strings
\end_layout
\begin_layout Itemize
Symbols
\end_layout
\begin_layout Itemize
Sub-expressions
\end_layout
\begin_layout Itemize
Lists
\end_layout
\begin_layout Itemize
Parser macros and directives
\end_layout
\begin_layout Subsubsection
Comments
\end_layout
\begin_layout Standard
All characters following a hash
\begin_inset Index idx
status open
\begin_layout Plain Layout
hash
\end_layout
\end_inset
(pound) until the end of the line are ignored by the parser.
For example:
\end_layout
\begin_layout LyX-Code
\series bold
# This whole line is a comment
\end_layout
\begin_layout LyX-Code
- 4 3
\series bold
# this comment goes to the end
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout Subsubsection
Numbers
\end_layout
\begin_layout Standard
Numbers can be either integers or floating point with any number of leading
or trailing digits.
Examples:
\end_layout
\begin_layout LyX-Code
-3 23.78 -100.0089 34.45e7
\end_layout
\begin_layout Subsubsection
Strings
\end_layout
\begin_layout Standard
Strings are delimited by either double quote characters " or single quotes
'.
Within a string quotes and special characters are escaped with backslash
\backslash
.
For example
\family typewriter
\emph on
"She said
\backslash
"sea shells
\backslash
"
\family default
\emph default
"yields the string:
\end_layout
\begin_layout LyX-Code
She said "sea shells"
\end_layout
\begin_layout Standard
Other escape sequences are encoded as follows:
\end_layout
\begin_layout Standard
\noindent
\align center
\begin_inset Tabular
<lyxtabular version="3" rows="8" columns="2">
<features rotate="0" tabularvalignment="middle">
<column alignment="left" valignment="top">
<column alignment="left" valignment="bottom">
<row>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\family typewriter
\series bold
\backslash
n
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
newline
\begin_inset Index idx
status open
\begin_layout Plain Layout
New Line
\end_layout
\end_inset
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\family typewriter
\series bold
\backslash
r
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
carriage return
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\family typewriter
\series bold
\backslash
f
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
form feed
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\family typewriter
\series bold
\backslash
\backslash
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
backslash
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\family typewriter
\series bold
\backslash
t
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
tab
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\family typewriter
\series bold
\backslash
\begin_inset Quotes erd
\end_inset
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
quote
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\series bold
\backslash
a
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
bell
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\backslash
'
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
single quote
\end_layout
\end_inset
</cell>
</row>
</lyxtabular>
\end_inset
\end_layout
\begin_layout Standard
The two styles of string are internally identical, which allows you to avoid
escaping.
For example this string contains double quotes:
\end_layout
\begin_layout LyX-Code
'"After all," said the young man, "golf
\begin_inset Index idx
status open
\begin_layout Plain Layout
golf
\end_layout
\end_inset
is only a game."'
\end_layout
\begin_layout Subsubsection
Symbols
\end_layout
\begin_layout Standard
Symbols are a group of any printable characters with the following exceptions:
\end_layout
\begin_layout Standard
\noindent
\align center
\begin_inset Tabular
<lyxtabular version="3" rows="13" columns="2">
<features rotate="0" tabularvalignment="middle">
<column alignment="center" valignment="top">
<column alignment="center" valignment="top">
<row>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
$
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
dollar
\begin_inset Index idx
status open
\begin_layout Plain Layout
dollar
\end_layout
\end_inset
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
^
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
carat
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
.
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
period
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
\family typewriter
\series bold
'
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text
\begin_layout Plain Layout
single quote
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" usebox="none">
\begin_inset Text