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
|
<html><head><TITLE>Description of ComFunc</TITLE><BASE TARGET="_parent" ></head>
<body BGCOLOR=#FFFFFF>
<FONT FACE=Helvetica>
<DL><DT>
<FONT SIZE=4>
class
</FONT>
<FONT SIZE=5><B>ComFunc</B></FONT>
<A HREF="index.html">(Return to index)</A>
<br><br>
<DD><FONT FACE=Times SIZE=4>
command base class for extending <A HREF="ComTerp.html" >ComTerp</A>.<br><br>
<B>Type:</B><br>
<UL>
Abstract
</UL>
<br>
<A HREF=derivedclasses.html#ComFunc><B>Derived Classes</B></A>
<p>
<B>Include file:</B><br>
<UL><FONT FACE=Helvetica SIZE=3>
ComTerp/comfunc.h
</FONT></UL>
<br>
<B>Description:</B><P> class whose derived classes get constructed and added to a
<A HREF="ComTerp.html" >ComTerp</A> command interpreter, one per command to be supported.
<br><br>
</DL></FONT>
<FONT FACE=Times SIZE=4><B>Public:</B></FONT><br><br><UL>
<DT><FONT FACE=Helvetica>
<A NAME="ComFunc(ComTerp*)">
<B>ComFunc</B> (<A HREF="ComTerp.html" >ComTerp</A>*) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>void
<A NAME="assign_symval(intid&&COMMComValue*)">
<B>assign_symval</B> (int id, <A HREF="ComValue.html" >ComValue</A>*) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>static boolean
<A NAME="bincheck(constchar*name)">
<B>bincheck</B> (const char* name) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>static int
<A NAME="bintest(constchar*name)">
<B>bintest</B> (const char* name) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica><A HREF="ComTerp.html" >ComTerp</A>*
<A NAME="comterp()">
<B>comterp</B> () </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
return <A HREF="ComTerp.html" >ComTerp</A> this <A HREF="ComFunc.html" >ComFunc</A> is associated with.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica><A HREF="ComTerpServ.html" >ComTerpServ</A>*
<A NAME="comterpserv()">
<B>comterpserv</B> () </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
return <A HREF="ComTerpServ.html" >ComTerpServ</A> this <A HREF="ComFunc.html" >ComFunc</A> is associated with.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>virtual const char*
<A NAME="docstring()">
<B>docstring</B> () </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>void
<A NAME="exec(intnargs&&COMMintnkeys&&COMMintpedepth=0&&COMMintcommand_symid=0)">
<B>exec</B> (int nargs, int nkeys, int pedepth=0, int command_symid=0) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
invokes push_funcstate, then plain execute, then pop_funcstate.
for use from the body of regular execute methods.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>pure virtual void
<A NAME="execute()">
<B>execute</B> () </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
method that needs to be filled in, that will take <A HREF="ComValue.html" >ComValue</A> arguments
off the stack, then compute and push a <A HREF="ComValue.html" >ComValue</A> result on the stack.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica><A HREF="ComFuncState.html" >ComFuncState</A>*
<A NAME="funcstate()">
<B>funcstate</B> () </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
current <A HREF="ComFuncState.html" >ComFuncState</A> for use of current <A HREF="ComFunc.html" >ComFunc</A>.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica><A HREF="ComValue.html" >ComValue</A>&
<A NAME="lookup_symval(ComValue&)">
<B>lookup_symval</B> (<A HREF="ComValue.html" >ComValue</A>&) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>int&
<A NAME="nargs()">
<B>nargs</B> () </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
number of white space separated arguments inside parentheses
that are not keywords (keywords indicated by a ':' prefix
on a symbol).
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>int
<A NAME="nargsfixed()">
<B>nargsfixed</B> () </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
number of arguments prior to any keyword. The ones that require a
fixed order to determine their meaning (unlike the arguments that
follow keywords, which can be in any order).
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>int
<A NAME="nargskey()">
<B>nargskey</B> () </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
number of arguments follow keywords, assumed to be less than
or equal to nkeys() (this requirement could be relaxed).
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>int
<A NAME="nargspost()">
<B>nargspost</B> () </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
number of arguments to a post-evaluating command
that represent commands and arguments ready to be evaluated
by the post-eval methods: stack_arg_post_eval() and
stack_key_post_eval().
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>int
<A NAME="nargstotal()">
<B>nargstotal</B> () </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
nargs()+nkeys()
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>int&
<A NAME="nkeys()">
<B>nkeys</B> () </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
number of arguments inside parentheses that are keywords (keywords
indicated by a ':' prefix on a symbol). Arguments that follow
keywords are counted by nargs(). That's why there is a need for
nargsfixed() and nargstotal() methods, to distinguish between
arguments associated with fixed arguments (the ones that
precede the keyword arguments), and the ones enmeshed with the
keywords.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>void
<A NAME="pop_funcstate()">
<B>pop_funcstate</B> () </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
pop the top one off the <A HREF="ComFuncState.html" >ComFuncState</A> stack.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica><A HREF="ComValue.html" >ComValue</A>&
<A NAME="pop_stack()">
<B>pop_stack</B> () </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
pop top off the stack.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica><A HREF="ComValue.html" >ComValue</A>&
<A NAME="pop_symbol()">
<B>pop_symbol</B> () </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
pop top off the stack preserving symbol ids if <A HREF="ComValue.html" >ComValue</A> is a symbol type.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>virtual boolean
<A NAME="post_eval()">
<B>post_eval</B> () </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>void
<A NAME="push_funcstate(intnargs&&COMMintnkeys&&COMMintpedepth=0&&COMMintcommand_symid=0)">
<B>push_funcstate</B> (int nargs, int nkeys, int pedepth=0, int command_symid=0) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
push new <A HREF="ComFuncState.html" >ComFuncState</A> on a stack of them.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>void
<A NAME="push_stack(AttributeValue&)">
<B>push_stack</B> (<A HREF="AttributeValue.html" >AttributeValue</A>&) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
push <A HREF="AttributeValue.html" >AttributeValue</A> onto the stack, converting to a <A HREF="ComValue.html" >ComValue</A>
in the process.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>void
<A NAME="push_stack(ComValue&)">
<B>push_stack</B> (<A HREF="ComValue.html" >ComValue</A>&) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
push <A HREF="ComValue.html" >ComValue</A> onto the stack.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>void
<A NAME="reset_stack()">
<B>reset_stack</B> () </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
reset the stack to its state before this <A HREF="ComFunc.html" >ComFunc</A> execute() method
was called. Needs to be called once and only once in each
derived execute() method. Save it to last if you're using references
to <A HREF="ComValue.html" >ComValue</A> objects directly on the stack. Otherwise, call it as
soon as all the arguments have been loaded into local copies.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica><A HREF="ComValue.html" >ComValue</A>&
<A NAME="stack_arg(intn&&COMMbooleansymbol=false&&COMMComValue&dflt=ComValue::nullval&&BRAKO&&BRAKC)">
<B>stack_arg</B> (int n, boolean symbol=false, <A HREF="ComValue.html" >ComValue</A>& dflt=<A HREF="ComValue.html" >ComValue</A>::nullval()) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
return the nth argument on the stack for this <A HREF="ComFunc.html" >ComFunc</A> execute() call.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica><A HREF="ComValue.html" >ComValue</A>&
<A NAME="stack_arg_post_eval(intn&&COMMbooleansymbol=false&&COMMComValue&dflt=ComValue::nullval&&BRAKO&&BRAKC)">
<B>stack_arg_post_eval</B> (int n, boolean symbol=false, <A HREF="ComValue.html" >ComValue</A>& dflt=<A HREF="ComValue.html" >ComValue</A>::nullval()) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
evaluate the nth argument for this post-evaluating <A HREF="ComFunc.html" >ComFunc</A>.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica><A HREF="ComValue.html" >ComValue</A>&
<A NAME="stack_dotname(intn)">
<B>stack_dotname</B> (int n) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
unused method to get at a dotted list of names, i.e. a.b.c
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica><A HREF="ComValue.html" >ComValue</A>&
<A NAME="stack_key(intid&&COMMbooleansymbol=false&&COMMComValue&dflt=ComValue::trueval&&BRAKO&&BRAKC&&COMMbooleanuse_dflt_for_no_key=false)">
<B>stack_key</B> (int id, boolean symbol=false, <A HREF="ComValue.html" >ComValue</A>& dflt=<A HREF="ComValue.html" >ComValue</A>::trueval(), boolean use_dflt_for_no_key=false ) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
return the value of an argument that follows a keyword,
optionally return the value of 'dflt' if no argument follows
the keyword. If 'use_dflt_for_no_key' is true, 'dflt' gets returned
as the value when a keyword is not found.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica><A HREF="ComValue.html" >ComValue</A>&
<A NAME="stack_key_post_eval(intid&&COMMbooleansymbol=false&&COMMComValue&dflt=ComValue::trueval&&BRAKO&&BRAKC&&COMMbooleanuse_dflt_for_no_key=false)">
<B>stack_key_post_eval</B> (int id, boolean symbol=false, <A HREF="ComValue.html" >ComValue</A>& dflt=<A HREF="ComValue.html" >ComValue</A>::trueval(), boolean use_dflt_for_no_key=false) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
evaluate the argument following a keyword for this post-evaluating <A HREF="ComFunc.html" >ComFunc</A>.
Optionally return the value of 'dflt' if no argument follows
the keyword. If 'use_dflt_for_no_key' is true, 'dflt' gets returned
as the value when a keyword is not found.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica><A HREF="AttributeList.html" >AttributeList</A>*
<A NAME="stack_keys(booleansymbol=false&&COMMAttributeValue&dflt=ComValue::trueval&&BRAKO&&BRAKC)">
<B>stack_keys</B> (boolean symbol = false, <A HREF="AttributeValue.html" >AttributeValue</A>& dflt=<A HREF="ComValue.html" >ComValue</A>::trueval()) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
return newly-constructed <A HREF="AttributeList.html" >AttributeList</A> (which needs referencing)
that contains a copy of each keyword/value pair in the arguments
to the invocation of this <A HREF="ComFunc.html" >ComFunc</A>. 'dflt' is used whenever a
keyword has no matching argument.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>virtual
<A NAME="~ComFunc()">
<B>~ComFunc</B> () </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
<br>
</UL></FONT><br>
</UL><br><br>
<FONT FACE=Times SIZE=4><B>Protected:</B></FONT><br><br><UL>
<DT><FONT FACE=Helvetica><A HREF="ComTerp.html" >ComTerp</A>*
<A NAME="_comterp">
<B>_comterp</B>
<DD><FONT FACE=Times SIZE=3><UL>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>int&
<A NAME="npops()">
<B>npops</B> () </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
number of calls to pop_stack() since execute method called.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>int&
<A NAME="pedepth()">
<B>pedepth</B> () </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
depth of being embedded in blocks of post-evaluated ccommands
(commands whose arguments are not pre-evaluated for them).
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>boolean
<A NAME="skip_arg_in_expr(int&topptr&&COMMint&arglen)">
<B>skip_arg_in_expr</B> (int& topptr, int& arglen) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
skip an argument in unevaluated <A HREF="ComValue.html" >ComValue</A> objects,
decrementing an index into a buffer set up to hold the
currently interpreting expression.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>boolean
<A NAME="skip_arg_on_stack(int&stackptr&&COMMint&arglen)">
<B>skip_arg_on_stack</B> (int& stackptr, int& arglen) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
skip an argument going down the stack.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>boolean
<A NAME="skip_key_in_expr(int&topptr&&COMMint&arglen)">
<B>skip_key_in_expr</B> (int& topptr, int& arglen) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
skip a keyword in a buffer of unevaluated <A HREF="ComValue.html" >ComValue</A> objects,
decrementing an index into a buffer set up to hold the
currently interpreting expression.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica>boolean
<A NAME="skip_key_on_stack(int&stackptr&&COMMint&arglen)">
<B>skip_key_on_stack</B> (int& stackptr, int& arglen) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
skip a keyword going down the stack.
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica><A HREF="ComValue.html" >ComValue</A>&
<A NAME="stack_arg_post(intn&&COMMbooleansymbol=false&&COMMComValue&dflt=ComValue::nullval&&BRAKO&&BRAKC)">
<B>stack_arg_post</B> (int n, boolean symbol=false, <A HREF="ComValue.html" >ComValue</A>& dflt=<A HREF="ComValue.html" >ComValue</A>::nullval()) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
find the <A HREF="ComValue.html" >ComValue</A> object in the unevaluated input arguments
of a post-eval <A HREF="ComFunc.html" >ComFunc</A> that represents the start of the
code for the nth argument (prior to any keywords).
<br>
<br>
</UL></FONT><br>
<DT><FONT FACE=Helvetica><A HREF="ComValue.html" >ComValue</A>&
<A NAME="stack_key_post(intid&&COMMbooleansymbol=false&&COMMComValue&dflt=ComValue::trueval&&BRAKO&&BRAKC&&COMMbooleanuse_dflt_for_no_key=false)">
<B>stack_key_post</B> (int id, boolean symbol=false, <A HREF="ComValue.html" >ComValue</A>& dflt=<A HREF="ComValue.html" >ComValue</A>::trueval(), boolean use_dflt_for_no_key=false) </FONT>
<DD><FONT FACE=Times SIZE=3><UL>
find the <A HREF="ComValue.html" >ComValue</A> object in the unevaluated input arguments
of a post-eval <A HREF="ComFunc.html" >ComFunc</A> that represents the start of the
code for the argument that follows a keyword. If no argument
follows keyword, 'dflt' is returned, unless 'use_dflt_for_no_key'
is true, when 'dflt' gets returned when no matching keyword is found.
<br>
<br>
</UL></FONT><br>
</UL><br><br>
<A HREF="../index.html">(more documentation)</A>
<br><br>
</FONT>
</body>
</html>
|
