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
|
--
-- Ada reference manual formatter (ARM_Form).
--
-- This subprogram is part of the command processor.
--
-- We use dispatching calls to call the formatter, so the details of
-- formatting are insulated from the code that reads the source and
-- determines the details of the text.
--
-- ---------------------------------------
-- Copyright 2000, 2002, 2004, 2005, 2006, 2007, 2009, 2011
-- AXE Consultants. All rights reserved.
-- P.O. Box 1512, Madison WI 53701
-- E-Mail: randy@rrsoftware.com
--
-- ARM_Form is free software: you can redistribute it and/or modify
-- it under the terms of the GNU General Public License version 3
-- as published by the Free Software Foundation.
--
-- AXE CONSULTANTS MAKES THIS TOOL AND SOURCE CODE AVAILABLE ON AN "AS IS"
-- BASIS AND MAKES NO WARRANTY, EXPRESS OR IMPLIED, AS TO THE ACCURACY,
-- CAPABILITY, EFFICIENCY, MERCHANTABILITY, OR FUNCTIONING OF THIS TOOL.
-- IN NO EVENT WILL AXE CONSULTANTS BE LIABLE FOR ANY GENERAL,
-- CONSEQUENTIAL, INDIRECT, INCIDENTAL, EXEMPLARY, OR SPECIAL DAMAGES,
-- EVEN IF AXE CONSULTANTS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
-- DAMAGES.
--
-- A copy of the GNU General Public License is available in the file
-- gpl-3-0.txt in the standard distribution of the ARM_Form tool.
-- Otherwise, see <http://www.gnu.org/licenses/>.
--
-- If the GPLv3 license is not satisfactory for your needs, a commercial
-- use license is available for this tool. Contact Randy at AXE Consultants
-- for more information.
--
-- ---------------------------------------
--
-- Edit History:
--
-- 2/10/06 - RLB - Split from base package.
-- 9/22/06 - RLB - Revised to use Clause_Number_Type, and to support
-- Subsubclauses.
-- 10/16/06 - RLB - Added definition of old non-terminals for NT linking.
-- 2/16/07 - RLB - Added missing code to handle comments here.
-- 7/31/07 - RLB - Added code to detect duplicated titles.
-- 12/18/07 - RLB - Added Plain_Annex and associated commands.
-- 5/06/09 - RLB - Added Labeled_Deleted_xxx.
-- 5/07/09 - RLB - Changed above to load dead clauses.
-- 10/18/11 - RLB - Changed to GPLv3 license.
separate(ARM_Format)
procedure Scan (Format_Object : in out Format_Type;
File_Name : in String;
Section_Number : in ARM_Contents.Section_Number_Type;
Starts_New_Section : in Boolean) is
-- Scans the contents for File_Name, determining the table of contents
-- for the section. The results are written to the contents package.
-- Starts_New_Section is True if the file starts a new section.
-- Section_Number is the number (or letter) of the section.
type Items is record
Command : Command_Type;
Close_Char : Character; -- Ought to be }, ], >, or ).
end record;
Nesting_Stack : array (1 .. 60) of Items;
Nesting_Stack_Ptr : Natural := 0;
Saw_a_Section_Header : Boolean := False;
Input_Object : ARM_File.File_Input_Type;
procedure Set_Nesting_for_Command (Command : in Command_Type;
Param_Ch : in Character) is
-- Push the command onto the nesting stack.
begin
if Nesting_Stack_Ptr < Nesting_Stack'Last then
Nesting_Stack_Ptr := Nesting_Stack_Ptr + 1;
Nesting_Stack (Nesting_Stack_Ptr) :=
(Command => Command,
Close_Char => ARM_Input.Get_Close_Char (Param_Ch));
--Ada.Text_IO.Put_Line (" &Stack (" & Command_Type'Image(Command) & "); Close-Char=" &
-- Nesting_Stack(Nesting_Stack_Ptr).Close_Char);
else
Ada.Text_IO.Put_Line ("** Nesting stack overflow on line" & ARM_File.Line_String (Input_Object));
for I in reverse Nesting_Stack'range loop
Ada.Text_IO.Put_Line ("-- Command at" & Natural'Image(I) & " has a close char of '" &
Nesting_Stack (Nesting_Stack_Ptr).Close_Char & "' for " & Command_Type'Image(Nesting_Stack (Nesting_Stack_Ptr).Command));
end loop;
raise Program_Error;
end if;
end Set_Nesting_for_Command;
procedure Scan_Command_with_Parameter is
-- Scan the start of a command with a parameter.
-- The parameter character has been scanned, and
-- a stack item pushed.
Title : ARM_Contents.Title_Type;
Title_Length : Natural;
procedure Get_Change_Version (Is_First : in Boolean;
Version : out ARM_Contents.Change_Version_Type) is
-- Get a parameter named "Version", containing a character
-- representing the version number.
Ch, Close_Ch : Character;
begin
ARM_Input.Check_Parameter_Name (Input_Object,
Param_Name => "Version" & (8..ARM_Input.Command_Name_Type'Last => ' '),
Is_First => Is_First,
Param_Close_Bracket => Close_Ch);
if Close_Ch /= ' ' then
-- Get the version character:
ARM_File.Get_Char (Input_Object, Ch);
Version := ARM_Contents.Change_Version_Type(Ch);
ARM_File.Get_Char (Input_Object, Ch);
if Ch /= Close_Ch then
Ada.Text_IO.Put_Line (" ** Bad close for change version on line " & ARM_File.Line_String (Input_Object));
ARM_File.Replace_Char (Input_Object);
end if;
-- else no parameter. Weird.
end if;
end Get_Change_Version;
begin
case Nesting_Stack(Nesting_Stack_Ptr).Command is
when Labeled_Section | Labeled_Section_No_Break |
Labeled_Annex | Labeled_Informative_Annex |
Labeled_Normative_Annex | Labeled_Clause |
Labeled_Subclause | Labeled_Subsubclause =>
-- Load the title into the Title string:
ARM_Input.Copy_to_String_until_Close_Char (
Input_Object,
Nesting_Stack(Nesting_Stack_Ptr).Close_Char,
Title, Title_Length);
Title(Title_Length+1 .. Title'Last) :=
(others => ' ');
if Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Subclause then
Format_Object.Clause_Number :=
(Section => Format_Object.Clause_Number.Section,
Clause => Format_Object.Clause_Number.Clause,
Subclause => Format_Object.Clause_Number.Subclause + 1,
Subsubclause => 0);
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Subsubclause then
Format_Object.Clause_Number.Subsubclause :=
Format_Object.Clause_Number.Subsubclause + 1;
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Clause then
Format_Object.Clause_Number :=
(Section => Format_Object.Clause_Number.Section,
Clause => Format_Object.Clause_Number.Clause + 1,
Subclause => 0, Subsubclause => 0);
elsif Saw_a_Section_Header then
Ada.Text_IO.Put_Line (" ** Multiple section headers in a file, line " &
ARM_File.Line_String (Input_Object));
else
Saw_a_Section_Header := True;
Format_Object.Clause_Number :=
(Section => Format_Object.Clause_Number.Section, -- Will be set elsewhere.
Clause => 0,
Subclause => 0, Subsubclause => 0);
end if;
begin
declare
Ref : constant String := ARM_Contents.Lookup_Clause_Number (Title);
begin
-- If we get here, this title is already defined. Oops.
Ada.Text_IO.Put_Line (" ** Title """ &
Title(1..Title_Length) & """ is multiply defined on line " &
ARM_File.Line_String (Input_Object));
Ada.Text_IO.Put_Line (" Initial use is for clause " & Ref);
end;
exception
when ARM_Contents.Not_Found_Error =>
-- OK, not previously defined.
-- Load the title into the contents package:
if Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Subclause then
ARM_Contents.Add (Title, ARM_Contents.Subclause,
Format_Object.Clause_Number);
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Subsubclause then
ARM_Contents.Add (Title, ARM_Contents.Subsubclause,
Format_Object.Clause_Number);
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Clause then
ARM_Contents.Add (Title, ARM_Contents.Clause,
Format_Object.Clause_Number);
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Section or else
Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Section_No_Break then
ARM_Contents.Add (Title, ARM_Contents.Section,
Format_Object.Clause_Number);
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Annex then
ARM_Contents.Add (Title, ARM_Contents.Plain_Annex,
Format_Object.Clause_Number);
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Normative_Annex then
ARM_Contents.Add (Title, ARM_Contents.Normative_Annex,
Format_Object.Clause_Number);
else
ARM_Contents.Add (Title, ARM_Contents.Informative_Annex,
Format_Object.Clause_Number);
end if;
end;
Nesting_Stack_Ptr := Nesting_Stack_Ptr - 1;
--Ada.Text_IO.Put_Line (" &Unstack (Header)");
when Unnumbered_Section =>
-- Load the title into the Title string:
ARM_Input.Copy_to_String_until_Close_Char (
Input_Object,
Nesting_Stack(Nesting_Stack_Ptr).Close_Char,
Title, Title_Length);
Title(Title_Length+1 .. Title'Last) :=
(others => ' ');
Format_Object.Unnumbered_Section :=
Format_Object.Unnumbered_Section + 1;
-- This section will be numbered 0.Unnumbered_Section:
Format_Object.Clause_Number :=
(Section => 0,
Clause => Format_Object.Unnumbered_Section,
Subclause => 0, Subsubclause => 0);
begin
declare
Ref : constant String := ARM_Contents.Lookup_Clause_Number (Title);
begin
-- If we get here, this title is already defined. Oops.
Ada.Text_IO.Put_Line (" ** Title """ &
Title(1..Title_Length) & """ is multiply defined on line " &
ARM_File.Line_String (Input_Object));
Ada.Text_IO.Put_Line (" Initial use is for clause " & Ref);
end;
exception
when ARM_Contents.Not_Found_Error =>
-- OK, not previously defined.
-- Load the title into the contents package:
ARM_Contents.Add (Title, ARM_Contents.Unnumbered_Section,
Format_Object.Clause_Number);
end;
Nesting_Stack_Ptr := Nesting_Stack_Ptr - 1;
--Ada.Text_IO.Put_Line (" &Unstack (Header)");
when Labeled_Revised_Annex |
Labeled_Revised_Informative_Annex |
Labeled_Revised_Normative_Annex |
Labeled_Revised_Section |
Labeled_Revised_Clause |
Labeled_Revised_Subclause |
Labeled_Revised_Subsubclause =>
declare
Old_Title : ARM_Contents.Title_Type;
Old_Title_Length : Natural;
Close_Ch : Character;
Version : ARM_Contents.Change_Version_Type := '0';
Initial_Version : ARM_Contents.Change_Version_Type := '0';
begin
Get_Change_Version (Is_First => True,
Version => Version);
-- Check for the optional "InitialVersion" parameter,
-- stopping when we reach "New":
declare
Which_Param : ARM_Input.Param_Num;
Ch : Character;
begin
-- If there is no InitialVersion command, use the same
-- version of the rest of the command.
loop
ARM_Input.Check_One_of_Parameter_Names (Input_Object,
Param_Name_1 => "InitialVersion" & (15..ARM_Input.Command_Name_Type'Last => ' '),
Param_Name_2 => "New" & (4..ARM_Input.Command_Name_Type'Last => ' '),
Is_First => False,
Param_Found => Which_Param,
Param_Close_Bracket => Close_Ch);
if Which_Param = 1 and then Close_Ch /= ' ' then
-- Found InitialVersion
ARM_File.Get_Char (Input_Object, Ch);
Initial_Version := Ch;
ARM_File.Get_Char (Input_Object, Ch);
if Ch /= Close_Ch then
Ada.Text_IO.Put_Line (" ** Bad close for InitialVersion parameter on line " &
ARM_File.Line_String (Input_Object));
ARM_File.Replace_Char (Input_Object);
end if;
else -- We found "New" (or an error)
exit; -- Handling of New is below.
end if;
end loop;
end;
if Close_Ch /= ' ' then
-- There is a parameter:
-- Load the new title into the Title string:
ARM_Input.Copy_to_String_until_Close_Char (
Input_Object,
Close_Ch,
Title, Title_Length);
Title(Title_Length+1 .. Title'Last) :=
(others => ' ');
ARM_Input.Check_Parameter_Name (Input_Object,
Param_Name => "Old" & (4..ARM_Input.Command_Name_Type'Last => ' '),
Is_First => False,
Param_Close_Bracket => Close_Ch);
if Close_Ch /= ' ' then
-- There is a parameter:
-- Load the new title into the Title string:
ARM_Input.Copy_to_String_until_Close_Char (
Input_Object,
Close_Ch,
Old_Title, Old_Title_Length);
Old_Title(Old_Title_Length+1 .. Old_Title'Last) :=
(others => ' ');
end if;
end if;
ARM_File.Get_Char (Input_Object, Close_Ch);
if Close_Ch /= Nesting_Stack(Nesting_Stack_Ptr).Close_Char then
Ada.Text_IO.Put_Line (" ** Bad close for Labeled_Revised_(SubClause|Annex) on line " & ARM_File.Line_String (Input_Object));
ARM_File.Replace_Char (Input_Object);
end if;
if Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Revised_Subclause then
Format_Object.Clause_Number :=
(Section => Format_Object.Clause_Number.Section,
Clause => Format_Object.Clause_Number.Clause,
Subclause => Format_Object.Clause_Number.Subclause + 1,
Subsubclause => 0);
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Revised_Subsubclause then
Format_Object.Clause_Number.Subsubclause :=
Format_Object.Clause_Number.Subsubclause + 1;
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Revised_Clause then
Format_Object.Clause_Number :=
(Section => Format_Object.Clause_Number.Section,
Clause => Format_Object.Clause_Number.Clause + 1,
Subclause => 0, Subsubclause => 0);
elsif Saw_a_Section_Header then
Ada.Text_IO.Put_Line (" ** Multiple section headers in a file, line " &
ARM_File.Line_String (Input_Object));
else
Saw_a_Section_Header := True;
Format_Object.Clause_Number :=
(Section => Format_Object.Clause_Number.Section, -- Will be set elsewhere.
Clause => 0,
Subclause => 0, Subsubclause => 0);
end if;
begin
declare
Ref : constant String := ARM_Contents.Lookup_Clause_Number (Title);
begin
-- If we get here, this title is already defined. Oops.
Ada.Text_IO.Put_Line (" ** Title """ &
Title(1..Title_Length) & """ is multiply defined on line " &
ARM_File.Line_String (Input_Object));
Ada.Text_IO.Put_Line (" Initial use is for clause " & Ref);
end;
exception
when ARM_Contents.Not_Found_Error =>
-- OK, not previously defined.
-- Load the title into the contents package:
if Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Revised_Subclause then
ARM_Contents.Add (Title, ARM_Contents.Subclause,
Format_Object.Clause_Number,
Version => Version);
ARM_Contents.Add_Old (Old_Title,
ARM_Contents.Subclause,
Format_Object.Clause_Number,
Version => Initial_Version);
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Revised_Subsubclause then
ARM_Contents.Add (Title, ARM_Contents.Subsubclause,
Format_Object.Clause_Number,
Version => Version);
ARM_Contents.Add_Old (Old_Title,
ARM_Contents.Subsubclause,
Format_Object.Clause_Number,
Version => Initial_Version);
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Revised_Clause then
ARM_Contents.Add (Title, ARM_Contents.Clause,
Format_Object.Clause_Number,
Version => Version);
ARM_Contents.Add_Old (Old_Title,
ARM_Contents.Clause,
Format_Object.Clause_Number,
Version => Initial_Version);
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Revised_Section then
ARM_Contents.Add (Title, ARM_Contents.Section,
Format_Object.Clause_Number,
Version => Version);
ARM_Contents.Add_Old (Old_Title,
ARM_Contents.Section,
Format_Object.Clause_Number,
Version => Initial_Version);
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Revised_Annex then
ARM_Contents.Add (Title,
ARM_Contents.Plain_Annex,
Format_Object.Clause_Number,
Version => Version);
ARM_Contents.Add_Old (Old_Title,
ARM_Contents.Plain_Annex,
Format_Object.Clause_Number,
Version => Initial_Version);
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Revised_Normative_Annex then
ARM_Contents.Add (Title,
ARM_Contents.Normative_Annex,
Format_Object.Clause_Number,
Version => Version);
ARM_Contents.Add_Old (Old_Title,
ARM_Contents.Normative_Annex,
Format_Object.Clause_Number,
Version => Initial_Version);
else -- Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Revised_Informative_Annex then
ARM_Contents.Add (Title,
ARM_Contents.Informative_Annex,
Format_Object.Clause_Number,
Version => Version);
ARM_Contents.Add_Old (Old_Title,
ARM_Contents.Informative_Annex,
Format_Object.Clause_Number,
Version => Initial_Version);
end if;
end;
Nesting_Stack_Ptr := Nesting_Stack_Ptr - 1;
--Ada.Text_IO.Put_Line (" &Unstack (Header)");
end;
when Labeled_Added_Annex |
Labeled_Added_Informative_Annex |
Labeled_Added_Normative_Annex |
Labeled_Added_Section |
Labeled_Added_Clause |
Labeled_Added_Subclause |
Labeled_Added_Subsubclause =>
declare
Ch : Character;
Version : ARM_Contents.Change_Version_Type := '0';
How : ARM_Output.Change_Type;
use type ARM_Output.Change_Type;
begin
Get_Change_Version (Is_First => True,
Version => Version);
ARM_Input.Check_Parameter_Name (Input_Object,
Param_Name => "Name" & (5..ARM_Input.Command_Name_Type'Last => ' '),
Is_First => False,
Param_Close_Bracket => Ch);
if Ch /= ' ' then
-- There is a parameter:
-- Load the new title into the Title string:
ARM_Input.Copy_to_String_until_Close_Char (
Input_Object,
Ch,
Title, Title_Length);
Title(Title_Length+1 .. Title'Last) :=
(others => ' ');
end if;
ARM_File.Get_Char (Input_Object, Ch);
if Ch /= Nesting_Stack(Nesting_Stack_Ptr).Close_Char then
Ada.Text_IO.Put_Line (" ** Bad close for Labeled_Added_(Sub)Clause on line " & ARM_File.Line_String (Input_Object));
ARM_File.Replace_Char (Input_Object);
end if;
-- Determine the insertion state for this label:
Calc_Change_Disposition (Format_Object,
Version => Version,
Operation => ARM_Output.Insertion,
Text_Kind => How);
if How = Do_Not_Display_Text then
null; -- Nothing to display, so we do *not* number it
-- or insert it into the contents database.
else
begin
declare
Ref : constant String := ARM_Contents.Lookup_Clause_Number (Title);
begin
-- If we get here, this title is already defined. Oops.
Ada.Text_IO.Put_Line (" ** Title """ &
Title(1..Title_Length) & """ is multiply defined on line " &
ARM_File.Line_String (Input_Object));
Ada.Text_IO.Put_Line (" Initial use is for clause " & Ref);
end;
exception
when ARM_Contents.Not_Found_Error =>
-- OK, not previously defined.
-- Load the title into the contents package:
if Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Added_Subclause then
Format_Object.Clause_Number :=
(Section => Format_Object.Clause_Number.Section,
Clause => Format_Object.Clause_Number.Clause,
Subclause => Format_Object.Clause_Number.Subclause + 1,
Subsubclause => 0);
ARM_Contents.Add (Title, ARM_Contents.Subclause,
Format_Object.Clause_Number,
Version => Version);
ARM_Contents.Add_Old ((others => ' '),
ARM_Contents.Subclause,
Format_Object.Clause_Number);
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Added_Subsubclause then
Format_Object.Clause_Number.Subsubclause :=
Format_Object.Clause_Number.Subsubclause + 1;
ARM_Contents.Add (Title, ARM_Contents.Subsubclause,
Format_Object.Clause_Number,
Version => Version);
ARM_Contents.Add_Old ((others => ' '),
ARM_Contents.Subsubclause,
Format_Object.Clause_Number);
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Added_Clause then
Format_Object.Clause_Number :=
(Section => Format_Object.Clause_Number.Section,
Clause => Format_Object.Clause_Number.Clause + 1,
Subclause => 0, Subsubclause => 0);
ARM_Contents.Add (Title, ARM_Contents.Clause,
Format_Object.Clause_Number,
Version => Version);
ARM_Contents.Add_Old ((others => ' '),
ARM_Contents.Clause,
Format_Object.Clause_Number);
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Added_Section then
if Saw_a_Section_Header then
Ada.Text_IO.Put_Line (" ** Multiple section headers in a file, line " &
ARM_File.Line_String (Input_Object));
end if;
Saw_a_Section_Header := True;
Format_Object.Clause_Number :=
(Section => Format_Object.Clause_Number.Section, -- Will be set elsewhere.
Clause => 0,
Subclause => 0, Subsubclause => 0);
ARM_Contents.Add (Title,
ARM_Contents.Section,
Format_Object.Clause_Number,
Version => Version);
ARM_Contents.Add_Old ((others => ' '),
ARM_Contents.Section,
Format_Object.Clause_Number);
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Added_Annex then
if Saw_a_Section_Header then
Ada.Text_IO.Put_Line (" ** Multiple section headers in a file, line " &
ARM_File.Line_String (Input_Object));
end if;
Saw_a_Section_Header := True;
Format_Object.Clause_Number :=
(Section => Format_Object.Clause_Number.Section, -- Will be set elsewhere.
Clause => 0,
Subclause => 0, Subsubclause => 0);
ARM_Contents.Add (Title,
ARM_Contents.Plain_Annex,
Format_Object.Clause_Number,
Version => Version);
ARM_Contents.Add_Old ((others => ' '),
ARM_Contents.Plain_Annex,
Format_Object.Clause_Number);
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Added_Normative_Annex then
if Saw_a_Section_Header then
Ada.Text_IO.Put_Line (" ** Multiple section headers in a file, line " &
ARM_File.Line_String (Input_Object));
end if;
Saw_a_Section_Header := True;
Format_Object.Clause_Number :=
(Section => Format_Object.Clause_Number.Section, -- Will be set elsewhere.
Clause => 0,
Subclause => 0, Subsubclause => 0);
ARM_Contents.Add (Title,
ARM_Contents.Normative_Annex,
Format_Object.Clause_Number,
Version => Version);
ARM_Contents.Add_Old ((others => ' '),
ARM_Contents.Normative_Annex,
Format_Object.Clause_Number);
else -- Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Added_Informative_Annex then
if Saw_a_Section_Header then
Ada.Text_IO.Put_Line (" ** Multiple section headers in a file, line " &
ARM_File.Line_String (Input_Object));
end if;
Saw_a_Section_Header := True;
Format_Object.Clause_Number :=
(Section => Format_Object.Clause_Number.Section, -- Will be set elsewhere.
Clause => 0,
Subclause => 0, Subsubclause => 0);
ARM_Contents.Add (Title,
ARM_Contents.Informative_Annex,
Format_Object.Clause_Number,
Version => Version);
ARM_Contents.Add_Old ((others => ' '),
ARM_Contents.Informative_Annex,
Format_Object.Clause_Number);
end if;
end;
end if;
Nesting_Stack_Ptr := Nesting_Stack_Ptr - 1;
--Ada.Text_IO.Put_Line (" &Unstack (Header)");
end;
when Labeled_Deleted_Clause |
Labeled_Deleted_Subclause |
Labeled_Deleted_Subsubclause =>
declare
Ch : Character;
Version : ARM_Contents.Change_Version_Type := '0';
How : ARM_Output.Change_Type;
use type ARM_Output.Change_Type;
begin
Get_Change_Version (Is_First => True,
Version => Version);
ARM_Input.Check_Parameter_Name (Input_Object,
Param_Name => "Name" & (5..ARM_Input.Command_Name_Type'Last => ' '),
Is_First => False,
Param_Close_Bracket => Ch);
if Ch /= ' ' then
-- There is a parameter:
-- Load the new title into the Title string:
ARM_Input.Copy_to_String_until_Close_Char (
Input_Object,
Ch,
Title, Title_Length);
Title(Title_Length+1 .. Title'Last) :=
(others => ' ');
end if;
ARM_File.Get_Char (Input_Object, Ch);
if Ch /= Nesting_Stack(Nesting_Stack_Ptr).Close_Char then
Ada.Text_IO.Put_Line (" ** Bad close for Labeled_Deleted_(Sub)Clause on line " & ARM_File.Line_String (Input_Object));
ARM_File.Replace_Char (Input_Object);
end if;
-- Determine the insertion state for this label:
Calc_Change_Disposition (Format_Object,
Version => Version,
Operation => ARM_Output.Deletion,
Text_Kind => How);
--Ada.Text_IO.Put_Line ("Labeled_Deleted disp: " & ARM_Output.Change_Type'Image(How));
if How = ARM_Output.None then
-- Normal text, number normally.
begin
declare
Ref : constant String := ARM_Contents.Lookup_Clause_Number (Title);
begin
-- If we get here, this title is already defined. Oops.
Ada.Text_IO.Put_Line (" ** Title """ &
Title(1..Title_Length) & """ is multiply defined on line " &
ARM_File.Line_String (Input_Object));
Ada.Text_IO.Put_Line (" Initial use is for clause " & Ref);
end;
exception
when ARM_Contents.Not_Found_Error =>
-- OK, not previously defined.
-- Load the title into the contents package:
if Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Deleted_Subclause then
Format_Object.Clause_Number :=
(Section => Format_Object.Clause_Number.Section,
Clause => Format_Object.Clause_Number.Clause,
Subclause => Format_Object.Clause_Number.Subclause + 1,
Subsubclause => 0);
ARM_Contents.Add (Title, ARM_Contents.Subclause,
Format_Object.Clause_Number,
Version => '0'); -- Version here is an insertion version, and this was available from the beginning.
ARM_Contents.Add_Old ((others => ' '),
ARM_Contents.Subclause,
Format_Object.Clause_Number);
elsif Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Deleted_Subsubclause then
Format_Object.Clause_Number.Subsubclause :=
Format_Object.Clause_Number.Subsubclause + 1;
ARM_Contents.Add (Title, ARM_Contents.Subsubclause,
Format_Object.Clause_Number,
Version => '0');
ARM_Contents.Add_Old ((others => ' '),
ARM_Contents.Subsubclause,
Format_Object.Clause_Number);
else -- Nesting_Stack(Nesting_Stack_Ptr).Command = Labeled_Deleted_Clause then
Format_Object.Clause_Number :=
(Section => Format_Object.Clause_Number.Section,
Clause => Format_Object.Clause_Number.Clause + 1,
Subclause => 0, Subsubclause => 0);
ARM_Contents.Add (Title, ARM_Contents.Clause,
Format_Object.Clause_Number,
Version => '0');
ARM_Contents.Add_Old ((others => ' '),
ARM_Contents.Clause,
Format_Object.Clause_Number);
end if;
end;
elsif How = ARM_Output.Insertion then
-- Huh? We're deleting here.
raise Program_Error;
elsif How = ARM_Output.Deletion then
-- We'll just display the header without a number.
-- But we need to insert it so that x-refs don't
-- fail.
begin
declare
Ref : constant String := ARM_Contents.Lookup_Clause_Number (Title);
begin
-- If we get here, this title is already defined. Oops.
Ada.Text_IO.Put_Line (" ** Title """ &
Title(1..Title_Length) & """ is multiply defined on line " &
ARM_File.Line_String (Input_Object));
Ada.Text_IO.Put_Line (" Initial use is for clause " & Ref);
end;
exception
when ARM_Contents.Not_Found_Error =>
-- OK, not previously defined.
-- Load the title into the contents package as a dead clause:
ARM_Contents.Add (Title, ARM_Contents.Dead_Clause,
(Section => 0,
Clause => 1,
Subclause => 0,
Subsubclause => 0),
Version => '0');
ARM_Contents.Add_Old ((others => ' '),
ARM_Contents.Dead_Clause,
(Section => 0,
Clause => 1,
Subclause => 0,
Subsubclause => 0));
end;
elsif How = Do_Not_Display_Text then
null; -- Nothing to display/number.
end if;
Nesting_Stack_Ptr := Nesting_Stack_Ptr - 1;
--Ada.Text_IO.Put_Line (" &Unstack (Header)");
end;
when Syntax_Rule | Added_Syntax_Rule | Deleted_Syntax_Rule =>
-- @Syn{[Tabs=<Tabset>, ]LHS=<Non-terminal>, RHS=<Production>}
-- @AddedSyn{Version=[<Version>],[Tabs=<Tabset>, ]LHS=<Non-terminal>, RHS=<Production>}
-- @DeletedSyn{Version=[<Version>],[Tabs=<Tabset>, ]LHS=<Non-terminal>, RHS=<Production>}
-- We need to index the non-terminal, so we can link to it
-- later. (If we didn't do this here, we wouldn't be able
-- to handle forward references.)
-- We only care about the non-terminal, so we skip the other
-- parts.
declare
Close_Ch, Ch : Character;
Seen_First_Param : Boolean := False;
Non_Terminal : String (1..120);
NT_Len : Natural := 0;
begin
if Nesting_Stack(Nesting_Stack_Ptr).Command /= Syntax_Rule then
-- Get and skip the Version parameter.
Seen_First_Param := True;
Get_Change_Version (Is_First => True,
Version => Ch);
end if;
-- Peek to see if Tabs parmeter is present, and skip it if
-- it is:
ARM_File.Get_Char (Input_Object, Ch);
ARM_File.Replace_Char (Input_Object);
if Ch = 'T' or else Ch = 't' then
ARM_Input.Check_Parameter_Name (Input_Object,
Param_Name => "Tabs" & (5..ARM_Input.Command_Name_Type'Last => ' '),
Is_First => (not Seen_First_Param),
Param_Close_Bracket => Close_Ch);
Seen_First_Param := True;
if Close_Ch /= ' ' then
-- Grab the tab string:
ARM_Input.Skip_until_Close_Char (
Input_Object,
Close_Ch);
-- else no parameter. Weird.
end if;
end if;
-- Get the LHS parameter and save it:
ARM_Input.Check_Parameter_Name (Input_Object,
Param_Name => "LHS" & (4..ARM_Input.Command_Name_Type'Last => ' '),
Is_First => (not Seen_First_Param),
Param_Close_Bracket => Close_Ch);
if Close_Ch /= ' ' then
-- Copy over the non-terminal:
ARM_Input.Copy_to_String_until_Close_Char (
Input_Object,
Close_Ch,
Non_Terminal,
NT_Len);
-- else no parameter. Weird.
end if;
-- Skip the RHS parameter:
ARM_Input.Check_Parameter_Name (Input_Object,
Param_Name => "RHS" & (4..ARM_Input.Command_Name_Type'Last => ' '),
Is_First => False,
Param_Close_Bracket => Close_Ch);
Seen_First_Param := True;
if Close_Ch /= ' ' then
-- Grab the tab string:
ARM_Input.Skip_until_Close_Char (
Input_Object,
Close_Ch);
-- else no parameter. Weird.
end if;
declare
The_Non_Terminal : constant String :=
Ada.Characters.Handling.To_Lower (
Get_Current_Item (Format_Object, Input_Object,
Non_Terminal(1..NT_Len))); -- Handle embedded @Chg.
The_Old_Non_Terminal : constant String :=
Ada.Characters.Handling.To_Lower (
Get_Old_Item (Format_Object, Input_Object,
Non_Terminal(1..NT_Len))); -- Handle embedded @Chg.
begin
if Ada.Strings.Fixed.Index (The_Non_Terminal, "@") /= 0 then
-- Still embedded commands, do not register.
Ada.Text_IO.Put_Line ("** Saw Non-Terminal with embedded commands: " &
Non_Terminal(1..NT_Len) & " in " & Clause_String (Format_Object));
elsif The_Non_Terminal = "" then
null; -- Deleted Non-Terminal, nothing to do.
else
-- Save the non-terminal:
declare
Link_Target : ARM_Syntax.Target_Type;
begin
ARM_Syntax.Add_Non_Terminal
(NT_Name => The_Non_Terminal,
For_Clause => Clause_String (Format_Object),
Link_Target => Link_Target);
end;
--Ada.Text_IO.Put_Line ("%% Saw simple Non-Terminal: " & The_Non_Terminal & " in "
-- & Clause_String (Format_Object));
end if;
if The_Old_Non_Terminal = "" then
null; -- No old Non-Terminal, nothing to do.
elsif ARM_Syntax.Non_Terminal_Clause (The_Old_Non_Terminal) /= "" then
null; -- This non-terminal is already defined;
-- that presumably is a *new* definition,
-- we'll use that instead of this one.
else
-- Save the non-terminal:
declare
Link_Target : ARM_Syntax.Target_Type;
begin
ARM_Syntax.Add_Non_Terminal
(NT_Name => The_Old_Non_Terminal,
For_Clause => Clause_String (Format_Object),
Link_Target => Link_Target);
end;
--Ada.Text_IO.Put_Line ("%% Saw simple old Non-Terminal: " & The_Old_Non_Terminal & " in "
-- & Clause_String (Format_Object));
end if;
end;
end;
when Comment =>
--Ada.Text_IO.Put_Line("Comment with Close=" & Nesting_Stack(Nesting_Stack_Ptr).Close_Char &
-- " on line " & ARM_File.Line_String (Input_Object));
-- Skip the contents of this command.
ARM_Input.Skip_until_Close_Char (Input_Object,
Nesting_Stack(Nesting_Stack_Ptr).Close_Char);
ARM_File.Replace_Char (Input_Object); -- Put the close character back.
--Ada.Text_IO.Put_Line("Comment done");
when others =>
null; -- Not in scanner.
end case;
end Scan_Command_with_Parameter;
procedure Handle_End_of_Command is
-- Unstack and handle the end of Commands.
begin
case Nesting_Stack(Nesting_Stack_Ptr).Command is
when others =>
-- No special handling needed.
null;
end case;
--Ada.Text_IO.Put_Line (" &Unstack (Normal-"& Command_Type'Image(Nesting_Stack(Nesting_Stack_Ptr).Command) & ")");
Nesting_Stack_Ptr := Nesting_Stack_Ptr - 1;
end Handle_End_of_Command;
procedure Scan_Special is
-- Scan a special command/macro/tab.
-- These all start with '@'.
-- @xxxx is a command. It may have parameters delimited by
-- (), {}, [], or <>. There does not appear to be an escape, so
-- we don't have to worry about '}' being used in {} brackets,
-- for example. (Must be a pain to write, though.)
Command_Name : ARM_Input.Command_Name_Type;
Ch : Character;
begin
ARM_File.Get_Char (Input_Object, Ch);
if Ch = '\' then
-- This represents a tab (or the end of centered text). We're
-- done here.
return;
elsif Ch = '=' then
-- This marks the beginning of centered text.
-- We're done here.
return;
elsif Ch = '^' then
-- This represented a tab stop (these should have been
-- deleted from the input). We're done here.
return;
elsif Ch = '@' then
-- This represents @ in the text. We're done here.
return;
elsif Ch = ' ' then
-- This represents a hard space in the text. We're done here.
return;
elsif Ch = ';' then
-- This seems to be an end of command (or substitution) marker.
-- For instance, it is used in Section 1:
-- .. the distinction between @ResolutionName@;s and ...
-- This converts to:
-- .. the distinction between Name Resolution Rules and ...
-- Without it, the 's' would append to the command name, and
-- we would get the wrong command. Thus, it itself does nothing
-- at all, so we're done here.
return;
elsif Ch = '-' then
-- This represents a subscript. It has an argument.
ARM_File.Get_Char (Input_Object, Ch);
if ARM_Input.Is_Open_Char (Ch) then -- Start parameter:
Set_Nesting_for_Command
(Command => Unknown,
Param_Ch => Ch);
else -- No parameter. Weird.
ARM_File.Replace_Char (Input_Object);
end if;
return;
elsif Ch = '+' then
-- This represents a superscript. It has an argument.
ARM_File.Get_Char (Input_Object, Ch);
if ARM_Input.Is_Open_Char (Ch) then -- Start parameter:
Set_Nesting_for_Command
(Command => Unknown,
Param_Ch => Ch);
else -- No parameter. Weird.
ARM_File.Replace_Char (Input_Object);
end if;
return;
elsif Ch = ':' then
-- This is a period type marker. We're done here.
return;
elsif Ch = '*' then
-- This is a line break. We're done here.
return;
elsif Ch = '|' then
-- This is a soft line break. We're done here.
return;
elsif Ch = '!' then
-- This is a soft hyphen break. We're done here.
return;
elsif Ch = Ascii.LF then
-- Stand alone '@'.
-- I now believe this is an error. It appears in
-- Infosys.MSS, and seems to have something to do with formatting.
return;
end if;
ARM_File.Replace_Char (Input_Object);
Arm_Input.Get_Name (Input_Object, Command_Name);
--Ada.Text_IO.Put_Line("Command=" & Command_Name & " Nesting=" & Natural'Image(Nesting_Stack_Ptr));
ARM_File.Get_Char (Input_Object, Ch);
if ARM_Input.Is_Open_Char (Ch) then -- Start parameter:
Set_Nesting_for_Command
(Command => Command (Ada.Characters.Handling.To_Lower (Command_Name)),
Param_Ch => Ch);
Scan_Command_with_Parameter;
else
ARM_File.Replace_Char (Input_Object);
-- We're not interested in commands with no parameters.
end if;
end Scan_Special;
begin
Ada.Text_IO.Put_Line ("-- Scanning " & File_Name);
begin
Arm_File.Open (Input_Object, File_Name);
exception
when others =>
Ada.Text_IO.Put_Line ("** Unable to open file " & File_Name);
raise;
end;
if Starts_New_Section then
Format_Object.Clause_Number := (Section => Section_Number, others => 0);
end if;
loop
declare
Char : Character;
begin
ARM_File.Get_Char (Input_Object, Char);
--Ada.Text_IO.Put_Line("Char=" & Char & " Nesting=" & Natural'Image(Nesting_Stack_Ptr));
case Char is
when '@' =>
Scan_Special;
when Ascii.SUB =>
exit; -- End of file.
when others =>
if Nesting_Stack_Ptr /= 0 and then
Nesting_Stack (Nesting_Stack_Ptr).Close_Char /= ' ' and then
Nesting_Stack (Nesting_Stack_Ptr).Close_Char = Char then
-- Closing a command, remove it from the stack.
Handle_End_of_Command;
else
null; -- Ordinary characters, nothing to do.
end if;
end case;
end;
end loop;
-- Reached end of the file.
Ada.Text_IO.Put_Line (" Lines scanned: " &
ARM_File.Line_String (Input_Object));
ARM_File.Close (Input_Object);
if Nesting_Stack_Ptr /= 0 then
Ada.Text_IO.Put_Line (" ** Unfinished commands detected.");
end if;
end Scan;
|
