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
|
with Ada.Text_IO,
Ada.Strings.Fixed,
Ada.Strings.Unbounded,
Ada.Characters.Handling,
Ada.Command_Line;
with ARM_Master,
ARM_Contents,
ARM_Format;
procedure ARM_Formatter is
--
-- Ada reference manual formatter (ARM_Form).
--
-- This is the main subprogram: format the sources for the
-- Ada reference manual and other documents
-- (in a vaguely Scribe-like macro language) into the actual
-- reference manual files (in various formats).
--
-- ---------------------------------------
-- Copyright 2000, 2002, 2004, 2005, 2006, 2011, 2012, 2016
-- 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:
--
-- 3/ 9/00 - RLB - Created base program.
-- 4/14/00 - RLB - Created from analysis program.
-- 4/18/00 - RLB - Added scanning pass.
-- 4/19/00 - RLB - Split 03 into two files. Added HTML output object.
-- 4/24/00 - RLB - Added Change_Kind and Display_Index_Entries.
-- 5/15/00 - RLB - Split formatter from input.
-- 5/16/00 - RLB - Added missing Destroy for formatting objects.
-- 5/18/00 - RLB - Added RTF output object.
-- 5/25/00 - RLB - Added the Big-Files option. Added the library separator.
-- 5/28/00 - RLB - Added index.
-- 8/31/00 - RLB - Added the New-Changes option.
-- 7/18/02 - RLB - Changed copyright date.
-- - RLB - Changed Creates to include title and header.
-- - RLB - Added Version parameter to command line and formatting
-- commands.
-- 9/10/04 - RLB - Updated descriptions of standard commands.
-- 9/14/04 - RLB - Moved version to ARM_Contents.
-- 12/05/04 - RLB - Split/added various source files.
-- 6/ 2/05 - RLB - Added Corrigendum output module for comparisons to
-- Amendment document.
-- 10/12/05 - RLB - Changed the title to reflect what we learned from ISO.
-- 10/28/05 - RLB - Added Annex Q.
-- 1/ 5/06 - RLB - Revised to use master files, rather than hard-coded
-- properties.
-- 1/12/06 - RLB - Removed Document completely.
-- 10/18/11 - RLB - Changed to GPLv3 license.
-- 10/19/11 - RLB - Removed junk withs (now in master file handler).
-- 4/ 3/12 - RLB - Removed dead variable.
-- 8/31/12 - RLB - Added output path parameter.
-- 3/17/16 - RLB - Added lower version to command line.
-- Standard commands for Ada standards:
-- For Original (Ada 95) RM:
-- Arm_Form RM <Format> No-Changes 0 0
-- For Original AARM:
-- Arm_Form AARM <Format> No-Changes 0 0
-- For RM with Corr:
-- [With change bars for Word 97/2000:]
-- Arm_Form RM RTF New-Changes 1 1
-- [Final versions with no changes:]
-- Arm_Form RM <Format> New-Only 1 1
-- For AARM with Corr:
-- [HTML; RTF for display]:
-- Arm_Form AARM <Format> Show-Changes 1 1
-- [TXT; RTF for printing]:
-- Arm_Form AARM <Format> New-Only 1 1
-- For RM with Corr and Amd:
-- [With change bars for Word 97/2000:]
-- Arm_Form RM RTF New-Changes 1 2
-- [With change ballons for Word XP/2003:]
-- Arm_Form RM RTF Show-Changes 1 2
-- [Final versions with no changes:]
-- Arm_Form RM <Format> New-Only 1 2
-- For AARM with Corr and Amd:
-- [HTML; RTF for display]:
-- Arm_Form AARM <Format> Show-Changes 2 2
-- (for only Amd changes) or
-- Arm_Form AARM <Format> Show-Changes 1 2
-- (for all changes)
-- [TXT; RTF for printing]:
-- Arm_Form AARM <Format> New-Only 2 2
-- For Ada 2012 RM: (To include TC1, change 3 to 4).
-- [With change ballons for Word XP/2003:]
-- Arm_Form RM RTF Show-Changes 1 3
-- [For change bar version for Word 97/2000:]
-- Arm_Form RM RTF Show-Changes 3 3
-- [Final versions with no changes:]
-- Arm_Form RM <Format> New-Only 3 3
-- For Ada 2012 AARM: (To include TC1, change 3 to 4).
-- [HTML; RTF for display]:
-- Arm_Form AARM <Format> Show-Changes 3 3
-- (for only Amd 2012 changes) or
-- Arm_Form AARM <Format> Show-Changes 1 3
-- (for all changes)
-- [TXT; RTF for printing]:
-- Arm_Form AARM <Format> New-Only 1 3
-- For Ada 202x RM:
-- [For change bar version:]
-- Arm_Form RM RTF Show-Changes 4 5
-- [Final versions with no changes:]
-- Arm_Form RM <Format> New-Only 5 5
-- For Ada 202x AARM with:
-- [HTML; RTF for display]:
-- Arm_Form AARM <Format> Show-Changes 4 5
-- (for only Amd 2012 changes) or
-- Arm_Form AARM <Format> Show-Changes 1 5
-- (for all changes)
-- [TXT; RTF for printing]:
-- Arm_Form AARM <Format> New-Only 5 5
No_Command_Error : exception;
Format : ARM_Master.Output_Format_Type; -- Format to generate.
Master_File : Ada.Strings.Unbounded.Unbounded_String; -- Master file for document to generate.
Change_Kind : ARM_Format.Change_Kind; -- Changes to generate.
Base_Change_Version : ARM_Contents.Change_Version_Type; -- Lower Change version.
Change_Version : ARM_Contents.Change_Version_Type; -- (Upper) Change version.
Output_Path : Ada.Strings.Unbounded.Unbounded_String; -- Output path.
procedure Get_Commands is
-- Process the command line for this program.
begin
if Ada.Command_Line.Argument_Count not in 1 .. 6 then
Ada.Text_IO.Put_Line ("** Wrong number of arguments");
raise No_Command_Error;
end if;
if Ada.Command_Line.Argument_Count >= 6 then
Output_Path := Ada.Strings.Unbounded.To_Unbounded_String(
Ada.Strings.Fixed.Trim (Ada.Command_Line.Argument(6),
Ada.Strings.Right));
-- Check that the Output_Path ends with a path separator.
-- Note: This is a simple Windows check; it doesn't check for and
-- allow bare disk names. This check works on Linux but allows
-- ending with '\' which does not work on Linux (that will be
-- failed when the files are opened).
declare
Last : constant Character :=
Ada.Strings.Unbounded.Element (Ada.Strings.Unbounded.Tail (Output_Path, 1), 1);
begin
if Last = '/' or else Last = '\' then
null; -- OK; this ends with a path separator.
else
Ada.Text_IO.Put_Line ("** Output path does not end with a path separator: " &
Ada.Strings.Unbounded.To_String (Output_Path));
raise No_Command_Error;
end if;
end;
else
Output_Path := Ada.Strings.Unbounded.To_Unbounded_String
("./output/"); -- Use '/' so this works on Linux and Windows.
end if;
if Ada.Command_Line.Argument_Count >= 5 then
declare
Version_Arg : String :=
Ada.Characters.Handling.To_Lower (
Ada.Strings.Fixed.Trim (Ada.Command_Line.Argument(5),
Ada.Strings.Right));
begin
if Version_Arg'Length = 1 and then
Version_Arg(Version_Arg'First) in ARM_Contents.Change_Version_Type then
Change_Version := Version_Arg(Version_Arg'First);
else
Ada.Text_IO.Put_Line ("** Unrecognized change version: " & Version_Arg);
raise No_Command_Error;
end if;
end;
else
Change_Version := '0';
end if;
if Ada.Command_Line.Argument_Count >= 4 then
declare
Version_Arg : String :=
Ada.Characters.Handling.To_Lower (
Ada.Strings.Fixed.Trim (Ada.Command_Line.Argument(4),
Ada.Strings.Right));
begin
if Version_Arg'Length = 1 and then
Version_Arg(Version_Arg'First) in ARM_Contents.Change_Version_Type then
Base_Change_Version := Version_Arg(Version_Arg'First);
else
Ada.Text_IO.Put_Line ("** Unrecognized change version: " & Version_Arg);
raise No_Command_Error;
end if;
end;
else
Base_Change_Version := '0';
end if;
if Ada.Command_Line.Argument_Count >= 3 then
declare
Changes_Arg : String :=
Ada.Characters.Handling.To_Lower (
Ada.Strings.Fixed.Trim (Ada.Command_Line.Argument(3),
Ada.Strings.Right));
begin
if Changes_Arg = "no-changes" then
Change_Kind := ARM_Format.Old_Only;
elsif Changes_Arg = "new-only" then
Change_Kind := ARM_Format.New_Only;
elsif Changes_Arg = "show-changes" then
Change_Kind := ARM_Format.Show_Changes;
elsif Changes_Arg = "new-changes" then
Change_Kind := ARM_Format.New_Changes;
else
Ada.Text_IO.Put_Line ("** Unrecognized changes: " & Changes_Arg);
raise No_Command_Error;
end if;
end;
else
Change_Kind := ARM_Format.New_Only;
end if;
if Ada.Command_Line.Argument_Count >= 2 then
declare
Format_Arg : String :=
Ada.Characters.Handling.To_Lower (
Ada.Strings.Fixed.Trim (Ada.Command_Line.Argument(2),
Ada.Strings.Right));
begin
if Format_Arg = "rtf" then
Format := ARM_Master.RTF;
elsif Format_Arg = "html" then
Format := ARM_Master.HTML;
elsif Format_Arg = "text" then
Format := ARM_Master.Text;
elsif Format_Arg = "corr" then
Format := ARM_Master.Corr;
elsif Format_Arg = "info" then
Format := ARM_Master.Info;
else
Ada.Text_IO.Put_Line ("** Unrecognized format: " & Format_Arg);
raise No_Command_Error;
end if;
end;
else
Format := ARM_Master.HTML;
end if;
declare
use type Ada.Strings.Unbounded.Unbounded_String;
begin
Master_File := Ada.Strings.Unbounded.To_Unbounded_String
(Ada.Characters.Handling.To_Lower
(Ada.Strings.Fixed.Trim (Ada.Command_Line.Argument(1), Ada.Strings.Right)));
if Ada.Strings.Unbounded.Index (Master_File, ".") = 0 then
-- Add extension if it is missing.
Master_File := Master_File & ".msm";
end if;
end;
exception
when No_Command_Error =>
Ada.Text_IO.Put_Line (" Usage: Arm_Form <Master_File> [<Format>[ <Changes>[ <BaseVers>[ <ChgVers>[ <Output Path>]]]]]}");
Ada.Text_IO.Put_Line (" where: <Master_File> is the file name (and optional path) for the master file");
Ada.Text_IO.Put_Line (" for the document;");
Ada.Text_IO.Put_Line (" where: <Format> = 'Text' (text files),");
Ada.Text_IO.Put_Line (" 'HTML' (HTML files),");
Ada.Text_IO.Put_Line (" 'RTF' (RTF files for Word 97 or later),");
Ada.Text_IO.Put_Line (" 'Corr' (Corrigendum-style command files for comparisons);");
Ada.Text_IO.Put_Line (" where: <Changes> = 'No-Changes' (Original RM text),");
Ada.Text_IO.Put_Line (" 'New-Only' (Revised RM text only up to <ChgVers>),");
Ada.Text_IO.Put_Line (" 'Show-Changes' (Text with changes marked between");
Ada.Text_IO.Put_Line (" <BaseVers> and <ChgVers>),");
Ada.Text_IO.Put_Line (" 'New-Changes' (Text with insertions marked between");
Ada.Text_IO.Put_Line (" <BaseVers> and <ChgVers>);");
Ada.Text_IO.Put_Line (" where: <BaseVers> and <ChgVers> = a value in 0 .. 9 representing the");
Ada.Text_IO.Put_Line (" base and primary change versions, respectively");
Ada.Text_IO.Put_Line (" 0-Original Ada 95 (equivalent to No-Changes)");
Ada.Text_IO.Put_Line (" 1-Technical Corrigendum 1");
Ada.Text_IO.Put_Line (" 2-Amendment 1");
Ada.Text_IO.Put_Line (" 3-Ada 2012");
Ada.Text_IO.Put_Line (" 4-Ada 2012 Technical Corrigendum 1");
Ada.Text_IO.Put_Line (" 5-Ada 202x");
Ada.Text_IO.Put_Line (" where: <Output_Path> = it the path where to write the result files. This must");
Ada.Text_IO.Put_Line (" end with a path separator. It defaults to ./output/");
raise No_Command_Error;
end Get_Commands;
begin
Ada.Text_IO.Put_Line ("Ada Manual formatter");
Ada.Text_IO.Put_Line (" Copyright 2000, 2002, 2004, 2005, 2006, 2011, 2012, 2016 AXE Consultants");
Ada.Text_IO.Put_Line (" P.O. Box 1512, Madison WI 53701");
Get_Commands;
Ada.Text_IO.Put_Line (" Master File = " & Ada.Strings.Unbounded.To_String(Master_File));
Ada.Text_IO.Put_Line (" Format = " & ARM_Master.Output_Format_Type'Image(Format));
Ada.Text_IO.Put_Line (" Changes = " & ARM_Format.Change_Kind'Image(Change_Kind));
Ada.Text_IO.Put_Line (" Version = " & Change_Version);
ARM_Master.Read_and_Process_Master_File (
File_Name => Ada.Strings.Unbounded.To_String(Master_File),
The_Change_Kind => Change_Kind,
The_Change_Version => Change_Version,
The_Base_Change_Version => Base_Change_Version,
Output_Format => Format,
Output_Path => Ada.Strings.Unbounded.To_String(Output_Path));
Ada.Text_IO.Put_Line ("Ada document created");
exception
when No_Command_Error =>
null; -- Error message displayed by command line processor.
end ARM_Formatter;
|
