1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 2003-2006, 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, 51 Franklin Street, Fifth Floor, --
20 -- Boston, MA 02110-1301, 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 ------------------------------------------------------------------------------
27 -- This utility application creates symbol files in a format that is
28 -- platform-dependent.
30 -- A symbol file is a text file that lists the symbols to be exported from
31 -- a shared library. The format of a symbol file depends on the platform;
32 -- it may be a simple enumeration of the symbol (one per line) or a more
33 -- elaborate format (on VMS, for example). A symbol file may be used as an
34 -- input to the platform linker when building a shared library.
36 -- This utility is not available on all platforms. It is currently supported
39 -- gnatsym takes as parameters:
40 -- - the name of the symbol file to create
41 -- - (optional) the policy to create the symbol file
42 -- - (optional) the name of the reference symbol file
43 -- - the names of one or more object files where the symbols are found
45 with GNAT
.Command_Line
; use GNAT
.Command_Line
;
46 with GNAT
.OS_Lib
; use GNAT
.OS_Lib
;
48 with Gnatvsn
; use Gnatvsn
;
49 with Osint
; use Osint
;
50 with Output
; use Output
;
52 with Symbols
; use Symbols
;
57 Empty_String
: aliased String := "";
58 Empty
: constant String_Access
:= Empty_String
'Unchecked_Access;
59 -- To initialize variables Reference and Version_String
61 Copyright_Displayed
: Boolean := False;
62 -- A flag to prevent multiple display of the Copyright notice
64 Success
: Boolean := True;
66 Symbol_Policy
: Policy
:= Autonomous
;
68 Verbose
: Boolean := False;
69 -- True when -v switch is used
71 Quiet
: Boolean := False;
72 -- True when -q switch is used
74 Symbol_File_Name
: String_Access
:= null;
75 -- The name of the symbol file
77 Reference_Symbol_File_Name
: String_Access
:= Empty
;
78 -- The name of the reference symbol file
80 Version_String
: String_Access
:= Empty
;
81 -- The version of the library (used on VMS)
83 package Object_Files
is new Table
.Table
84 (Table_Component_Type
=> String_Access
,
85 Table_Index_Type
=> Natural,
88 Table_Increment
=> 100,
89 Table_Name
=> "Gnatsymb.Object_Files");
90 -- A table to store the object file names
92 Object_File
: Natural := 0;
93 -- An index to traverse the Object_Files table
95 procedure Display_Copyright
;
96 -- Display Copyright notice
98 procedure Parse_Cmd_Line
;
99 -- Parse the command line switches and file names
104 -----------------------
105 -- Display_Copyright --
106 -----------------------
108 procedure Display_Copyright
is
110 if not Copyright_Displayed
then
112 Write_Str
("GNATSYMB ");
113 Write_Str
(Gnat_Version_String
);
115 Write_Str
("Copyright 2003-2004 Free Software Foundation, Inc");
117 Copyright_Displayed
:= True;
119 end Display_Copyright
;
125 procedure Parse_Cmd_Line
is
128 case GNAT
.Command_Line
.Getopt
("c C q r: R s: v V:") is
133 Symbol_Policy
:= Compliant
;
136 Symbol_Policy
:= Controlled
;
142 Reference_Symbol_File_Name
:=
143 new String'(GNAT.Command_Line.Parameter);
146 Symbol_Policy := Restricted;
149 Symbol_File_Name := new String'(GNAT
.Command_Line
.Parameter
);
155 Version_String
:= new String'(GNAT.Command_Line.Parameter);
158 Fail ("invalid switch: ", Full_Switch);
162 -- Get the file names
166 S : constant String_Access :=
167 new String'(GNAT
.Command_Line
.Get_Argument
);
170 exit when S
'Length = 0;
172 Object_Files
.Increment_Last
;
173 Object_Files
.Table
(Object_Files
.Last
) := S
;
177 when Invalid_Switch
=>
179 Fail
("invalid switch : ", Full_Switch
);
188 Write_Line
("gnatsym [options] object_file {object_file}");
190 Write_Line
(" -c Compliant symbol policy");
191 Write_Line
(" -C Controlled symbol policy");
192 Write_Line
(" -q Quiet mode");
193 Write_Line
(" -r<ref> Reference symbol file name");
194 Write_Line
(" -R Restricted symbol policy");
195 Write_Line
(" -s<sym> Symbol file name");
196 Write_Line
(" -v Verbose mode");
197 Write_Line
(" -V<ver> Version");
199 Write_Line
("Specifying a symbol file with -s<sym> is compulsory");
203 -- Start of processing of Gnatsym
206 -- Initialize Object_Files table
208 Object_Files
.Set_Last
(0);
210 -- Parse the command line
218 -- If there is no symbol file or no object files on the command line,
219 -- display the usage and exit with an error status.
221 if Symbol_File_Name
= null or else Object_Files
.Last
= 0 then
227 Write_Str
("Initializing symbol file """);
228 Write_Str
(Symbol_File_Name
.all);
232 -- Initialize symbol file and, if specified, read reference file
235 (Symbol_File
=> Symbol_File_Name
.all,
236 Reference
=> Reference_Symbol_File_Name
.all,
237 Symbol_Policy
=> Symbol_Policy
,
239 Version
=> Version_String
.all,
242 -- Process the object files in order. Stop as soon as there is
247 while Success
and then Object_File
< Object_Files
.Last
loop
248 Object_File
:= Object_File
+ 1;
251 Write_Str
("Processing object file """);
252 Write_Str
(Object_Files
.Table
(Object_File
).all);
256 Processing
.Process
(Object_Files
.Table
(Object_File
).all, Success
);
259 -- Finalize the object file
263 Write_Str
("Finalizing """);
264 Write_Str
(Symbol_File_Name
.all);
268 Finalize
(Quiet
, Success
);
271 -- Fail if there was anything wrong
274 Fail
("unable to build symbol file");