ncurses 6.1 - patch 20180707
[ncurses.git] / Ada95 / gen / terminal_interface-curses-aux.ads.m4
1 --  -*- ada -*-
2 define(`HTMLNAME',`terminal_interface-curses-aux__ads.htm')dnl
3 include(M4MACRO)dnl
4 ------------------------------------------------------------------------------
5 --                                                                          --
6 --                           GNAT ncurses Binding                           --
7 --                                                                          --
8 --                       Terminal_Interface.Curses.Aux                      --
9 --                                                                          --
10 --                                 S P E C                                  --
11 --                                                                          --
12 ------------------------------------------------------------------------------
13 -- Copyright (c) 1998-2014,2018 Free Software Foundation, Inc.              --
14 --                                                                          --
15 -- Permission is hereby granted, free of charge, to any person obtaining a  --
16 -- copy of this software and associated documentation files (the            --
17 -- "Software"), to deal in the Software without restriction, including      --
18 -- without limitation the rights to use, copy, modify, merge, publish,      --
19 -- distribute, distribute with modifications, sublicense, and/or sell       --
20 -- copies of the Software, and to permit persons to whom the Software is    --
21 -- furnished to do so, subject to the following conditions:                 --
22 --                                                                          --
23 -- The above copyright notice and this permission notice shall be included  --
24 -- in all copies or substantial portions of the Software.                   --
25 --                                                                          --
26 -- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  --
27 -- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               --
28 -- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   --
29 -- IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   --
30 -- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    --
31 -- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    --
32 -- THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               --
33 --                                                                          --
34 -- Except as contained in this notice, the name(s) of the above copyright   --
35 -- holders shall not be used in advertising or otherwise to promote the     --
36 -- sale, use or other dealings in this Software without prior written       --
37 -- authorization.                                                           --
38 ------------------------------------------------------------------------------
39 --  Author:  Juergen Pfeifer, 1996
40 --  Version Control:
41 --  $Revision: 1.24 $
42 --  Binding Version 01.00
43 ------------------------------------------------------------------------------
44 with System;
45 with Interfaces.C;
46 with Interfaces.C.Strings; use Interfaces.C.Strings;
47
48 package Terminal_Interface.Curses.Aux is
49    pragma Preelaborate (Terminal_Interface.Curses.Aux);
50
51    subtype C_Int      is Interfaces.C.int;
52    subtype C_Short    is Interfaces.C.short;
53    subtype C_Long_Int is Interfaces.C.long;
54    subtype C_Size_T   is Interfaces.C.size_t;
55    subtype C_UInt     is Interfaces.C.unsigned;
56    subtype C_ULong    is Interfaces.C.unsigned_long;
57    subtype C_Char_Ptr is Interfaces.C.Strings.chars_ptr;
58    type    C_Void_Ptr is new System.Address;
59
60    --  This is how those constants are defined in ncurses. I see them also
61    --  exactly like this in all ETI implementations I ever tested. So it
62    --  could be that this is quite general, but please check with your curses.
63    --  This is critical, because curses sometime mixes Boolean returns with
64    --  returning an error status.
65    Curses_Ok    : constant C_Int := Curses_Constants.OK;
66    Curses_Err   : constant C_Int := Curses_Constants.ERR;
67
68    Curses_True  : constant C_Int := Curses_Constants.TRUE;
69    Curses_False : constant C_Int := Curses_Constants.FALSE;
70
71    --  Eti_Error: type for error codes returned by the menu and form subsystem
72    type Eti_Error is
73      (E_Current,
74       E_Invalid_Field,
75       E_Request_Denied,
76       E_Not_Connected,
77       E_Not_Selectable,
78       E_No_Match,
79       E_Unknown_Command,
80       E_Not_Posted,
81       E_No_Room,
82       E_Bad_State,
83       E_Connected,
84       E_Posted,
85       E_Bad_Argument,
86       E_System_Error,
87       E_Ok);
88
89    procedure Eti_Exception (Code : Eti_Error);
90    --  Do nothing if Code = E_Ok.
91    --  Else dispatch the error code and raise the appropriate exception.
92
93    procedure Fill_String (Cp  : chars_ptr;
94                           Str : out String);
95    --  Fill the Str parameter with the string denoted by the chars_ptr
96    --  C-Style string.
97
98    function Fill_String (Cp : chars_ptr) return String;
99    --  Same but as function.
100
101 private
102    for Eti_Error'Size use C_Int'Size;
103    pragma Convention (C, Eti_Error);
104    for Eti_Error use
105      (E_Current         => Curses_Constants.E_CURRENT,
106       E_Invalid_Field   => Curses_Constants.E_INVALID_FIELD,
107       E_Request_Denied  => Curses_Constants.E_REQUEST_DENIED,
108       E_Not_Connected   => Curses_Constants.E_NOT_CONNECTED,
109       E_Not_Selectable  => Curses_Constants.E_NOT_SELECTABLE,
110       E_No_Match        => Curses_Constants.E_NO_MATCH,
111       E_Unknown_Command => Curses_Constants.E_UNKNOWN_COMMAND,
112       E_Not_Posted      => Curses_Constants.E_NOT_POSTED,
113       E_No_Room         => Curses_Constants.E_NO_ROOM,
114       E_Bad_State       => Curses_Constants.E_BAD_STATE,
115       E_Connected       => Curses_Constants.E_CONNECTED,
116       E_Posted          => Curses_Constants.E_POSTED,
117       E_Bad_Argument    => Curses_Constants.E_BAD_ARGUMENT,
118       E_System_Error    => Curses_Constants.E_SYSTEM_ERROR,
119       E_Ok              => Curses_Constants.E_OK);
120 end Terminal_Interface.Curses.Aux;