OSDN Git Service

2012-02-22 Hristian Kirtchev <kirtchev@adacore.com>
[pf3gnuchains/gcc-fork.git] / gcc / ada / output.ads
index 2df0da6..ddc3954 100644 (file)
 with Hostparm; use Hostparm;
 with Types;    use Types;
 
+pragma Warnings (Off);
+--  This package is used also by gnatcoll
+with System.OS_Lib; use System.OS_Lib;
+pragma Warnings (On);
+
 package Output is
    pragma Elaborate_Body;
 
    type Output_Proc is access procedure (S : String);
-   --  This type is used for the Set_Special_Output procedure. If this
-   --  procedure is called, then instead of lines being written to
-   --  standard error or standard output, a call is made to the given
-   --  procedure for each line, passing the line with an end of line
-   --  character (which is a single ASCII.LF character, even in systems
-   --  which normally use CR/LF or some other sequence for line end).
+   --  This type is used for the Set_Special_Output procedure. If Output_Proc
+   --  is called, then instead of lines being written to standard error or
+   --  standard output, a call is made to the given procedure for each line,
+   --  passing the line with an end of line character (which is a single
+   --  ASCII.LF character, even in systems which normally use CR/LF or some
+   --  other sequence for line end).
 
    -----------------
    -- Subprograms --
    -----------------
 
    procedure Set_Special_Output (P : Output_Proc);
-   --  Sets subsequent output to call procedure P. If P is null, then
-   --  the call cancels the effect of a previous call, reverting the
-   --  output to standard error or standard output depending on the
-   --  mode at the time of previous call. Any exception generated by
-   --  by calls to P is simply propagated to the caller of the routine
-   --  causing the write operation.
+   --  Sets subsequent output to call procedure P. If P is null, then the call
+   --  cancels the effect of a previous call, reverting the output to standard
+   --  error or standard output depending on the mode at the time of previous
+   --  call. Any exception generated by by calls to P is simply propagated to
+   --  the caller of the routine causing the write operation.
 
    procedure Cancel_Special_Output;
-   --  Cancels the effect of a call to Set_Special_Output, if any.
-   --  The output is then directed to standard error or standard output
-   --  depending on the last call to Set_Standard_Error or Set_Standard_Output.
-   --  It is never an error to call Cancel_Special_Output. It has the same
-   --  effect as calling Set_Special_Output (null).
+   --  Cancels the effect of a call to Set_Special_Output, if any. The output
+   --  is then directed to standard error or standard output depending on the
+   --  last call to Set_Standard_Error or Set_Standard_Output. It is never an
+   --  error to call Cancel_Special_Output. It has the same effect as calling
+   --  Set_Special_Output (null).
 
    procedure Ignore_Output (S : String);
    --  Does nothing. To disable output, pass Ignore_Output'Access to
@@ -79,11 +83,17 @@ package Output is
 
    procedure Set_Standard_Output;
    --  Sets subsequent output to appear on the standard output file (whatever
-   --  that might mean for the host operating system, if anything) when
-   --  no special output is in effect. When a special output is in effect,
-   --  the output will appear on standard output only after special output
-   --  has been cancelled. Output to standard output is the default mode
-   --  before any call to either of the Set procedures.
+   --  that might mean for the host operating system, if anything) when no
+   --  special output is in effect. When a special output is in effect, the
+   --  output will appear on standard output only after special output has been
+   --  cancelled. Output to standard output is the default mode before any call
+   --  to either of the Set procedures.
+
+   procedure Set_Output (FD : File_Descriptor);
+   --  Sets subsequent output to appear on the given file descriptor when no
+   --  special output is in effect. When a special output is in effect, the
+   --  output will appear on the given file descriptor only after special
+   --  output has been cancelled.
 
    procedure Indent;
    --  Increases the current indentation level. Whenever a line is written
@@ -101,36 +111,36 @@ package Output is
    --  If last character in buffer matches C, erase it, otherwise no effect
 
    procedure Write_Eol;
-   --  Write an end of line (whatever is required by the system in use,
-   --  e.g. CR/LF for DOS, or LF for Unix) to the standard output file.
-   --  This routine also empties the line buffer, actually writing it
-   --  to the file. Note that Write_Eol is the only routine that causes
-   --  any actual output to be written. Trailing spaces are removed.
+   --  Write an end of line (whatever is required by the system in use, e.g.
+   --  CR/LF for DOS, or LF for Unix) to the standard output file. This routine
+   --  also empties the line buffer, actually writing it to the file. Note that
+   --  Write_Eol is the only routine that causes any actual output to be
+   --  written. Trailing spaces are removed.
 
    procedure Write_Eol_Keep_Blanks;
    --  Similar as Write_Eol, except that trailing spaces are not removed
 
    procedure Write_Int (Val : Int);
-   --  Write an integer value with no leading blanks or zeroes. Negative
-   --  values are preceded by a minus sign).
+   --  Write an integer value with no leading blanks or zeroes. Negative values
+   --  are preceded by a minus sign).
 
    procedure Write_Spaces (N : Nat);
    --  Write N spaces
 
    procedure Write_Str (S : String);
    --  Write a string of characters to the standard output file. Note that
-   --  end of line is normally handled separately using WRITE_EOL, but it
-   --  is allowed for the string to contain LF (but not CR) characters,
-   --  which are properly interpreted as end of line characters. The string
-   --  may also contain horizontal tab characters.
+   --  end of line is normally handled separately using WRITE_EOL, but it is
+   --  allowable for the string to contain LF (but not CR) characters, which
+   --  are properly interpreted as end of line characters. The string may also
+   --  contain horizontal tab characters.
 
    procedure Write_Line (S : String);
    --  Equivalent to Write_Str (S) followed by Write_Eol;
 
    function Column return Pos;
    pragma Inline (Column);
-   --  Returns the number of the column about to be written (e.g. a value
-   --  of 1 means the current line is empty).
+   --  Returns the number of the column about to be written (e.g. a value of 1
+   --  means the current line is empty).
 
    -------------------------
    -- Buffer Save/Restore --