gcc/ada/osint-b.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                              O S I N T - B                               --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --          Copyright (C) 2001-2010, 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 3,  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 COPYING3.  If not, go to --
  19 -- http://www.gnu.org/licenses for a complete copy of the license.          --
  20 --                                                                          --
  21 -- GNAT was originally developed  by the GNAT team at  New York University. --
  22 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  23 --                                                                          --
  24 ------------------------------------------------------------------------------
  25
  26 --  This package contains the low level, operating system routines used only
  27 --  in the GNAT binder for command line processing and file input output.
  28
  29 package Osint.B is
  30
  31    function More_Lib_Files return Boolean;
  32    --  Indicates whether more library information files remain to be processed.
  33    --  Returns False right away if no source files, or if all source files
  34    --  have been processed.
  35
  36    function Next_Main_Lib_File return File_Name_Type;
  37    --  This function returns the name of the next library info file specified
  38    --  on the command line. It is an error to call Next_Main_Lib_File if no
  39    --  more library information files exist (i.e. Next_Main_Lib_File may be
  40    --  called only if a previous call to More_Lib_Files returned True). This
  41    --  name is the simple name, excluding any directory information.
  42
  43    -------------------
  44    -- Binder Output --
  45    -------------------
  46
  47    --  These routines are used by the binder to generate the C or Ada source
  48    --  files containing the binder output. The format of these files is
  49    --  described in package Bindgen.
  50
  51    procedure Create_Binder_Output
  52      (Output_File_Name : String;
  53       Typ              : Character;
  54       Bfile            : out Name_Id);
  55    --  Creates the binder output file. Typ is one of
  56    --
  57    --    'c'   create output file for case of generating C
  58    --    'b'   create body file for case of generating Ada
  59    --    's'   create spec file for case of generating Ada
  60    --
  61    --  If Output_File_Name is null, then a default name is used based on
  62    --  the name of the most recently accessed main source file name. If
  63    --  Output_File_Name is non-null then it is the full path name of the
  64    --  file to be output (in the case of Ada, it must have an extension
  65    --  of adb, and the spec file is created by changing the last character
  66    --  from b to s. On return, Bfile also contains the Name_Id for the
  67    --  generated file name.
  68
  69    procedure Write_Binder_Info (Info : String);
  70    --  Writes the contents of the referenced string to the binder output file
  71    --  created by a previous call to Create_Binder_Output. Info represents a
  72    --  single line in the file, but does not contain any line termination
  73    --  characters. The implementation of Write_Binder_Info is responsible
  74    --  for adding necessary end of line and end of file control characters
  75    --  as required by the operating system.
  76
  77    procedure Close_Binder_Output;
  78    --  Closes the file created by Create_Binder_Output, flushing any
  79    --  buffers etc. from writes by Write_Binder_Info.
  80
  81    procedure Set_Current_File_Name_Index (To : Int);
  82    --  Set value of Current_File_Name_Index (in private part of Osint) to To
  83
  84    ----------------------------------
  85    -- Other binder-generated files --
  86    ----------------------------------
  87
  88    procedure Set_List_File (Filename : String);
  89    --  Create Filename as a text output file and set it as the current output
  90    --  (see Output.Set_Output).
  91
  92    procedure Close_List_File;
  93    --  If a specific output file was created by Set_List_File, close it and
  94    --  reset the current output file to standard output.
  95
  96 end Osint.B;