summaryrefslogtreecommitdiff
path: root/gcc/ada/prj-conf.ads
diff options
context:
space:
mode:
authorcharlet <charlet@138bc75d-0d04-0410-961f-82ee72b054a4>2009-06-23 09:30:59 +0000
committercharlet <charlet@138bc75d-0d04-0410-961f-82ee72b054a4>2009-06-23 09:30:59 +0000
commitb5601373463f367410d177c6e466e339b3d932ac (patch)
treee3a126bf326b9b39704593163279da9adcebd89e /gcc/ada/prj-conf.ads
parenteb8ca1ee508341fe82f7a892b70414a93ca6dde1 (diff)
downloadgcc-b5601373463f367410d177c6e466e339b3d932ac.tar.gz
2009-06-23 Emmanuel Briot <briot@adacore.com>
* prj-conf.ads, prj-conf.adb: New files part of the project manager. git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@148835 138bc75d-0d04-0410-961f-82ee72b054a4
Diffstat (limited to 'gcc/ada/prj-conf.ads')
-rw-r--r--gcc/ada/prj-conf.ads140
1 files changed, 140 insertions, 0 deletions
diff --git a/gcc/ada/prj-conf.ads b/gcc/ada/prj-conf.ads
new file mode 100644
index 00000000000..773e3ba680a
--- /dev/null
+++ b/gcc/ada/prj-conf.ads
@@ -0,0 +1,140 @@
+------------------------------------------------------------------------------
+-- --
+-- GNAT COMPILER COMPONENTS --
+-- --
+-- P R J . C O N F --
+-- --
+-- S p e c --
+-- --
+-- Copyright (C) 2006-2009, Free Software Foundation, Inc. --
+-- --
+-- GNAT is free software; you can redistribute it and/or modify it under --
+-- terms of the GNU General Public License as published by the Free Soft- --
+-- ware Foundation; either version 2, or (at your option) any later ver- --
+-- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
+-- OUT 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 distributed with GNAT; see file COPYING. If not, write --
+-- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
+-- Boston, MA 02110-1301, USA. --
+-- --
+-- GNAT was originally developed by the GNAT team at New York University. --
+-- Extensive contributions were provided by Ada Core Technologies Inc. --
+-- --
+------------------------------------------------------------------------------
+
+-- The following package manipulates the configuration files.
+
+with Prj.Tree;
+
+package Prj.Conf is
+
+ type Config_File_Hook is access procedure
+ (Config_File : Prj.Project_Id;
+ Project_Tree : Prj.Project_Tree_Ref);
+ -- Hook called after the config file has been parsed. This lets the
+ -- application do last minute changes to it (GPS uses this to add the
+ -- default naming schemes for instance). At that point, the config file has
+ -- not been applied to the project yet.
+
+ procedure Parse_Project_And_Apply_Config
+ (Main_Project : out Prj.Project_Id;
+ User_Project_Node : out Prj.Tree.Project_Node_Id;
+ Config_File_Name : String := "";
+ Autoconf_Specified : Boolean;
+ Project_File_Name : String;
+ Project_Tree : Prj.Project_Tree_Ref;
+ Project_Node_Tree : Prj.Tree.Project_Node_Tree_Ref;
+ Packages_To_Check : String_List_Access;
+ Allow_Automatic_Generation : Boolean := True;
+ Automatically_Generated : out Boolean;
+ Config_File_Path : out String_Access;
+ Target_Name : String := "";
+ Normalized_Hostname : String;
+ On_Load_Config : Config_File_Hook := null);
+ -- Find the main configuration project and parse the project tree rooted at
+ -- this configuration project.
+ -- If the processing fails, Main_Project is set to No_Project. If the error
+ -- happend while parsing the project itself (ie creating the tree),
+ -- User_Project_Node is also set to Empty_Node
+ --
+ -- Autoconf_Specified indicates whether the user has specified --autoconf.
+ -- If this is the case, the config file might be (re)generated, as
+ -- appropriate, to match languages and target if the one specified doesn't
+ -- already match.
+ -- Normalized_Hostname is the host on which gprbuild is returned,
+ -- normalized so that we can more easily compare it with what is stored in
+ -- configuration files. It is used when the target is unspecified, although
+ -- we need to know the target specified by the user (Target_Name) when
+ -- computing the name of the default config file that should be used.
+ --
+ -- If specified, On_Load_Config is called just after the config file has
+ -- been created/loaded. You can then modify it before it is later applied
+ -- to the project itself.
+
+ procedure Get_Or_Create_Configuration_File
+ (Project : Prj.Project_Id;
+ Project_Tree : Prj.Project_Tree_Ref;
+ Project_Node_Tree : Prj.Tree.Project_Node_Tree_Ref;
+ Allow_Automatic_Generation : Boolean;
+ Config_File_Name : String := "";
+ Autoconf_Specified : Boolean;
+ Target_Name : String := "";
+ Normalized_Hostname : String;
+ Packages_To_Check : String_List_Access := null;
+ Config : out Prj.Project_Id;
+ Config_File_Path : out String_Access;
+ Automatically_Generated : out Boolean);
+ -- Compute the name of the configuration file that should be used. If no
+ -- default configuration file is found, a new one will be automatically
+ -- generated if Allow_Automatic_Generation is true (otherwise an error
+ -- reported to the user via Osint.Fail).
+ -- On exit, Configuration_Project_Path is never null (if none could be
+ -- found, Os.Fail was called and the program exited anyway).
+ -- The choice and generation of a configuration file depends on several
+ -- attributes of the user's project file (given by the Project argument),
+ -- like the list of languages that must be supported. Project must
+ -- therefore have been partially processed (phase one of the processing
+ -- only).
+ -- Config_File_Name should be set to the name of the config file specified
+ -- by the user (either through gprbuild's --config or --autoconf switches).
+ -- In the latter case, Autoconf_Specified should be set to true, to
+ -- indicate that the configuration file can be regenerated to match target
+ -- and languages. This name can either be an absolute path, or the a base
+ -- name that will be searched in the default config file directories (which
+ -- depends on the installation path for the tools).
+ -- Target_Name is used to chose among several possibilities
+ -- the configuration file that will be used.
+ --
+ -- If a project file could be found, it is automatically parsed and
+ -- processed (and Packages_To_Check is used to indicate which packages
+ -- should be processed)
+
+ procedure Apply_Config_File
+ (Config_File : Prj.Project_Id;
+ Project_Tree : Prj.Project_Tree_Ref);
+ -- Apply the configuration file settings to all the projects in the
+ -- project tree. The Project_Tree must have been parsed first, and
+ -- processed through the first phase so that all its projects are known.
+ --
+ -- Currently, this will add new attributes and packages in the various
+ -- projects, so that when the second phase of the processing is performed
+ -- these attributes are automatically taken into account.
+
+ --------------
+ -- Runtimes --
+ --------------
+
+ procedure Set_Runtime_For (Language : Name_Id; RTS_Name : String);
+ -- Specifies the runtime to use for a specific language. Most of the time
+ -- this should be used for Ada, but other languages can also specify their
+ -- own runtime. This is in general specified via the --RTS command line
+ -- switch, and results in a specific component passed to gprconfig's
+ -- --config switch then automatically generating a configuration file.
+
+ function Runtime_Name_For (Language : Name_Id) return String;
+ -- Returns the runtime name for a language. Returns an empty string if
+ -- no runtime was specified for the language using option --RTS.
+
+end Prj.Conf;