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
|
with -- ARM_Output, redundant with spec
ARM_Contents,
Ada.Exceptions,
Ada.Characters.Handling,
Ada.Strings.Fixed,
Ada.Text_IO,
Ada.Calendar,
Ada.Unchecked_Deallocation;
package body ARM_Index is
--
-- Ada reference manual formatter (ARM_Form).
--
-- This package contains the routines to manage and generate the index.
--
-- ---------------------------------------
-- Copyright 2000, 2002, 2003, 2004, 2005, 2006, 2007, 2010, 2011, 2012
-- 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:
--
-- 5/28/00 - RLB - Created package.
-- 8/ 7/00 - RLB - Improved sorting of entries.
-- 1/31/02 - RLB - Added missing with of Unchecked_Deallocation.
-- 4/11/03 - RLB - Added a hard space in the indexing routine, in order
-- that the empty paragraph isn't ignored.
-- 9/09/04 - RLB - Removed unused junk noted by Stephen Leake.
-- 10/28/05 - RLB - Added key reuse.
-- 10/30/05 - RLB - Added subtype declaration.
-- 1/16/06 - RLB - Fixed so a letter header is output if the first
-- indexed item starts with a letter.
-- 2/17/06 - RLB - Added Remove_Soft_Hyphens flag to Clean (for output).
-- 9/22/06 - RLB - Changed to use Clause_Number_Type.
-- 2/13/07 - RLB - Changed Start_Paragraph to use explicit indents.
-- 12/19/07 - RLB - Revised Text_Format calls.
-- 3/31/10 - RLB - Fixed sorting to ignore embedded commands (like
-- soft hyphens).
-- 10/18/11 - RLB - Changed to GPLv3 license.
-- 3/12/12 - RLB - Lengthened indexing so that
-- "Ada.Strings.Wide_Wide_@!Unbounded.Wide_Wide_@!Equal_Case_Insensitive"
-- would fit. (Don't ask.)
-- 8/31/12 - RLB - Fixed to avoid reading uninitialized section numbers.
Next_Index_Key : Index_Key;
type Term_Type;
type Term_Ptr is access Term_Type;
type Term_Type is record
Clause : String (1..10);
Clause_Len : Natural;
Clause_Number : ARM_Contents.Clause_Number_Type;
Paragraph : String (1..10);
Paragraph_Len : Natural;
Term : String (1..72);
Term_Len : Natural;
Subterm : String (1..80);
Subterm_Len : Natural;
Kind : Index_Item_Kind_Type;
Key : Index_Key;
Next : Term_Ptr;
end record;
procedure Free is new Ada.Unchecked_Deallocation (Term_Type, Term_Ptr);
Index_List : Term_Ptr;
Term_Count : Natural := 0;
procedure Create is
-- Initialize this package.
begin
Index_List := null;
Next_Index_Key := 1001;
Term_Count := 0;
end Create;
procedure Destroy is
-- Finalize this package; make sure the index is empty.
TTemp : Term_Ptr;
begin
while Index_List /= null loop
TTemp := Index_List;
Index_List := TTemp.Next;
Free (TTemp);
end loop;
end Destroy;
function Clean (Item : in String;
Remove_Soft_Hyphens : in Boolean) return String is
-- Remove any commands from Item. (Except for soft hyphens
-- if Remove_Soft_Hyphens is False.) We keep the contents of any
-- commands (we assume the commands are basic formatting).
Result : String (1 .. Item'Length);
Len : Natural := 0;
In_Command : Boolean := False;
Skip_Next_Char : Boolean := False;
Close_Char : Character := ' ';
begin
for I in Item'Range loop
if Item(I) = '@' then
if I < Item'Last and then
(Item(I+1) = '!' or else -- Soft hyphen
Item(I+1) = '|' or else -- Soft linebreak
Item(I+1) = ';' or else -- "nothing"
Item(I+1) = '\' or else -- tab
Item(I+1) = ' ' or else -- hard space
Item(I+1) = '*') then -- hard return
if Remove_Soft_Hyphens then
Skip_Next_Char := True;
else
-- Allow soft hyphens and other simple commands.
Len := Len + 1;
Result(Len) := Item(I);
end if;
elsif I < Item'Last and then
Item(I+1) = '@' then
-- Literal '@' command.
if Remove_Soft_Hyphens then
Len := Len + 1;
Result(Len) := '@';
Skip_Next_Char := True;
else
-- Leave these markers, as we'll format the
-- resulting string.
Len := Len + 1;
Result(Len) := Item(I);
end if;
else
In_Command := True;
Close_Char := ' ';
-- Skip it.
end if;
elsif Skip_Next_Char then
Skip_Next_Char := False;
elsif In_Command then
if Item(I) = '{' then
Close_Char := '}';
In_Command := False; -- Finished command header.
elsif Item(I) = '[' then
Close_Char := ']';
In_Command := False;
elsif Item(I) = '(' then
Close_Char := ')';
In_Command := False;
elsif Item(I) = '<' then
Close_Char := '>';
In_Command := False;
elsif Item(I) = '`' then
Close_Char := ''';
In_Command := False;
elsif Ada.Characters.Handling.Is_Alphanumeric (Item(I)) then
-- Skip character (part of the command name).
null;
else -- End of parameterless command (note: '@' already
-- was recognized).
Close_Char := ' ';
In_Command := False;
Len := Len + 1;
Result(Len) := Item(I);
end if;
elsif Close_Char /= ' ' and then
Close_Char = Item(I) then
-- Skip the close character.
Close_Char := ' ';
elsif Item(I) = Ascii.LF then
Len := Len + 1;
Result(Len) := ' ';
else
Len := Len + 1;
Result(Len) := Item(I);
end if;
end loop;
return Result (1..Len);
end Clean;
function Get_Key return Index_Key is
-- Returns a Key value to refer to one or more index entries
-- (for a single entity).
Temp : Index_Key := Next_Index_Key;
begin
Next_Index_Key := Next_Index_Key + 1;
return Temp;
end Get_Key;
procedure Add_Reusing_Key (Term : in String;
Subterm : in String := "";
Kind : in Index_Item_Kind_Type := Primary_Term;
Clause : in String := "";
Paragraph : in String := "";
Key : in Index_Key) is
-- Add an index reference to the index, (re)using the specified Key
-- to refer to this index entry. Key must have previously
-- returned by Add or Get_Key.
Temp_Term : Term_Type;
CTerm : constant String := Clean(Term, Remove_Soft_Hyphens => False);
CSubterm : constant String := Clean(Subterm, Remove_Soft_Hyphens => False);
begin
Temp_Term.Kind := Kind;
Ada.Strings.Fixed.Move (Target => Temp_Term.Term,
Source => CTerm,
Drop => Ada.Strings.Error,
Pad => ' ');
Temp_Term.Term_Len := CTerm'Length;
if Kind /= Primary_Term_and_Subterm and then
Kind /= Partial_Term_with_Subterm and then
Kind /= Child_Unit_Parent and then
Kind /= Declaration_in_Package and then
Kind /= Subdeclaration_in_Package and then
Kind /= Subtype_Declaration_in_Package and then
Kind /= See_Term and then
Kind /= See_Also_Term and then
Kind /= See_Other_Term and then
Kind /= See_Also_Other_Term then
if Subterm /= "" then
Ada.Exceptions.Raise_Exception (Not_Valid_Error'Identity,
"Subterm used in kind without subterm");
else
Temp_Term.Subterm_Len := 0;
end if;
else
Ada.Strings.Fixed.Move (Target => Temp_Term.Subterm,
Source => CSubterm,
Drop => Ada.Strings.Error,
Pad => ' ');
Temp_Term.Subterm_Len := CSubterm'Length;
end if;
if (Kind = See_Other_Term or else
Kind = See_Also_Other_Term) then
if Clause /= "" or else Paragraph /= "" then
raise Not_Valid_Error with
"Clause used in kind without reference";
else
Temp_Term.Clause_Len := 0;
Temp_Term.Paragraph_Len := 0;
-- Note: These have no clause numbers.
end if;
else
Ada.Strings.Fixed.Move (Target => Temp_Term.Clause,
Source => Clause,
Drop => Ada.Strings.Error,
Pad => ' ');
Temp_Term.Clause_Len := Clause'Length;
Ada.Strings.Fixed.Move (Target => Temp_Term.Paragraph,
Source => Paragraph,
Drop => Ada.Strings.Error,
Pad => ' ');
Temp_Term.Paragraph_Len := Paragraph'Length;
ARM_Contents.Make_Clause (Clause, Temp_Term.Clause_Number);
end if;
Temp_Term.Key := Key;
Temp_Term.Next := Index_List;
Index_List := new Term_Type'(Temp_Term);
Term_Count := Term_Count + 1;
exception
when Ada.Strings.Length_Error =>
Ada.Text_IO.Put_Line ("**** Index doesn't fit: Term: " & CTerm &
" [Subterm: " & CSubterm & "]");
end Add_Reusing_Key;
procedure Add (Term : in String;
Subterm : in String := "";
Kind : in Index_Item_Kind_Type := Primary_Term;
Clause : in String := "";
Paragraph : in String := "";
Key : out Index_Key) is
-- Add an index reference to the index. Returns a Key value to
-- refer to this index entry.
-- Raises Not_Valid_Error if Subterm, Clause, or Paragraph is not
-- empty when the kind does not use it.
begin
Key := Get_Key;
Add_Reusing_Key (Term, Subterm, Kind, Clause, Paragraph, Key);
end Add;
procedure Generate_Index_Body (Output_Object : in out ARM_Output.Output_Type'Class;
Use_Paragraphs : in Boolean := True) is
-- Generate the index body. (The section header has already been
-- generated). References include paragraph numbers if Use_Paragraphs
-- is true.
-- Note: This should not leave us in a paragraph.
Temp : Term_Ptr;
Last : Term_Ptr := null;
Items : array (1..Term_Count) of Term_Ptr;
Keep_Set : Boolean := False;
Start : Ada.Calendar.Time := Ada.Calendar.Clock;
function To_Lower (A : in String) return String renames
Ada.Characters.Handling.To_Lower;
function To_Lower (A : in Character) return Character renames
Ada.Characters.Handling.To_Lower;
procedure Clause_Ref (Item : Term_Ptr) is
-- Generate a clause reference:
begin
if Item.Clause_Len > 5 and then Item.Clause (1..5) = "Annex" then
-- Strip off the "Annex".
if Use_Paragraphs and then Item.Paragraph_Len /= 0 then
ARM_Output.Index_Reference (Output_Object,
Text => Item.Clause (Item.Clause_Len) & '(' &
Item.Paragraph (1..Item.Paragraph_Len) & ')',
Index_Key => Item.Key,
Clause_Number => Item.Clause (1..Item.Clause_Len));
else
ARM_Output.Index_Reference (Output_Object,
Text => Item.Clause (Item.Clause_Len) & "",
Index_Key => Item.Key,
Clause_Number => Item.Clause (1..Item.Clause_Len));
end if;
elsif Use_Paragraphs and then Item.Paragraph_Len /= 0 then
ARM_Output.Index_Reference (Output_Object,
Text => Item.Clause (1..Item.Clause_Len) & '(' &
Item.Paragraph (1..Item.Paragraph_Len) & ')',
Index_Key => Item.Key,
Clause_Number => Item.Clause (1..Item.Clause_Len));
else
ARM_Output.Index_Reference (Output_Object,
Text => Item.Clause (1..Item.Clause_Len),
Index_Key => Item.Key,
Clause_Number => Item.Clause (1..Item.Clause_Len));
end if;
end Clause_Ref;
procedure Italic_Text (Text : in String) is
begin
ARM_Output.Text_Format (Output_Object,
Format => (Bold => False, Italic => True,
Font => ARM_Output.Default,
Size => 0, Color => ARM_Output.Default,
Change => ARM_Output.None,
Version | Added_Version => '0',
Location => ARM_Output.Normal));
ARM_Output.Ordinary_Text (Output_Object, Text);
ARM_Output.Text_Format (Output_Object,
Format => (Bold => False, Italic => False,
Font => ARM_Output.Default,
Size => 0, Color => ARM_Output.Default,
Change => ARM_Output.None,
Version | Added_Version => '0',
Location => ARM_Output.Normal));
end Italic_Text;
procedure Term_Text (Text : in String) is
A_Soft_Hyphen : Natural := Ada.Strings.Fixed.Index (Text, "@!");
begin
if A_Soft_Hyphen = 0 then
ARM_Output.Ordinary_Text (Output_Object, Text);
else
ARM_Output.Ordinary_Text (Output_Object, Text(Text'First .. A_Soft_Hyphen-1));
ARM_Output.Soft_Hyphen_Break (Output_Object);
Term_Text (Text(A_Soft_Hyphen+2 .. Text'Last)); -- In case there is more than one soft hyphen.
end if;
end Term_Text;
procedure New_Kind (Item : Term_Ptr; Reset_Keep : in Boolean) is
-- Generate and item of a new kind. Note that the term has already
-- been generated (at some point).
begin
case Item.Kind is
when Primary_Term =>
-- ** Must be first, so can't get here.
Italic_Text ("*SORT ERROR*");
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Ordinary_Character (Output_Object, ' ');
Clause_Ref (Item);
when Partial_Term =>
ARM_Output.Index_Line_Break (Output_Object, Clear_Keep_with_Next => Reset_Keep);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Ordinary_Character (Output_Object, '[');
Italic_Text ("partial");
ARM_Output.Ordinary_Character (Output_Object, ']');
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Ordinary_Character (Output_Object, ' ');
Clause_Ref (Item);
when Primary_Term_and_Subterm =>
ARM_Output.Index_Line_Break (Output_Object, Clear_Keep_with_Next => Reset_Keep);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
Term_Text (Item.Subterm (1..Item.Subterm_Len));
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Ordinary_Character (Output_Object, ' ');
Clause_Ref (Item);
when Partial_Term_with_Subterm =>
ARM_Output.Index_Line_Break (Output_Object, Clear_Keep_with_Next => Reset_Keep);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
Term_Text (Item.Subterm (1..Item.Subterm_Len));
--[The "partial" does not seem to appear on subterms.]
--ARM_Output.Hard_Space (Output_Object);
--ARM_Output.Ordinary_Character (Output_Object, '[');
--Italic_Text ("partial");
--ARM_Output.Ordinary_Character (Output_Object, ']');
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Ordinary_Character (Output_Object, ' ');
Clause_Ref (Item);
when Syntax_NT_Used =>
ARM_Output.Index_Line_Break (Output_Object, Clear_Keep_with_Next => Reset_Keep);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
Italic_Text ("used");
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Ordinary_Character (Output_Object, ' ');
Clause_Ref (Item);
when Child_Unit_Parent =>
ARM_Output.Index_Line_Break (Output_Object, Clear_Keep_with_Next => Reset_Keep);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
Italic_Text ("child of");
ARM_Output.Ordinary_Character (Output_Object, ' ');
Term_Text (Item.Subterm (1..Item.Subterm_Len));
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Ordinary_Character (Output_Object, ' ');
Clause_Ref (Item);
when Declaration_In_Package =>
ARM_Output.Index_Line_Break (Output_Object, Clear_Keep_with_Next => Reset_Keep);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
Italic_Text ("in");
ARM_Output.Ordinary_Character (Output_Object, ' ');
Term_Text (Item.Subterm (1..Item.Subterm_Len));
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Ordinary_Character (Output_Object, ' ');
Clause_Ref (Item);
when SubDeclaration_In_Package =>
ARM_Output.Index_Line_Break (Output_Object, Clear_Keep_with_Next => Reset_Keep);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
declare
In_Loc : Natural :=
Ada.Strings.Fixed.Index (Item.Subterm (1..Item.Subterm_Len),
" in ");
begin
if In_Loc = 0 then
-- Weird, "in" not found.
Term_Text (Item.Subterm (1..Item.Subterm_Len));
else
Term_Text (Item.Subterm (1 .. In_Loc));
Italic_Text ("in");
Term_Text (Item.Subterm (In_Loc+3 .. Item.Subterm_Len));
end if;
end;
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Ordinary_Character (Output_Object, ' ');
Clause_Ref (Item);
when Subtype_Declaration_In_Package =>
ARM_Output.Index_Line_Break (Output_Object, Clear_Keep_with_Next => Reset_Keep);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
Italic_Text ("in");
ARM_Output.Ordinary_Character (Output_Object, ' ');
Term_Text (Item.Subterm (1..Item.Subterm_Len));
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Ordinary_Character (Output_Object, ' ');
Clause_Ref (Item);
when See_Term =>
ARM_Output.Index_Line_Break (Output_Object, Clear_Keep_with_Next => Reset_Keep);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
Italic_Text ("See");
ARM_Output.Ordinary_Character (Output_Object, ' ');
Term_Text (Item.Subterm (1..Item.Subterm_Len));
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Ordinary_Character (Output_Object, ' ');
Clause_Ref (Item);
when See_Also_Term =>
ARM_Output.Index_Line_Break (Output_Object, Clear_Keep_with_Next => Reset_Keep);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
Italic_Text ("See also");
ARM_Output.Ordinary_Character (Output_Object, ' ');
Term_Text (Item.Subterm (1..Item.Subterm_Len));
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Ordinary_Character (Output_Object, ' ');
Clause_Ref (Item);
when See_Other_Term =>
ARM_Output.Index_Line_Break (Output_Object, Clear_Keep_with_Next => Reset_Keep);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
Italic_Text ("See");
ARM_Output.Ordinary_Character (Output_Object, ' ');
Term_Text (Item.Subterm (1..Item.Subterm_Len));
-- No clause reference here.
when See_Also_Other_Term =>
ARM_Output.Index_Line_Break (Output_Object, Clear_Keep_with_Next => Reset_Keep);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
Italic_Text ("See also");
ARM_Output.Ordinary_Character (Output_Object, ' ');
Term_Text (Item.Subterm (1..Item.Subterm_Len));
-- No clause reference here.
end case;
end New_Kind;
function Is_Last_for_Term (Item : in Term_Ptr) return Boolean is
-- Returns True if this is the last line for Item's Term.
begin
if Item.Next = null then
return True;
elsif To_Lower (Item.Term (1..Item.Term_Len)) /= To_Lower (Item.Next.Term (1..Item.Next.Term_Len)) then
-- The next item has a different term.
return True;
elsif Temp.Kind /= Temp.Next.Kind then
-- The next item has a different kind, so another line will
-- be generated.
return False;
elsif To_Lower (Item.Subterm (1..Item.Subterm_Len)) /= To_Lower (Item.Next.Subterm (1..Item.Next.Subterm_Len)) then
-- The next item has a different subterm, so another line will
-- be generated.
return False;
else
-- The following term will just add another clause reference.
-- So we must look at the term following that:
return Is_Last_for_Term (Item.Next);
end if;
end Is_Last_for_Term;
begin
Ada.Text_IO.Put_Line (" -- Start index sorting - " & Natural'Image(Term_Count) & " items.");
-- Sort the items:
-- Load the items:
Temp := Index_List;
for I in Items'range loop
Items(I) := Temp;
Temp := Temp.Next;
end loop;
-- Sort the items array:
declare
function "<" (Left, Right : Term_Ptr) return Boolean is
function To_Lower (A : in String) return String renames
Ada.Characters.Handling.To_Lower;
use type ARM_Contents.Clause_Number_Type;
type Compare_Result is (Less, Greater, Equal);
function Compare (Left, Right : in String) return Compare_Result is
-- Compare two items; the compare is case insensitive and
-- ignores embedded commands.
begin
-- Simple cases in order to increase performance.
-- Check for null cases so we don't have to worry about them
-- later.
if Left = Right then
return Equal;
elsif Left'Length = 0 then
return Less; -- Right can't be null or they'd be equal.
elsif Right'Length = 0 then
return Greater;
end if;
-- Both strings are non-null.
if Left(Left'First) in '0'..'9' or else
Left(Left'First) in 'A'..'Z' then
if Right(Right'First) in '0'..'9' or else
Right(Right'First) in 'A'..'Z' then
if Left(Left'First) < Right(Right'First) then
return Less;
elsif Left(Left'First) > Right(Right'First) then
return Greater;
-- else continue below.
end if;
elsif Right(Right'First) in 'a'..'z' then
if Left(Left'First) < Character'Val(Character'Pos(Right(Right'First))+Character'Pos('A')-Character'Pos('a')) then
return Less;
elsif Left(Left'First) > Character'Val(Character'Pos(Right(Right'First))+Character'Pos('A')-Character'Pos('a')) then
return Greater;
end if;
-- else continue below.
end if;
elsif Left(Left'First) in 'a'..'z' then
if Right(Right'First) in '0'..'9' or else
Right(Right'First) in 'A'..'Z' then
if Character'Val(Character'Pos(Left(Left'First))+Character'Pos('A')-Character'Pos('a')) < Right(Right'First) then
return Less;
elsif Character'Val(Character'Pos(Left(Left'First))+Character'Pos('A')-Character'Pos('a')) > Right(Right'First) then
return Greater;
-- else continue below.
end if;
elsif Right(Right'First) in 'a'..'z' then -- Both lower.
if Left(Left'First) < Right(Right'First) then
return Less;
elsif Left(Left'First) > Right(Right'First) then
return Greater;
end if;
-- else continue below.
end if;
-- else continue below.
end if;
-- OK, do a full compare:
declare
-- %% Warning: This has terrible performance, too much heap use.
L : constant String := Clean (To_Lower (Left), Remove_Soft_Hyphens => True);
R : constant String := Clean (To_Lower (Right), Remove_Soft_Hyphens => True);
begin
--Ada.Text_IO.Put_Line("Full compare: Left=" & Left & "; Right=" & Right);
--Ada.Text_IO.Put_Line(" Clean Left=" & L & "; Clean Right=" & R);
if L < R then
--Ada.Text_IO.Put_Line(" Result=Less");
return Less;
elsif L > R then
--Ada.Text_IO.Put_Line(" Result=Greater");
return Greater;
else
--Ada.Text_IO.Put_Line(" Result=Equal");
return Equal;
end if;
end;
end Compare;
begin
-- We sort first on "Term", then on "Kind", then on "Subterm",
-- then on "Clause", and finally on "Paragraph".
case Compare (Left.Term (1..Left.Term_Len), Right.Term (1..Right.Term_Len)) is
when Less => return True;
when Greater => return False;
when Equal => null; -- Continue to next compare.
end case;
-- Partial_Term_with_Subterm and Primary_Term_and_Subterm
-- look identical, so they should compare equal for this
-- purpose:
if Left.Kind = Right.Kind or else
(Left.Kind = Partial_Term_with_Subterm and then
Right.Kind = Primary_Term_and_Subterm) or else
(Left.Kind = Primary_Term_and_Subterm and then
Right.Kind = Partial_Term_with_Subterm) then
null; -- Continue to next compare.
elsif Left.Kind < Right.Kind then
return True;
else --if Left.Kind > Right.Kind then
return False;
end if;
case Compare (Left.Subterm (1..Left.Subterm_Len), Right.Subterm (1..Right.Subterm_Len)) is
when Less => return True;
when Greater => return False;
when Equal => null; -- Continue to next compare.
end case;
if Left.Kind = See_Other_Term or else
Left.Kind = See_Also_Other_Term then
-- These have no clause or paragraph number to compare,
-- and the Kinds must match, so they are equal.
-- Since this is "<" and not "<=", the result is False.
return False;
end if;
-- Note: We use the numbers, because the references don't
-- sort right (11.1 comes before 2.8, etc.)
if Left.Clause_Number < Right.Clause_Number then
return True;
elsif Left.Clause_Number = Right.Clause_Number then
-- Make sure that single digit paragraph numbers sort before
-- multiple digit ones:
if Left.Paragraph_Len <= 1 or else Left.Paragraph(2) = '.' or else Left.Paragraph(2) = '/' then
-- Single digit number:
if Right.Paragraph_Len <= 1 or else Right.Paragraph(2) = '.' or else Right.Paragraph(2) = '/' then
-- Single digit number, normal compare:
return Left.Paragraph (1..Left.Paragraph_Len) < Right.Paragraph (1..Right.Paragraph_Len);
else
-- Single digit is always less than multiple digits:
return True;
end if;
else -- Not single digit number:
if Right.Paragraph_Len <= 1 or else Right.Paragraph(2) = '.' or else Right.Paragraph(2) = '/' then
-- Single digit number, always less than multiple digits:
return False;
else
-- Else both multiple, use normal compare:
return Left.Paragraph (1..Left.Paragraph_Len) < Right.Paragraph (1..Right.Paragraph_Len);
end if;
end if;
else -- Left.Clause_Number > Right.Clause_Number
return False;
end if;
end "<";
--procedure Final_Sort_Slice (Left, Right : in Natural) is
-- -- Use an insertion sort to sort the slice between Left and Right.
-- Working_Left : Natural; -- Working Left sorting stop
-- Temp : Term_Ptr;
--begin
-- for Working_Right In Left+1 .. Right loop -- Right sorting stop
-- Temp := Items(Working_Right);
-- Working_Left := Working_Right - 1;
-- while Temp < Items(Working_Left) loop -- Switch items
-- Items(Working_Left + 1) := Items(Working_Left);
-- Working_Left := Working_Left - 1;
-- exit when Working_Left = 0;
-- end loop;
-- Items(Working_Left + 1) := Temp;
-- end loop;
--end Final_Sort_Slice;
procedure Partition_Sort_Slice (Start_Index, End_Index : Natural) is
-- Use quicksort partition sort to sort the slice between
-- Start_Index and End_Index.
Temp_Item : Term_Ptr;
begin
case ((End_Index - Start_Index) + 1) is
when 0 | 1 => null; -- A single element is obviously sorted (trivially).
when 2 =>
-- Unrolled Insertion Sort.
if Items(Start_Index+1) < Items(Start_Index) then
-- Move the record down.
Temp_Item := Items(Start_Index+1);
Items(Start_Index+1) := Items(Start_Index );
Items(Start_Index ) := Temp_Item; -- Put at beginning.
-- else Doesn't need to move.
end if;
when 3 =>
-- Unrolled Insertion Sort.
if Items(Start_Index+1) < Items(Start_Index) then
-- Move the record down.
Temp_Item := Items(Start_Index+1);
Items(Start_Index+1) := Items(Start_Index );
Items(Start_Index ) := Temp_Item; -- Put at beginning.
-- else Doesn't need to move.
end if;
if Items(Start_Index+2) < Items(Start_Index+1) then
-- Move the record down.
Temp_Item := Items(Start_Index+2);
Items(Start_Index+2) := Items(Start_Index+1);
if Temp_Item < Items(Start_Index) then
-- Move the record down.
Items(Start_Index+1) := Items(Start_Index);
Items(Start_Index) := Temp_Item; -- Put at beginning.
else
-- Put the record here.
Items(Start_Index+1) := Temp_Item;
end if;
-- else Doesn't need to move.
end if;
when 4 =>
-- Unrolled Insertion Sort.
if Items(Start_Index+1) < Items(Start_Index) then
-- Move the record down.
Temp_Item := Items(Start_Index+1);
Items(Start_Index+1) := Items(Start_Index );
Items(Start_Index ) := Temp_Item; -- Put at beginning.
-- else Doesn't need to move.
end if;
if Items(Start_Index+2) < Items(Start_Index+1) then
-- Move the record down.
Temp_Item := Items(Start_Index+2);
Items(Start_Index+2) := Items(Start_Index+1);
if Temp_Item < Items(Start_Index) then
-- Move the record down.
Items(Start_Index+1) := Items(Start_Index);
Items(Start_Index) := Temp_Item; -- Put at beginning.
else
-- Put the record here.
Items(Start_Index+1) := Temp_Item;
end if;
-- else Doesn't need to move.
end if;
if Items(Start_Index+3) < Items(Start_Index+2) then
-- Move the record down.
Temp_Item := Items(Start_Index+3);
Items(Start_Index+3) := Items(Start_Index+2);
if Temp_Item < Items(Start_Index+1) then
-- Move the record down.
Items(Start_Index+2) := Items(Start_Index+1);
if Temp_Item < Items(Start_Index) then
-- Move the record down.
Items(Start_Index+1) := Items(Start_Index);
Items(Start_Index) := Temp_Item; -- Put at beginning.
else -- Put the record here.
Items(Start_Index+1) := Temp_Item;
end if;
else
-- Put the record here.
Items(Start_Index+2) := Temp_Item;
end if;
-- else Don't move the record.
end if;
when others => -- Longer partitions, quicksort.
declare
Left_Index, Right_Index : Natural;
Pivot_Item : Term_Ptr;
begin
-- Split into partitions, and sort them.
Left_Index := Start_Index;
Right_Index := End_Index;
-- Use the middle element for the pivot, in case the items are
-- somewhat sorted.
Pivot_Item := Items ((End_Index - Start_Index) / 2 + Start_Index);
loop
loop
exit when not (Items(Left_Index) < Pivot_Item); -- >=
Left_Index := Left_Index + 1;
end loop;
loop
exit when not (Pivot_Item < Items(Right_Index));
Right_Index := Right_Index - 1;
end loop;
if Left_Index <= Right_Index then
if Left_Index < Right_Index then
Temp_Item := Items(Left_Index);
Items(Left_Index) := Items(Right_Index);
Items(Right_Index) := Temp_Item;
end if;
Left_Index := Left_Index + 1;
Right_Index := Right_Index - 1;
end if;
exit when Left_Index > Right_Index;
end loop; -- Repeat Loop
-- Recursive calls on partitions.
Partition_Sort_Slice (Left_Index, End_Index);
Partition_Sort_Slice (Start_Index, Right_Index);
end;
end case;
end Partition_Sort_Slice;
begin
-- Debug: (This should only print Kinds that have no clause number).
--for Idx in Items'range loop
-- if Arm_Contents."=" (Items(Idx).Clause_Number.Section, Arm_Contents.UNKNOWN) then
-- Ada.Text_IO.Put_Line ("For index item" & Natural'Image(Idx) &
-- " Clause.Section=" & Arm_Contents.Section_Number_Type'Image(Items(Idx).Clause_Number.Section) &
-- " Kind=" & Index_Item_Kind_Type'Image(Items(Idx).Kind));
-- -- else OK.
-- end if;
--end loop;
-- Use quicksort to handle most of the array, then
-- insertion sort for the final slices.
Partition_Sort_Slice (Items'First, Items'Last);
end;
-- Relink the items in the sorted order:
for I in Items'First .. Items'Last - 1 loop
Items(I).Next := Items(I+1);
end loop;
if Items'Length > 0 then
Items(Items'Last).Next := null;
Index_List := Items(1);
else
Index_List := null;
end if;
Ada.Text_IO.Put_Line (" -- Finish index sorting - " & Duration'Image (
Ada.Calendar."-" (Ada.Calendar.Clock, Start)) & " secs.");
ARM_Output.Start_Paragraph (Output_Object, ARM_Output.Index, Indent => 0,
Number => "", No_Breaks => True);
Keep_Set := False;
Temp := Index_List;
while Temp /= null loop
-- First, check if we've changed to a new group:
if (Last /= null and then
To_Lower (Last.Term(1)) /= To_Lower(Temp.Term(1))) or else
(Last = null and then To_Lower(Temp.Term(1)) in 'a' .. 'z') then
-- The first character has changed, or this is the first item.
-- We only generate letters, so we try not to come here for
-- non-letters.
ARM_Output.End_Paragraph (Output_Object);
ARM_Output.Start_Paragraph (Output_Object, ARM_Output.Index,
Indent => 0, Number => "");
Keep_Set := False;
if To_Lower(Temp.Term(1)) in 'a' .. 'z' then
ARM_Output.Index_Line_Break (Output_Object, Clear_Keep_with_Next => False);
ARM_Output.Text_Format (Output_Object,
Format => (Bold => True, Italic => False,
Font => ARM_Output.Default,
Size => 2, Color => ARM_Output.Default,
Change => ARM_Output.None,
Version | Added_Version => '0',
Location => ARM_Output.Normal));
ARM_Output.Ordinary_Character (Output_Object,
Ada.Characters.Handling.To_Upper(Temp.Term(1)));
ARM_Output.Text_Format (Output_Object,
Format => (Bold => False, Italic => False,
Font => ARM_Output.Default,
Size => 0, Color => ARM_Output.Default,
Change => ARM_Output.None,
Version | Added_Version => '0',
Location => ARM_Output.Normal));
ARM_Output.Index_Line_Break (Output_Object, Clear_Keep_with_Next => False);
else
ARM_Output.Hard_Space (Output_Object);
-- So the paragraph isn't empty (which causes it to be
-- ignored in HTML).
end if;
end if;
if Last = null or else
To_Lower(Last.Term (1..Last.Term_Len)) /= To_Lower(Temp.Term (1..Temp.Term_Len)) then
-- New term: (Note that we ignore case differences here. Perhaps
-- there ought to be a warning?)
if Last /= null then
ARM_Output.End_Paragraph (Output_Object);
if Temp.Kind = Primary_Term then
ARM_Output.Start_Paragraph (Output_Object, ARM_Output.Index,
Indent => 0, Number => "",
No_Breaks => True);
Keep_Set := False;
else -- The item has at least two lines; keep them together.
ARM_Output.Start_Paragraph (Output_Object, ARM_Output.Index,
Indent => 0, Number => "",
No_Breaks => True, Keep_with_Next => True);
Keep_Set := True;
end if;
end if;
if Temp.Kind /= Subtype_Declaration_in_Package then
Term_Text (Temp.Term (1..Temp.Term_Len));
else
declare
Of_Loc : Natural :=
Ada.Strings.Fixed.Index (Temp.Term (1..Temp.Term_Len),
" subtype of ");
begin
if Of_Loc = 0 then
-- Weird, "subtype of" not found.
Term_Text (Temp.Term (1..Temp.Term_Len));
else
Term_Text (Temp.Term (1 .. Of_Loc));
Italic_Text ("subtype of");
Term_Text (Temp.Term (Of_Loc+11 .. Temp.Term_Len));
end if;
end;
end if;
if Temp.Kind = Primary_Term then
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Hard_Space (Output_Object);
ARM_Output.Ordinary_Character (Output_Object, ' ');
Clause_Ref (Temp);
else
if Is_Last_for_Term(Temp) then
-- Last (only) item of this term, always clear Keep:
New_Kind (Temp, Reset_Keep => True);
Keep_Set := False;
else -- Leave keep set:
New_Kind (Temp, Reset_Keep => False);
end if;
end if;
elsif Last.Kind /= Temp.Kind then
New_Kind (Temp, Reset_Keep => Keep_Set);
Keep_Set := False;
elsif (Temp.Kind = Primary_Term_and_Subterm or else
Temp.Kind = Partial_Term_with_Subterm or else
Temp.Kind = Syntax_NT_Used or else
Temp.Kind = Child_Unit_Parent or else
Temp.Kind = Declaration_in_Package or else
Temp.Kind = SubDeclaration_in_Package or else
Temp.Kind = Subtype_Declaration_in_Package) and then
Last.Subterm (1..Last.Subterm_Len) /= Temp.Subterm (1..Temp.Subterm_Len) then
New_Kind (Temp, Reset_Keep => Keep_Set);
Keep_Set := False;
elsif (Temp.Kind = See_Other_Term or else
Temp.Kind = See_Also_Other_Term) then
-- Just add the next reference.
ARM_Output.Ordinary_Character (Output_Object, ',');
ARM_Output.Ordinary_Character (Output_Object, ' ');
ARM_Output.Ordinary_Text (Output_Object,
Temp.Subterm (1..Temp.Subterm_Len));
-- No clause references here.
elsif (Temp.Kind = See_Term or else
Temp.Kind = See_Also_Term) then
-- Just add the next reference. We'll just use New_Kind for
-- this, so we don't get the formats slightly different.
New_Kind (Temp, Reset_Keep => Keep_Set);
Keep_Set := False;
elsif Last.Clause (1..Last.Clause_Len) = Temp.Clause (1..Temp.Clause_Len) and then
Last.Paragraph (1..Last.Paragraph_Len) = Temp.Paragraph (1..Temp.Paragraph_Len) then
-- The reference and everything else is the same, so just
-- forget this item.
null;
else
-- Just add the next clause.
ARM_Output.Ordinary_Character (Output_Object, ',');
ARM_Output.Ordinary_Character (Output_Object, ' ');
Clause_Ref (Temp);
end if;
Last := Temp;
Temp := Temp.Next;
end loop;
ARM_Output.End_Paragraph (Output_Object);
end Generate_Index_Body;
end ARM_Index;
|
