aboutsummaryrefslogtreecommitdiff
path: root/src/interp/setvart.boot
blob: d84b29ecaa25ae8dd30c4c6d02f661de0d835075 (plain)
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
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
-- Copyright (c) 1991-2002, The Numerical ALgorithms Group Ltd.
-- All rights reserved.
-- Copyright (C) 2007-2012, Gabriel Dos Reis.
-- All rights reserved.
--
-- Redistribution and use in source and binary forms, with or without
-- modification, are permitted provided that the following conditions are
-- met:
--
--     - Redistributions of source code must retain the above copyright
--       notice, this list of conditions and the following disclaimer.
--
--     - Redistributions in binary form must reproduce the above copyright
--       notice, this list of conditions and the following disclaimer in
--       the documentation and/or other materials provided with the
--       distribution.
--
--     - Neither the name of The Numerical ALgorithms Group Ltd. nor the
--       names of its contributors may be used to endorse or promote products
--       derived from this software without specific prior written permission.
--
-- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
-- IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
-- TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
-- PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
-- OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-- EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-- PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-- PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-- LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-- NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-- SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


import sys_-macros
namespace BOOT

--% Table of )set options
$setOptions := '(
-- -------------------- The breakmode Option ---------------------
--
--  Description: execute break processing on error
--
--  The breakmode option may be followed by any one of the 
--  following:
--
--     nobreak
--  -> break 
--     query
--     resume
--     fastlinks
--
--  The current setting is indicated within the list.
  (breakmode
   "execute break processing on error"
   interpreter
   LITERALS
   $BreakMode
   (nobreak break query resume fastlinks)
   nobreak)         -- needed to avoid possible startup looping

-- ---------------------- The expose Option ----------------------
--
--  Description: control interpreter constructor exposure
--
--    The following groups are explicitly exposed in the current 
--    frame (called initial ):
--                                    basic                                   
--                                 categories                                 
-- 
--    The following constructors are explicitly exposed in the 
--    current frame:
--                there are no explicitly exposed constructors                
-- 
--    The following constructors are explicitly hidden in the 
--    current frame:
--                 there are no explicitly hidden constructors                
-- 
--    When )set expose is followed by no arguments, the information
--    you now see is displayed. When followed by the initialize 
--    argument, the exposure group data in the file INTERP.EXPOSED 
--    is read and is then available. The arguments add and drop are 
--    used to add or drop exposure groups or explicit constructors 
--    from the local frame exposure data. Issue
--                   )set expose add    or    )set expose drop 
--    for more information.
  (expose
   "control interpreter constructor exposure"
   interpreter
   FUNCTION
   setExpose
   NIL
   htSetExpose)

--              Current Values of  functions  Variables                  
--
-- Variable     Description                           Current Value
-- -----------------------------------------------------------------
-- cache        number of function results to cache        0 
-- compile      compile, don't just define function bodies off 
-- recurrence   specially compile recurrence relations     on 
  (functions
   "some interpreter function options"
   interpreter
   TREE
   novar

-- ---------------------- The cache Option -----------------------
--
--  Description: number of function results to cache
--
--  )set functions cache is used to tell AXIOM how many  values 
--   computed by interpreter functions should be saved.  This can 
--   save quite a bit of time in recursive functions, though one 
--   must consider that the cached values will take up (perhaps 
--   valuable) room in the workspace.
--
--  The value given  after cache must either be the word all or 
--  a positive integer. This may be followed by any number of 
--  function names whose cache sizes you wish to so set.  If no 
--  functions are given, the default cache  size is set.
--
--  Examples:   )set fun cache all
--              )set fun cache 10 f g Legendre
--
--  In general, functions will cache no returned values.
   ((cache
     "number of function results to cache"
     interpreter
     FUNCTION
     setFunctionsCache
     NIL
     htSetCache)

-- --------------------- The compile Option ----------------------
--
--  Description: compile, don't just define function bodies
--
--  The compile option may be followed by any one of the following:
--
--  -> on
--     off 
--
--  The current setting is indicated within the list.
    (compile
     "compile, don't just define function bodies"
     interpreter
     LITERALS
     $compileDontDefineFunctions
     (on off)
     on)

-- -------------------- The recurrence Option --------------------
--
--  Description: specially compile recurrence relations
--
--  The recurrence option may be followed by any one of the 
--  following:
--
--  -> on 
--     off
--
--  The current setting is indicated within the list.
    (recurrence
     "specially compile recurrence relations"
     interpreter
     LITERALS
     $compileRecurrence
     (on off)
     on)))

--               Current Values of  fortran  Variables                   
--
-- Variable     Description                           Current Value
-- -----------------------------------------------------------------
-- ints2floats  where sensible, coerce integers to reals   on 
-- fortindent   the number of characters indented          6 
-- fortlength   the number of characters on a line         72 
-- typedecs     print type and dimension lines             on 
-- defaulttype  default generic type for FORTRAN object    REAL 
-- precision    precision of generated FORTRAN objects     double 
-- intrinsic    whether to use INTRINSIC FORTRAN functions off 
-- explength    character limit for FORTRAN expressions    1320 
-- segment      split long FORTRAN expressions             on 
-- optlevel     FORTRAN optimisation level                 0 
-- startindex   starting index for FORTRAN arrays          1 
-- calling      options for external FORTRAN calls         ... 
--
-- Variables with current values of ... have further sub-options. 
-- For example, issue )set calling to see what the options are for 
-- calling.
-- For more information, issue )help set .
  (fortran
   "view and set options for FORTRAN output"
   interpreter
   TREE
   novar

-- ------------------- The ints2floats Option --------------------
--
--  Description: where sensible, coerce integers to reals
--
--  The ints2floats option may be followed by any one of the 
--  following:
--
--  -> on 
--     off
--
--  The current setting is indicated within the list.
   ((ints2floats
     "where sensible, coerce integers to reals"
     interpreter
     LITERALS
     $fortInts2Floats
     (on off)
     on)

-- -------------------- The fortindent Option --------------------
--
--  Description: the number of characters indented
--
--  The fortindent option may be followed by an integer in the range 
--  0 to inclusive. The current setting is 6 
    (fortindent
     "the number of characters indented"
     interpreter
     INTEGER
     $fortIndent
     (0 NIL)
     6)

-- -------------------- The fortlength Option --------------------
--
--  Description: the number of characters on a line
--
--  The fortlength option may be followed by an integer in the range 
--  1 to inclusive. The current setting is 72 
    (fortlength
     "the number of characters on a line"
     interpreter
     INTEGER
     $fortLength
     (1 NIL)
     72)

-- --------------------- The typedecs Option ---------------------
--
--  Description: print type and dimension lines
--
--  The typedecs option may be followed by any one of the 
--  following:
--
--  -> on 
--     off
--
--  The current setting is indicated within the list.
    (typedecs
     "print type and dimension lines"
     interpreter
     LITERALS
     $printFortranDecs
     (on off)
     on)

-- ------------------- The defaulttype Option --------------------
--
--  Description: default generic type for FORTRAN object
--
--  The defaulttype option may be followed by any one of the 
--  following:
--
--  -> REAL 
--     INTEGER
--     COMPLEX
--     LOGICAL
--     CHARACTER
--
--  The current setting is indicated within the list.
    (defaulttype
     "default generic type for FORTRAN object"
     interpreter
     LITERALS
     $defaultFortranType
     (REAL INTEGER COMPLEX LOGICAL CHARACTER)
     REAL)

-- -------------------- The precision Option ---------------------
--
--  Description: precision of generated FORTRAN objects
--
--  The precision option may be followed by any one of the 
--  following:
--
--     single
--  -> double 
--
--  The current setting is indicated within the list.
    (precision
    "precision of generated FORTRAN objects"
     interpreter
     LITERALS
     $fortranPrecision
     (single double)
     double)

-- -------------------- The intrinsic Option ---------------------
--
--  Description: whether to use INTRINSIC FORTRAN functions
--
--  The intrinsic option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
    (intrinsic
     "whether to use INTRINSIC FORTRAN functions"
     interpreter
     LITERALS
     $useIntrinsicFunctions
     (on off)
     off)

-- -------------------- The explength Option ---------------------
--
--  Description: character limit for FORTRAN expressions
--
--  The explength option may be followed by an integer in the range 
--  0 to inclusive. The current setting is 1320 
    (explength
     "character limit for FORTRAN expressions"
     interpreter
     INTEGER
     $maximumFortranExpressionLength
     (0 NIL)
     1320)

-- --------------------- The segment Option ----------------------
--
--  Description: split long FORTRAN expressions
--
--  The segment option may be followed by any one of the following:
--
--  -> on 
--     off
--
--  The current setting is indicated within the list.
    (segment
     "split long FORTRAN expressions"
     interpreter
     LITERALS
     $fortranSegment
     (on off)
     on)

-- --------------------- The optlevel Option ---------------------
--
--  Description: FORTRAN optimisation level
--
--  The optlevel option may be followed by an integer in the range 
--  0 to 2 inclusive. The current setting is 0 
    (optlevel
     "FORTRAN optimisation level"
     interpreter
     INTEGER
     $fortranOptimizationLevel
     (0 2)
     0)

-- -------------------- The startindex Option --------------------
--
--  Description: starting index for FORTRAN arrays
--
--  The startindex option may be followed by an integer in the range 
--  0 to 1 inclusive. The current setting is 1 
    (startindex
     "starting index for FORTRAN arrays"
     interpreter
     INTEGER
     $fortranArrayStartingIndex
     (0 1)
     1)

--               Current Values of  calling  Variables                   
--
-- Variable     Description                           Current Value
-- -----------------------------------------------------------------
-- tempfile     set location of temporary data files       /tmp/ 
-- directory    set location of generated FORTRAN files    ./ 
-- linker       linker arguments (e.g. libraries to search) -lxlf 
    (calling
    "options for external FORTRAN calls"
    interpreter
    TREE
    novar

-- --------------------- The tempfile Option ---------------------
--
--  Description: set location of temporary data files
--
--  )set fortran calling tempfile  is used to tell AXIOM where
--  to place intermediate FORTRAN data files . This must be the 
--  name of a valid existing directory to which you have permission 
--  to write (including the final slash).
--
--  Syntax:
--    )set fortran calling tempfile DIRECTORYNAME
--
--  The current setting is /tmp/ 
    ((tempfile
      "set location of temporary data files"
      interpreter
      FUNCTION
      setFortTmpDir
      (("enter directory name for which you have write-permission"
        DIRECTORY
        $fortranTmpDir
        chkDirectory
        "/tmp/"))
      NIL)

-- -------------------- The directory Option ---------------------
--
--  Description: set location of generated FORTRAN files
--
--  )set fortran calling directory  is used to tell AXIOM where
--  to place generated FORTRAN files. This must be the name 
--  of a valid existing directory to which you have permission 
--  to write (including the final slash).
--
--  Syntax:
--    )set fortran calling directory DIRECTORYNAME
--
--  The current setting is ./ 
     (directory
      "set location of generated FORTRAN files"
      interpreter
      FUNCTION
      setFortDir
      (("enter directory name for which you have write-permission"
	DIRECTORY
	$fortranDirectory
	chkDirectory
	"./"))
      NIL)

-- ---------------------- The linker Option ----------------------
--
--  Description: linker arguments (e.g. libraries to search)
--
--  )set fortran calling linkerargs is used to pass arguments to 
--  the linker when using  mkFort  to create functions which call 
--  Fortran code. For example, it might give a list of libraries 
--  to be searched, and their locations.
--  The string is passed verbatim, so must be the correct syntax for
--  the particular linker being used.
--
--  Example: )set fortran calling linker "-lxlf"
--
--  The current setting is -lxlf 
     (linker
      "linker arguments (e.g. libraries to search)"
      interpreter
      FUNCTION
      setLinkerArgs
      (("enter linker arguments "
	STRING
	$fortranLibraries
	chkDirectory
	"-lxlf"))
      NIL)
     ))
   ))

--               Current Values of  kernel  Variables                    
--
-- Variable     Description                           Current Value
-- -----------------------------------------------------------------
-- warn         warn when re-definition is attempted       off 
-- protect      prevent re-definition of kernel functions  off 
  (kernel
   "library functions built into the kernel for efficiency"
   interpreter
   TREE
   novar

-- ----------------------- The warn Option -----------------------
--
--  Description: warn when re-definition is attempted
--
-- Some AXIOM library functions are compiled into the kernel for 
-- efficiency reasons. To prevent them being re-defined when loaded 
-- from a library they are specially protected. If a user wishes to 
-- know when an attempt is made to re-define such a function, he or 
-- she should issue the command:
--         )set kernel warn on
-- To restore the default behaviour, he or she should issue the 
-- command:
--         )set kernel warn off
   ((warn
     "warn when re-definition is attempted"
     interpreter
     FUNCTION
     protectedSymbolsWarning
     NIL
     htSetKernelWarn)
-- --------------------- The protect Option ----------------------
--
--  Description: prevent re-definition of kernel functions
--
-- Some AXIOM library functions are compiled into the kernel for 
-- efficiency reasons. To prevent them being re-defined when loaded
-- from a library they are specially protected.  If a user wishes 
-- to re-define these functions, he or she should issue the command:
--         )set kernel protect off
-- To restore the default behaviour, he or she should issue the 
-- command:
--         )set kernel protect on
    (protect
     "prevent re-definition of kernel functions"
     interpreter
     FUNCTION
     protectSymbols
     NIL
     htSetKernelProtect)
   ))

--              Current Values of  hyperdoc  Variables                   
--
-- Variable     Description                           Current Value
-- -----------------------------------------------------------------
-- fullscreen   use full screen for this facility          off 
-- mathwidth    screen width for history output            120 
  (hyperdoc
   "options in using HyperDoc"
   interpreter
   TREE
   novar
-- -------------------- The fullscreen Option --------------------
--
--  Description: use full screen for this facility
--
--  The fullscreen option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
   ((fullscreen
     "use full screen for this facility"
     interpreter
     LITERALS
     $fullScreenSysVars
     (on off)
     off)
-- -------------------- The mathwidth Option ---------------------
--
--  Description: screen width for history output
--
--  The mathwidth option may be followed by an integer in the range 
--  0 to inclusive. The current setting is 120 
    (mathwidth
     "screen width for history output"
     interpreter
     INTEGER
     $historyDisplayWidth
     (0 NIL)
     120)
   ))

--                Current Values of  help  Variables                     
--
-- Variable     Description                           Current Value
-- -----------------------------------------------------------------
-- fullscreen   use fullscreen facility, if possible       off 
  (help
   "view and set some help options"
   interpreter
   TREE
   novar
-- -------------------- The fullscreen Option --------------------
--
--  Description: use fullscreen facility, if possible
--
--  The fullscreen option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
   ((fullscreen
    "use fullscreen facility, if possible"
    interpreter
    LITERALS
    $useFullScreenHelp
    (on off)
    off)
   ))

-- --------------------- The history Option ----------------------
--
--  Description: save workspace values in a history file
--
--  The history option may be followed by any one of the 
--  following:
--
--  -> on 
--     off
--
--  The current setting is indicated within the list.
  (history
   "save workspace values in a history file"
   interpreter
   LITERALS
   $HiFiAccess
   (on off)
   on)

--              Current Values of  messages  Variables                   
--
-- Variable     Description                           Current Value
-- -----------------------------------------------------------------
-- autoload     print file auto-load messages              off 
-- bottomup     display bottom up modemap selection        off 
-- coercion     display datatype coercion messages         off 
-- dropmap      display old map defn when replaced         off 
-- expose       warning for unexposed functions            off 
-- file         print msgs also to SPADMSG LISTING         off 
-- frame        display messages about frames              off 
-- highlighting use highlighting in system messages        off 
-- instant      present instantiation summary              off 
-- insteach     present instantiation info                 off 
-- interponly   say when function code is interpreted      on 
-- number       display message number with message        off 
-- prompt       set type of input prompt to display        step 
-- selection    display function selection msgs            off 
-- set          show )set setting after assignment         off 
-- startup      display messages on start-up               off 
-- summary      print statistics after computation         off 
-- testing      print system testing header                off 
-- time         print timings after computation            off 
-- type         print type after computation               on 
-- void         print Void value when it occurs            off 
-- any          print the internal type of objects of domain Any on 
  (messages
   "show messages for various system features"
   interpreter
   TREE
   novar

-- ----------------------- The any Option ------------------------
--
--  Description: print the internal type of objects of domain Any
--
--  The any option may be followed by any one of the following:
--
--  -> on 
--     off
--
--  The current setting is indicated within the list.
   ((any
     "print the internal type of objects of domain Any"
     interpreter
     LITERALS
     $printAnyIfTrue
     (on off)
     on)
-- --------------------- The autoload Option ---------------------
--
--  Description: print file auto-load messages
    (autoload
     "print file auto-load messages"
     interpreter
     FUNCTION
     printLoadMessages
     (on off)
     on)

-- --------------------- The bottomup Option ---------------------
--
--  Description: display bottom up modemap selection
--
--  The bottomup option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
    (bottomup
     "display bottom up modemap selection"
     development
     LITERALS
     $reportBottomUpFlag
     (on off)
     off)

-- --------------------- The coercion Option ---------------------
--
--  Description: display datatype coercion messages
--
--  The coercion option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
    (coercion
     "display datatype coercion messages"
     development
     LITERALS
     $reportCoerceIfTrue
     (on off)
     off)

-- --------------------- The dropmap Option ----------------------
--
--  Description: display old map defn when replaced
--
--  The dropmap option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
    (dropmap
     "display old map defn when replaced"
     interpreter
     LITERALS
     $displayDroppedMap
     (on off)
     off)

-- ---------------------- The expose Option ----------------------
--
--  Description: warning for unexposed functions
--
--  The expose option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
    (expose
     "warning for unexposed functions"
     interpreter
     LITERALS
     $giveExposureWarning
     (on off)
     off)

-- ----------------------- The file Option -----------------------
--
--  Description: print msgs also to SPADMSG LISTING
--
--  The file option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
    (file
     "print msgs also to SPADMSG LISTING"
     development
     LITERALS
     $printMsgsToFile
     (on off)
     off)

-- ---------------------- The frame Option -----------------------
--
--  Description: display messages about frames
--
--  The frame option may be followed by any one of the following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
    (frame
     "display messages about frames"
     interpreter
     LITERALS
     $frameMessages
     (on off)
     off)

-- ------------------- The highlighting Option -------------------
--
--  Description: use highlighting in system messages
--
--  The highlighting option may be followed by any one of the 
--  following:
--
--  -> on
--     off 
--
--  The current setting is indicated within the list.
    (highlighting
     "use highlighting in system messages"
     interpreter
     LITERALS
     $highlightAllowed
     (on off)
     on)

-- --------------------- The instant Option ----------------------
--
--  Description: present instantiation summary
--
--  The instant option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
    (instant
     "present instantiation summary"
     development
     LITERALS
     $reportInstantiations
     (on off)
     off)

-- --------------------- The insteach Option ---------------------
--
--  Description: present instantiation info
--
--  The insteach option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
    (insteach
     "present instantiation info"
     development
     LITERALS
     $reportEachInstantiation
     (on off)
     off)

-- -------------------- The interponly Option --------------------
--
--  Description: say when function code is interpreted
--
--  The interponly option may be followed by any one of the 
--  following:
--
--  -> on 
--     off
--
--  The current setting is indicated within the list.
    (interponly
     "say when function code is interpreted"
     interpreter
     LITERALS
     $reportInterpOnly
     (on off)
     on)

-- ---------------------- The number Option ----------------------
--
--  Description: display message number with message
--
--  The number option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
    (number
     "display message number with message"
     interpreter
     LITERALS
     $displayMsgNumber
     (on off)
     off)

-- ---------------------- The prompt Option ----------------------
--
--  Description: set type of input prompt to display
--
--  The prompt option may be followed by any one of the following:
--
--     none
--     frame
--     plain
--  -> step 
--     verbose
--
--  The current setting is indicated within the list.
    (prompt
     "set type of input prompt to display"
     interpreter
     LITERALS
     $inputPromptType
     (none frame plain step verbose)
     step)

-- -------------------- The selection Option ---------------------
--
--  Description: display function selection msgs
--
--  The selection option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
    (selection
     "display function selection msgs"
     interpreter
     LITERALS
     $reportBottomUpFlag
     (on off)
     off)

-- ----------------------- The set Option ------------------------
--
--  Description: show )set setting after assignment
--
--  The set option may be followed by any one of the following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
    (set
     "show )set setting after assignment"
     interpreter
     LITERALS
     $displaySetValue
     (on off)
     off)

-- --------------------- The startup Option ----------------------
--
--  Description: display messages on start-up
--
--  The startup option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
    (startup
     "display messages on start-up"
     interpreter
     LITERALS
     $displayStartMsgs
     (on off)
     on)

-- --------------------- The summary Option ----------------------
--
--  Description: print statistics after computation
--
--  The summary option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
    (summary
     "print statistics after computation"
     interpreter
     LITERALS
     $printStatisticsSummaryIfTrue
     (on off)
     off)

-- --------------------- The testing Option ----------------------
--
--  Description: print system testing header
--
--  The testing option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
    (testing
     "print system testing header"
     development
     LITERALS
     $testingSystem
     (on off)
     off)

-- ----------------------- The time Option -----------------------
--
--  Description: print timings after computation
--
--  The time option may be followed by any one of the following:
--
--     on
--  -> off 
--     long
--
--  The current setting is indicated within the list.
    (time
     "print timings after computation"
     interpreter
     LITERALS
     $printTimeIfTrue
     (on off long)
     off)

-- ----------------------- The type Option -----------------------
--
--  Description: print type after computation
--
--  The type option may be followed by any one of the following:
--
--  -> on 
--     off
--
--  The current setting is indicated within the list.
    (type
     "print type after computation"
     interpreter
     LITERALS
     $printTypeIfTrue
     (on off)
     on)

-- ----------------------- The void Option -----------------------
--
--  Description: print Void value when it occurs
--
--  The void option may be followed by any one of the following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
    (void
     "print Void value when it occurs"
     interpreter
     LITERALS
     $printVoidIfTrue
     (on off)
     off)
   ))

-- Variable     Description                           Current Value
-- -----------------------------------------------------------------
-- abbreviate  abbreviate type names                    off 
-- algebra     display output in algebraic form         On:CONSOLE 
-- asgard      show output in asgard form               off 
-- characters  choose special output character set      plain 
-- fortran     create output in FORTRAN format          Off:CONSOLE 
-- fraction    how fractions are formatted              vertical 
-- length      line length of output displays           77 
-- scripts     show subscripts,... linearly             off 
-- showeditor  view output of )show in editor           off 
-- tex         create output in TeX style               Off:CONSOLE
-- mathml      create output in MathML style            Off:CONSOLE 
  (output
   "view and set some output options"
   interpreter
   TREE
   novar

-- -------------------- The abbreviate Option --------------------
--
--  Description: abbreviate type names
--
--  The abbreviate option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
    ((abbreviate
      "abbreviate type names"
      interpreter
      LITERALS
      $abbreviateTypes
      (on off)
      off)

-- --------------------- The algebra Option ----------------------
--
--  Description: display output in algebraic form
--
--  )set output algebra is used to tell AXIOM to turn algebra-style
--   output printing on and off, and where to place the output.  By
--   default, the destination for the output is the screen but 
--   printing is turned off.
--
-- Syntax:   )set output algebra <arg>
--     where arg can be one of
--   on          turn algebra printing on (default state)
--   off         turn algebra printing off
--   console     send algebra output to screen (default state)
--   fp<.fe>     send algebra output to file with file prefix fp
--               and file extension .fe. If not given, 
--               .fe defaults to .spout.
--
-- If you wish to send the output to a file, you may need to issue
-- this command twice: once with on and once with the file name. 
-- For example, to send algebra output to the file polymer.spout,
-- issue the two commands
--
--   )set output algebra on
--   )set output algebra polymer
--
-- The output is placed in the directory from which you invoked 
-- AXIOM or the one you set with the )cd system command.
-- The current setting is:  On:CONSOLE 
     (algebra
      "display output in algebraic form"
      interpreter
      FUNCTION
      setOutputAlgebra
      (("display output in algebraic form"
        LITERALS
        $algebraFormat
        (off on)
        on)
       (break $algebraFormat)
       ("where algebra printing goes (enter {\em console} or a pathname)?"
        FILENAME
        $algebraOutputFile
        chkOutputFileName
        "console"))
      NIL)

-- -------------------- The Asgard Form Option --------------------
--
--  Description: show output in asgard form
--
--  The abbreviate option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
     (asgard
      "show output in asgard form"
      interpreter
      LITERALS
      $asgardForm
      (on off)
      off)

-- -------------------- The characters Option --------------------
--
--  Description: choose special output character set
--
--  The characters option may be followed by any one of the 
--  following:
--
--     default
--  -> plain 
--
--  The current setting is indicated within the list.  This 
--  option  determines the special characters used for algebraic 
--  output. This is what the current choice of special characters 
--  looks like:
--    ulc is shown as +          urc is shown as +       
--    llc is shown as +          lrc is shown as +       
--    vbar is shown as |         hbar is shown as -      
--    quad is shown as ?         lbrk is shown as [      
--    rbrk is shown as ]         lbrc is shown as {      
--    rbrc is shown as }         ttee is shown as +      
--    btee is shown as +         rtee is shown as +      
--    ltee is shown as +         ctee is shown as +      
--    bslash is shown as \    
     (characters
      "choose special output character set"
      interpreter
      FUNCTION
      setOutputCharacters
      NIL
      htSetOutputCharacters)

-- --------------------- The fortran Option ----------------------
--
--  Description: create output in FORTRAN format
--
--  )set output fortran is used to tell AXIOM to turn FORTRAN-style
--   output printing on and off, and where to place the output.  By
--   default, the destination for the output is the screen but 
--   printing is turned off.
--
-- Also See: )set fortran
--
-- Syntax:   )set output fortran <arg>
--     where arg can be one of
--   on          turn FORTRAN printing on
--   off         turn FORTRAN printing off (default state)
--   console     send FORTRAN output to screen (default state)
--   fp<.fe>     send FORTRAN output to file with file prefix 
--               fp and file extension .fe. If not given, 
--               .fe defaults to .sfort.
--
-- If you wish to send the output to a file, you must issue 
-- this command twice: once with on and once with the file name.
-- For example, to send FORTRAN output to the file polymer.sfort,
--  issue the two commands
--
--   )set output fortran on
--   )set output fortran polymer
--
-- The output is placed in the directory from which you invoked
-- AXIOM or the one you set with the )cd system command.
-- The current setting is:  Off:CONSOLE 
     (fortran
      "create output in FORTRAN format"
      interpreter
      FUNCTION
      setOutputFortran
      (("create output in FORTRAN format"
        LITERALS
        $fortranFormat
        (off on)
        off)
       (break $fortranFormat)
       ("where FORTRAN output goes (enter {\em console} or a a pathname)"
        FILENAME
        $fortranOutputFile
        chkOutputFileName
        "console"))
      NIL)

-- --------------------- The fraction Option ---------------------
--
--  Description: how fractions are formatted
--
--  The fraction option may be followed by any one of the following:
--
--  -> vertical 
--     horizontal
--
--  The current setting is indicated within the list.
     (fraction
      "how fractions are formatted"
      interpreter
      LITERALS
      $fractionDisplayType
      (vertical horizontal)
      vertical)

-- ---------------------- The length Option ----------------------
--
--  Description: line length of output displays
--
--  The length option may be followed by an integer in the range 
--  10 to 245 inclusive. The current setting is 77 
     (length
      "line length of output displays"
      interpreter
      INTEGER
      $LINELENGTH
      (10 245)
      77)

-- --------------------- The scripts Option ----------------------
--
--  Description: show subscripts,... linearly
--
--  The scripts option may be followed by any one of the following:
--
--     yes
--     no
--
--  The current setting is indicated within the list.
     (scripts
      "show subscripts,... linearly"
      interpreter
      LITERALS
      $linearFormatScripts
      (yes no)
      no)

-- -------------------- The showeditor Option --------------------
--
--  Description: view output of )show in editor
--
--  The showeditor option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
     (showeditor
      "view output of )show in editor"
      interpreter
      LITERALS
      $useEditorForShowOutput
      (on off)
      off)

-- ----------------------- The tex Option ------------------------
--
--  Description: create output in TeX style
--
--  )set output tex is used to tell AXIOM to turn TeX-style output
-- printing on and off, and where to place the output.  By default,
-- the destination for the output is the screen but printing is 
-- turned off.
--
-- Syntax:   )set output tex <arg>
--     where arg can be one of
--   on          turn TeX printing on
--   off         turn TeX printing off (default state)
--   console     send TeX output to screen (default state)
--   fp<.fe>     send TeX output to file with file prefix fp
--               and file extension .fe. If not given, 
--               .fe defaults to .stex.
--
-- If you wish to send the output to a file, you must issue 
-- this command twice: once with on and once with the file name. 
-- For example, to send TeX output to the file polymer.stex, 
-- issue the two commands
--
--   )set output tex on
--   )set output tex polymer
--
-- The output is placed in the directory from which you invoked 
-- AXIOM or the one you set with the )cd system command.
-- The current setting is:  Off:CONSOLE 
     (tex
      "create output in TeX style"
      interpreter
      FUNCTION
      setOutputTex
      (("create output in TeX format"
        LITERALS
        $texFormat
        (off on)
        off)
       (break $texFormat)
       ("where TeX output goes (enter {\em console} or a pathname)"
        FILENAME
        $texOutputFile
        chkOutputFileName
        "console"))
      NIL)

-- ----------------------- The mathml Option ------------------------
--
-- Description: create output in MathML style
--
-- )set output mathml is used to tell OpenAxiom to turn MathML-style output
-- printing on and off, and where to place the output. By default,
-- the destination for the output is the screen but printing is
-- turned off.
--
-- Syntax: )set output mathml <arg>
-- where arg can be one of
-- on turn MathML printing on
-- off turn MathML printing off (default state)
-- console send MathML output to screen (default state)
-- fp<.fe> send MathML output to file with file prefix fp
-- and file extension .fe. If not given,
-- .fe defaults to .smml.
--
-- If you wish to send the output to a file, you must issue
-- this command twice: once with on and once with the file name.
-- For example, to send MathML output to the file polymer.smml,
-- issue the two commands
--
-- )set output mathml on
-- )set output mathml polymer
--
-- The output is placed in the directory from which you invoked
-- OpenAxiom or the one you set with the )cd system command.
-- The current setting is: Off:CONSOLE

  (mathml
  "create output in MathML style"
  interpreter
  FUNCTION
  setOutputMathml
  (("create output in MathML format"
  LITERALS
  $mathmlFormat
  (off on)
  off)
  (break $mathmlFormat)
  ("where MathML output goes (enter {\em console} or a pathname)"
  FILENAME
  $mathmlOutputFile
  chkOutputFileName
  "console"))
  NIL)
  ))

-- ----------------------- The quit Option -----------------------
--
--  Description: protected or unprotected quit
--
--  The quit option may be followed by any one of the following:
--
--     protected
--  -> unprotected 
--
--  The current setting is indicated within the list.
  (quit
   "protected or unprotected quit"
   interpreter
   LITERALS
   $quitCommandType
   (protected unprotected)
   unprotected)

--               Current Values of  streams  Variables                   
--
-- Variable     Description                           Current Value
-- -----------------------------------------------------------------
-- calculate    specify number of elements to calculate    10 
-- showall      display all stream elements computed       off 
  (streams
   "set some options for working with streams"
   interpreter
   TREE
   novar

-- -------------------- The calculate Option ---------------------
--
--  Description: specify number of elements to calculate
--
--    )set streams calculate is used to tell AXIOM how many elements
--     of a stream to calculate when a computation uses the stream. 
--     The value given after calculate must either be the word all 
--     or a positive integer.
--
--       The current setting is 10 .
   ((calculate
     "specify number of elements to calculate"
     interpreter
     FUNCTION
     setStreamsCalculate
     (("number of initial stream elements you want calculated"
      INTEGER
      $streamCount
      (0 NIL)
      10))
     NIL)

-- --------------------- The showall Option ----------------------
--
--  Description: display all stream elements computed
--
--  The showall option may be followed by any one of the following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
   (showall
    "display all stream elements computed"
    interpreter
    LITERALS
    $streamsShowAll
    (on off)
    off)
  ))

--               Current Values of  system  Variables                    
--
-- Variable     Description                           Current Value
-- -----------------------------------------------------------------
-- functioncode show gen. LISP for functions when compiled off 
-- optimization show optimized LISP code                   off 
-- prettyprint  prettyprint BOOT func's as they compile    off 
  (system
   "set some system development variables"
   development
   TREE
   novar

-- ------------------- The functioncode Option -------------------
--
--  Description: show gen. LISP for functions when compiled
--
--  The functioncode option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
   ((functioncode
     "show gen. LISP for functions when compiled"
     development
     LITERALS
     $reportCompilation
     (on off)
     off)

-- ------------------- The prettyprint Option --------------------
--
--  Description: prettyprint BOOT func's as they compile
--
--  The prettyprint option may be followed by any one of the 
--  following:
--
--     on
--  -> off 
--
--  The current setting is indicated within the list.
    (prettyprint
     "prettyprint BOOT func's as they compile"
     development
     LITERALS
     $PrettyPrint
     (on off)
     off)
   ))

-- -------------------- The userlevel Option ---------------------
--
--  Description: operation access level of system user
--
--  The userlevel option may be followed by any one of the 
--  following:
--
--     interpreter
--     compiler
--  -> development 
--
--  The current setting is indicated within the list.
  (userlevel
   "operation access level of system user"
   interpreter
   LITERALS
   $UserLevel
   (interpreter compiler development)
   development)
 )

--%
$reportCoerceIfTrue := nil

--%
printLoadMessages u ==
  u in '(%display% %describe%) =>
    ($printLoadMsgs => '"on"; '"off")
  $printLoadMsgs := u is ["on"]

-- The following creates a list of option names in the above table.

$setOptionNames := [x.0 for x in $setOptions]

initializeSetVariables $setOptions