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
|
-- VHDL code formatter.
-- Copyright (C) 2019 Tristan Gingold
--
-- GHDL is free software; you can redistribute it and/or modify it under
-- the terms of the GNU General Public License as published by the Free
-- Software Foundation; either version 2, or (at your option) any later
-- version.
--
-- GHDL is distributed in the hope that it will be useful, but WITHOUT ANY
-- WARRANTY; without even the implied warranty of MERCHANTABILITY or
-- FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
-- for more details.
--
-- You should have received a copy of the GNU General Public License
-- along with GHDL; see the file COPYING. If not, write to the Free
-- Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-- 02111-1307, USA.
with Types; use Types;
with Files_Map;
with Simple_IO;
with Vhdl.Tokens; use Vhdl.Tokens;
with Vhdl.Scanner; use Vhdl.Scanner;
with Vhdl.Prints; use Vhdl.Prints;
package body Vhdl.Formatters is
-- Check token TOK with the one from the scanner. Deal with irregular
-- cases.
procedure Check_Token (Tok : Token_Type) is
begin
-- There are a couple of exceptions due to attributes or
-- PSL.
if Tok = Tok_Identifier
and then (Current_Token = Tok_Range
or else Current_Token = Tok_Subtype)
then
null;
elsif (Tok = Tok_Psl_Default
or else Tok = Tok_Psl_Clock)
and then Current_Token = Tok_Identifier
then
null;
elsif Tok /= Current_Token then
declare
use Simple_IO;
begin
Put_Line_Err ("error: token mismatch. ");
Put_Err (" need to print: ");
Put_Err (Image (Tok));
Put_Err (", but read ");
Put_Err (Image (Current_Token));
Put_Err (" from file.");
New_Line_Err;
end;
raise Internal_Error;
end if;
end Check_Token;
package Format_Disp_Ctxt is
type Format_Ctxt is new Disp_Ctxt with record
Vnum : Natural;
Hnum : Natural;
Prev_Tok : Token_Type;
Sfe : Source_File_Entry;
Source : File_Buffer_Acc;
end record;
procedure Init (Ctxt : out Format_Ctxt; Sfe : Source_File_Entry);
procedure Start_Hbox (Ctxt : in out Format_Ctxt);
procedure Close_Hbox (Ctxt : in out Format_Ctxt);
procedure Start_Vbox (Ctxt : in out Format_Ctxt);
procedure Close_Vbox (Ctxt : in out Format_Ctxt);
procedure Disp_Token (Ctxt : in out Format_Ctxt; Tok : Token_Type);
procedure Start_Lit (Ctxt : in out Format_Ctxt; Tok : Token_Type);
procedure Disp_Char (Ctxt : in out Format_Ctxt; C : Character);
procedure Close_Lit (Ctxt : in out Format_Ctxt);
private
procedure Disp_Newline (Ctxt : in out Format_Ctxt);
procedure Disp_Indent (Ctxt : in out Format_Ctxt);
procedure Put (Ctxt : in out Format_Ctxt; C : Character);
procedure Sync (Ctxt : in out Format_Ctxt; Tok : Token_Type);
end Format_Disp_Ctxt;
package body Format_Disp_Ctxt is
procedure Init (Ctxt : out Format_Ctxt; Sfe : Source_File_Entry) is
begin
Ctxt := (Vnum => 0,
Hnum => 0,
Prev_Tok => Tok_Newline,
Sfe => Sfe,
Source => Files_Map.Get_File_Source (Sfe));
end Init;
procedure Put (Ctxt : in out Format_Ctxt; C : Character)
is
pragma Unreferenced (Ctxt);
begin
Simple_IO.Put (C);
end Put;
procedure Start_Hbox (Ctxt : in out Format_Ctxt) is
begin
Ctxt.Hnum := Ctxt.Hnum + 1;
end Start_Hbox;
procedure Disp_Newline (Ctxt : in out Format_Ctxt) is
begin
Put (Ctxt, ASCII.LF);
Ctxt.Prev_Tok := Tok_Newline;
end Disp_Newline;
procedure Close_Hbox (Ctxt : in out Format_Ctxt) is
begin
Ctxt.Hnum := Ctxt.Hnum - 1;
if Ctxt.Hnum = 0 then
Disp_Newline (Ctxt);
end if;
end Close_Hbox;
procedure Start_Vbox (Ctxt : in out Format_Ctxt) is
begin
pragma Assert (Ctxt.Hnum = 0);
Ctxt.Vnum := Ctxt.Vnum + 1;
end Start_Vbox;
procedure Close_Vbox (Ctxt : in out Format_Ctxt) is
begin
Ctxt.Vnum := Ctxt.Vnum - 1;
end Close_Vbox;
procedure Disp_Indent (Ctxt : in out Format_Ctxt) is
begin
for I in 1 .. Ctxt.Vnum loop
Put (Ctxt, ' ');
Put (Ctxt, ' ');
end loop;
end Disp_Indent;
procedure Disp_Space (Ctxt : in out Format_Ctxt; Tok : Token_Type)
is
Prev_Tok : constant Token_Type := Ctxt.Prev_Tok;
begin
if Prev_Tok = Tok_Newline
and then Ctxt.Hnum = 1
then
Disp_Indent (Ctxt);
elsif Need_Space (Tok, Prev_Tok) then
Put (Ctxt, ' ');
end if;
Ctxt.Prev_Tok := Tok;
end Disp_Space;
procedure Disp_Token (Ctxt : in out Format_Ctxt; Tok : Token_Type) is
begin
Sync (Ctxt, Tok);
Disp_Space (Ctxt, Tok);
Disp_Str (Ctxt, Image (Tok));
end Disp_Token;
procedure Start_Lit (Ctxt : in out Format_Ctxt; Tok : Token_Type) is
begin
Sync (Ctxt, Tok);
Disp_Space (Ctxt, Tok);
end Start_Lit;
procedure Disp_Char (Ctxt : in out Format_Ctxt; C : Character) is
begin
Put (Ctxt, C);
end Disp_Char;
procedure Close_Lit (Ctxt : in out Format_Ctxt) is
begin
null;
end Close_Lit;
procedure Sync (Ctxt : in out Format_Ctxt; Tok : Token_Type) is
begin
-- The easy case.
loop
case Current_Token is
when Tok_Eof =>
raise Internal_Error;
when Tok_Newline =>
-- Ignored
Scan;
-- But empty lines are kept.
while Current_Token = Tok_Newline loop
Disp_Newline (Ctxt);
Scan;
end loop;
when Tok_Line_Comment
| Tok_Block_Comment =>
-- Display the comment as it is.
declare
P : Source_Ptr;
begin
-- Re-indent the comment unless this is an end-of-line
-- comment or a comment at line 0.
if Ctxt.Prev_Tok = Tok_Newline then
-- Compute the offset. Not trivial for block
-- comment as this is a multi-line token and
-- Get_Token_Offset is not valid in that case.
declare
Off : Natural;
Line_Pos : Source_Ptr;
Line : Positive;
begin
if Current_Token = Tok_Block_Comment then
Files_Map.File_Pos_To_Coord
(Ctxt.Sfe, Get_Token_Position,
Line_Pos, Line, Off);
else
Off := Get_Token_Offset;
end if;
if Off /= 0 then
Disp_Indent (Ctxt);
end if;
end;
end if;
P := Get_Token_Position;
for I in 1 .. Get_Token_Length loop
Disp_Char (Ctxt, Ctxt.Source (P));
P := P + 1;
end loop;
end;
Scan;
while Current_Token = Tok_Newline loop
Disp_Newline (Ctxt);
Scan;
end loop;
when others =>
if Current_Token = Tok_Integer_Letter
and then Tok = Tok_Bit_String
then
Scan;
end if;
Check_Token (Tok);
Scan;
return;
end case;
end loop;
end Sync;
end Format_Disp_Ctxt;
procedure Format (F : Iir_Design_File)
is
use Format_Disp_Ctxt;
Sfe : constant Source_File_Entry := Get_Design_File_Source (F);
Ctxt : Format_Ctxt;
begin
Scanner.Flag_Comment := True;
Scanner.Flag_Newline := True;
Set_File (Sfe);
Scan;
Init (Ctxt, Sfe);
Prints.Disp_Vhdl (Ctxt, F);
end Format;
package Indent_Disp_Ctxt is
type Indent_Ctxt is new Disp_Ctxt with record
Vnum : Natural;
Hnum : Natural;
Hfirst : Boolean; -- First token in the hbox.
Prev_Tok : Token_Type;
Last_Tok : Source_Ptr;
Col : Natural;
Sfe : Source_File_Entry;
Source : File_Buffer_Acc;
end record;
procedure Init (Ctxt : out Indent_Ctxt; Sfe : Source_File_Entry);
procedure Start_Hbox (Ctxt : in out Indent_Ctxt);
procedure Close_Hbox (Ctxt : in out Indent_Ctxt);
procedure Start_Vbox (Ctxt : in out Indent_Ctxt);
procedure Close_Vbox (Ctxt : in out Indent_Ctxt);
procedure Disp_Token (Ctxt : in out Indent_Ctxt; Tok : Token_Type);
procedure Start_Lit (Ctxt : in out Indent_Ctxt; Tok : Token_Type);
procedure Disp_Char (Ctxt : in out Indent_Ctxt; C : Character) is null;
procedure Close_Lit (Ctxt : in out Indent_Ctxt) is null;
private
procedure Sync (Ctxt : in out Indent_Ctxt; Tok : Token_Type);
end Indent_Disp_Ctxt;
package body Indent_Disp_Ctxt is
procedure Init (Ctxt : out Indent_Ctxt; Sfe : Source_File_Entry) is
begin
Ctxt := (Vnum => 0,
Hnum => 0,
Hfirst => False,
Prev_Tok => Tok_Newline,
Last_Tok => Source_Ptr_Org,
Col => 0,
Sfe => Sfe,
Source => Files_Map.Get_File_Source (Sfe));
end Init;
procedure Disp_Spaces (Ctxt : in out Indent_Ctxt)
is
use Files_Map;
C : Character;
P : Source_Ptr;
N_Col : Natural;
Bef_Tok : Source_Ptr;
Indent : Natural;
begin
if Ctxt.Col = 0 then
-- Reindent.
Indent := Ctxt.Vnum;
if Ctxt.Hnum > 0 and not Ctxt.Hfirst then
Indent := Indent + 1;
end if;
for I in 1 .. Indent loop
Simple_IO.Put (" ");
end loop;
Ctxt.Col := 2 * Indent;
else
P := Ctxt.Last_Tok;
Bef_Tok := Get_Token_Position;
while P < Bef_Tok loop
C := Ctxt.Source (P);
if C = ASCII.HT then
-- Expand TABS.
N_Col := Ctxt.Col + Tab_Stop;
N_Col := N_Col - N_Col mod Tab_Stop;
while Ctxt.Col < N_Col loop
Simple_IO.Put (' ');
Ctxt.Col := Ctxt.Col + 1;
end loop;
else
Simple_IO.Put (' ');
Ctxt.Col := Ctxt.Col + 1;
end if;
P := P + 1;
end loop;
end if;
end Disp_Spaces;
-- Disp text for sources for the current token.
procedure Disp_Text (Ctxt : in out Indent_Ctxt)
is
Aft_Tok : constant Source_Ptr := Get_Position;
P : Source_Ptr;
begin
P := Get_Token_Position;
while P < Aft_Tok loop
Simple_IO.Put (Ctxt.Source (P));
Ctxt.Col := Ctxt.Col + 1;
P := P + 1;
end loop;
end Disp_Text;
procedure Disp_Comments (Ctxt : in out Indent_Ctxt) is
begin
loop
case Current_Token is
when Tok_Eof =>
raise Internal_Error;
when Tok_Newline =>
Simple_IO.New_Line;
Ctxt.Col := 0;
when Tok_Line_Comment
| Tok_Block_Comment =>
Disp_Spaces (Ctxt);
Disp_Text (Ctxt);
when others =>
exit;
end case;
Ctxt.Last_Tok := Get_Position;
Scan;
end loop;
end Disp_Comments;
procedure Start_Hbox (Ctxt : in out Indent_Ctxt) is
begin
Disp_Comments (Ctxt);
Ctxt.Hnum := Ctxt.Hnum + 1;
Ctxt.Hfirst := True;
end Start_Hbox;
procedure Close_Hbox (Ctxt : in out Indent_Ctxt) is
begin
-- An hbox cannot be empty.
pragma Assert (Ctxt.Hfirst = False);
Ctxt.Hnum := Ctxt.Hnum - 1;
end Close_Hbox;
procedure Start_Vbox (Ctxt : in out Indent_Ctxt) is
begin
pragma Assert (Ctxt.Hnum = 0);
Ctxt.Vnum := Ctxt.Vnum + 1;
end Start_Vbox;
procedure Close_Vbox (Ctxt : in out Indent_Ctxt) is
begin
Ctxt.Vnum := Ctxt.Vnum - 1;
end Close_Vbox;
procedure Sync (Ctxt : in out Indent_Ctxt; Tok : Token_Type) is
begin
Disp_Comments (Ctxt);
Disp_Spaces (Ctxt);
Disp_Text (Ctxt);
if Current_Token = Tok_Integer_Letter
and then Tok = Tok_Bit_String
then
Scan;
Disp_Text (Ctxt);
end if;
Check_Token (Tok);
Ctxt.Last_Tok := Get_Position;
Ctxt.Hfirst := False;
Scan;
end Sync;
procedure Disp_Token (Ctxt : in out Indent_Ctxt; Tok : Token_Type) is
begin
Sync (Ctxt, Tok);
end Disp_Token;
procedure Start_Lit (Ctxt : in out Indent_Ctxt; Tok : Token_Type) is
begin
Sync (Ctxt, Tok);
end Start_Lit;
end Indent_Disp_Ctxt;
procedure Indent (F : Iir_Design_File)
is
use Indent_Disp_Ctxt;
Sfe : constant Source_File_Entry := Get_Design_File_Source (F);
Ctxt : Indent_Ctxt;
begin
Scanner.Flag_Comment := True;
Scanner.Flag_Newline := True;
Set_File (Sfe);
Scan;
Init (Ctxt, Sfe);
Prints.Disp_Vhdl (Ctxt, F);
end Indent;
end Vhdl.Formatters;
|