Add an UNSPEC_PROLOGUE_USE to prevent the link register from being considered dead.
[official-gcc.git] / gcc / ada / output.ads
blob2ade9b2d2b3342b97e69778dc26c8a680317d2f2
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- O U T P U T --
6 -- --
7 -- S p e c --
8 -- --
9 -- --
10 -- Copyright (C) 1992-2001 Free Software Foundation, Inc. --
11 -- --
12 -- GNAT is free software; you can redistribute it and/or modify it under --
13 -- terms of the GNU General Public License as published by the Free Soft- --
14 -- ware Foundation; either version 2, or (at your option) any later ver- --
15 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
16 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
17 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
18 -- for more details. You should have received a copy of the GNU General --
19 -- Public License distributed with GNAT; see file COPYING. If not, write --
20 -- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
21 -- MA 02111-1307, USA. --
22 -- --
23 -- As a special exception, if other files instantiate generics from this --
24 -- unit, or you link this unit with other files to produce an executable, --
25 -- this unit does not by itself cause the resulting executable to be --
26 -- covered by the GNU General Public License. This exception does not --
27 -- however invalidate any other reasons why the executable file might be --
28 -- covered by the GNU Public License. --
29 -- --
30 -- GNAT was originally developed by the GNAT team at New York University. --
31 -- Extensive contributions were provided by Ada Core Technologies Inc. --
32 -- --
33 ------------------------------------------------------------------------------
35 -- This package contains low level output routines used by the compiler
36 -- for writing error messages and informational output. It is also used
37 -- by the debug source file output routines (see Sprintf.Print_Eol).
39 with Types; use Types;
41 package Output is
42 pragma Elaborate_Body (Output);
44 type Output_Proc is access procedure (S : String);
45 -- This type is used for the Set_Special_Output procedure. If this
46 -- procedure is called, then instead of lines being written to
47 -- standard error or standard output, a call is made to the given
48 -- procedure for each line, passing the line with an end of line
49 -- character (which is a single ASCII.LF character, even in systems
50 -- which normally use CR/LF or some other sequence for line end).
52 -----------------
53 -- Subprograms --
54 -----------------
56 procedure Set_Special_Output (P : Output_Proc);
57 -- Sets subsequent output to call procedure P. If P is null, then
58 -- the call cancels the effect of a previous call, reverting the
59 -- output to standard error or standard output depending on the
60 -- mode at the time of previous call. Any exception generated by
61 -- by calls to P is simply propagated to the caller of the routine
62 -- causing the write operation.
64 procedure Cancel_Special_Output;
65 -- Cancels the effect of a call to Set_Special_Output, if any.
66 -- The output is then directed to standard error or standard output
67 -- depending on the last call to Set_Standard_Error or Set_Standard_Output.
68 -- It is never an error to call Cancel_Special_Output. It has the same
69 -- effect as calling Set_Special_Output (null).
71 procedure Set_Standard_Error;
72 -- Sets subsequent output to appear on the standard error file (whatever
73 -- that might mean for the host operating system, if anything) when
74 -- no special output is in effect. When a special output is in effect,
75 -- the output will appear on standard error only after special output
76 -- has been cancelled.
78 procedure Set_Standard_Output;
79 -- Sets subsequent output to appear on the standard output file (whatever
80 -- that might mean for the host operating system, if anything) when
81 -- no special output is in effect. When a special output is in effect,
82 -- the output will appear on standard output only after special output
83 -- has been cancelled. Output to standard output is the default mode
84 -- before any call to either of the Set procedures.
86 procedure Write_Char (C : Character);
87 -- Write one character to the standard output file. Note that the
88 -- character should not be LF or CR (use Write_Eol for end of line)
90 procedure Write_Eol;
91 -- Write an end of line (whatever is required by the system in use,
92 -- e.g. CR/LF for DOS, or LF for Unix) to the standard output file.
93 -- This routine also empties the line buffer, actually writing it
94 -- to the file. Note that Write_Eol is the only routine that causes
95 -- any actual output to be written.
97 procedure Write_Int (Val : Int);
98 -- Write an integer value with no leading blanks or zeroes. Negative
99 -- values are preceded by a minus sign).
101 procedure Write_Str (S : String);
102 -- Write a string of characters to the standard output file. Note that
103 -- end of line is handled separately using WRITE_EOL, so the string
104 -- should not contain either of the characters LF or CR, but it may
105 -- contain horizontal tab characters.
107 procedure Write_Line (S : String);
108 -- Equivalent to Write_Str (S) followed by Write_Eol;
110 function Column return Nat;
111 pragma Inline (Column);
112 -- Returns the number of the column about to be written (e.g. a value
113 -- of 1 means the current line is empty).
115 --------------------------
116 -- Debugging Procedures --
117 --------------------------
119 -- The following procedures are intended only for debugging purposes,
120 -- for temporary insertion into the text in environments where a debugger
121 -- is not available. They all have non-standard very short lower case
122 -- names, precisely to make sure that they are only used for debugging!
124 procedure w (C : Character);
125 -- Dump quote, character quote, followed by line return
127 procedure w (S : String);
128 -- Dump string followed by line return
130 procedure w (V : Int);
131 -- Dump integer followed by line return
133 procedure w (B : Boolean);
134 -- Dump Boolean followed by line return
136 procedure w (L : String; C : Character);
137 -- Dump contents of string followed by blank, quote, character, quote
139 procedure w (L : String; S : String);
140 -- Dump two strings separated by blanks, followed by line return
142 procedure w (L : String; V : Int);
143 -- Dump contents of string followed by blank, integer, line return
145 procedure w (L : String; B : Boolean);
146 -- Dump contents of string followed by blank, Boolean, line return
148 end Output;