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
|
#! /usr/bin/perl -w
# $Cambridge: exim/doc/doc-scripts/g2h,v 1.3 2005/02/17 12:17:09 ph10 Exp $
# This is a script that turns the SGCAL source of Exim's documentation into
# HTML. It can be used for both the filter document and the main Exim
# specification. The syntax is
#
# g2h [-split no|section|chapter] <source file> <title>
#
# Previously, -split section was used for the filter document, and -split
# chapter for the main specification. However, the filter document has gained
# some chapters, so they are both split by chapter now. Only one -split can be
# specified.
#
# A number of assumptions about the style of the input markup are made.
#
# The HTML is written into the directory html/ using the source file base
# name as its base.
# Written by Philip Hazel
# Starting 21-Dec-2001
# Last modified 26-Nov-2003
#############################################################################
##################################################
# Open an output file #
##################################################
sub openout {
open (OUT, ">$_[0]") || die "Can't open $_[0]\n";
# Boilerplate
print OUT "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML//EN\">\n";
print OUT "<html>\n<head>\n<title>$doctitle" .
(($thischapter > 0)? " chapter $thischapter" : "") .
(($thissection > 0)? " section $thissection" : "") .
"</title>\n</head>\n" .
"<body bgcolor=\"#F8F8F8\" text=\"#00005A\" " .
"link=\"#FF6600\" alink=\"#FF9933\" vlink=\"#990000\">\n";
# Forward/backward links when chapter splitting
if ($chapsplit)
{
print OUT "<font size=2>\n";
printf OUT ("<a href=\"${file_base}_%s.html\">Previous</a> \n",
$thischapter - 1) if $thischapter > 1;
printf OUT ("<a href=\"${file_base}_%s.html\">Next</a> \n",
$thischapter + 1) if $thischapter < $maxchapter;
print OUT "<a href=\"${file_base}_toc.html\">Contents</a>\n";
print OUT " " x 6, "($doctitle)\n</font><hr>\n";
}
# Forward/backward links when section splitting
elsif ($sectsplit)
{
print OUT "<font size=2>\n";
printf OUT ("<a href=\"${file_base}_%s.html\">Previous</a> \n",
$thissection - 1) if $thissection > 1;
printf OUT ("<a href=\"${file_base}_%s.html\">Next</a> \n",
$thissection + 1) if $thissection < $maxsection;
print OUT "<a href=\"${file_base}_toc.html\">Contents</a>\n";
print OUT " " x 6, "($doctitle)\n</font><hr>\n";
}
# Save the final component of the current file name (for TOC creation)
$_[0] =~ /^(?:.*)\/([^\/]+)$/;
$current_file = $1;
}
##################################################
# Close an output file #
##################################################
# The first argument is one of:
#
# "CHAP" a chapter is ending
# "SECT" a section is ending
# "" the whole thing is ending
#
# In the first two cases $thischapter and $thissection contain the new chapter
# and section numbers, respectively. In the third case, we can deduce what is
# ending from the flags. The variables contain the current values.
sub closeout {
my($s) = $_[0];
print OUT "<hr>\n" if !$lastwasrule;
&setpar(0);
if ($s eq "CHAP")
{
print OUT "<font size=2>\n";
printf OUT ("<a href=\"${file_base}_%s.html\">Previous</a> ",
$thischapter - 2) if ($thischapter > 2);
print OUT "<a href=\"${file_base}_$thischapter.html\">Next</a> ";
print OUT "<a href=\"${file_base}_toc.html\">Contents</a>\n";
print OUT " " x 6, "($doctitle)\n</font>\n";
}
elsif ($s eq "SECT")
{
print OUT "<font size=2>\n";
printf OUT ("<a href=\"${file_base}_%s.html\">Previous</a> ",
$thissection - 2) if ($thissection > 2);
print OUT "<a href=\"${file_base}_$thissection.html\">Next</a> ";
print OUT "<a href=\"${file_base}_toc.html\">Contents</a>\n";
print OUT " " x 6, "($doctitle)\n</font>\n";
}
else
{
if ($chapsplit)
{
print OUT "<font size=2>\n";
printf OUT ("<a href=\"${file_base}_%s.html\">Previous</a> ",
$thischapter - 1) if ($thischapter > 1);
print OUT "<a href=\"${file_base}_toc.html\">Contents</a>\n";
print OUT " " x 6, "($doctitle)\n</font>\n";
}
elsif ($sectsplit)
{
print OUT "<font size=2>\n";
printf OUT ("<a href=\"${file_base}_%s.html\">Previous</a> ",
$thissection - 1) if ($thissection > 1);
print OUT "<a href=\"${file_base}_toc.html\">Contents</a>\n";
print OUT " " x 6, "($doctitle)\n</font>\n";
}
}
print OUT "</body>\n</html>\n";
close(OUT);
}
##################################################
# Handle an index line #
##################################################
# This function returns an empty string so that it can be called as part
# of an s operator when handling index items within paragraphs. The two
# arguments are:
#
# the text to index, already converted to HTML
# 1 for the concept index, 0 for the options index
sub handle_index {
my($text) = $_[0];
my($hash) = $_[1]? \%cindex : \%oindex;
my ($key,$ref);
# Up the index count, and compute the reference to the file and the
# label within it.
$index_count++;
$ref = $chapsplit?
"${file_base}_$thischapter.html#IX$index_count"
: $sectsplit?
"${file_base}_$thissection.html#IX$index_count"
:
"#IX$index_count";
# Create the index key, which consists of the text with all the HTML
# coding and any leading quotation marks removed. Turn the primary/secondary
# splitting string "||" into ":".
$text =~ s/\|\|/:/g;
$key = "$text";
$key =~ s/<[^>]+>//g;
$key =~ s/&#(\d+);/chr($1)/eg;
$key =~ s/^`+//;
$key =~ s/^"//;
# Turn all spaces in the text into so that they don't ever split.
# However, there may be spaces in the HTML that already exists in the
# text, so we have to avoid changing spaces inside <>.
$text =~ s/ (?=[^<>]*(?:<|$))/ /g;
# If this is the first encounter with this index key, we create a
# straightforward reference.
if (!defined $$hash{$key})
{
$$hash{$key} = "<a href=\"$ref\">$text</a>";
}
# For the second and subsequent encounters, add "[2]" etc. to the
# index text. We find out the number by counting occurrences of "<a"
# in the existing string.
else
{
my($number) = 1;
$number++ while $$hash{$key} =~ /<a/g;
$$hash{$key} .= " <a href=\"$ref\">[$number]</a>";
}
# Place the name in the current output
print OUT "<a name=\"IX$index_count\"></a>\n";
return "";
}
##################################################
# Handle emphasis bars #
##################################################
# Set colour green for text marked with "emphasis bars", keeping
# track in case the matching isn't perfect.
sub setinem {
if ($_[0])
{
return "" if $inem;
$inem = 1;
return "<font color=green>\n";
}
else
{
return "" if !$inem;
$inem = 0;
return "</font>\n";
}
}
##################################################
# Convert marked-up text #
##################################################
# This function converts text from SGCAL markup to HTML markup, with a couple
# of exceptions:
#
# 1. We don't touch $t because that is handled by the .display code.
#
# 2. The text may contain embedded .index, .em, and .nem directives. We
# handle .em and .nem, but leave .index because it must be done during
# paragraph outputting.
#
# In a non-"rm" display, we turn $rm{ into cancelling of <tt>. Otherwise
# it is ignored - in practice it is only used in that special case.
#
# The order in which things are done in this function is highly sensitive!
sub handle_text {
my($s) = $_[0];
my($rmspecial) = $_[1];
# Escape all & characters (they aren't involved in markup) but for the moment
# use &+ instead of &# so that we can handle # characters in the text.
$s =~ s/&/&+038;/g;
# Turn SGCAL literals into HTML literals that don't look like SGCAL
# markup, so won't be touched by what follows. Again, use + instead of #.
$s =~ s/@@/&+064;/g;
$s =~ s/@([^@])/"&+".sprintf("%0.3d",ord($1)).";"/eg;
# Now turn any #s that are markup into spaces, and convert the previously
# created literals to the correct form.
$s =~ s/#/ /g;
$s =~ s/&\+(\d+);/&#$1;/g;
# Some simple markup that doesn't involve argument text.
$s =~ s/\$~//g; # turn $~ into nothing
$s =~ s/__/_/g; # turn __ into _
$s =~ s/--(?=$|\s|\d)/–/mg; # turn -- into endash in text or number range
$s =~ s/\(c\)/©/g; # turn (c) into copyright symbol
# Use double quotes
# $s =~ s/`([^']+)'/``$1''/g;
$s =~ s/`([^']+)'/“$1”/g;
# This is a fudge for some specific usages of $<; can't just do a global
# is it occurs in things like "$<variable name>" as well.
$s =~ s/(\d)\$<-/$1-/g; # turn 0$<- into 0-
$s =~ s/\$<//g; # other $< is ignored
# Turn <<...>> into equivalent SGCAL markup that doesn't involve the use of
# < and >, and then escape the remaining < and > characters in the text.
$s =~ s/<<([^>]*?)>>/<\$it{$1}>/g; # turn <<xxx>> into <$it{xxx}>
$s =~ s/</</g;
$s =~ s/>/>/g;
# Other markup...
$s =~ s/\$sm\{//g; # turn $sm{ into nothing
$s =~ s/\$smc\{//g; # turn $smc{ into nothing
$s =~ s/\$smi\{//g; # turn $smi{ into nothing
$s =~ s/\$tt\{([^\}]*?)\}/<tt>$1<\/tt>/g; # turn $tt{xxx} into <tt>xxx</tt>
$s =~ s/\$it\{([^\}]*?)\}/<em>$1<\/em>/g; # turn $it{xxx} into <em>xxx</em>
$s =~ s/\$bf\{([^\}]*?)\}/<b>$1<\/b>/g; # turn $bf{xxx} into <b>xxx</b>
$s =~ s/\$cb\{([^\}]*?)\}/<tt><b>$1<\/b><\/tt>/g; # turn $cb{xxx} into
# <tt><b>xxx</b></tt>
$s =~ s/\\\\([^\\]*?)\\\\/<font size=-1>$1<\/font>/g; # turn \\xxx\\ into
# small font
$s =~ s/\\\?([^?]*?)\?\\/<a href="$1">$1<\/a>/g; # turn \?URL?\ into URL
$s =~ s/\\\(([^)]*?)\)\\/<i>$1<\/i>/g; # turn \(xxx)\ into <i>xxx</i>
$s =~ s/\\\"([^\"]*?)\"\\/<tt>$1<\/tt>/g; # turn \"xxx"\ into <tt>xxx</tt>
$s =~ s/\\\$([^\$]*?)\$\\/<tt>\$$1<\/tt>/g; # turn \$xxx$\ into <tt>$xxx</tt>
$s =~ s/\\\-([^\\]*?)\-\\/<i>-$1<\/i>/g; # turn \-xxx-\ into -italic
$s =~ s/\\\*\*([^*]*?)\*\*\\/<b>$1<\/b>/g; # turn \**xxx**\ into <b>xxx</b>
$s =~ s/\\\*([^*]*?)\*\\/<i>$1<\/i>/g; # turn \*xxx*\ into italic
$s =~ s/\\%([^*]*?)%\\/<b>$1<\/b>/g; # turn \%xxx%\ into bold
$s =~ s/\\([^\\]*?)\\/<tt>$1<\/tt>/g; # turn \xxx\ into <tt>xxx</tt>
$s =~ s/::([^\$]*?)::/<i>$1:<\/i>/g; # turn ::xxx:: into italic:
$s =~ s/\$\*\$/\*/g; # turn $*$ into *
# Handle $rm{...}
if ($rmspecial)
{
$s =~ s/\$rm\{([^\}]*?)\}/<\/tt>$1<tt>/g; # turn $rm{xxx} into </tt>xxx<tt>
}
else
{
$s =~ s/\$rm\{([^\}]*?)\}/$1/g; # turn $rm{xxx} into xxx
}
# There is one case where the terminating } of an escape sequence is
# in another paragraph - this follows $sm{ - it can be fixed by
# removing any stray } in a paragraph that contains no { chars.
$s =~ s/\}//g if !/\{/;
# Remove any null flags ($$)
$s =~ s/\$\$//g;
# If the paragraph starts with $c\b, remove it.
$s =~ s/^\$c\b//;
# If the paragraph starts with $e\b, indent it slightly.
$s =~ s/^\$e\b/ /;
# Handle .em, and .nem directives that occur within the paragraph
$s =~ s/\.em\s*\n/&setinem(1)/eg;
$s =~ s/\.nem\s*\n/&setinem(0)/eg;
# Explicitly included HTML
$s =~ s/\[\(([^)]+)\)\]/<$1>/g; # turn [(...)] into <...>
# Finally, do the substitutions and return the modified text.
$s =~ s/~~(\w+)/$var_value{$1}/eg;
return $s;
}
##################################################
# Start/end a paragraph #
##################################################
# We want to leave paragraphs unterminated until we know that a horizontal
# rule does not follow, to avoid getting space inserted before the rule,
# which doesn't look good. So we have this function to help control things.
# If the argument is 1 we are starting a new paragraph; if it is 0 we want
# to force the ending of any incomplete paragraph.
sub setpar {
if ($inpar)
{
print OUT "</p>\n";
$inpar = 0;
}
if ($_[0])
{
print OUT "<p>\n";
$inpar = 1;
}
}
##################################################
# Handle a "paragraph" #
##################################################
# Read a paragraph of text, which may contain many lines and may contain
# .index, .em, and .nem directives within it. We may also encounter
# ".if ~~html" within paragraphs. Process those directives,
# convert the markup, and output the rest as an HTML paragraph.
sub handle_paragraph{
my($par) = $_;
my($htmlcond) = 0;
while(<IN>)
{
if (/^\.if\s+~~html\b/)
{
$htmlcond = 1;
$par =~ s/\s+$//; # lose unwanted whitespace and newlines
next;
}
elsif ($htmlcond && /^\.else\b/)
{
while (<IN>) { last if /^\.fi\b/; }
$htmlcond = 0;
next;
}
elsif ($htmlcond && /^\.fi\b/)
{
$htmlcond = 0;
next;
}
last if /^\s*$/ || (/^\./ && !/^\.index\b/ && !/^\.em\b/ && !/^\.nem\b/);
$par .= $_;
}
$par = &handle_text($par, 0);
# We can't handle .index until this point, when we do it just before
# outputting the paragraph.
if ($par !~ /^\s*$/)
{
&setpar(1);
$par =~ s/\.index\s+([^\n]+)\n/&handle_index($1, 1)/eg;
print OUT "$par";
}
}
##################################################
# Handle a non-paragraph directive #
##################################################
# The directives .index, .em, and .nem can also appear within paragraphs,
# and are then handled within the handle_paragraph() code.
sub handle_directive{
my($new_lastwasitem) = 0;
$lastwasrule = 0;
if (/^\.r?set\b/ || /^\.(?:\s|$)/) {} # ignore .(r)set and comments
elsif (/^\.justify\b/) {} # and .justify
elsif (/^\.newline\b/) { print OUT "<br>\n"; }
elsif (/^\.blank\b/ || /^\.space\b/) { print OUT "<br>\n"; }
elsif (/^\.rule\b/) { &setpar(0); print OUT "<hr>\n"; $lastwasrule = 1; }
elsif (/^\.index\s+(.*)/) { &handle_index(&handle_text($1), 1); }
# Emphasis is handled by colour
elsif (/^\.em\b/)
{
&setpar(0);
print OUT "<font color=green>" if ! $inem;
$inem = 1;
}
elsif (/^\.nem\b/)
{
&setpar(0);
print OUT "</font>" if $inem;
$inem = 0;
}
# Ignore tab setting stuff - we use tables instead.
elsif (/^\.tabs(?:et)?\b/) {}
# .tempindent is used only to align some of the expansion stuff nicely;
# just ignore it. It is used in conjunction with .push/.pop.
elsif (/^\.(tempindent|push|pop)\b/) {}
# There are some instances of .if ~~sys.fancy in the source. Some of those
# that are not inside displays are two-part things, in which case we just keep
# the non-fancy part. For diagrams, however, they are in three parts:
#
# .if ~~sys.fancy
# <aspic drawing stuff for PostScript and PDF>
# .elif !~~html
# <ascii art for txt and Texinfo>
# .else
# <HTML instructions for including a gif>
# .fi
#
# In this case, we skip to the third part.
elsif (/^\.if\s+~~sys\.fancy/ || /^\.else\b/)
{
while (<IN>)
{ last if /^\.else\b/ || /^\.elif\s+!\s*~~html/ || /^\.fi\b/; }
if (/^\.elif\b/)
{
while (<IN>) { last if /^\.else\b/ || /^\.fi\b/; }
}
}
# Similarly, for .if !~~sys.fancy, take the non-fancy part.
elsif (/^\.if\s+!\s*~~sys.fancy/) {}
# There are some explicit tests for ~~html for direct HTML inclusions
elsif (/^\.if\s+~~html\b/) {}
# There are occasional requirements to do things differently for Texinfo/HTML
# and PS/txt versions. The latter are produced by SGCAL, so that's what the
# flag is called.
elsif (/\.if\s+~~sgcal/)
{
while (<IN>) { last if /\.else\b/ || /\.fi\b/; }
}
# Also there is a texinfo flag
elsif (/^\.if\s+~~texinfo\b/)
{
while (<IN>)
{ last if /^\.else\b/ || /^\.elif\s+!\s*~~html/ || /^\.fi\b/; }
}
# Ignore any other .if, .else, or .fi directives
elsif (/^\.if\b/ || /^\.fi\b/ || /^\.else\b/) {}
# Ignore .indent
elsif (/^\.indent\b/) {}
# Various flavours of numberpars map to corresponding list types.
elsif (/^\.numberpars\b/)
{
$rest = $';
&setpar(0);
if ($rest =~ /(?:\$\.|\" \")/)
{
unshift @endlist, "ul";
unshift @listtype, "";
print OUT "<ul>\n<li>";
}
else
{
$nptype = ($rest =~ /roman/)? "a" : "1";
unshift @endlist, "ol";
unshift @listtype, " TYPE=\"$nptype\"";
print OUT "<ol>\n<li$listtype[0]>";
}
}
elsif (/^\.nextp\b/)
{
&setpar(0);
print OUT "</li>\n<li$listtype[0]>";
}
elsif (/^\.endp\b/)
{
&setpar(0);
print OUT "</li>\n</$endlist[0]>\n";
shift @listtype;
shift @endlist;
}
# .display asis can use <pre> which uses a typewriter font.
# Otherwise, we have to do our own line breaking. Turn tabbed lines
# into an HTML table. There will always be a .tabs line first.
elsif (/^\.display\b/)
{
my($intable) = 0;
my($asis) = /asis/;
my($rm) = /rm/;
my($eol,$indent);
# For non asis displays, start a paragraph, and set up to put an
# explicit break after every line.
if (!$asis)
{
&setpar(1);
$eol = "<br>";
$indent = "<tt> </tt>";
}
# For asis displays, use <pre> and no explicit breaks
else
{
print OUT "<pre>\n";
$eol = "";
$indent = " ";
}
# Now read through until we hit .endd (or EOF, but that shouldn't happen)
# and process the lines in the display.
while (<IN>)
{
last if /^\.endd\b/;
# The presence of .tabs[et] starts a table
if (/^\.tabs/)
{
$intable = 1;
print OUT "<table cellspacing=0 cellpadding=0>\n";
}
# Some displays have an indent setting - ignore
elsif (/^\.indent\b/) {}
# Some displays have .blank inside them
elsif (/^\.blank\b/)
{
print OUT "<br>\n";
}
# Some displays have emphasis inside them
elsif (/^\.em\b/)
{
print OUT "<font color=green>" if ! $inem;
$inem = 1;
}
elsif (/^\.nem\b/)
{
print OUT "</font>" if $inem;
$inem = 0;
}
# There are occasional instances of .if [!]~~sys.fancy inside displays.
# In both cases we want the non-fancy alternative. (The only thing that
# matters in practice is noticing .tabs[et] actually.) Assume the syntax
# is valid.
elsif (/^\.if\s+~~sys.fancy/ || /^\.else\b/)
{
while (<IN>)
{
last if /^\.fi\b/ || /^\.else/;
}
}
elsif (/^\.if\s+!\s*~~sys.fancy/) {}
elsif (/^\.fi\b/) {}
# Ignore .newline and .linelength
elsif (/^\.newline\b/ || /^\.linelength\b/) {}
# Ignore comments
elsif (/^\.(\s|$)/) {}
# There shouldn't be any other directives inside displays
elsif (/^\./)
{
print "*** Ignored directive inside .display: $_";
}
# Handle a data line within a display. If it's an asis display, the only
# conversion is to escape the HTML characters. Otherwise, process the
# SGCAL markup.
else
{
chomp;
if ($asis)
{
s/&/&/g;
s/</</g;
s/>/>/g;
}
else
{
$_ = &handle_text($_, !$rm);
$_ = "<tt>$_</tt>" if !$rm && $_ ne "";
}
# In a table, break fields at $t. For non-rm we must break the
# <tt> group as well.
if ($intable)
{
if ($rm)
{
s/\s*\$t\s*/ <\/td><td>/g;
}
else
{
s/\s*\$t\s*/ <\/tt><\/td><td><tt>/g;
}
s/<tt><\/tt>//g;
print OUT "<tr><td> $_</td></tr>\n";
}
# Otherwise, output straight, with <br> for non asis displays
else
{
s/<tt><\/tt>//g;
print OUT "$indent$_$eol\n";
}
}
} # Loop for display contents
# Finish off the table and the <pre> - leave a paragraph open
print OUT "</table>\n" if $intable;
print OUT "</pre>\n" if $asis;
}
# Handle configuration option definitions
elsif (/^\.startconf\s+(.*)/)
{
$confuse = &handle_text($1);
}
elsif (/^\.conf\b/)
{
my($option, $type, $default) =
/^\.conf\s+(\S+)\s+("(?:[^"]|"")+"|\S+)\s+("(?:[^"]|"")+"|.*)/;
$option =~ s/\@_/_/g; # Underscore will be quoted in option name
# If $type ends with $**$, add ",expanded" as there doesn't seem to be
# a dagger character generally available.
$type =~ s/^"([^"]+)"/$1/;
$type =~ s/\$\*\*\$/, expanded/;
# Default may be quoted, and it may also have quotes that are required,
# if it is a string.
$default =~ s/^"(.*)"$/$1/;
$default =~ s/""/"/g;
$default = &handle_text($default, 0);
print OUT "<hr>";
&setpar(0);
&handle_index($option, 0);
print OUT "<h3>$option</h3>\n" .
"<i>Use:</i> $confuse<br>" .
"<i>Type:</i> $type<br><i>Default:</i> $default<br>\n";
}
elsif (/^\.endconf\b/)
{
print OUT "<hr><br>\n";
}
# Handle "items" - used for expansion items and the like. We force the
# item text into bold, and put a rule between items.
elsif (/^\.startitems\b/) {}
elsif (/^\.item\s+(.*)/)
{
my($arg) = $1;
chomp($arg);
$arg =~ s/^"(.*)"$/$1/;
$arg = &handle_text($arg, 0);
# If there are two .items in a row, we don't want to put in the
# separator line or start a new paragraph.
if ($lastwasitem)
{
print OUT "<br>";
}
else
{
print OUT "<hr>";
&setpar(1);
}
print OUT "<b>$arg</b>\n";
$new_lastwasitem = 1;
}
elsif (/^\.enditems\b/)
{
print OUT "<hr><br>\n";
}
# Handle command line option items
elsif (/^\.startoptions\b/) {}
elsif (/^\.option\s+(.*)/)
{
my($arg) = $1;
$arg =~ s/"([^"]*)"/$1/g;
print OUT "<hr>";
&setpar(0);
# For indexing, we want to take up to the first # or < in the line,
# before processing.
my($name) = $arg =~ /^([^#<]+)/;
$name = &handle_text($name, 0);
&handle_index("-$name", 0);
# Output as heading, after the index
$arg = &handle_text($arg, 0);
print OUT "<h3>-$arg</h3>\n";
}
elsif (/^\.endoptions\b/)
{
print OUT "<hr><br>\n";
}
# Found an SGCAL directive that isn't dealt with. Oh dear.
else
{
print "*** Unexpected SGCAL directive: line $. ignored:\n";
print "$_\n";
}
# Remember if last was a .item, and read the next line
$lastwasitem = $new_lastwasitem;
$_ = <IN>;
}
##################################################
# First Pass - collect references #
##################################################
sub pass_one{
$thischapter = 0;
open (IN, $source_file) || die "Can't open $source_file (first pass)\n";
$_ = <IN>;
# At the start of the specification text, there are some textual replacement
# definitions. They set values, but not cross-references. They may be preceded
# by comments.
$_ = <IN> while (/^\.(\s|$)/);
while (/^\.r?set\s+(\S+)\s+"?([^"]+)\"?\s*$/)
{
$var_value{$1} = $2;
$_ = <IN>;
}
# Now skip on till we hit the start of the first chapter. It will be numbered
# 0 if we hit ".set chapter -1". There is only ever one unnumbered chapter.
while (!/^\.chapter/)
{
$thischapter = -1 if /^\.set\s+chapter\s+-1/;
$_ = <IN>;
}
# Loop for handling chapters
while ($_)
{
$thischapter++;
$thissection = 0;
# Scan through chapter, setting up cross-references to the chapter
# and to the sections within it.
while (<IN>)
{
last if /^\.chapter/;
chomp;
if (/^\.section/)
{
$thissection++;
next;
}
# Handle .(r)set directives.
if (/^\.r?set\s+(\S+)\s+"?([^"]+)\"?\s*$/ && $1 ne "runningfoot")
{
my($key,$value) = ($1,$2);
$value =~ s/~~chapter/$thischapter/e;
$value =~ s/~~section/$thissection/e;
# Only one of $chapsplit or $sectsplit can be set.
if ($key =~ /^CHAP/)
{
$value = $chapsplit?
"<a href=\"${file_base}_$thischapter.html\">$value</a>"
:
"<a href=\"#CHAP$thischapter\">$value</a>";
}
elsif ($key =~ /^SECT/)
{
$value = $chapsplit?
"<a href=\"${file_base}_$thischapter.html" .
"#SECT$thischapter.$thissection\">$value</a>"
:
$sectsplit? "<a href=\"${file_base}_$thissection.html\">$value</a>"
:
"<a href=\"#SECT$thischapter.$thissection\">$value</a>";
}
$var_value{$key} = $value;
}
}
}
close(IN);
}
##################################################
# Second Pass - generate HTML #
##################################################
sub pass_two{
my($tocn) = 0;
my($inmacro) = 0;
my($insection) = 0;
$inem = 0;
$thischapter = 0;
$thissection = 0;
# Open the source file and get the first line
open (IN, $source_file) || die "Can't open $source_file (2nd pass)\n";
$_ = <IN>;
# Skip on till we hit the start of the first chapter, but note if we
# pass ".set chapter -1", which is used to indicate no chapter numbering for
# the first chapter (we number is 0). Keep track of whether we are in macro
# definitions or not, and when not, notice occurrences of .index, because this
# are the "x see y" type entries.
while (!/^\.chapter/)
{
$thischapter = -1 if /^\.set\s+chapter\s+-1/;
$inmacro = 1 if /^\.macro/;
$inmacro = 0 if /^\.endm/;
if (!$inmacro && /^\.index\s+(.*)/)
{
my($key);
my($s) = $1;
$s = &handle_text($s, 0);
$s =~ s/ / /g; # All spaces unsplittable
$key = "\L$s";
$key =~ s/<[^>]+>//g;
$key =~ s/&#(\d+);/chr($1)/eg;
$cindex{$key} = $s;
}
$_ = <IN>;
}
# Open the TOC file
open (TOC, ">$html/${file_base}_toc.html") ||
die "Can't open $html/${file_base}_toc.html\n";
print TOC "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML//EN\">\n";
print TOC "<html>\n<head>\n<title>$doctitle Contents</title>\n</head>\n" .
"<body bgcolor=\"#F8F8F8\" text=\"#00005A\" " .
"link=\"#FF6600\" alink=\"#FF9933\" vlink=\"#990000\">\n";
print TOC "<h1>$doctitle</h1><hr>\n<ul>\n";
# Open the data file if we are not splitting at chapters
&openout("$html/${file_base}.html") if !$chapsplit;
# Loop for handling chapters. At the start of this loop, $_ is either EOF,
# or contains a .chapter line.
$firstchapter = $thischapter + 1;
while ($_)
{
print TOC "</ul>\n" if $insection;
$insection = 0;
$thischapter++;
$thissection = 0;
$lastwasrule = 0;
# Start a new file if required
if ($chapsplit)
{
&closeout("CHAP") if $thischapter != $firstchapter;
&openout("$html/${file_base}_$thischapter.html");
}
# Set up the chapter title. Save it for the TOC. Set up the anchor and
# link back to the TOC and show the title.
$_ =~ /^\.chapter\s+(.*)/;
my($title) = (($thischapter > 0)? "$thischapter. " : "") . &handle_text($1, 0);
$tocn++;
print TOC "<li><a " .
"name=\"TOC$tocn\" " .
"href=\"$current_file#CHAP$thischapter\">$title</a></li>\n";
print OUT "<h1>\n";
print OUT "<a name=\"CHAP$thischapter\" href=\"${file_base}_toc.html#TOC$tocn\">\n";
print OUT "$title\n</a></h1>\n";
# Scan the contents of the chapter
$_ = <IN>;
while ($_)
{
last if /^\.chapter/;
# Handle the start of a new section, starting a new file if required
if (/^\.section\s+(.*)/)
{
$thissection++;
print TOC "<ul>\n" if !$insection;
$insection = 1;
my($title) = (($thischapter > 0)? "$thischapter.$thissection " :
"$thissection. ") . &handle_text($1, 0);
if ($sectsplit)
{
&closeout("SECT");
&openout("$html/${file_base}_$thissection.html");
}
$tocn++;
printf TOC ("<li><a " .
"name=\"TOC$tocn\" " .
"href=\"$current_file#SECT%s$thissection\">%s</a></li>\n",
($thischapter > 0)? "$thischapter." : "", $title);
&setpar(0);
print OUT "<h2>\n";
printf OUT ("<a name=\"SECT%s$thissection\" ",
($thischapter > 0)? "$thischapter." : "");
print OUT "href=\"${file_base}_toc.html#TOC$tocn\">\n";
print OUT "$title\n</a></h2>\n";
$_ = <IN>;
$lastwasrule = 0;
}
# Blank lines at this level are ignored
elsif (/^\s*$/)
{
$_ = <IN>;
}
# Directive and non-directive lines are handled independently, though
# in each case further lines may be read. Afterwards, the next line is
# in $_. If .em is at the start of a paragraph, treat it with the
# paragraph, because the matching .nem will be too. Messy!
elsif (/^\./)
{
if (/^\.em\b/)
{
$_=<IN>;
if (/^\./)
{
print OUT "<font color=green>" if ! $inem;
$inem = 1;
# Used to handle it here - but that fails if it is .section.
# Just let the next iteration of the loop handle it.
# &handle_directive();
}
else
{
$_ = ".em\n" . $_;
&handle_paragraph();
$lastwasrule = 0;
$lastwasitem = 0;
}
}
# Not .em
else
{
&handle_directive();
}
}
# Not a directive
else
{
&handle_paragraph();
$lastwasrule = 0;
$lastwasitem = 0;
}
} # Loop for each line in a chapter
} # Loop for each chapter
# Close the last file, end off the TOC, and we are done.
&closeout("");
print TOC "</ul>\n" if $insection;
if (defined %cindex)
{
$cindex_tocn = ++$tocn;
print TOC "<li><a name=\"TOC$tocn\" ".
"href=\"${file_base}_cindex.html\">Concept Index</a></li>\n";
}
if (defined %oindex)
{
$oindex_tocn = ++$tocn;
print TOC "<li><a name=\"TOC$tocn\" ".
"href=\"${file_base}_oindex.html\">Option Index</a></li>\n";
}
print TOC "</ul>\n</body>\n</html>\n";
close(TOC);
close(IN);
}
##################################################
# Adjust index points #
##################################################
# Because of the way the source is written, there are often index entries
# that immediately follow the start of chapters and sections and the definition
# of "items" like "helo = verify". This gets the correct page numbers for the
# PostScript and PDF formats. However, for HTML we want the index anchor to be
# before the section heading, because browsers tend to put the index point at
# the top of the screen. So we re-read all the files we've just created, and
# move some of the index points about. This is necessary only if indexes exist.
# The files are small enough to be handled entirely in memory.
sub adjust_index_points {
print "Adjusting index points to precede headings\n";
$" = "";
opendir(DIR, "$html") || die "Failed to opendir $html\n";
while ($file = readdir(DIR))
{
my($i);
next unless $file =~ /^${file_base}_\d+\.html$/;
open(IN, "<$html/$file") ||
die "Failed to open $html/$file (read)\n";
my(@lines) = <IN>;
close(IN);
for ($i = 0; $i < @lines; $i++)
{
if ($lines[$i] =~ /^<a name="IX\d+"><\/a>$/)
{
# Handle an index line that follows a heading definition. Move it back
# to just before the <h1> or whatever. This preserves the order of
# multiple index lines, not that that matters.
if ($lines[$i-1] =~ /^<\/a><\/h(\d)>/)
{
my($j);
my($found) = 0;
for ($j = $i-2; $j > 0 && $j > $i - 10; $j--)
{
if ($lines[$j] =~ /<h$1>/)
{
$found = 1;
last;
}
}
if ($found)
{
splice(@lines, $j, 0, splice(@lines, $i, 1));
}
}
# Handle an index line that follows an "item". Move it back one line.
elsif ($lines[$i-1] =~ /^<b>.*<\/b>\s*$/)
{
splice(@lines, $i-1, 0, splice(@lines, $i, 1));
}
# Handle an index line that follows a "conf" definition
elsif ($lines[$i-1] =~ /^<i>Type:<\/i>/ && $lines[$i-2] =~ /^<h3>/)
{
splice(@lines, $i-2, 0, splice(@lines, $i, 1));
}
# Handle an index line that follows an "option" definition
elsif ($lines[$i-1] =~ /^<h3>/)
{
splice(@lines, $i-1, 0, splice(@lines, $i, 1));
}
}
}
open(OUT, ">$html/$file") ||
die "Failed to open $html/$file (write)\n";
print OUT "@lines";
close OUT;
undef @lines;
}
}
##################################################
# Create Index #
##################################################
sub create_index{
my($hash) = $_[0];
my($ifname) = $_[1];
my($ititle) = $_[2];
my(%indexindex);
open(INDEX, ">$html/${file_base}_$_[1].html") ||
die "Failed to open $html/${file_base}_$ifname\n";
print INDEX "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML//EN\">\n";
print INDEX "<html>\n<head>\n<title>$doctitle $ititle</title>\n";
print INDEX "<base target=\"body\">\n</head>\n";
print INDEX "<body bgcolor=\"#FFFFDF\" text=\"#00005A\" " .
"link=\"#FF6600\" alink=\"#FF9933\" vlink=\"#990000\">\n";
print INDEX "<h3>$ititle</h3>\n";
# We have to scan the keys in the hash twice; first to build the list
# of initial letters, and then to do the business. The first time we
# do not need to sort them.
foreach $key (keys %$hash)
{
my($initial) = substr($key,0,1);
$initial = "\U$initial";
$indexindex{$initial} = 1 if $initial ge "A" && $initial le "Z";
}
print INDEX "<p>\n";
foreach $key (sort keys %indexindex)
{
print INDEX " <a href=\"#$key\" target=\"index\">$key</a>\n";
}
print INDEX "<hr></p>\n";
my($letter) = "";
print INDEX "<p>\n";
foreach $key (sort
{
my($aa) = $a;
my($bb) = $b;
$aa =~ s/^\x93//; # Seems like the actual char values are
$bb =~ s/^\x93//; # set by this time, not "“"
return ("\L$aa" eq "\L$bb")? ("$aa" cmp "$bb") : ("\L$aa" cmp "\L$bb");
}
keys %$hash)
{
my($initial) = substr($key,0,1);
$initial = "\U$initial";
if ($initial ne $letter && $initial ge "A" && $initial le "Z")
{
print INDEX "<br>\n";
print INDEX "<a name=\"$initial\"></a>\n";
print INDEX "<font size=\"+1\">\U$initial\E</font><br>\n";
$letter = $initial;
}
print INDEX "$$hash{$key}<br>\n";
}
print INDEX "</p>\n";
print INDEX "</body>\n</html>\n";
close(INDEX);
}
##################################################
# Show usage and die #
##################################################
sub usage {
die "Usage: g2h [-split no|section|chapter] <source> <title>\n";
}
##################################################
# Entry point and main program #
##################################################
# Directory in which to put the new HTML files
$html = "html";
# Global variables.
%cindex = ();
%oindex = ();
$chapsplit = 0;
$cindex_tocn = 0;
$confuse = "";
$file_base = "";
$index_count = 0;
$inem = 0;
$inpar = 0;
$lastwasitem = 0;
$lastwasrule = 0;
$oindex_tocn = 0;
$sectsplit = 0;
$source_file = "";
$thischapter = 0;
$thissection = 0;
# Handle options
my($splitset) = 0;
while (scalar @ARGV > 0 && $ARGV[0] =~ /^-/)
{
if ($ARGV[0] eq "-split" && !$splitset)
{
$splitset = 1;
shift @ARGV;
my($type) = shift @ARGV;
if ($type eq "section") { $sectsplit = 1; }
elsif ($type eq "chapter") { $chapsplit = 1; }
elsif ($type eq "no" ) { $sectsplit = $chapsplit = 0; }
else { &usage(); }
}
else { &usage(); }
}
# Get the source file and its base
&usage() if scalar @ARGV <= 0;
$source_file = shift @ARGV;
($file_base) = $source_file =~ /^(.*)\.src$/;
&usage() if scalar @ARGV <= 0;
$doctitle = shift @ARGV;
print "\nCreate HTML for $doctitle from $source_file\n";
# Remove the old HTML files
print "Removing old HTML files\n";
system("/bin/rm -rf $html/${file_base}_*.html");
# First pass identifies all the chapters and sections, and collects the
# values of the cross-referencing variables.
print "Scanning for cross-references\n";
&pass_one();
$maxchapter = $thischapter; # Used if chapter splitting
$maxsection = $thissection; # Used if section splitting
# Second pass actually creates the HTML files.
print "Creating the HTML files\n";
&pass_two();
# Reprocess for moving some of the index points, if indexes were created
&adjust_index_points() if scalar(keys %cindex) > 0 || scalar(keys %oindex) > 0;
# Finally, we must create the option and concept indexes if any data
# has been collected for them.
if (scalar(keys %cindex) > 0)
{
print "Creating concept index\n";
&create_index(\%cindex, "cindex", "Concepts");
}
if (scalar(keys %oindex) > 0)
{
print "Creating option index\n";
&create_index(\%oindex, "oindex", "Options");
}
# End of g2h
|
