ncurses 6.3 - patch 20211127
[ncurses.git] / doc / html / ada / terminal_interface-curses-aux__adb.htm
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
2 <HTML>
3 <HEAD>
4 <TITLE>terminal_interface-curses-aux.adb</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-aux.adb </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.Aux                       --</EM></span>
23 <span class="comment"><EM>--                                                                          --</EM></span>
24 <span class="comment"><EM>--                                 B O D Y                                  --</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.12 @</EM></span>
57 <span class="comment"><EM>--  Binding Version 01.00</EM></span>
58 <span class="comment"><EM>------------------------------------------------------------------------------</EM></span>
59 <b>package</b> <b>body</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_42_40" HREF="terminal_interface-curses-aux__ads.htm#ref_46_35">Aux</A></span> <b>is</b>
60    <span class="comment"><EM>--</EM></span>
61    <span class="comment"><EM>--  Some helpers</EM></span>
62    <b>procedure</b> <span class="symbol"><A NAME="ref_45_14" HREF="terminal_interface-curses-aux__ads.htm#ref_91_14">Fill_String</A></span> (<span class="symbol"><A NAME="ref_45_27" HREF="terminal_interface-curses-aux__ads.htm#ref_91_27">Cp</A></span>  : chars_ptr;
63                           <span class="symbol"><A NAME="ref_46_27" HREF="terminal_interface-curses-aux__ads.htm#ref_92_27">Str</A></span> : <b>out</b> String)
64    <b>is</b>
65       <span class="comment"><EM>--  Fill the string with the characters referenced by the</EM></span>
66       <span class="comment"><EM>--  chars_ptr.</EM></span>
67       <span class="comment"><EM>--</EM></span>
68       <span class="symbol"><A NAME="ref_51_7">Len</A></span> : Natural;
69    <b>begin</b>
70       <b>if</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_91_27">Cp</A> /= Null_Ptr <b>then</b>
71          <A HREF="terminal_interface-curses-aux__adb.htm#ref_51_7">Len</A> := Natural (Strlen (<A HREF="terminal_interface-curses-aux__ads.htm#ref_91_27">Cp</A>));
72          <b>if</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_92_27">Str</A>'Length &lt; <A HREF="terminal_interface-curses-aux__adb.htm#ref_51_7">Len</A> <b>then</b>
73             <b>raise</b> Constraint_Error;
74          <b>end</b> <b>if</b>;
75          <b>declare</b>
76             <span class="symbol"><A NAME="ref_59_13">S</A></span> : String (1 .. <A HREF="terminal_interface-curses-aux__adb.htm#ref_51_7">Len</A>);
77          <b>begin</b>
78             <A HREF="terminal_interface-curses-aux__adb.htm#ref_59_13">S</A> := Value (<A HREF="terminal_interface-curses-aux__ads.htm#ref_91_27">Cp</A>);
79             <A HREF="terminal_interface-curses-aux__ads.htm#ref_92_27">Str</A> (<A HREF="terminal_interface-curses-aux__ads.htm#ref_92_27">Str</A>'First .. (<A HREF="terminal_interface-curses-aux__ads.htm#ref_92_27">Str</A>'First + <A HREF="terminal_interface-curses-aux__adb.htm#ref_51_7">Len</A> - 1)) := <A HREF="terminal_interface-curses-aux__adb.htm#ref_59_13">S</A> (<A HREF="terminal_interface-curses-aux__adb.htm#ref_59_13">S</A>'<b>Range</b>);
80          <b>end</b>;
81       <b>else</b>
82          <A HREF="terminal_interface-curses-aux__adb.htm#ref_51_7">Len</A> := 0;
83       <b>end</b> <b>if</b>;
84
85       <b>if</b> <A HREF="terminal_interface-curses-aux__adb.htm#ref_51_7">Len</A> &lt; <A HREF="terminal_interface-curses-aux__ads.htm#ref_92_27">Str</A>'Length <b>then</b>
86          <A HREF="terminal_interface-curses-aux__ads.htm#ref_92_27">Str</A> ((<A HREF="terminal_interface-curses-aux__ads.htm#ref_92_27">Str</A>'First + <A HREF="terminal_interface-curses-aux__adb.htm#ref_51_7">Len</A>) .. <A HREF="terminal_interface-curses-aux__ads.htm#ref_92_27">Str</A>'Last) := (<b>others</b> =&gt; ' ');
87       <b>end</b> <b>if</b>;
88
89    <b>end</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_91_14">Fill_String</A>;
90
91    <b>function</b> <span class="symbol"><A NAME="ref_74_13" HREF="terminal_interface-curses-aux__ads.htm#ref_96_13">Fill_String</A></span> (<span class="symbol"><A NAME="ref_74_26" HREF="terminal_interface-curses-aux__ads.htm#ref_96_26">Cp</A></span> : chars_ptr) <b>return</b> String
92    <b>is</b>
93       <span class="symbol"><A NAME="ref_76_7">Len</A></span> : Natural;
94    <b>begin</b>
95       <b>if</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_96_26">Cp</A> /= Null_Ptr <b>then</b>
96          <A HREF="terminal_interface-curses-aux__adb.htm#ref_76_7">Len</A> := Natural (Strlen (<A HREF="terminal_interface-curses-aux__ads.htm#ref_96_26">Cp</A>));
97          <b>if</b> <A HREF="terminal_interface-curses-aux__adb.htm#ref_76_7">Len</A> = 0 <b>then</b>
98             <b>return</b> "";
99          <b>else</b>
100             <b>declare</b>
101                <span class="symbol"><A NAME="ref_84_16">S</A></span> : String (1 .. <A HREF="terminal_interface-curses-aux__adb.htm#ref_76_7">Len</A>);
102             <b>begin</b>
103                <A HREF="terminal_interface-curses-aux__ads.htm#ref_91_14">Fill_String</A> (<A HREF="terminal_interface-curses-aux__ads.htm#ref_96_26">Cp</A>, <A HREF="terminal_interface-curses-aux__adb.htm#ref_84_16">S</A>);
104                <b>return</b> <A HREF="terminal_interface-curses-aux__adb.htm#ref_84_16">S</A>;
105             <b>end</b>;
106          <b>end</b> <b>if</b>;
107       <b>else</b>
108          <b>return</b> "";
109       <b>end</b> <b>if</b>;
110    <b>end</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_96_13">Fill_String</A>;
111
112    <b>procedure</b> <span class="symbol"><A NAME="ref_95_14" HREF="terminal_interface-curses-aux__ads.htm#ref_87_14">Eti_Exception</A></span> (<span class="symbol"><A NAME="ref_95_29" HREF="terminal_interface-curses-aux__ads.htm#ref_87_29">Code</A></span> : <A HREF="terminal_interface-curses-aux__ads.htm#ref_70_9">Eti_Error</A>)
113    <b>is</b>
114    <b>begin</b>
115       <b>case</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_87_29">Code</A> <b>is</b>
116          <b>when</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_85_7">E_Ok</A>              =&gt; <b>null</b>;
117          <b>when</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_84_7">E_System_Error</A>    =&gt; <b>raise</b> <A HREF="terminal_interface-curses__ads.htm#ref_528_4">Eti_System_Error</A>;
118          <b>when</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_83_7">E_Bad_Argument</A>    =&gt; <b>raise</b> <A HREF="terminal_interface-curses__ads.htm#ref_529_4">Eti_Bad_Argument</A>;
119          <b>when</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_82_7">E_Posted</A>          =&gt; <b>raise</b> <A HREF="terminal_interface-curses__ads.htm#ref_530_4">Eti_Posted</A>;
120          <b>when</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_81_7">E_Connected</A>       =&gt; <b>raise</b> <A HREF="terminal_interface-curses__ads.htm#ref_531_4">Eti_Connected</A>;
121          <b>when</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_80_7">E_Bad_State</A>       =&gt; <b>raise</b> <A HREF="terminal_interface-curses__ads.htm#ref_532_4">Eti_Bad_State</A>;
122          <b>when</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_79_7">E_No_Room</A>         =&gt; <b>raise</b> <A HREF="terminal_interface-curses__ads.htm#ref_533_4">Eti_No_Room</A>;
123          <b>when</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_78_7">E_Not_Posted</A>      =&gt; <b>raise</b> <A HREF="terminal_interface-curses__ads.htm#ref_534_4">Eti_Not_Posted</A>;
124          <b>when</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_77_7">E_Unknown_Command</A> =&gt; <b>raise</b> <A HREF="terminal_interface-curses__ads.htm#ref_535_4">Eti_Unknown_Command</A>;
125          <b>when</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_76_7">E_No_Match</A>        =&gt; <b>raise</b> <A HREF="terminal_interface-curses__ads.htm#ref_536_4">Eti_No_Match</A>;
126          <b>when</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_75_7">E_Not_Selectable</A>  =&gt; <b>raise</b> <A HREF="terminal_interface-curses__ads.htm#ref_537_4">Eti_Not_Selectable</A>;
127          <b>when</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_74_7">E_Not_Connected</A>   =&gt; <b>raise</b> <A HREF="terminal_interface-curses__ads.htm#ref_538_4">Eti_Not_Connected</A>;
128          <b>when</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_73_7">E_Request_Denied</A>  =&gt; <b>raise</b> <A HREF="terminal_interface-curses__ads.htm#ref_539_4">Eti_Request_Denied</A>;
129          <b>when</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_72_7">E_Invalid_Field</A>   =&gt; <b>raise</b> <A HREF="terminal_interface-curses__ads.htm#ref_540_4">Eti_Invalid_Field</A>;
130          <b>when</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_71_7">E_Current</A>         =&gt; <b>raise</b> <A HREF="terminal_interface-curses__ads.htm#ref_541_4">Eti_Current</A>;
131       <b>end</b> <b>case</b>;
132    <b>end</b> <A HREF="terminal_interface-curses-aux__ads.htm#ref_87_14">Eti_Exception</A>;
133
134 <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-aux__ads.htm#ref_46_35">Aux</A>;
135 </PRE></BODY></HTML>