1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2003, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 2, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING. If not, write --
19 -- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
20 -- MA 02111-1307, USA. --
22 -- GNAT was originally developed by the GNAT team at New York University. --
23 -- Extensive contributions were provided by Ada Core Technologies Inc. --
25 ------------------------------------------------------------------------------
28 with Debug; use Debug;
31 with Namet; use Namet;
33 with Osint; use Osint;
35 with Widechar; use Widechar;
39 package body Fname.UF is
41 --------------------------------------------------------
42 -- Declarations for Handling Source_File_Name pragmas --
43 --------------------------------------------------------
45 type SFN_Entry is record
46 U : Unit_Name_Type; -- Unit name
47 F : File_Name_Type; -- Spec/Body file name
49 -- Record single Unit_Name type call to Set_File_Name
51 package SFN_Table is new Table.Table (
52 Table_Component_Type => SFN_Entry,
53 Table_Index_Type => Int,
55 Table_Initial => Alloc.SFN_Table_Initial,
56 Table_Increment => Alloc.SFN_Table_Increment,
57 Table_Name => "SFN_Table");
58 -- Table recording all Unit_Name calls to Set_File_Name
60 type SFN_Header_Num is range 0 .. 100;
62 function SFN_Hash (F : Unit_Name_Type) return SFN_Header_Num;
63 -- Compute hash index for use by Simple_HTable
65 No_Entry : constant Int := -1;
66 -- Signals no entry in following table
68 package SFN_HTable is new GNAT.HTable.Simple_HTable (
69 Header_Num => SFN_Header_Num,
71 No_Element => No_Entry,
72 Key => Unit_Name_Type,
75 -- Hash table allowing rapid access to SFN_Table, the element value
76 -- is an index into this table.
78 type SFN_Pattern_Entry is record
79 Pat : String_Ptr; -- File name pattern (with asterisk in it)
80 Typ : Character; -- 'S'/'B'/'U' for spec/body/subunit
81 Dot : String_Ptr; -- Dot_Separator string
82 Cas : Casing_Type; -- Upper/Lower/Mixed
84 -- Records single call to Set_File_Name_Patterm
86 package SFN_Patterns is new Table.Table (
87 Table_Component_Type => SFN_Pattern_Entry,
88 Table_Index_Type => Int,
91 Table_Increment => 100,
92 Table_Name => "SFN_Patterns");
93 -- Table recording all calls to Set_File_Name_Pattern. Note that the
94 -- first two entries are set to represent the standard GNAT rules
97 -----------------------
98 -- File_Name_Of_Body --
99 -----------------------
101 function File_Name_Of_Body (Name : Name_Id) return File_Name_Type is
103 Get_Name_String (Name);
104 Name_Buffer (Name_Len + 1 .. Name_Len + 2) := "%b";
105 Name_Len := Name_Len + 2;
106 return Get_File_Name (Name_Enter, Subunit => False);
107 end File_Name_Of_Body;
109 -----------------------
110 -- File_Name_Of_Spec --
111 -----------------------
113 function File_Name_Of_Spec (Name : Name_Id) return File_Name_Type is
115 Get_Name_String (Name);
116 Name_Buffer (Name_Len + 1 .. Name_Len + 2) := "%s";
117 Name_Len := Name_Len + 2;
118 return Get_File_Name (Name_Enter, Subunit => False);
119 end File_Name_Of_Spec;
125 function Get_File_Name
126 (Uname : Unit_Name_Type;
127 Subunit : Boolean) return File_Name_Type
129 Unit_Char : Character;
130 -- Set to 's' or 'b' for spec or body or to 'u' for a subunit
132 Unit_Char_Search : Character;
133 -- Same as Unit_Char, except that in the case of 'u' for a subunit,
134 -- we set Unit_Char_Search to 'b' if we do not find a subunit match.
138 Pname : File_Name_Type := No_File;
139 Fname : File_Name_Type := No_File;
140 -- Path name and File name for mapping
143 -- Null or error name means that some previous error occurred
144 -- This is an unrecoverable error, so signal it.
146 if Uname <= Error_Name then
147 raise Unrecoverable_Error;
150 -- Look in the map from unit names to file names
152 Fname := Mapped_File_Name (Uname);
154 -- If the unit name is already mapped, return the corresponding
155 -- file name from the map.
157 if Fname /= No_File then
161 -- If there is a specific SFN pragma, return the corresponding file name
163 N := SFN_HTable.Get (Uname);
165 if N /= No_Entry then
166 return SFN_Table.Table (N).F;
169 -- Here for the case where the name was not found in the table
171 Get_Decoded_Name_String (Uname);
173 -- A special fudge, normally we don't have operator symbols present,
174 -- since it is always an error to do so. However, if we do, at this
175 -- stage it has a leading double quote.
177 -- What we do in this case is to go back to the undecoded name, which
178 -- is of the form, for example:
182 -- and build a file name that looks like:
186 -- which is bit peculiar, but we keep it that way. This means that
187 -- we avoid bombs due to writing a bad file name, and w get expected
188 -- error processing downstream, e.g. a compilation following gnatchop.
190 if Name_Buffer (1) = '"' then
191 Get_Name_String (Uname);
192 Name_Len := Name_Len + 1;
193 Name_Buffer (Name_Len) := Name_Buffer (Name_Len - 1);
194 Name_Buffer (Name_Len - 1) := Name_Buffer (Name_Len - 2);
195 Name_Buffer (Name_Len - 2) := '_';
196 Name_Buffer (1) := '_';
199 -- Deal with spec or body suffix
201 Unit_Char := Name_Buffer (Name_Len);
202 pragma Assert (Unit_Char = 'b' or else Unit_Char = 's');
203 pragma Assert (Name_Len >= 3 and then Name_Buffer (Name_Len - 1) = '%');
204 Name_Len := Name_Len - 2;
210 -- Now we need to find the proper translation of the name
213 Uname : constant String (1 .. Name_Len) :=
214 Name_Buffer (1 .. Name_Len);
218 Fnam : File_Name_Type := No_File;
224 -- Set True for predefined file
226 function C (N : Natural) return Character;
227 -- Return N'th character of pattern
229 function C (N : Natural) return Character is
231 return SFN_Patterns.Table (Pent).Pat (N);
234 -- Start of search through pattern table
237 -- Search pattern table to find a matching entry. In the general
238 -- case we do two complete searches. The first time through we
239 -- stop only if a matching file is found, the second time through
240 -- we accept the first match regardless. Note that there will
241 -- always be a match the second time around, because of the
242 -- default entries at the end of the table.
244 for No_File_Check in False .. True loop
245 Unit_Char_Search := Unit_Char;
248 -- The search is repeated with Unit_Char_Search set to b, if an
249 -- initial search for the subunit case fails to find any match.
251 Pent := SFN_Patterns.First;
252 while Pent <= SFN_Patterns.Last loop
253 if SFN_Patterns.Table (Pent).Typ = Unit_Char_Search then
256 -- Determine if we have a predefined file name
258 Name_Len := Uname'Length;
259 Name_Buffer (1 .. Name_Len) := Uname;
261 Is_Predefined_File_Name (Renamings_Included => True);
263 -- Found a match, execute the pattern
265 Name_Len := Uname'Length;
266 Name_Buffer (1 .. Name_Len) := Uname;
268 -- Apply casing, except that we do not do this for the case
269 -- of a predefined library file. For the latter, we always
270 -- use the all lower case name, regardless of the setting.
272 if not Is_Predef then
273 Set_Casing (SFN_Patterns.Table (Pent).Cas);
276 -- If dot translation required do it
278 Dot := SFN_Patterns.Table (Pent).Dot;
279 Dotl := Dot.all'Length;
281 if Dot.all /= "." then
284 while J <= Name_Len loop
285 if Name_Buffer (J) = '.' then
288 Name_Buffer (J) := Dot (Dot'First);
291 Name_Buffer (J + Dotl .. Name_Len + Dotl - 1) :=
292 Name_Buffer (J + 1 .. Name_Len);
293 Name_Buffer (J .. J + Dotl - 1) := Dot.all;
294 Name_Len := Name_Len + Dotl - 1;
299 -- Skip past wide char sequences to avoid messing
300 -- with dot characters that are part of a sequence.
302 elsif Name_Buffer (J) = ASCII.ESC
303 or else (Upper_Half_Encoding
305 Name_Buffer (J) in Upper_Half_Character)
307 Skip_Wide (Name_Buffer, J);
314 -- Here move result to right if preinsertion before *
316 Plen := SFN_Patterns.Table (Pent).Pat'Length;
317 for K in 1 .. Plen loop
320 Name_Buffer (1 + K - 1 .. Name_Len + K - 1) :=
321 Name_Buffer (1 .. Name_Len);
323 for L in 1 .. K - 1 loop
324 Name_Buffer (L) := C (L);
327 Name_Len := Name_Len + K - 1;
330 for L in K + 1 .. Plen loop
331 Name_Len := Name_Len + 1;
332 Name_Buffer (Name_Len) := C (L);
339 -- Execute possible crunch on constructed name. The krunch
340 -- operation excludes any extension that may be present.
344 exit when Name_Buffer (J) = '.';
348 -- Case of extension present
352 Ext : constant String := Name_Buffer (J .. Name_Len);
359 -- Krunch what's left
364 Integer (Maximum_File_Name_Length),
370 (Name_Len + 1 .. Name_Len + Ext'Length) := Ext;
371 Name_Len := Name_Len + Ext'Length;
374 -- Case of no extension present, straight krunch on
375 -- the entire file name.
381 Integer (Maximum_File_Name_Length),
385 Fnam := File_Name_Type (Name_Find);
387 -- If we are in the second search of the table, we accept
388 -- the file name without checking, because we know that
389 -- the file does not exist.
391 if No_File_Check then
394 -- Otherwise we check if the file exists
397 Pname := Find_File (Fnam, Source);
399 -- If it does exist, we add it to the mappings and
400 -- return the file name.
402 if Pname /= No_File then
404 -- Add to mapping, so that we don't do another
405 -- path search in Find_File for this file name
406 -- and, if we use a mapping file, we are ready
407 -- to update it at the end of this compilation
408 -- for the benefit of other compilation processes.
410 Add_To_File_Map (Get_File_Name.Uname, Fnam, Pname);
413 -- If there are only two entries, they are those of
414 -- the default GNAT naming scheme. The file does
415 -- not exist, but there is no point doing the
416 -- second search, because we will end up with the
417 -- same file name. Just return the file name.
419 elsif SFN_Patterns.Last = 2 then
422 -- The file does not exist, but there may be other
423 -- naming scheme. Keep on searching.
434 -- If search failed, and was for a subunit, repeat the search
435 -- with Unit_Char_Search reset to 'b', since in the normal case
436 -- we simply treat subunits as bodies.
438 if Fnam = No_File and then Unit_Char_Search = 'u' then
439 Unit_Char_Search := 'b';
443 -- Repeat entire search in No_File_Check mode if necessary
447 -- Something is wrong if search fails completely, since the
448 -- default entries should catch all possibilities at this stage.
458 procedure Initialize is
463 -- Add default entries to SFN_Patterns.Table to represent the
464 -- standard default GNAT rules for file name translation.
466 SFN_Patterns.Append (New_Val =>
467 (Pat => new String'("*.ads"),
469 Dot => new String'("-"),
470 Cas => All_Lower_Case));
472 SFN_Patterns.Append (New_Val =>
473 (Pat => new String'("*.adb"),
475 Dot => new String'("-"),
476 Cas => All_Lower_Case));
485 SFN_Table.Locked := True;
493 procedure Set_File_Name (U : Unit_Name_Type; F : File_Name_Type) is
495 SFN_Table.Increment_Last;
496 SFN_Table.Table (SFN_Table.Last) := (U, F);
497 SFN_HTable.Set (U, SFN_Table.Last);
500 ---------------------------
501 -- Set_File_Name_Pattern --
502 ---------------------------
504 procedure Set_File_Name_Pattern
510 L : constant Nat := SFN_Patterns.Last;
512 SFN_Patterns.Increment_Last;
514 -- Move up the last two entries (the default ones) and then
515 -- put the new entry into the table just before them (we
516 -- always have the default entries be the last ones).
518 SFN_Patterns.Table (L + 1) := SFN_Patterns.Table (L);
519 SFN_Patterns.Table (L) := SFN_Patterns.Table (L - 1);
520 SFN_Patterns.Table (L - 1) := (Pat, Typ, Dot, Cas);
521 end Set_File_Name_Pattern;
527 function SFN_Hash (F : Unit_Name_Type) return SFN_Header_Num is
529 return SFN_Header_Num (Int (F) rem SFN_Header_Num'Range_Length);
534 -- We call the initialization routine from the package body, so that
535 -- Fname.Init only needs to be called explicitly to reinitialize.