OSDN Git Service

* gcc-interface/ada-tree.h (SET_TYPE_RM_VALUE): Mark the expression
[pf3gnuchains/gcc-fork.git] / gcc / ada / a-comlin.ads
index b7848e7..a0335a4 100644 (file)
@@ -6,9 +6,7 @@
 --                                                                          --
 --                                 S p e c                                  --
 --                                                                          --
---                            $Revision: 1.12 $
---                                                                          --
---          Copyright (C) 1992-2001 Free Software Foundation, Inc.          --
+--          Copyright (C) 1992-2009, Free Software Foundation, Inc.         --
 --                                                                          --
 -- This specification is derived from the Ada Reference Manual for use with --
 -- GNAT. The copyright notice above, and the license provisions that follow --
 --                                                                          --
 -- 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.                                                      --
+-- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
+--                                                                          --
+-- As a special exception under Section 7 of GPL version 3, you are granted --
+-- additional permissions described in the GCC Runtime Library Exception,   --
+-- version 3.1, as published by the Free Software Foundation.               --
 --                                                                          --
--- As a special exception,  if other files  instantiate  generics from this --
--- unit, or you link  this unit with other files  to produce an executable, --
--- this  unit  does not  by itself cause  the resulting  executable  to  be --
--- covered  by the  GNU  General  Public  License.  This exception does not --
--- however invalidate  any other reasons why  the executable file  might be --
--- covered by the  GNU Public License.                                      --
+-- You should have received a copy of the GNU General Public License and    --
+-- a copy of the GCC Runtime Library Exception along with this program;     --
+-- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
+-- <http://www.gnu.org/licenses/>.                                          --
 --                                                                          --
 -- GNAT was originally developed  by the GNAT team at  New York University. --
--- It is now maintained by Ada Core Technologies Inc (http://www.gnat.com). --
+-- Extensive contributions were provided by Ada Core Technologies Inc.      --
 --                                                                          --
 ------------------------------------------------------------------------------
 
 package Ada.Command_Line is
-pragma Preelaborate (Command_Line);
+   pragma Preelaborate;
 
    function Argument_Count return Natural;
    --  If the external execution environment supports passing arguments to a
@@ -71,13 +67,48 @@ pragma Preelaborate (Command_Line);
 
    procedure Set_Exit_Status (Code : Exit_Status);
 
-private
+   ------------------------------------
+   -- Note on Interface Requirements --
+   ------------------------------------
+
+   --  If the main program is in Ada, this package works as specified without
+   --  any other work than the normal steps of WITH'ing the package and then
+   --  calling the desired routines.
+
+   --  If the main program is not in Ada, then the information must be made
+   --  available for this package to work correctly. In particular, it is
+   --  required that the global variable "gnat_argc" contain the number of
+   --  arguments, and that the global variable "gnat_argv" points to an
+   --  array of null-terminated strings, the first entry being the command
+   --  name, and the remaining entries being the command arguments.
 
+   --  These correspond to the normal argc/argv variables passed to a C
+   --  main program, and the following is an example of a complete C main
+   --  program that stores the required information:
+
+   --    main(int argc, char **argv, char **envp)
+   --    {
+   --       extern int    gnat_argc;
+   --       extern char **gnat_argv;
+   --       extern char **gnat_envp;
+   --       gnat_argc = argc;
+   --       gnat_argv = argv;
+   --       gnat_envp = envp;
+
+   --       adainit();
+   --       adamain();
+   --       adafinal();
+   --    }
+
+   --  The assignment statements ensure that the necessary information is
+   --  available for finding the command name and command line arguments.
+
+private
    Success : constant Exit_Status := 0;
    Failure : constant Exit_Status := 1;
 
    --  The following locations support the operation of the package
-   --  Ada.Command_Line_Remove, whih provides facilities for logically
+   --  Ada.Command_Line.Remove, which provides facilities for logically
    --  removing arguments from the command line. If one of the remove
    --  procedures is called in this unit, then Remove_Args/Remove_Count
    --  are set to indicate which arguments are removed. If no such calls