gcc/ada/tempdir.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                              T E M P D I R                               --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 2003-2007, Free Software Foundation, Inc.         --
  10 --                                                                          --
  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.                                              --
  21 --                                                                          --
  22 -- GNAT was originally developed  by the GNAT team at  New York University. --
  23 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  24 --                                                                          --
  25 ------------------------------------------------------------------------------
  26
  27 --  This package is used by gnatmake and by the Project Manager to create
  28 --  temporary files.  If environment variable TMPDIR is defined and
  29 --  designates an absolute path, temporary files are create in this directory.
  30 --  Otherwise, temporary files are created in the current working directory.
  31
  32 with Namet; use Namet;
  33
  34 with System.OS_Lib; use System.OS_Lib;
  35
  36 package Tempdir is
  37
  38    procedure Create_Temp_File
  39      (FD   : out File_Descriptor;
  40       Name : out Path_Name_Type);
  41    --  Create a temporary text file and return its file descriptor and
  42    --  its path name as a Name_Id. If environment variable TMPDIR is defined
  43    --  and its value is an absolute path, the temp file is created in the
  44    --  directory designated by TMPDIR, otherwise, it is created in the current
  45    --  directory. If temporary file cannot be created, FD gets the value
  46    --  Invalid_FD and Name gets the value No_Name.
  47
  48 end Tempdir;