ncurses 5.7 - patch 20090321
[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 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.16 $
42 --  Binding Version 01.00
43 ------------------------------------------------------------------------------
44 include(`Base_Defs')
45 with System;
46 with Interfaces.C;
47 with Interfaces.C.Strings; use Interfaces.C.Strings;
48 with Unchecked_Conversion;
49
50 package Terminal_Interface.Curses.Aux is
51    pragma Preelaborate (Terminal_Interface.Curses.Aux);
52
53    use type Interfaces.C.int;
54
55    subtype C_Int      is Interfaces.C.int;
56    subtype C_Short    is Interfaces.C.short;
57    subtype C_Long_Int is Interfaces.C.long;
58    subtype C_Size_T   is Interfaces.C.size_t;
59    subtype C_UInt     is Interfaces.C.unsigned;
60    subtype C_ULong    is Interfaces.C.unsigned_long;
61    subtype C_Char_Ptr is Interfaces.C.Strings.chars_ptr;
62    type    C_Void_Ptr is new System.Address;
63 include(`Chtype_Def')
64    --  This is how those constants are defined in ncurses. I see them also
65    --  exactly like this in all ETI implementations I ever tested. So it
66    --  could be that this is quite general, but please check with your curses.
67    --  This is critical, because curses sometime mixes boolean returns with
68    --  returning an error status.
69    Curses_Ok    : constant C_Int := CF_CURSES_OK;
70    Curses_Err   : constant C_Int := CF_CURSES_ERR;
71
72    Curses_True  : constant C_Int := CF_CURSES_TRUE;
73    Curses_False : constant C_Int := CF_CURSES_FALSE;
74
75    --  Eti_Error: type for error codes returned by the menu and form subsystem
76 include(`Eti_Defs')
77    procedure Eti_Exception (Code : Eti_Error);
78    --  Dispatch the error code and raise the appropriate exception
79    --
80    --
81    --  Some helpers
82    function Chtype_To_AttrChar is new
83      Unchecked_Conversion (Source => C_Chtype,
84                            Target => Attributed_Character);
85    function AttrChar_To_Chtype is new
86      Unchecked_Conversion (Source => Attributed_Character,
87                            Target => C_Chtype);
88
89    function AttrChar_To_AttrType is new
90      Unchecked_Conversion (Source => Attributed_Character,
91                            Target => C_AttrType);
92
93    function AttrType_To_AttrChar is new
94      Unchecked_Conversion (Source => C_AttrType,
95                            Target => Attributed_Character);
96
97    procedure Fill_String (Cp  : in  chars_ptr;
98                           Str : out String);
99    --  Fill the Str parameter with the string denoted by the chars_ptr
100    --  C-Style string.
101
102    function Fill_String (Cp : chars_ptr) return String;
103    --  Same but as function.
104
105 end Terminal_Interface.Curses.Aux;