ncurses 6.2 - patch 20210925
[ncurses.git] / doc / html / ada / terminal_interface-curses-text_io__ads.htm
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
2 <HTML>
3 <HEAD>
4 <TITLE>terminal_interface-curses-text_io.ads</TITLE>
5 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
6 <style type="text/css">
7 *.comment {
8         color: green;
9 }
10 *.symbol {
11         color: red;
12 }
13 </style>
14 </HEAD>
15 <BODY>
16 <HR><DIV style="text-align:center"><H1> File : terminal_interface-curses-text_io.ads </H1></DIV><HR>
17 <PRE>
18 <span class="comment"><EM>------------------------------------------------------------------------------</EM></span>
19 <span class="comment"><EM>--                                                                          --</EM></span>
20 <span class="comment"><EM>--                           <A HREF="http://www.gnat.com">GNAT</A> ncurses Binding                           --</EM></span>
21 <span class="comment"><EM>--                                                                          --</EM></span>
22 <span class="comment"><EM>--                     Terminal_Interface.Curses.Text_IO                    --</EM></span>
23 <span class="comment"><EM>--                                                                          --</EM></span>
24 <span class="comment"><EM>--                                 S P E C                                  --</EM></span>
25 <span class="comment"><EM>--                                                                          --</EM></span>
26 <span class="comment"><EM>------------------------------------------------------------------------------</EM></span>
27 <span class="comment"><EM>-- Copyright 2020 Thomas E. Dickey                                          --</EM></span>
28 <span class="comment"><EM>-- Copyright 1999-2003,2009 Free Software Foundation, Inc.                  --</EM></span>
29 <span class="comment"><EM>--                                                                          --</EM></span>
30 <span class="comment"><EM>-- Permission is hereby granted, free of charge, to any person obtaining a  --</EM></span>
31 <span class="comment"><EM>-- copy of this software and associated documentation files (the            --</EM></span>
32 <span class="comment"><EM>-- "Software"), to deal in the Software without restriction, including      --</EM></span>
33 <span class="comment"><EM>-- without limitation the rights to use, copy, modify, merge, publish,      --</EM></span>
34 <span class="comment"><EM>-- distribute, distribute with modifications, sublicense, and/or sell       --</EM></span>
35 <span class="comment"><EM>-- copies of the Software, and to permit persons to whom the Software is    --</EM></span>
36 <span class="comment"><EM>-- furnished to do so, subject to the following conditions:                 --</EM></span>
37 <span class="comment"><EM>--                                                                          --</EM></span>
38 <span class="comment"><EM>-- The above copyright notice and this permission notice shall be included  --</EM></span>
39 <span class="comment"><EM>-- in all copies or substantial portions of the Software.                   --</EM></span>
40 <span class="comment"><EM>--                                                                          --</EM></span>
41 <span class="comment"><EM>-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  --</EM></span>
42 <span class="comment"><EM>-- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               --</EM></span>
43 <span class="comment"><EM>-- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   --</EM></span>
44 <span class="comment"><EM>-- IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   --</EM></span>
45 <span class="comment"><EM>-- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    --</EM></span>
46 <span class="comment"><EM>-- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    --</EM></span>
47 <span class="comment"><EM>-- THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               --</EM></span>
48 <span class="comment"><EM>--                                                                          --</EM></span>
49 <span class="comment"><EM>-- Except as contained in this notice, the name(s) of the above copyright   --</EM></span>
50 <span class="comment"><EM>-- holders shall not be used in advertising or otherwise to promote the     --</EM></span>
51 <span class="comment"><EM>-- sale, use or other dealings in this Software without prior written       --</EM></span>
52 <span class="comment"><EM>-- authorization.                                                           --</EM></span>
53 <span class="comment"><EM>------------------------------------------------------------------------------</EM></span>
54 <span class="comment"><EM>--  Author:  Juergen Pfeifer, 1996</EM></span>
55 <span class="comment"><EM>--  Version Control:</EM></span>
56 <span class="comment"><EM>--  @Revision: 1.15 @</EM></span>
57 <span class="comment"><EM>--  Binding Version 01.00</EM></span>
58 <span class="comment"><EM>------------------------------------------------------------------------------</EM></span>
59 <b>with</b> Ada.Text_IO;
60 <b>with</b> Ada.IO_Exceptions;
61
62 <b>package</b> <A HREF="terminal_interface__ads.htm#ref_43_9">Terminal_Interface</A>.<A HREF="terminal_interface-curses__ads.htm#ref_48_28">Curses</A>.<span class="symbol"><A NAME="ref_45_35" HREF="terminal_interface-curses-text_io__adb.htm#ref_43_40">Text_IO</A></span> <b>is</b>
63
64    <b>use</b> <b>type</b> Ada.Text_IO.Count;
65    <b>subtype</b> <span class="symbol"><A NAME="ref_48_12">Count</A></span> <b>is</b> Ada.Text_IO.Count;
66    <b>subtype</b> <span class="symbol"><A NAME="ref_49_12">Positive_Count</A></span> <b>is</b> <A HREF="terminal_interface-curses-text_io__ads.htm#ref_48_12">Count</A> <b>range</b> 1 .. <A HREF="terminal_interface-curses-text_io__ads.htm#ref_48_12">Count</A>'Last;
67
68    <b>subtype</b> <span class="symbol"><A NAME="ref_51_12">Field</A></span> <b>is</b> Ada.Text_IO.Field;
69    <b>subtype</b> <span class="symbol"><A NAME="ref_52_12">Number_Base</A></span> <b>is</b> Integer <b>range</b> 2 .. 16;
70
71    <b>type</b> <span class="symbol"><A NAME="ref_54_9">Type_Set</A></span> <b>is</b> (<span class="symbol"><A NAME="ref_54_22">Lower_Case</A></span>, <span class="symbol"><A NAME="ref_54_34">Upper_Case</A></span>, <span class="symbol"><A NAME="ref_54_46">Mixed_Case</A></span>);
72
73    <span class="comment"><EM>--  For most of the routines you will see a version without a Window</EM></span>
74    <span class="comment"><EM>--  type parameter. They will operate on a default window, which can</EM></span>
75    <span class="comment"><EM>--  be set by the user. It is initially equal to Standard_Window.</EM></span>
76
77    <b>procedure</b> <span class="symbol"><A NAME="ref_60_14" HREF="terminal_interface-curses-text_io__adb.htm#ref_47_14">Set_Window</A></span> (<span class="symbol"><A NAME="ref_60_26" HREF="terminal_interface-curses-text_io__adb.htm#ref_47_26">Win</A></span> : <A HREF="terminal_interface-curses__ads.htm#ref_56_9">Window</A>);
78    <span class="comment"><EM>--  Set Win as the default window</EM></span>
79
80    <b>function</b> <span class="symbol"><A NAME="ref_63_13" HREF="terminal_interface-curses-text_io__adb.htm#ref_53_13">Get_Window</A></span> <b>return</b> <A HREF="terminal_interface-curses__ads.htm#ref_56_9">Window</A>;
81    <span class="comment"><EM>--  Get the current default window</EM></span>
82
83    <b>procedure</b> <span class="symbol"><A NAME="ref_66_14" HREF="terminal_interface-curses-text_io__adb.htm#ref_64_14">Flush</A></span> (<span class="symbol"><A NAME="ref_66_21" HREF="terminal_interface-curses-text_io__adb.htm#ref_64_21">Win</A></span> : <A HREF="terminal_interface-curses__ads.htm#ref_56_9">Window</A>);
84    <b>procedure</b> <span class="symbol"><A NAME="ref_67_14" HREF="terminal_interface-curses-text_io__adb.htm#ref_70_14">Flush</A></span>;
85
86    <span class="comment"><EM>--------------------------------------------</EM></span>
87    <span class="comment"><EM>-- Specification of line and page lengths --</EM></span>
88    <span class="comment"><EM>--------------------------------------------</EM></span>
89
90    <span class="comment"><EM>--  There are no set routines in this package. I assume, that you allocate</EM></span>
91    <span class="comment"><EM>--  the window with an appropriate size.</EM></span>
92    <span class="comment"><EM>--  A scroll-window is interpreted as an page with unbounded page length,</EM></span>
93    <span class="comment"><EM>--  i.e. it returns the conventional 0 as page length.</EM></span>
94
95    <b>function</b> <span class="symbol"><A NAME="ref_78_13" HREF="terminal_interface-curses-text_io__adb.htm#ref_85_13">Line_Length</A></span> (<span class="symbol"><A NAME="ref_78_26" HREF="terminal_interface-curses-text_io__adb.htm#ref_85_26">Win</A></span> : <A HREF="terminal_interface-curses__ads.htm#ref_56_9">Window</A>) <b>return</b> <A HREF="terminal_interface-curses-text_io__ads.htm#ref_48_12">Count</A>;
96    <b>function</b> <span class="symbol"><A NAME="ref_79_13" HREF="terminal_interface-curses-text_io__adb.htm#ref_97_13">Line_Length</A></span> <b>return</b> <A HREF="terminal_interface-curses-text_io__ads.htm#ref_48_12">Count</A>;
97
98    <b>function</b> <span class="symbol"><A NAME="ref_81_13" HREF="terminal_interface-curses-text_io__adb.htm#ref_103_13">Page_Length</A></span> (<span class="symbol"><A NAME="ref_81_26" HREF="terminal_interface-curses-text_io__adb.htm#ref_103_26">Win</A></span> : <A HREF="terminal_interface-curses__ads.htm#ref_56_9">Window</A>) <b>return</b> <A HREF="terminal_interface-curses-text_io__ads.htm#ref_48_12">Count</A>;
99    <b>function</b> <span class="symbol"><A NAME="ref_82_13" HREF="terminal_interface-curses-text_io__adb.htm#ref_119_13">Page_Length</A></span> <b>return</b> <A HREF="terminal_interface-curses-text_io__ads.htm#ref_48_12">Count</A>;
100
101    <span class="comment"><EM>------------------------------------</EM></span>
102    <span class="comment"><EM>-- Column, Line, and Page Control --</EM></span>
103    <span class="comment"><EM>------------------------------------</EM></span>
104    <b>procedure</b> <span class="symbol"><A NAME="ref_87_14" HREF="terminal_interface-curses-text_io__adb.htm#ref_128_14">New_Line</A></span> (<span class="symbol"><A NAME="ref_87_24" HREF="terminal_interface-curses-text_io__adb.htm#ref_128_24">Win</A></span> : <A HREF="terminal_interface-curses__ads.htm#ref_56_9">Window</A>; <span class="symbol"><A NAME="ref_87_38" HREF="terminal_interface-curses-text_io__adb.htm#ref_128_38">Spacing</A></span> : <A HREF="terminal_interface-curses-text_io__ads.htm#ref_49_12">Positive_Count</A> := 1);
105    <b>procedure</b> <span class="symbol"><A NAME="ref_88_14" HREF="terminal_interface-curses-text_io__adb.htm#ref_145_14">New_Line</A></span> (<span class="symbol"><A NAME="ref_88_24" HREF="terminal_interface-curses-text_io__adb.htm#ref_145_24">Spacing</A></span> : <A HREF="terminal_interface-curses-text_io__ads.htm#ref_49_12">Positive_Count</A> := 1);
106
107    <b>procedure</b> <span class="symbol"><A NAME="ref_90_14" HREF="terminal_interface-curses-text_io__adb.htm#ref_151_14">New_Page</A></span> (<span class="symbol"><A NAME="ref_90_24" HREF="terminal_interface-curses-text_io__adb.htm#ref_151_24">Win</A></span> : <A HREF="terminal_interface-curses__ads.htm#ref_56_9">Window</A>);
108    <b>procedure</b> <span class="symbol"><A NAME="ref_91_14" HREF="terminal_interface-curses-text_io__adb.htm#ref_157_14">New_Page</A></span>;
109
110    <b>procedure</b> <span class="symbol"><A NAME="ref_93_14" HREF="terminal_interface-curses-text_io__adb.htm#ref_163_14">Set_Col</A></span> (<span class="symbol"><A NAME="ref_93_23" HREF="terminal_interface-curses-text_io__adb.htm#ref_163_23">Win</A></span> : <A HREF="terminal_interface-curses__ads.htm#ref_56_9">Window</A>;  <span class="symbol"><A NAME="ref_93_38" HREF="terminal_interface-curses-text_io__adb.htm#ref_163_38">To</A></span> : <A HREF="terminal_interface-curses-text_io__ads.htm#ref_49_12">Positive_Count</A>);
111    <b>procedure</b> <span class="symbol"><A NAME="ref_94_14" HREF="terminal_interface-curses-text_io__adb.htm#ref_191_14">Set_Col</A></span> (<span class="symbol"><A NAME="ref_94_23" HREF="terminal_interface-curses-text_io__adb.htm#ref_191_23">To</A></span> : <A HREF="terminal_interface-curses-text_io__ads.htm#ref_49_12">Positive_Count</A>);
112
113    <b>procedure</b> <span class="symbol"><A NAME="ref_96_14" HREF="terminal_interface-curses-text_io__adb.htm#ref_197_14">Set_Line</A></span> (<span class="symbol"><A NAME="ref_96_24" HREF="terminal_interface-curses-text_io__adb.htm#ref_197_24">Win</A></span> : <A HREF="terminal_interface-curses__ads.htm#ref_56_9">Window</A>; <span class="symbol"><A NAME="ref_96_38" HREF="terminal_interface-curses-text_io__adb.htm#ref_197_38">To</A></span> : <A HREF="terminal_interface-curses-text_io__ads.htm#ref_49_12">Positive_Count</A>);
114    <b>procedure</b> <span class="symbol"><A NAME="ref_97_14" HREF="terminal_interface-curses-text_io__adb.htm#ref_221_14">Set_Line</A></span> (<span class="symbol"><A NAME="ref_97_24" HREF="terminal_interface-curses-text_io__adb.htm#ref_221_24">To</A></span> : <A HREF="terminal_interface-curses-text_io__ads.htm#ref_49_12">Positive_Count</A>);
115
116    <b>function</b> <span class="symbol"><A NAME="ref_99_13" HREF="terminal_interface-curses-text_io__adb.htm#ref_227_13">Col</A></span> (<span class="symbol"><A NAME="ref_99_18" HREF="terminal_interface-curses-text_io__adb.htm#ref_227_18">Win</A></span> : <A HREF="terminal_interface-curses__ads.htm#ref_56_9">Window</A>) <b>return</b> <A HREF="terminal_interface-curses-text_io__ads.htm#ref_49_12">Positive_Count</A>;
117    <b>function</b> <span class="symbol"><A NAME="ref_100_13" HREF="terminal_interface-curses-text_io__adb.htm#ref_241_13">Col</A></span> <b>return</b> <A HREF="terminal_interface-curses-text_io__ads.htm#ref_49_12">Positive_Count</A>;
118
119    <b>function</b> <span class="symbol"><A NAME="ref_102_13" HREF="terminal_interface-curses-text_io__adb.htm#ref_247_13">Line</A></span> (<span class="symbol"><A NAME="ref_102_19" HREF="terminal_interface-curses-text_io__adb.htm#ref_247_19">Win</A></span> : <A HREF="terminal_interface-curses__ads.htm#ref_56_9">Window</A>) <b>return</b> <A HREF="terminal_interface-curses-text_io__ads.htm#ref_49_12">Positive_Count</A>;
120    <b>function</b> <span class="symbol"><A NAME="ref_103_13" HREF="terminal_interface-curses-text_io__adb.htm#ref_261_13">Line</A></span> <b>return</b> <A HREF="terminal_interface-curses-text_io__ads.htm#ref_49_12">Positive_Count</A>;
121
122    <span class="comment"><EM>-----------------------</EM></span>
123    <span class="comment"><EM>-- Characters-Output --</EM></span>
124    <span class="comment"><EM>-----------------------</EM></span>
125
126    <b>procedure</b> <span class="symbol"><A NAME="ref_109_14" HREF="terminal_interface-curses-text_io__adb.htm#ref_271_14">Put</A></span> (<span class="symbol"><A NAME="ref_109_19" HREF="terminal_interface-curses-text_io__adb.htm#ref_271_19">Win</A></span>  : <A HREF="terminal_interface-curses__ads.htm#ref_56_9">Window</A>; <span class="symbol"><A NAME="ref_109_34" HREF="terminal_interface-curses-text_io__adb.htm#ref_271_34">Item</A></span> : Character);
127    <b>procedure</b> <span class="symbol"><A NAME="ref_110_14" HREF="terminal_interface-curses-text_io__adb.htm#ref_289_14">Put</A></span> (<span class="symbol"><A NAME="ref_110_19" HREF="terminal_interface-curses-text_io__adb.htm#ref_289_19">Item</A></span> : Character);
128
129    <span class="comment"><EM>--------------------</EM></span>
130    <span class="comment"><EM>-- Strings-Output --</EM></span>
131    <span class="comment"><EM>--------------------</EM></span>
132
133    <b>procedure</b> <span class="symbol"><A NAME="ref_116_14" HREF="terminal_interface-curses-text_io__adb.htm#ref_299_14">Put</A></span> (<span class="symbol"><A NAME="ref_116_19" HREF="terminal_interface-curses-text_io__adb.htm#ref_299_19">Win</A></span>  : <A HREF="terminal_interface-curses__ads.htm#ref_56_9">Window</A>; <span class="symbol"><A NAME="ref_116_34" HREF="terminal_interface-curses-text_io__adb.htm#ref_299_34">Item</A></span> : String);
134    <b>procedure</b> <span class="symbol"><A NAME="ref_117_14" HREF="terminal_interface-curses-text_io__adb.htm#ref_317_14">Put</A></span> (<span class="symbol"><A NAME="ref_117_19" HREF="terminal_interface-curses-text_io__adb.htm#ref_317_19">Item</A></span> : String);
135
136    <b>procedure</b> <span class="symbol"><A NAME="ref_119_14" HREF="terminal_interface-curses-text_io__adb.htm#ref_323_14">Put_Line</A></span>
137      (<span class="symbol"><A NAME="ref_120_7" HREF="terminal_interface-curses-text_io__adb.htm#ref_324_7">Win</A></span>  : <A HREF="terminal_interface-curses__ads.htm#ref_56_9">Window</A>;
138       <span class="symbol"><A NAME="ref_121_7" HREF="terminal_interface-curses-text_io__adb.htm#ref_325_7">Item</A></span> : String);
139
140    <b>procedure</b> <span class="symbol"><A NAME="ref_123_14" HREF="terminal_interface-curses-text_io__adb.htm#ref_332_14">Put_Line</A></span>
141      (<span class="symbol"><A NAME="ref_124_7" HREF="terminal_interface-curses-text_io__adb.htm#ref_333_7">Item</A></span> : String);
142
143    <span class="comment"><EM>--  Exceptions</EM></span>
144
145    <span class="symbol"><A NAME="ref_128_4">Status_Error</A></span> : <b>exception</b> <b>renames</b> Ada.IO_Exceptions.Status_Error;
146    <span class="symbol"><A NAME="ref_129_4">Mode_Error</A></span>   : <b>exception</b> <b>renames</b> Ada.IO_Exceptions.Mode_Error;
147    <span class="symbol"><A NAME="ref_130_4">Name_Error</A></span>   : <b>exception</b> <b>renames</b> Ada.IO_Exceptions.Name_Error;
148    <span class="symbol"><A NAME="ref_131_4">Use_Error</A></span>    : <b>exception</b> <b>renames</b> Ada.IO_Exceptions.Use_Error;
149    <span class="symbol"><A NAME="ref_132_4">Device_Error</A></span> : <b>exception</b> <b>renames</b> Ada.IO_Exceptions.Device_Error;
150    <span class="symbol"><A NAME="ref_133_4">End_Error</A></span>    : <b>exception</b> <b>renames</b> Ada.IO_Exceptions.End_Error;
151    <span class="symbol"><A NAME="ref_134_4">Data_Error</A></span>   : <b>exception</b> <b>renames</b> Ada.IO_Exceptions.Data_Error;
152    <span class="symbol"><A NAME="ref_135_4">Layout_Error</A></span> : <b>exception</b> <b>renames</b> Ada.IO_Exceptions.Layout_Error;
153
154 <b>end</b> <A HREF="terminal_interface__ads.htm#ref_43_9">Terminal_Interface</A>.<A HREF="terminal_interface-curses__ads.htm#ref_48_28">Curses</A>.<A HREF="terminal_interface-curses-text_io__ads.htm#ref_45_35">Text_IO</A>;
155 </PRE></BODY></HTML>