OSDN Git Service

2009-08-28 Sebastian Pop <sebastian.pop@amd.com>
[pf3gnuchains/gcc-fork.git] / gcc / ada / prj-makr.ads
index 868e9a9..91543a2 100644 (file)
@@ -6,58 +6,83 @@
 --                                                                          --
 --                                 S p e c                                  --
 --                                                                          --
---             Copyright (C) 2001-2002 Free Software Foundation, Inc.       --
+--          Copyright (C) 2001-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- --
+-- ware  Foundation;  either version 3,  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,  59 Temple Place - Suite 330,  Boston, --
--- MA 02111-1307, USA.                                                      --
+-- Public License  distributed with GNAT; see file COPYING3.  If not, go to --
+-- http://www.gnu.org/licenses for a complete copy of the license.          --
 --                                                                          --
 -- GNAT was originally developed  by the GNAT team at  New York University. --
 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
 --                                                                          --
 ------------------------------------------------------------------------------
 
---  Support for procedure Gnatname.
+--  Support for procedure Gnatname
 
---  For arbitrary naming schemes, create or update a project file,
---  or create a configuration pragmas file.
+--  For arbitrary naming schemes, create or update a project file, or create a
+--  configuration pragmas file.
 
-with GNAT.OS_Lib; use GNAT.OS_Lib;
+with System.Regexp; use System.Regexp;
 
 package Prj.Makr is
 
-   procedure Make
+   procedure Initialize
      (File_Path         : String;
       Project_File      : Boolean;
-      Directories       : Argument_List;
-      Name_Patterns     : Argument_List;
-      Excluded_Patterns : Argument_List;
-      Very_Verbose      : Boolean);
-   --  Create a project file or a configuration pragmas file
-   --
-   --  Project_File is the path name of the project file. If the project
-   --  file already exists parse it and keep all the elements that are not
-   --  automatically generated.
-   --
-   --  Directory_List_File is the path name of a text file that
-   --  contains on each non empty line the path names of the source
-   --  directories for the project file. The source directories
-   --  are relative to the directory of the project file.
-   --
-   --  File_Name_Patterns is a GNAT.Regexp string pattern such as
-   --  ".*\.ads|.*\.adb" or any other pattern.
-   --
-   --  A project file (without any sources) is automatically generated
-   --  with the name <project>_naming. It contains a package Naming with
-   --  all the specs and bodies for the project.
-   --  A file containing the source file names is automatically
-   --  generated and used as the Source_File_List for the project file.
+      Preproc_Switches  : Argument_List;
+      Very_Verbose      : Boolean;
+      Flags             : Processing_Flags);
+   --  Start the creation of a configuration pragmas file or the creation or
+   --  modification of a project file, for gnatname.
+   --
+   --  When Project_File is False, File_Path is the name of a configuration
+   --  pragmas file to create. When Project_File is True, File_Path is the name
+   --  of a project file to create if it does not exist or to modify if it
+   --  already exists.
+   --
+   --  Preproc_Switches is a list of switches to be used when invoking the
+   --  compiler to get the name and kind of unit of a source file.
+   --
+   --  Very_Verbose controls the verbosity of the output, in conjunction with
+   --  Opt.Verbose_Mode.
+
+   type Regexp_List is array (Positive range <>) of Regexp;
+
+   procedure Process
+     (Directories       : Argument_List;
+      Name_Patterns     : Regexp_List;
+      Excluded_Patterns : Regexp_List;
+      Foreign_Patterns  : Regexp_List);
+   --  Look for source files in the specified directories, with the specified
+   --  patterns.
+   --
+   --  Directories is the list of source directories where to look for sources.
+   --
+   --  Name_Patterns is a potentially empty list of file name patterns to check
+   --  for Ada Sources.
+   --
+   --  Excluded_Patterns is a potentially empty list of file name patterns that
+   --  should not be checked for Ada or non Ada sources.
+   --
+   --  Foreign_Patterns is a potentially empty list of file name patterns to
+   --  check for non Ada sources.
+   --
+   --  At least one of Name_Patterns and Foreign_Patterns is not empty
+   --
+   --  Note that this procedure currently assumes that it is only used by
+   --  gnatname. If other processes start using it, then an additional
+   --  parameter would need to be added, and call to Osint.Program_Name
+   --  updated accordingly in the body.
+
+   procedure Finalize;
+   --  Write the configuration pragmas file or the project file indicated in a
+   --  call to procedure Initialize, after one or several calls to procedure
+   --  Process.
 
 end Prj.Makr;