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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>System Definitions (GCL SI Manual)</title>
<meta name="description" content="System Definitions (GCL SI Manual)">
<meta name="keywords" content="System Definitions (GCL SI Manual)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Function-and-Variable-Index.html" rel="index" title="Function and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html" rel="up" title="Top">
<link href="Debugging.html" rel="next" title="Debugging">
<link href="C-Interface.html" rel="prev" title="C Interface">
<style type="text/css">
<!--
a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em}
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
span:hover a.copiable-anchor {visibility: visible}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en">
<div class="chapter" id="System-Definitions">
<div class="header">
<p>
Next: <a href="Debugging.html" accesskey="n" rel="next">Debugging</a>, Previous: <a href="C-Interface.html" accesskey="p" rel="prev">C Interface</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="System-Definitions-1"></span><h2 class="chapter">17 System Definitions</h2>
<dl class="def">
<dt id="index-ALLOCATE_002dCONTIGUOUS_002dPAGES"><span class="category">Function: </span><span><strong>ALLOCATE-CONTIGUOUS-PAGES</strong> <em>(number &optional (really-allocate nil))</em><a href='#index-ALLOCATE_002dCONTIGUOUS_002dPAGES' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Sets the maximum number of pages for contiguous blocks to
NUMBER. If REALLY-ALLOCATE is non-NIL, then the specified
number of pages will be allocated immediately.
</p>
</dd></dl>
<dl class="def">
<dt id="index-FREEZE_002dDEFSTRUCT"><span class="category">Function: </span><span><strong>FREEZE-DEFSTRUCT</strong> <em>(name)</em><a href='#index-FREEZE_002dDEFSTRUCT' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>The inline defstruct type checker will be made more efficient, in that
it will only check for types which currently include NAME. After
calling this the defstruct should not be altered.
</p>
</dd></dl>
<dl class="def">
<dt id="index-MAXIMUM_002dALLOCATABLE_002dPAGES"><span class="category">Function: </span><span><strong>MAXIMUM-ALLOCATABLE-PAGES</strong> <em>(type)</em><a href='#index-MAXIMUM_002dALLOCATABLE_002dPAGES' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the current maximum number of pages for the type class
of the GCL implementation type TYPE.
</p>
</dd></dl>
<dl class="def">
<dt id="index-ALLOCATED_002dRELOCATABLE_002dPAGES"><span class="category">Function: </span><span><strong>ALLOCATED-RELOCATABLE-PAGES</strong> <em>()</em><a href='#index-ALLOCATED_002dRELOCATABLE_002dPAGES' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the number of pages currently allocated for relocatable
blocks.
</p>
</dd></dl>
<dl class="def">
<dt id="index-PUTPROP"><span class="category">Function: </span><span><strong>PUTPROP</strong> <em>(symbol value indicator)</em><a href='#index-PUTPROP' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>Give SYMBOL the VALUE on INDICATOR property.
</p>
</dd></dl>
<dl class="def">
<dt id="index-ALLOCATED_002dPAGES"><span class="category">Function: </span><span><strong>ALLOCATED-PAGES</strong> <em>(type)</em><a href='#index-ALLOCATED_002dPAGES' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the number of pages currently allocated for the type
class of the GCL implementation type TYPE.
</p>
</dd></dl>
<dl class="def">
<dt id="index-ALLOCATE_002dRELOCATABLE_002dPAGES"><span class="category">Function: </span><span><strong>ALLOCATE-RELOCATABLE-PAGES</strong> <em>(number)</em><a href='#index-ALLOCATE_002dRELOCATABLE_002dPAGES' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Sets the maximum number of pages for relocatable blocks to
NUMBER.
</p>
</dd></dl>
<dl class="def">
<dt id="index-ALLOCATED_002dCONTIGUOUS_002dPAGES"><span class="category">Function: </span><span><strong>ALLOCATED-CONTIGUOUS-PAGES</strong> <em>()</em><a href='#index-ALLOCATED_002dCONTIGUOUS_002dPAGES' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the number of pages currently allocated for contiguous
blocks.
</p>
</dd></dl>
<dl class="def">
<dt id="index-MAXIMUM_002dCONTIGUOUS_002dPAGES"><span class="category">Function: </span><span><strong>MAXIMUM-CONTIGUOUS-PAGES</strong> <em>()</em><a href='#index-MAXIMUM_002dCONTIGUOUS_002dPAGES' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the current maximum number of pages for contiguous
blocks.
</p>
</dd></dl>
<dl class="def">
<dt id="index-GET_002dHOLE_002dSIZE"><span class="category">Function: </span><span><strong>GET-HOLE-SIZE</strong> <em>()</em><a href='#index-GET_002dHOLE_002dSIZE' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns as a fixnum the size of the memory hole (in pages).
</p>
</dd></dl>
<dl class="def">
<dt id="index-SPECIALP"><span class="category">Function: </span><span><strong>SPECIALP</strong> <em>(symbol)</em><a href='#index-SPECIALP' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns T if the SYMBOL is a globally special variable; NIL
otherwise.
</p>
</dd></dl>
<dl class="def">
<dt id="index-OUTPUT_002dSTREAM_002dSTRING"><span class="category">Function: </span><span><strong>OUTPUT-STREAM-STRING</strong> <em>(string-output-stream)</em><a href='#index-OUTPUT_002dSTREAM_002dSTRING' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the string corresponding to the STRING-OUTPUT-STREAM.
</p>
</dd></dl>
<dl class="def">
<dt id="index-GET_002dSTRING_002dINPUT_002dSTREAM_002dINDEX"><span class="category">Function: </span><span><strong>GET-STRING-INPUT-STREAM-INDEX</strong> <em>(string-input-stream)</em><a href='#index-GET_002dSTRING_002dINPUT_002dSTREAM_002dINDEX' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the current index of the STRING-INPUT-STREAM.
</p>
</dd></dl>
<dl class="def">
<dt id="index-STRING_002dCONCATENATE"><span class="category">Function: </span><span><strong>STRING-CONCATENATE</strong> <em>(&rest strings)</em><a href='#index-STRING_002dCONCATENATE' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the result of concatenating the given STRINGS.
</p>
</dd></dl>
<dl class="def">
<dt id="index-BDS_002dVAR"><span class="category">Function: </span><span><strong>BDS-VAR</strong> <em>(i)</em><a href='#index-BDS_002dVAR' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the symbol of the i-th entity in the bind stack.
</p>
</dd></dl>
<dl class="def">
<dt id="index-ERROR_002dSET"><span class="category">Function: </span><span><strong>ERROR-SET</strong> <em>(form)</em><a href='#index-ERROR_002dSET' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Evaluates the FORM in the null environment. If the evaluation
of the FORM has successfully completed, SI:ERROR-SET returns NIL as the first
value and the result of the evaluation as the rest of the values. If, in the
course of the evaluation, a non-local jump from the FORM is atempted,
SI:ERROR-SET traps the jump and returns the corresponding jump tag as its
value.
</p>
</dd></dl>
<dl class="def">
<dt id="index-COMPILED_002dFUNCTION_002dNAME"><span class="category">Function: </span><span><strong>COMPILED-FUNCTION-NAME</strong> <em>(compiled-function-object)</em><a href='#index-COMPILED_002dFUNCTION_002dNAME' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the name of the COMPILED-FUNCTION-OBJECT.
</p>
</dd></dl>
<dl class="def">
<dt id="index-STRUCTUREP"><span class="category">Function: </span><span><strong>STRUCTUREP</strong> <em>(object)</em><a href='#index-STRUCTUREP' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns T if the OBJECT is a structure; NIL otherwise.
</p>
</dd></dl>
<dl class="def">
<dt id="index-IHS_002dVS"><span class="category">Function: </span><span><strong>IHS-VS</strong> <em>(i)</em><a href='#index-IHS_002dVS' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the value stack index of the i-th entity in the
invocation history stack.
</p>
</dd></dl>
<dl class="def">
<dt id="index-UNIVERSAL_002dERROR_002dHANDLER"><span class="category">Function: </span><span><strong>UNIVERSAL-ERROR-HANDLER</strong> <em>(error-name correctable function-name continue-format-string error-format-string &rest args)</em><a href='#index-UNIVERSAL_002dERROR_002dHANDLER' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Starts the error handler of GCL. When an error is detected,
GCL calls SI:UNIVERSAL-ERROR-HANDLER with the specified arguments.
ERROR-NAME is the name of the error. CORRECTABLE is T for a correctable
error and NIL for a fatal error. FUNCTION-NAME is the name of the function
that caused the error. CONTINUE-FORMAT-STRING and ERROR-FORMAT-STRING are
the format strings of the error message. ARGS are the arguments to the
format strings.
To change the error handler of GCL, redefine SI:UNIVERSAL-ERROR-
HANDLER.
</p>
</dd></dl>
<dl class="def">
<dt id="index-_002aINTERRUPT_002dENABLE_002a"><span class="category">Variable: </span><span><strong>*INTERRUPT-ENABLE*</strong><a href='#index-_002aINTERRUPT_002dENABLE_002a' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
GCL specific: If the value of SI:*INTERRUPT-ENABLE* is non-NIL, GCL signals
an error on the terminal interrupt (this is the default case). If it is NIL,
GCL ignores the interrupt and assigns T to SI:*INTERRUPT-ENABLE*.
</p>
</dd></dl>
<dl class="def">
<dt id="index-CHDIR"><span class="category">Function: </span><span><strong>CHDIR</strong> <em>(pathname)</em><a href='#index-CHDIR' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL/UNIX specific: Changes the current working directory to the specified
pathname.
</p>
</dd></dl>
<dl class="def">
<dt id="index-COPY_002dSTREAM"><span class="category">Function: </span><span><strong>COPY-STREAM</strong> <em>(in-stream out-stream)</em><a href='#index-COPY_002dSTREAM' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Copies IN-STREAM to OUT-STREAM until the end-of-file on IN-
STREAM.
</p>
</dd></dl>
<dl class="def">
<dt id="index-INIT_002dSYSTEM"><span class="category">Function: </span><span><strong>INIT-SYSTEM</strong> <em>()</em><a href='#index-INIT_002dSYSTEM' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Initializes the library and the compiler of GCL. Since they
have already been initialized in the standard image of GCL, calling SI:INIT-
SYSTEM will cause an error.
</p>
</dd></dl>
<dl class="def">
<dt id="index-_002aINDENT_002dFORMATTED_002dOUTPUT_002a"><span class="category">Variable: </span><span><strong>*INDENT-FORMATTED-OUTPUT*</strong><a href='#index-_002aINDENT_002dFORMATTED_002dOUTPUT_002a' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
GCL specific: The FORMAT directive ~% indents the next line if the value of
this variable is non-NIL. If NIL, ~% simply does Newline.
</p>
</dd></dl>
<dl class="def">
<dt id="index-SET_002dHOLE_002dSIZE"><span class="category">Function: </span><span><strong>SET-HOLE-SIZE</strong> <em>(fixnum)</em><a href='#index-SET_002dHOLE_002dSIZE' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Sets the size of the memory hole (in pages).
</p>
</dd></dl>
<dl class="def">
<dt id="index-FRS_002dBDS"><span class="category">Function: </span><span><strong>FRS-BDS</strong> <em>(i)</em><a href='#index-FRS_002dBDS' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the bind stack index of the i-th entity in the frame
stack.
</p>
</dd></dl>
<dl class="def">
<dt id="index-IHS_002dFUN"><span class="category">Function: </span><span><strong>IHS-FUN</strong> <em>(i)</em><a href='#index-IHS_002dFUN' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the function value of the i-th entity in the invocation
history stack.
</p>
</dd></dl>
<dl class="def">
<dt id="index-_002aMAKE_002dCONSTANT"><span class="category">Function: </span><span><strong>*MAKE-CONSTANT</strong> <em>(symbol value)</em><a href='#index-_002aMAKE_002dCONSTANT' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Makes the SYMBOL a constant with the specified VALUE.
</p>
</dd></dl>
<dl class="def">
<dt id="index-FIXNUMP"><span class="category">Function: </span><span><strong>FIXNUMP</strong> <em>(object)</em><a href='#index-FIXNUMP' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns T if the OBJECT is a fixnum; NIL otherwise.
</p>
</dd></dl>
<dl class="def">
<dt id="index-BDS_002dVAL"><span class="category">Function: </span><span><strong>BDS-VAL</strong> <em>(i)</em><a href='#index-BDS_002dVAL' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the value of the i-th entity in the bind stack.
</p>
</dd></dl>
<dl class="def">
<dt id="index-STRING_002dTO_002dOBJECT"><span class="category">Function: </span><span><strong>STRING-TO-OBJECT</strong> <em>(string)</em><a href='#index-STRING_002dTO_002dOBJECT' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: (SI:STRING-TO-OBJECT STRING) is equivalent to
(READ-FROM-STRING STRING), but much faster.
</p>
</dd></dl>
<dl class="def">
<dt id="index-_002aSYSTEM_002dDIRECTORY_002a"><span class="category">Variable: </span><span><strong>*SYSTEM-DIRECTORY*</strong><a href='#index-_002aSYSTEM_002dDIRECTORY_002a' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
GCL specific: Holds the name of the system directory of GCL.
</p>
</dd></dl>
<dl class="def">
<dt id="index-FRS_002dIHS"><span class="category">Function: </span><span><strong>FRS-IHS</strong> <em>(i)</em><a href='#index-FRS_002dIHS' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the invocation history stack index of the i-th entity
in the frame stack.
</p>
</dd></dl>
<dl class="def">
<dt id="index-RESET_002dGBC_002dCOUNT"><span class="category">Function: </span><span><strong>RESET-GBC-COUNT</strong> <em>()</em><a href='#index-RESET_002dGBC_002dCOUNT' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Resets the counter of the garbage collector that records how
many times the garbage collector has been called for each implementation
type.
</p>
</dd></dl>
<dl class="def">
<dt id="index-CATCH_002dBAD_002dSIGNALS"><span class="category">Function: </span><span><strong>CATCH-BAD-SIGNALS</strong> <em>()</em><a href='#index-CATCH_002dBAD_002dSIGNALS' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL/BSD specific: Installs a signal catcher for bad signals:
SIGILL, SIGIOT, SIGEMT, SIGBUS, SIGSEGV, SIGSYS.
The signal catcher, upon catching the signal, signals an error (and enter
the break-level). Since the internal memory of GCL may be broken, the user
should check the signal and exit from GCL if necessary. When the signal
is caught during garbage collection, GCL terminates immediately.
</p>
</dd></dl>
<dl class="def">
<dt id="index-RESET_002dSTACK_002dLIMITS"><span class="category">Function: </span><span><strong>RESET-STACK-LIMITS</strong> <em>()</em><a href='#index-RESET_002dSTACK_002dLIMITS' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Resets the stack limits to the normal state. When a stack has
overflowed, GCL extends the limit for the stack in order to execute the error
handler. After processing the error, GCL resets the stack limit by calling
SI:RESET-STACK-LIMITS.
</p>
</dd></dl>
<dl class="def">
<dt id="index-_002aGBC_002dMESSAGE_002a"><span class="category">Variable: </span><span><strong>*GBC-MESSAGE*</strong><a href='#index-_002aGBC_002dMESSAGE_002a' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
GCL specific: If the value of SI:*GBC-MESSAGE* is non-NIL, the garbage
collector prints some information on the terminal. Usually SI:*GBC-MESSAGE*
should be set NIL.
</p>
</dd></dl>
<dl class="def">
<dt id="index-_002aGBC_002dNOTIFY_002a"><span class="category">Variable: </span><span><strong>*GBC-NOTIFY*</strong><a href='#index-_002aGBC_002dNOTIFY_002a' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
GCL specific: If the value is non-NIL, the garbage
collector prints a very brief one line message about the area causing the collection,
and the time spent in internal time units.
</p>
</dd></dl>
<dl class="def">
<dt id="index-_002aAFTER_002dGBC_002dHOOK_002a"><span class="category">Variable: </span><span><strong>*AFTER-GBC-HOOK*</strong><a href='#index-_002aAFTER_002dGBC_002dHOOK_002a' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
Defaults to nil, but may be set to a function of one argument TYPE which is
a lisp variable indicating the TYPE which caused the current collection.
</p>
</dd></dl>
<dl class="def">
<dt id="index-ALLOCATED"><span class="category">Funcition: </span><span><strong>ALLOCATED</strong> <em>(type)</em><a href='#index-ALLOCATED' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>Returns 6 values:
</p><dl compact="compact">
<dt><span>nfree</span></dt>
<dd><p>number free
</p></dd>
<dt><span>npages</span></dt>
<dd><p>number of pages
</p></dd>
<dt><span>maxpage</span></dt>
<dd><p>number of pages to grow to
</p></dd>
<dt><span>nppage</span></dt>
<dd><p>number per page
</p></dd>
<dt><span>gbccount</span></dt>
<dd><p>number of gc’s due to running out of items of this size
</p></dd>
<dt><span>nused</span></dt>
<dd><p>number of items used
</p></dd>
</dl>
<p>Note that all items of the same size are stored on similar pages.
Thus for example on a 486 under linux the following basic types are
all the same size and so will share the same allocated information:
CONS BIGNUM RATIO COMPLEX STRUCTURE.
</p>
</dd></dl>
<dl class="def">
<dt id="index-_002aMAKE_002dSPECIAL"><span class="category">Function: </span><span><strong>*MAKE-SPECIAL</strong> <em>(symbol)</em><a href='#index-_002aMAKE_002dSPECIAL' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Makes the SYMBOL globally special.
</p>
</dd></dl>
<dl class="def">
<dt id="index-MAKE_002dSTRING_002dOUTPUT_002dSTREAM_002dFROM_002dSTRING"><span class="category">Function: </span><span><strong>MAKE-STRING-OUTPUT-STREAM-FROM-STRING</strong> <em>(string)</em><a href='#index-MAKE_002dSTRING_002dOUTPUT_002dSTREAM_002dFROM_002dSTRING' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Creates a string-output-stream corresponding to the STRING and
returns it. The STRING should have a fill-pointer.
</p>
</dd></dl>
<dl class="def">
<dt id="index-_002aIGNORE_002dEOF_002dON_002dTERMINAL_002dIO_002a"><span class="category">Variable: </span><span><strong>*IGNORE-EOF-ON-TERMINAL-IO*</strong><a href='#index-_002aIGNORE_002dEOF_002dON_002dTERMINAL_002dIO_002a' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
GCL specific: If the value of SI:*IGNORE-EOF-ON-TERMINAL-IO* is non-NIL, GCL
ignores the eof-character (usually ^D) on the terminal and the terminal never
becomes end-of-file. The default value of SI:*IGNORE-EOF-ON-TERMINAL-IO* is
NIL.
</p>
</dd></dl>
<dl class="def">
<dt id="index-ADDRESS"><span class="category">Function: </span><span><strong>ADDRESS</strong> <em>(object)</em><a href='#index-ADDRESS' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the address of the OBJECT as a fixnum. The address of
an object depends on the version of GCL. E.g. (SI:ADDRESS NIL) returns
1879062044 on GCL/AOSVS dated March 14, 1986.
</p>
</dd></dl>
<dl class="def">
<dt id="index-_002aLISP_002dMAXPAGES_002a"><span class="category">Variable: </span><span><strong>*LISP-MAXPAGES*</strong><a href='#index-_002aLISP_002dMAXPAGES_002a' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
GCL specific: Holds the maximum number of pages (1 page = 2048 bytes) for the
GCL process. The result of changing the value of SI:*LISP-MAXPAGES* is
unpredictable.
</p>
</dd></dl>
<dl class="def">
<dt id="index-ARGC"><span class="category">Function: </span><span><strong>ARGC</strong> <em>()</em><a href='#index-ARGC' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the number of arguments on the command line that invoked
the GCL process.
</p>
</dd></dl>
<dl class="def">
<dt id="index-NANI"><span class="category">Function: </span><span><strong>NANI</strong> <em>(fixnum)</em><a href='#index-NANI' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the object in the address FIXNUM. This function is
the inverse of SI:ADDRESS. Although SI:ADDRESS is a harmless operation,
SI:NANI is quite dangerous and should be used with care.
</p>
</dd></dl>
<dl class="def">
<dt id="index-_002aNOTIFY_002dGBC_002a"><span class="category">Variable: </span><span><strong>*NOTIFY-GBC*</strong><a href='#index-_002aNOTIFY_002dGBC_002a' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
GCL specific: If the value of this variable is non-NIL, then the garbage
collector notifies that it begins to run whenever it is invoked. Otherwise,
garbage collection begins silently.
</p>
</dd></dl>
<dl class="def">
<dt id="index-SAVE_002dSYSTEM"><span class="category">Function: </span><span><strong>SAVE-SYSTEM</strong> <em>(pathname)</em><a href='#index-SAVE_002dSYSTEM' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Saves the current GCL core imange into a program file specified
by PATHNAME. This function differs from SAVE in that the contiguous and
relocatable areas are made permanent in the saved image. Usually the
standard image of GCL interpreter/compiler is saved by SI:SAVE-SYSTEM.
This function causes an exit from lisp. Various changes are made
to the memory of the running system, such as closing files and
resetting io streams. It would not be possible to continue normally.
</p>
</dd></dl>
<dl class="def">
<dt id="index-UNCATCH_002dBAD_002dSIGNALS"><span class="category">Function: </span><span><strong>UNCATCH-BAD-SIGNALS</strong> <em>()</em><a href='#index-UNCATCH_002dBAD_002dSIGNALS' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL/BSD specific: Undoes the effect of SI:CATCH-BAD-SIGNALS.
</p>
</dd></dl>
<dl class="def">
<dt id="index-VS"><span class="category">Function: </span><span><strong>VS</strong> <em>(i)</em><a href='#index-VS' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the i-th entity in the value stack.
</p>
</dd></dl>
<dl class="def">
<dt id="index-DISPLACED_002dARRAY_002dP"><span class="category">Function: </span><span><strong>DISPLACED-ARRAY-P</strong> <em>(array)</em><a href='#index-DISPLACED_002dARRAY_002dP' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns T if the ARRAY is a displaced array; NIL otherwise.
</p>
</dd></dl>
<dl class="def">
<dt id="index-ARGV"><span class="category">Function: </span><span><strong>ARGV</strong> <em>(fixnum)</em><a href='#index-ARGV' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the FIXNUM-th argument on the command line that invoked
the GCL process.
</p>
</dd></dl>
<dl class="def">
<dt id="index-_002aDEFAULT_002dTIME_002dZONE_002a"><span class="category">Variable: </span><span><strong>*DEFAULT-TIME-ZONE*</strong><a href='#index-_002aDEFAULT_002dTIME_002dZONE_002a' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
GCL specific: Holds the default time zone. The initial value of SI:*DEFAULT-
TIME-ZONE* is 6 (the time zone of Austin, Texas).
</p>
</dd></dl>
<dl class="def">
<dt id="index-GETENV"><span class="category">Function: </span><span><strong>GETENV</strong> <em>(string)</em><a href='#index-GETENV' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL/UNIX specific: Returns the environment with the name STRING as a string;
if the environment specified by STRING is not found, returns NIL.
</p>
</dd></dl>
<dl class="def">
<dt id="index-FASLINK"><span class="category">Function: </span><span><strong>FASLINK</strong> <em>(file string)</em><a href='#index-FASLINK' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL/BSD specific: Loads the FASL file FILE while linking the object files and
libraries specified by STRING. For example,
(faslink "foo.o" "bar.o boo.o -lpixrect")
loads foo.o while linking two object files (bar.o and boo.o) and the library
pixrect. Usually, foo.o consists of the C language interface for the
functions defined in the object files or the libraries.
</p>
<p>A more portable way of making references to C code, is to build it
in at the time of the original make. If foo.c references things
in -lpixrect, and foo.o is its compilation in the gcl/unixport directory
</p>
<p>(cd gcl/unixport ; make "EXTRAS= foo.o -lpixrect ")
</p>
<p>should add them. If EXTRAS was already joe.o in the unixport/makefile
you should of course add joe.o to the above "EXTRAS= joe.o foo.o.."
</p>
<p>Faslink does not work on most UNIX systems which are derived from SYS V or AIX.
</p>
</dd></dl>
<dl class="def">
<dt id="index-TOP_002dLEVEL"><span class="category">Function: </span><span><strong>TOP-LEVEL</strong> <em>()</em><a href='#index-TOP_002dLEVEL' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Starts the standard top-level listener of GCL. When the GCL
process is invoked, it calls SI:TOP-LEVEL by (FUNCALL ’SI:TOP-LEVEL).
To change the top-level of GCL, redefine SI:TOP-LEVEL and save the core
imange in a file. When the saved imange is invoked, it will start the
redefined top-level.
</p>
</dd></dl>
<dl class="def">
<dt id="index-FRS_002dVS"><span class="category">Function: </span><span><strong>FRS-VS</strong> <em>(i)</em><a href='#index-FRS_002dVS' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>GCL specific: Returns the value stack index of the i-th entity in the frame
stack.
</p>
</dd></dl>
<dl class="def">
<dt id="index-WRITE_002dDEBUG_002dSYMBOLS"><span class="category">Function: </span><span><strong>WRITE-DEBUG-SYMBOLS</strong> <em>(start file &key (main-file "/usr/local/schelter/xgcl/unixport/raw_gcl") (output-file "debug-symbols.o" ))</em><a href='#index-WRITE_002dDEBUG_002dSYMBOLS' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>Write out a file of debug-symbols using address START as the place
where FILE will be loaded into the running executable MAIN-FILE. The
last is a keyword argument.
</p>
</dd></dl>
<dl class="def">
<dt id="index-PROF"><span class="category">Function: </span><span><strong>PROF</strong> <em>(x y)</em><a href='#index-PROF' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>These functions in the SI package are GCL specific, and allow monitoring
the run time of functions loaded into GCL, as well as the basic functions.
Sample Usage:
(si::set-up-profile 1000000) (si::prof 0 90)
run program
(si::prof 0 0) ;; turn off profile
(si::display-prof)
(si::clear-profile)
(si::prof 0 90) ;; start profile again
run program
..
Profile can be stopped with (si::prof 0 0) and restarted with (si::prof 0 90)
The START-ADDRESS will correspond to the beginning of the profile array, and
the SCALE will mean that 256 bytes of code correspond to SCALE bytes in the
profile array.
</p>
<p>Thus if the profile array is 1,000,000 bytes long and the code segment is
5 megabytes long you can profile the whole thing using a scale of 50
Note that long runs may result in overflow, and so an understating of the
time in a function.
</p>
<p>You must run intensively however since, with a scale of 128 it takes
6,000,000 times through a loop to overflow the sampling in one part of
the code.
</p>
</dd></dl>
<dl class="def">
<dt id="index-CATCH_002dFATAL"><span class="category">Function: </span><span><strong>CATCH-FATAL</strong> <em>(i)</em><a href='#index-CATCH_002dFATAL' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>Sets the value of the C variable catch_fatal to I which should be an integer.
If catch_fatal is 1, then most unrecoverable fatal errors will be caught.
Upon catching such an error catch_fatal becomes -1, to avoid recursive errors.
The top level loop automatically sets catch_fatal to 1, if the value is less
than zero. Catching can be turned off by making catch_fatal = 0.
</p>
</dd></dl>
<dl class="def">
<dt id="index-_002aMULTIPLY_002dSTACKS_002a"><span class="category">Variable: </span><span><strong>*MULTIPLY-STACKS*</strong><a href='#index-_002aMULTIPLY_002dSTACKS_002a' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>If this variable is set to a positive fixnum, then the next time through the
TOP-LEVEL loop, the loop will be exited. The size of the stacks will be
multiplied by the value of *multiply-stacks*, and the TOP-LEVEL will be called
again. Thus to double the size of the stacks:
</p>
<p>>(setq si::*multiply-stacks* 2)
[exits top level and reinvokes it, with the new stacks in place]
>
</p>
<p>We must exit TOP-LEVEL, because it and any other lisp functions
maintain many pointers into the stacks, which would be incorrect when the
stacks have been moved. Interrupting the process of growing the stacks,
can leave you in an inconsistent state.
</p>
</dd></dl>
<dl class="def">
<dt id="index-GBC_002dTIME"><span class="category">Function: </span><span><strong>GBC-TIME</strong> <em>(&optional x)</em><a href='#index-GBC_002dTIME' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>Sets the internal C variable gc_time to X if X is supplied and then
returns gc_time. If gc_time is greater or equal to 0, then gc_time is
incremented by the garbage collector, according to the number of
internal time units spent there. The initial value of gc_time is -1.
</p>
</dd></dl>
<dl class="def">
<dt id="index-FWRITE"><span class="category">Function: </span><span><strong>FWRITE</strong> <em>(string start count stream)</em><a href='#index-FWRITE' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>Write from STRING starting at char START (or 0 if it is nil) COUNT characters
(or to end if COUNT is nil) to STREAM. STREAM must be a stream such as
returned by FP-OUTPUT-STREAM. Returns nil if it fails.
</p>
</dd></dl>
<dl class="def">
<dt id="index-FREAD"><span class="category">Function: </span><span><strong>FREAD</strong> <em>(string start count stream)</em><a href='#index-FREAD' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>Read characters into STRING starting at char START (or 0 if it is nil) COUNT
characters (or from start to length of STRING if COUNT is nil). Characters
are read from STREAM. STREAM must be a stream such as returned by
FP-INPUT-STREAM. Returns nil if it fails. Return number of characters read
if it succeeds.
</p>
</dd></dl>
<dl class="def">
<dt id="index-SGC_002dON"><span class="category">Function: </span><span><strong>SGC-ON</strong> <em>(&optional ON)</em><a href='#index-SGC_002dON' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>If ON is not nil then SGC (stratified garbage collection) is turned
on. If ON is supplied and is nil, then SGC is turned off.
If ON is not supplied, then it returns T if SGC is on, and NIL if
SGC is off.
</p>
<p>The purpose of SGC is to prevent paging activity during garbage
collection. It is efficient if the actual number of pages being
written to form a small percentage of the total image size. The image
should be built as compactly as possible. This can be accomplished by
using a settings such as (si::allocate-growth ’cons 1 10 50 20) to limit
the growth in the cons maxpage to 10 pages per time. Then
just before calling si::save-system to save your image you can
do something like:
</p>
<p>(si::set-hole-size 500)(gbc nil) (si::sgc-on t) (si::save-system ..)
</p>
<p>This makes the saved image come up with SGC on. We have set a
reasonably large hole size. This is so that allocation of pages
either because they fill up, or through specific calls to
si::allocate, will not need to move all the relocatable data. Moving
relocatable data requires turning SGC off, performing a full gc, and
then turning it back on. New relocatable data is collected by SGC,
but moving the old requires going through all pages of memory to
change pointers into it.
</p>
<p>Using si::*notify-gbc* gives information about the number of pages
used by SGC.
</p>
<p>Note that SGC is only available on operating systems which provide
the mprotect system call, to write protect pages. Otherwise we
cannot tell which pages have been written too.
</p>
</dd></dl>
<dl class="def">
<dt id="index-ALLOCATE_002dSGC"><span class="category">Function: </span><span><strong>ALLOCATE-SGC</strong> <em>(type min-pages max-pages percent-free)</em><a href='#index-ALLOCATE_002dSGC' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>If MIN-PAGES is 0, then this type will not be swept by SGC. Otherwise
this is the minimum number of pages to make available to SGC. MAX-PAGES
is the upper limit of such pages. Only pages with PERCENT-FREE objects
on them, will be assigned to SGC.
A list of the previous values for min, max and percent are returned.
</p>
</dd></dl>
<dl class="def">
<dt id="index-ALLOCATE_002dGROWTH"><span class="category">Function: </span><span><strong>ALLOCATE-GROWTH</strong> <em>(type min max percent percent-free)</em><a href='#index-ALLOCATE_002dGROWTH' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>The next time after a garbage collection for TYPE, if PERCENT-FREE of
the objects of this TYPE are not actually free, and if the maximum
number of pages for this type has already been allocated, then the
maximum number will be increased by PERCENT of the old maximum,
subject to the condition that this increment be at least MIN pages and
at most MAX pages. A list of the previous values for min, max,
percent, and percent-free for the type TYPE is returned. A value
of 0 means use the system default, and if an argument is out of range
then the current values are returned with no change made.
</p>
<p>Examples:
(si::allocate-growth ’cons 1 10 50 10)
would insist that after a garbage collection for cons, there be at least
10% cons’s free. If not the number of cons pages would be grown by
50% or 10 pages which ever was smaller. This might be reasonable if you
were trying to build an image which was ‘full’, ie had few free objects
of this type.
</p>
<p>(si::allocate-growth ’fixnum 0 10000 30 40)
would grow space till there were normally 40% free fixnums, usually
growing by 30% per time.
</p>
<p>(si::allocate-growth ’cons 0 0 0 40) would require 40% free conses after
garbage collection for conses, and would use system defaults for the the rate
to grow towards this goal.
</p>
<p>(si::allocate-growth ’cons -1 0 0 0)
would return the current values, but not make any changes.
</p>
</dd></dl>
<dl class="def">
<dt id="index-OPEN_002dFASD"><span class="category">Function: </span><span><strong>OPEN-FASD</strong> <em>(stream direction eof-value table)</em><a href='#index-OPEN_002dFASD' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>Given file STREAM open for input or output in DIRECTION,
set it up to start writing or reading in fasd format. When
reading from this stream the EOF-VALUE will be returned when
the end a fasd end of dump marker is encountered. TABLE should
be an eq hashtable on output, a vector on input, or nil. In this
last case a default one will be constructed.
</p>
<p>We shall refer to the result as a ‘fasd stream’. It is
suitable as the arg to CLOSE-FASD, READ-FASD-TOP, and as the second
second arg to WRITE-FASD. As a lisp object it is actually a vector,
whose body coincides with:
</p>
<p>struct fasd {
object stream; /* lisp object of type stream */
object table; /* hash table used in dumping or vector on input*/
object eof; /* lisp object to be returned on coming to eof mark */
object direction; /* holds Cnil or Kinput or Koutput */
object package; /* the package symbols are in by default */
object index; /* integer. The current_dump index on write */
object filepos; /* nil or the position of the start */
object table_length; /* On read it is set to the size dump array needed
or 0
*/
object macro ; }
</p>
<p>We did not use a defstruct for this, because we want the compiler to use this
and it makes bootstrapping more difficult. It is in "cmpnew/fasdmacros.lsp"
</p>
</dd></dl>
<dl class="def">
<dt id="index-WRITE_002dFASD_002dTOP"><span class="category">Function: </span><span><strong>WRITE-FASD-TOP</strong> <em>(X FASD-STREAM)</em><a href='#index-WRITE_002dFASD_002dTOP' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>Write X to FASD-STREAM.
</p>
</dd></dl>
<dl class="def">
<dt id="index-READ_002dFASD_002dTOP"><span class="category">Function: </span><span><strong>READ-FASD-TOP</strong> <em>(FASD-STREAM)</em><a href='#index-READ_002dFASD_002dTOP' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>Read the next object from FASD-STREAM. Return the eof-value of FASD-STREAM if we
encounter an eof marker put out by CLOSE-FASD. Encountering end of actual file
stream causes an error.
</p>
</dd></dl>
<dl class="def">
<dt id="index-CLOSE_002dFASD"><span class="category">Function: </span><span><strong>CLOSE-FASD</strong> <em>(FASD-STREAM)</em><a href='#index-CLOSE_002dFASD' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>On output write an eof marker to the associated file stream, and then
make FASD-STREAM invalid for further output. It also attempts to write
information to the stream on the size of the index table needed to read from the
stream from the last open. This is useful in growing the array.
It does not alter the file stream, other than for writing this information to it.
The file stream may be reopened for further use. It is an error
to OPEN-FASD the same file or file stream again with out first calling CLOSE-FASD.
</p>
</dd></dl>
<dl class="def">
<dt id="index-FIND_002dSHARING_002dTOP"><span class="category">Function: </span><span><strong>FIND-SHARING-TOP</strong> <em>(x table)</em><a href='#index-FIND_002dSHARING_002dTOP' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>X is any lisp object and TABLE is an eq hash table. This walks through X
making entries to indicate the frequency of symbols,lists, and arrays.
Initially items get -1 when they are first met, and this is decremented by 1
each time the object occurs. Call this function on all the objects in a fasd
file, which you wish to share structure.
</p>
</dd></dl>
<dl class="def">
<dt id="index-_002aLOAD_002dPATHNAME_002a"><span class="category">Variable: </span><span><strong>*LOAD-PATHNAME*</strong><a href='#index-_002aLOAD_002dPATHNAME_002a' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
Load binds this to the pathname of the file being loaded.
</p>
</dd></dl>
<dl class="def">
<dt id="index-DEFINE_002dINLINE_002dFUNCTION"><span class="category">Macro: </span><span><strong>DEFINE-INLINE-FUNCTION</strong> <em>(fname vars &body body)</em><a href='#index-DEFINE_002dINLINE_002dFUNCTION' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>This is equivalent to defun except that VARS may not contain
&optional, &rest, &key or &aux. Also a compiler property is
added, which essentially saves the body and turns this into
a let of the VARS and then execution of the body. This
last is done using si::DEFINE-COMPILER-MACRO
Example:
(si::define-inline-function myplus (a b c) (+ a b c))
</p>
</dd></dl>
<dl class="def">
<dt id="index-DEFINE_002dCOMPILER_002dMACRO"><span class="category">Macro: </span><span><strong>DEFINE-COMPILER-MACRO</strong> <em>(fname vars &body body)</em><a href='#index-DEFINE_002dCOMPILER_002dMACRO' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>FNAME may be the name of a function, but at compile time the macro
expansion given by this is used.
</p>
<p>(si::define-compiler-macro mycar (a) ‘(car ,a))
</p>
</dd></dl>
<dl class="def">
<dt id="index-DBL"><span class="category">Function: </span><span><strong>DBL</strong> <em>()</em><a href='#index-DBL' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>Invoke a top level loop, in which debug commands may be entered.
These commands may also be entered at breaks, or in the error
handler.
See SOURCE-LEVEL-DEBUG
</p>
</dd></dl>
<dl class="def">
<dt id="index-NLOAD"><span class="category">Function: </span><span><strong>NLOAD</strong> <em>(file)</em><a href='#index-NLOAD' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>Load a file with the readtable bound to a special readtable, which
permits tracking of source line information as the file is loaded.
see SOURCE-LEVEL-DEBUG
</p>
</dd></dl>
<dl class="def">
<dt id="index-BREAK_002dFUNCTION"><span class="category">Function: </span><span><strong>BREAK-FUNCTION</strong> <em>(function &optional line absolute)</em><a href='#index-BREAK_002dFUNCTION' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>Set a breakpoint for a FUNCTION at LINE if the function has source
information loaded. If ABSOLUTE is not nil, then the line is understood to be
relative to the beginning of the buffer. See also dbl-break-function, the
emacs command.
</p>
</dd></dl>
<dl class="def">
<dt id="index-XDR_002dOPEN"><span class="category">Function: </span><span><strong>XDR-OPEN</strong> <em>(stream)</em><a href='#index-XDR_002dOPEN' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>Returns an object suitable for passing to XDR-READ if the stream
is an input stream, and XDR-WRITE if it was an output stream.
Note the stream must be a unix stream, on which si::fp-input-stream
or si::fp-output-stream would act as the identity.
</p>
</dd></dl>
<dl class="def">
<dt id="index-FP_002dINPUT_002dSTREAM"><span class="category">Function: </span><span><strong>FP-INPUT-STREAM</strong> <em>(stream)</em><a href='#index-FP_002dINPUT_002dSTREAM' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>Return a unix stream for input associated to STREAM if possible,
otherwise return nil.
</p>
</dd></dl>
<dl class="def">
<dt id="index-FP_002dOUTPUT_002dSTREAM"><span class="category">Function: </span><span><strong>FP-OUTPUT-STREAM</strong> <em>(stream)</em><a href='#index-FP_002dOUTPUT_002dSTREAM' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>Return a unix stream for output associated to STREAM if possible,
otherwise return nil.
</p>
</dd></dl>
<dl class="def">
<dt id="index-XDR_002dREAD"><span class="category">Function: </span><span><strong>XDR-READ</strong> <em>(stream element)</em><a href='#index-XDR_002dREAD' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>Read one item from STREAM of type the type of ELEMENT. The representation
of the elements is machine independent. The xdr routines are what is
used by the basic unix rpc calls.
</p>
</dd></dl>
<dl class="def">
<dt id="index-XDR_002dWRITE"><span class="category">Function: </span><span><strong>XDR-WRITE</strong> <em>(stream element)</em><a href='#index-XDR_002dWRITE' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>Write to STREAM the given ELEMENT.
</p>
</dd></dl>
<dl class="def">
<dt id="index-_002aTOP_002dLEVEL_002dHOOK_002a"><span class="category">Variable: </span><span><strong>*TOP-LEVEL-HOOK*</strong><a href='#index-_002aTOP_002dLEVEL_002dHOOK_002a' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
If this variable is has a function as its value at start up time, then
it is run immediately after the init.lsp file is loaded. This is useful
for starting up an alternate top level loop.
</p>
</dd></dl>
<dl class="def">
<dt id="index-RUN_002dPROCESS"><span class="category">Function: </span><span><strong>RUN-PROCESS</strong> <em>(string arglist)</em><a href='#index-RUN_002dPROCESS' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package:SI
</p>
<p>Execute the command STRING in a subshell passing the strings in the
list ARGLIST as arguments to the command. Return a two way stream
associated to this. Use si::fp-output-stream to get an associated
output stream or si::fp-input-stream.
</p>
<p>Bugs: It does not properly deallocate everything, so that it will fail
if you call it too many times.
</p>
</dd></dl>
<dl class="def">
<dt id="index-_002aCASE_002dFOLD_002dSEARCH_002a"><span class="category">Variable: </span><span><strong>*CASE-FOLD-SEARCH*</strong><a href='#index-_002aCASE_002dFOLD_002dSEARCH_002a' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package: SI
Non nil means that a string-match should ignore case
</p></dd></dl>
<dl class="def">
<dt id="index-STRING_002dMATCH"><span class="category">Function: </span><span><strong>STRING-MATCH</strong> <em>(pattern string &optional start end)</em><a href='#index-STRING_002dMATCH' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Package: SI
Match regexp PATTERN in STRING starting in string starting at START
and ending at END. Return -1 if match not found, otherwise
return the start index of the first matches. The variable
*MATCH-DATA* will be set to a fixnum array of sufficient size to hold
the matches, to be obtained with match-beginning and match-end.
If it already contains such an array, then the contents of it will
be over written.
</p>
<p>The form of a regexp pattern is discussed in See <a href="Regular-Expressions.html">Regular Expressions</a>.
</p>
</dd></dl>
<dl class="def">
<dt id="index-MATCH_002dBEGINNING"><span class="category">Function: </span><span><strong>MATCH-BEGINNING</strong> <em>(index)</em><a href='#index-MATCH_002dBEGINNING' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Returns the beginning of the I’th match from the previous STRING-MATCH,
where the 0th is for the whole regexp and the subsequent ones match parenthetical expressions. -1 is returned if there is no match, or if the *match-data*
vector is not a fixnum array.
</p></dd></dl>
<dl class="def">
<dt id="index-MATCH_002dEND"><span class="category">Function: </span><span><strong>MATCH-END</strong> <em>(index)</em><a href='#index-MATCH_002dEND' class='copiable-anchor'> ¶</a></span></dt>
<dd><p>Returns the end of the I’th match from the previous STRING-MATCH
</p></dd></dl>
<dl class="def">
<dt id="index-SOCKET"><span class="category">Function: </span><span><strong>SOCKET</strong> <em>(port &key host server async myaddr myport daemon)</em><a href='#index-SOCKET' class='copiable-anchor'> ¶</a></span></dt>
<dd>
<p>Establishes a socket connection to the specified PORT under a variety
of circumstances.
</p>
<p>If HOST is specified, then it is a string designating the IP address
of the server to which we are the client. ASYNC specifies that the
connection should be made asynchronously, and the call return
immediately. MYADDR and MYPORT can specify the IP address and port
respectively of a client connection, for example when the running
machine has several network interfaces.
</p>
<p>If SERVER is specified, then it is a function which will handle
incoming connections to this PORT. DAEMON specifies that the running
process should be forked to handle incoming connections in the
background. If DAEMON is set to the keyword PERSISTENT, then the
backgrounded process will survive when the parent process exits, and
the SOCKET call returns NIL. Any other non-NIL setting of DAEMON
causes the socket call to return the process id of the backgrounded
process. DAEMON currently only works on BSD and Linux based systems.
</p>
<p>If DAEMON is not set or nil, or if the socket is not a SERVER socket,
then the SOCKET call returns a two way stream. In this case, the
running process is responsible for all I/O operations on the stream.
Specifically, if a SERVER socket is created as a non-DAEMON, then the
running process must LISTEN for connections, ACCEPT them when present,
and call the SERVER function on the stream returned by ACCEPT.
</p>
</dd></dl>
<dl class="def">
<dt id="index-ACCEPT"><span class="category">Function: </span><span><strong>ACCEPT</strong> <em>(stream)</em><a href='#index-ACCEPT' class='copiable-anchor'> ¶</a></span></dt>
<dd>
<p>Creates a new two-way stream to handle an individual incoming
connection to STREAM, which must have been created with the SOCKET
function with the SERVER keyword set. ACCEPT should only be invoked
when LISTEN on STREAM returns T. If the STREAM was created with the
DAEMON keyword set in the call to SOCKET, ACCEPT is unnecessary and
will be called automatically as needed.
</p>
</dd></dl>
<ul class="section-toc">
<li><a href="Regular-Expressions.html" accesskey="1">Regular Expressions</a></li>
</ul>
</div>
<hr>
<div class="header">
<p>
Next: <a href="Debugging.html">Debugging</a>, Previous: <a href="C-Interface.html">C Interface</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
