1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 2001-2005, Ada Core Technologies, 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 package provides a set of target dependent routines to build
28 -- static, dynamic and shared libraries.
30 -- There are several versions for the body of this package
32 -- In the default version, libraries are not supported, so function
33 -- Support_For_Libraries return None.
39 type Library_Support
is (None
, Static_Only
, Full
);
40 -- Support for Library Project File.
41 -- - None: Library Project Files are not supported at all
42 -- - Static_Only: Library Project Files are only supported for static
44 -- - Full: Library Project Files are supported for static and dynamic
45 -- (shared) libraries.
47 function Support_For_Libraries
return Library_Support
;
48 -- Indicates how building libraries by gnatmake is supported by the GNAT
49 -- implementation for the platform.
51 function Standalone_Library_Auto_Init_Is_Supported
return Boolean;
52 -- Indicates if when building a dynamic Standalone Library,
53 -- automatic initialization is supported. If it is, then it is the default,
54 -- unless attribute Library_Auto_Init has the value "false".
56 function Archive_Builder
return String;
57 -- Returns the name of the archive builder program, usually "ar"
59 function Archive_Builder_Options
return String_List_Access
;
60 -- A list of options to invoke the Archive_Builder, usually "cr" for "ar"
62 function Archive_Indexer
return String;
63 -- Returns the name of the program, if any, that generates an index to the
64 -- contents of an archive, usually "ranlib". If there is no archive indexer
65 -- to be used, returns an empty string.
67 function Archive_Indexer_Options
return String_List_Access
;
68 -- A list of options to invoke the Archive_Indexer, usually empty
70 function Dynamic_Option
return String;
71 -- gcc option to create a dynamic library.
72 -- For Unix, returns "-shared", for Windows returns "-mdll".
74 function Libgnat
return String;
75 -- System dependent static GNAT library
77 function Archive_Ext
return String;
78 -- System dependent static library extension, without leading dot.
79 -- For Unix and Windows, return "a".
81 function Object_Ext
return String;
82 -- System dependent object extension, without leadien dot.
83 -- On Unix, returns "o".
85 function DLL_Ext
return String;
86 -- System dependent dynamic library extension, without leading dot.
87 -- On Windows, returns "dll". On Unix, usually returns "so", but not
88 -- always, e.g. on HP-UX the extension for shared libraries is "sl".
90 function PIC_Option
return String;
91 -- Position independent code option
93 function Is_Object_Ext
(Ext
: String) return Boolean;
94 -- Returns True iff Ext is an object file extension
96 function Is_C_Ext
(Ext
: String) return Boolean;
97 -- Returns True iff Ext is a C file extension
99 function Is_Archive_Ext
(Ext
: String) return Boolean;
100 -- Returns True iff Ext is an extension for a library
102 procedure Build_Dynamic_Library
103 (Ofiles
: Argument_List
;
104 Foreign
: Argument_List
;
105 Afiles
: Argument_List
;
106 Options
: Argument_List
;
107 Options_2
: Argument_List
;
108 Interfaces
: Argument_List
;
109 Lib_Filename
: String;
111 Symbol_Data
: Symbol_Record
;
112 Driver_Name
: Name_Id
:= No_Name
;
113 Lib_Version
: String := "";
114 Auto_Init
: Boolean := False);
115 -- Build a dynamic/relocatable library
117 -- Ofiles is the list of all object files in the library
119 -- Foreign is the list of non Ada object files (also included in Ofiles)
121 -- Afiles is the list of ALI files for the Ada object files
123 -- Options and Options_2 are lists of options to be passed to the tool
124 -- (gcc or other) that effectively builds the dynamic library. Options
125 -- are passed before the object files, Options_2 are passed after the
128 -- Interfaces is the list of ALI files for the interfaces of a SAL.
129 -- It is empty if the library is not a SAL.
131 -- Lib_Filename is the name of the library, without any prefix or
132 -- extension. For example, on Unix, if Lib_Filename is "toto", the
133 -- name of the library file will be "libtoto.so".
135 -- Lib_Dir is the directory path where the library will be located
137 -- For OSes that support symbolic links, Lib_Version, if non null,
138 -- is the actual file name of the library. For example on Unix, if
139 -- Lib_Filename is "toto" and Lib_Version is "libtoto.so.2.1",
140 -- "libtoto.so" will be a symbolic link to "libtoto.so.2.1" which
141 -- will be the actual library file.
143 -- Symbol_Data is used for some patforms, including VMS, to generate
144 -- the symbols to be exported by the library.
146 -- Note: Depending on the OS, some of the parameters may not be taken
147 -- into account. For example, on Linux, Foreign, Afiles Lib_Address and
148 -- Relocatable are ignored.
150 function Library_Exists_For
151 (Project
: Project_Id
; In_Tree
: Project_Tree_Ref
) return Boolean;
152 -- Return True if the library file for a library project already exists.
153 -- This function can only be called for library projects.
155 function Library_File_Name_For
156 (Project
: Project_Id
;
157 In_Tree
: Project_Tree_Ref
) return Name_Id
;
158 -- Returns the file name of the library file of a library project.
159 -- This function can only be called for library projects.