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
|
-- Copyright (c) 1991-2002, The Numerical Algorithms Group Ltd.
-- All rights reserved.
-- Copyright (C) 2007-2011, 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 bc_-util
namespace BOOT
--=======================================================================
-- AXIOM Browser
-- Initial entry is from man0.ht page to one of these functions:
-- kSearch (cSearch, dSearch, or pSearch), for constructors
-- oSearch, for operations
-- aSearch, for attributes
-- aokSearch, for general search
-- docSearch, for documentation search
-- genSearch, for complete search
--=======================================================================
browserAutoloadOnceTrigger() == nil
----------------------> Global Variables <-----------------------
$includeUnexposed? := true --default setting
$tick == char "`" --field separator for database files
$wild1 := '"[^`]*" --phrase used to convert keys to grep strings
$browseCountThreshold := 10 --the maximum number of names that will display
--on a general search
$opDescriptionThreshold := 4 --if <= 4 operations with unique name, give desc
--otherwise, give signatures
$browseMixedCase := true --distinquish case in the browser?
$docTable := nil --cache for documentation table
$conArgstrings := nil --bound by conPage so that kPage
--will display arguments if given
$conformsAreDomains := false --are all arguments of a constructor given?
$dbDataFunctionAlist := nil --set by dbGatherData
$domain := nil --bound in koOps
$infovec := nil --bound in koOps
$predvec := nil --bound in koOps
$exposedOnlyIfTrue := nil --see repeatSearch, dbShowOps, dbShowCon
$bcMultipleNames := nil --see bcNameConTable
$bcConformBincount := nil --see bcConform1
$docTableHash := hashTable 'EQUAL --see dbExpandOpAlistIfNecessary
$groupChoice := nil --see dbShowOperationsFromConform
------------------> Initial Settings <---------------------
$pmFilterDelimiters := [char "(",char ")",char " "]
$dbKindAlist :=
[[char "a",:'"attribute"],[char "o",:'"operation"],
[char "d",:'"domain"],[char "p",:'"package"],
[char "c",:'"category"],[char "x",:'"default_ package"]]
$OpViewTable := '(
(names "Name" "Names" dbShowOpNames)
(documentation "Name" "Names" dbShowOpDocumentation)
(domains "Domain" "Domains" dbShowOpDomains)
(signatures "Signature" "Signatures" dbShowOpSignatures)
(parameters "Form" "Forms" dbShowOpParameters)
(origins "Origin" "Origins" dbShowOpOrigins)
(implementation nil "Implementation Domains" dbShowOpImplementations)
(conditions "Condition" "Conditions" dbShowOpConditions))
bcBlankLine() == bcHt '"\vspace{1}\newline "
pluralize k ==
k = '"child" => '"children"
k = '"category" => '"categories"
k = '"entry" => '"entries"
strconc(k,'"s")
capitalize s ==
LASSOC(s,'(
("domain" . "Domain")
("category" . "Category")
("package" . "Package")
("default package" . "Default Package")))
or
res := copyString s
stringChar(res,0) := charUpcase stringChar(res,0)
res
escapeSpecialIds u == --very expensive function
x := LASSOC(u,$htCharAlist) => [x]
#u = 1 =>
member(u, $htSpecialChars) => [strconc('"_\", u)]
[u]
c := char u.0
or/[c = char y for y in $htSpecialChars] =>
[strconc('"_\",u)]
[u]
escapeString com == --this makes changes on single comment lines
-- was htexCom
look := 0
while look repeat
look >= #com => look := []
look := STRPOSL ('"${}#%", com, look, [])
if look then
com := RPLACSTR (com,look,0,'"\") --note RPLACSTR copies!!!
look := look + 2
com
htPred2English(x,:options) ==
$emList :local := IFCAR options --list of identifiers to be emphasised
$precList: local := '((OR 10 . "or") (AND 9 . "and")
(_< 5) (_<_= 5) (_> 5) (_>_= 5) (_= 5) (_~_= 5) (or 10) (and 9))
fn(x,100) where
fn(x,prec) ==
x is [op,:l] =>
LASSOC(op,$precList) is [iprec,:rename] =>
if iprec > prec then htSay '"("
fn(first l,iprec)
for y in rest l repeat
htSay('" ",rename or op,'" ")
fn(y,iprec)
if iprec > prec then htSay '")"
if prec < 5 then htSay '"("
gn(x,op,l,prec)
if prec < 5 then htSay '")"
x = 'etc => htSay '"..."
ident? x and not symbolMember?(x,$emList) =>
htSay escapeSpecialIds symbolName x
htSay form2HtString(x,$emList)
gn(x,op,l,prec) ==
op in '(NOT not) =>
htSay('"not ")
fn(first l,0)
op = 'HasCategory =>
bcConform(first l,$emList)
htSay('" has ")
bcConform(CADADR l,$emList)
op = 'HasAttribute =>
bcConform(first l,$emList)
htSay('" has ")
fnAttr CADADR l
op in '(_has ofCategory) =>
bcConform(first l,$emList)
htSay('" has ")
[a,b] := l
b is ['ATTRIBUTE,c] and not constructor? c => fnAttr c
bcConform(b, $emList)
bcConform(x,$emList)
fnAttr c ==
s := form2HtString c
member(s,$emList) => htSay('"{\em ",s,'"}")
satDownLink(s, ['"(|aPage| '|",s,'"|)"])
unMkEvalable u ==
u is ['QUOTE,a] => a
u is ['%list,:r] => [unMkEvalable x for x in r]
u
lisp2HT u == ['"_'",:fn u] where fn u ==
ident? u => escapeSpecialIds symbolName u
string? u => escapeString u
atom u => systemError()
['"_(",:"append"/[fn x for x in u],'")"]
args2HtString(x,:options) ==
null x => '""
emList := IFCAR options
subString(form2HtString(['f,:x],emList),1)
quickForm2HtString(x) ==
atom x => STRINGIMAGE x
form2HtString x
form2HtString(x,:options) ==
$emList:local := IFCAR options --list of atoms to be emphasized
$brief: local := IFCAR IFCDR options --see dbShowOperationsFromConform (lib11)
fn(x) where
fn x ==
atom x =>
symbolMember?(x,$FormalMapVariableList) =>
strconc('"\",symbolName x)
u := escapeSpecialChars STRINGIMAGE x
symbolMember?(x,$emList) => strconc('"{\em ",u,'"}")
string? x => strconc('"_"",u,'"_"")
u
first x = 'QUOTE => strconc('"'",sexpr2HtString second x)
first x = ":" => strconc(fn second x,'": ",fn third x)
first x = 'Mapping =>
strconc(fnTail(rest rest x,'"()"),'"->",fn second x)
first x = 'construct => fnTail(rest x,'"[]")
tail := fnTail(rest x,'"()")
head := fn first x
-- $brief and #head + #tail > 35 => strconc(head,'"(...)")
strconc(head,tail)
fnTail(x,str) ==
null x => '""
strconc(str . 0,fn first x,fnTailTail rest x,str . 1)
fnTailTail x ==
null x => '""
strconc('",",fn first x,fnTailTail rest x)
sexpr2HtString x ==
atom x => form2HtString x
strconc('"(",fn x,'")") where fn x ==
r := rest x
suffix :=
null r => '""
atom r => strconc('" . ",form2HtString rest x)
strconc('" ",fn r)
strconc(sexpr2HtString first x,suffix)
form2LispString(x) ==
atom x =>
x = '_$ => '"__$"
symbolMember?(x,$FormalMapVariableList) => strconc('"__", symbolName x)
string? x => strconc('"_"",x,'"_"")
STRINGIMAGE x
x is ['QUOTE,a] => strconc('"'",sexpr2LispString a)
x is [":",a,b] => strconc(form2LispString a,'":",form2LispString b)
first x = 'Mapping =>
null rest (r := rest x) => strconc('"()->",form2LispString first r)
strconc(args2LispString rest r,'"->",form2LispString first r)
strconc(form2LispString first x,args2LispString rest x)
sexpr2LispString x ==
atom x => form2LispString x
strconc('"(",fn x,'")") where fn x ==
r := rest x
suffix :=
null r => '""
atom r => strconc('" . ",form2LispString rest x)
strconc('" ",fn r)
strconc(sexpr2HtString first x,suffix)
args2LispString x ==
null x => '""
strconc('"(",form2LispString first x,fnTailTail rest x,'")") where
fnTailTail x ==
null x => '""
strconc('",",form2LispString first x,fnTailTail rest x)
dbConstructorKind x ==
target := getConstructorModemapFromDB(x).mmTarget
target = '(Category) => 'category
target is ['CATEGORY,'package,:.] => 'package
tableValue($defaultPackageNamesHT,x) => 'default_ package
'domain
getConstructorForm name ==
name = 'Union => '(Union (_: a A) (_: b B))
name = 'UntaggedUnion => '(Union A B)
name = 'Record => '(Record (_: a A) (_: b B))
name = 'Mapping => '(Mapping T S)
name = 'Enumeration => '(Enumeration a b)
getConstructorFormFromDB name
getConstructorArgs conname == rest getConstructorForm conname
bcComments(comments,:options) ==
italics? := not IFCAR options
string? comments =>
comments = '"" => nil
htSay('"\newline ")
if italics? then htSay '"{\em "
htSay comments
if italics? then htSay '"}"
null comments => nil
htSay('"\newline ")
if italics? then htSay "{\em "
htSay first comments
for x in rest comments repeat htSay('" ",x)
if italics? then htSay '"}"
bcConform(form,:options) ==
$italics? : local := IFCAR options
$italicHead? : local := IFCAR IFCDR options
bcConform1 form
bcConstructor(form is [op,:arglist],cname) == --called only when $conformsAreDomains
htSayList dbConformGen form
htSayList u ==
for x in u repeat htSay x
conform2HtString form ==
for u in form2String form repeat
htSay u
dbEvalableConstructor? form ==
--form is constructor form; either
--(a) all arguments are specified or (b) none are specified
form is [op,:argl] =>
null argl => true
op = 'QUOTE => 'T --is a domain valued object
and/[dbEvalableConstructor? x for x in argl]
integer? form => true
false
htSayItalics s == htSay('"{\em ",s,'"}")
bcCon(name,:options) ==
argString := IFCAR options or '""
s := STRINGIMAGE name
bcStar name
htSayConstructorName(s,s)
htSay argString
bcAbb(name,abb) ==
s := STRINGIMAGE name
a := STRINGIMAGE abb
bcStar name
htSayConstructorName(a,s)
bcStar name ==
if $includeUnexposed? and not isExposedConstructor name then htSayUnexposed()
bcStarSpace name ==
null $includeUnexposed? => nil
not isExposedConstructor name => htSayUnexposed()
htBlank()
bcStarSpaceOp(op,exposed?) ==
null $includeUnexposed? => nil
not exposed? =>
htSayUnexposed()
if stringChar(op,0) = char "*" then htSay '" "
htBlank()
bcStarConform form ==
bcStar opOf form
bcConform form
dbSourceFile name ==
u:= getConstructorSourceFileFromDB name
null u => '""
n := PATHNAME_-NAME u
t := PATHNAME_-TYPE u
strconc(n,'".",t)
extractFileNameFromPath s == fn(s,0,#s) where
fn(s,i,m) ==
k := charPosition(char "/",s,i)
k = m => subString(s,i)
fn(s,k + 1,m)
bcOpTable(u,fn) ==
htBeginTable()
firstTime := true
for op in u for i in 0.. repeat
if firstTime then firstTime := false
else htSaySaturn '"&"
htSay '"{"
htMakePage [['bcLinks,[escapeSpecialChars STRINGIMAGE opOf op,'"",fn,i]]]
htSay '"}"
htEndTable()
bcNameConTable u ==
$bcMultipleNames: local := (#u ~= 1)
bcConTable removeDuplicates u
-- bcConTable u
bcConTable u ==
htBeginTable()
firstTime := true
for con in u repeat
if firstTime then firstTime := false
else htSaySaturn '"&"
htSay '"{"
bcStarSpace opOf con
bcConform con
htSay '"}"
htEndTable()
bcAbbTable u ==
htBeginTable()
firstTime := true
for x in removeDuplicates u repeat --allow x to be nil meaning "no abbreviation"
-- for x in u repeat --allow x to be nil meaning "no abbreviation"
if firstTime then firstTime := false
else htSaySaturn '"&"
if x is [con,abb,:.] then
htSay '"{"
bcAbb(con,abb)
htSay '"}"
htEndTable()
bcConPredTable(u,conname,:options) ==
italicList := IFCAR options
htBeginTable()
firstTime := true
for [conform,:pred] in u repeat
if firstTime then firstTime := false
else htSaySaturn '"&"
htSay '"{"
bcStarSpace opOf conform
form :=
atom conform => getConstructorForm conform
conform
bcConform(form,italicList)
if extractHasArgs pred is [arglist,:pred] then
htSay('" {\em of} ")
bcConform([conname,:arglist],italicList,true)
if pred ~= 'etc then bcPred(pred,italicList)
htSay '"}"
htEndTable()
bcPred(pred,:options) ==
pred = '"" or pred = true or null pred => 'skip
italicList := IFCAR options
if not IFCAR IFCDR options then htSay '" {\em if} "
htPred2English(pred,italicList)
extractHasArgs pred ==
x := find pred or return nil where find x ==
x is [op,:argl] =>
op = 'hasArgs => x
op in '(AND OR NOT) => or/[find y for y in argl]
nil
nil
[rest x,:simpBool substitute('T,x,pred)]
splitConTable cons ==
uncond := cond := nil
for (pair := [con,:pred]) in cons repeat
null pred => 'skip
pred = 'T or pred is ['hasArgs,:.] => uncond := [pair,:uncond]
cond := [pair,:cond]
[reverse! uncond,:reverse! cond]
bcNameTable(u,fn,:option) == --option if * prefix
htSay '"\newline"
htBeginTable()
firstTime := true
for x in u repeat
if firstTime then firstTime := false
else htSaySaturn '"&"
htSay '"{"
if IFCAR option then bcStar x
htMakePage [['bcLinks,[s := escapeSpecialChars STRINGIMAGE x,'"",fn,s]]]
htSay '"}"
htEndTable()
bcNameCountTable(u,fn,gn,:options) ==
linkFunction :=
IFCAR options => 'bcLispLinks
'bcLinks
htSay '"\newline"
htBeginTable()
firstTime := true
for i in 0.. for x in u repeat
if firstTime then firstTime := false
else htSaySaturn '"&"
htSay '"{"
htMakePage [[linkFunction,[FUNCALL(fn,x),'"",gn,i]]]
htSay '"}"
htEndTable()
dbSayItemsItalics(:u) ==
htSay '"{\em "
apply(function dbSayItems,u)
htSay '"}"
dbSayItems(countOrPrefix,singular,plural,:options) ==
bcHt '"\newline "
count :=
countOrPrefix is [:prefix,c] =>
htSay prefix
c
countOrPrefix
if count = 0 then htSay('"No ",singular)
else if count = 1 then htSay('"1 ",singular)
else htSay(count,'" ",plural)
for x in options repeat bcHt x
if count ~= 0 then bcHt '":"
dbBasicConstructor? conname ==
dbSourceFile conname in '("catdef" "coerce")
nothingFoundPage(:options) ==
htInitPage('"Sorry, no match found",nil)
htShowPage()
htCopyProplist htPage == [[x,:y] for [x,:y] in htpPropertyList htPage]
emptySearchPage(kind,filter,:options) ==
skipNamePart := IFCAR options
heading := ['"No ",capitalize kind,'" Found"]
htInitPage(heading,nil)
exposePart :=
null $includeUnexposed? => '"{\em exposed} "
'""
htSay('"\vspace{1}\newline\centerline{There is no ",exposePart,kind,'" matching pattern}\newline\centerline{{\em ")
if filter then htPred2English filter
htSay '"}}"
htShowPage()
isLoaded? conform ==
property(getConstructorAbbreviationFromDB opOf conform,'LOADED)
string2Integer s ==
and/[digit? (s.i) for i in 0..maxIndex s] => readInteger s
nil
dbGetInputString htPage ==
s := htpLabelInputString(htPage,'filter)
null s or s = '"" => '"*"
s
--=======================================================================
-- Error Pages
--=======================================================================
bcErrorPage u ==
u is ['error,:r] =>
htInitPage(first r,nil)
bcBlankLine()
for x in rest r repeat htSay x
htShowPage()
systemError '"Unexpected error message"
errorPage(htPage,[heading,kind,:info]) ==
kind = 'invalidType => kInvalidTypePage first info
if heading = 'error then htInitPage('"Error",nil) else
htInitPage(heading,nil)
bcBlankLine()
for x in info repeat htSay x
htShowPage()
htErrorStar() ==
errorPage(nil,['"{\em *} not a valid search string",nil,'"\vspace{3}\centerline{{\em *} is not a valid search string for a general search}\centerline{\em {it would match everything!}}"])
htQueryPage(htPage,heading,message,query,fn) ==
htInitPage(heading,nil)
htSay message
htQuery(query,fn)
htShowPage()
htQuery(question,fn,:options) ==
upLink? := IFCAR options
if question then
htSay('"\vspace{1}\centerline{")
htSay question
htSay('"}")
htSay('"\centerline{")
htMakePage [['bcLispLinks,['"\fbox{Yes}",'"",fn,'yes]]]
htBlank 4
if upLink?
then htSay('"\downlink{\fbox{No}}{UpPage}")
else htMakePage [['bcLispLinks,['"\fbox{No}",'"",fn,'no]]]
htSay('"}")
kInvalidTypePage form ==
htInitPage('"Error",nil)
bcBlankLine()
htSay('"\centerline{You gave an invalid type:}\newline\centerline{{\sf ")
htSay(form2HtString form,'"}}")
htShowPage()
dbNotAvailablePage(:options) ==
htInitPage('"Missing Page",nil)
bcBlankLine()
htSay(IFCAR options or '"\centerline{This page is not available yet}")
htShowPage()
--=======================================================================
-- Utility Functions for Manipulating Browse Datalines
--=======================================================================
dbpHasDefaultCategory? s == #s > 1 and s.1 = char "x" --s is part 3 of line
dbKind line == line.0
dbKindString kind == LASSOC(kind,$dbKindAlist)
dbName line == escapeString subString(line,1,charPosition($tick,line,1) - 1)
dbAttr line == strconc(dbName line,escapeString dbPart(line,4,0))
dbPart(line,n,k) == --returns part n of line (n=1,..) beginning in column k
n = 1 => subString(line,k + 1,charPosition($tick,line,k + 1) - k - 1)
dbPart(line,n - 1,charPosition($tick,line,k + 1))
dbXParts(line,n,m) ==
[.,nargs,:r] := dbParts(line,n,m)
[dbKindString line.0,dbName line,readInteger nargs,:r]
dbParts(line,n,m) == --split line into n parts beginning in column m
n = 0 => nil
[subString(line,m,-m + (k := charPosition($tick,line,m))),
:dbParts(line,n - 1,k + 1)]
dbConname(line) == dbPart(line,5,1)
dbComments line == dbReadComments(string2Integer dbPart(line,7,1))
dbNewConname(line) == --dbName line unless kind is 'a or 'o => name in 5th pos.
(kind := line.0) = char "a" or kind = char "o" =>
conform := dbPart(line,5,1)
k := charPosition(char "(",conform,1)
subString(conform,1,k - 1)
dbName line
dbTickIndex(line,n,k) == --returns index of nth tick in line starting at k
n = 1 => charPosition($tick,line,k)
dbTickIndex(line,n - 1,1 + charPosition($tick,line,k))
mySort u == listSort(function GLESSEQP,u)
quickAnd(a,b) ==
a = true => b
b = true => a
a = false or b = false => false
simpBool ['AND,a,b]
quickOr(a,b) ==
a = true or b = true => true
b = false => a
a = false => b
simpCatPredicate simpBool ['OR,a,b]
|