ncurses 6.2 - patch 20200627
[ncurses.git] / Ada95 / src / terminal_interface-curses-terminfo.ads
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                           GNAT ncurses Binding                           --
4 --                                                                          --
5 --                     Terminal_Interface.Curses.Terminfo                   --
6 --                                                                          --
7 --                                 S P E C                                  --
8 --                                                                          --
9 ------------------------------------------------------------------------------
10 -- Copyright 2020 Thomas E. Dickey                                          --
11 -- Copyright 2000-2002,2003 Free Software Foundation, Inc.                  --
12 --                                                                          --
13 -- Permission is hereby granted, free of charge, to any person obtaining a  --
14 -- copy of this software and associated documentation files (the            --
15 -- "Software"), to deal in the Software without restriction, including      --
16 -- without limitation the rights to use, copy, modify, merge, publish,      --
17 -- distribute, distribute with modifications, sublicense, and/or sell       --
18 -- copies of the Software, and to permit persons to whom the Software is    --
19 -- furnished to do so, subject to the following conditions:                 --
20 --                                                                          --
21 -- The above copyright notice and this permission notice shall be included  --
22 -- in all copies or substantial portions of the Software.                   --
23 --                                                                          --
24 -- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  --
25 -- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               --
26 -- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   --
27 -- IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   --
28 -- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    --
29 -- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    --
30 -- THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               --
31 --                                                                          --
32 -- Except as contained in this notice, the name(s) of the above copyright   --
33 -- holders shall not be used in advertising or otherwise to promote the     --
34 -- sale, use or other dealings in this Software without prior written       --
35 -- authorization.                                                           --
36 ------------------------------------------------------------------------------
37 --  Author:  Juergen Pfeifer, 1996
38 --  Version Control:
39 --  $Revision: 1.5 $
40 --  Binding Version 01.00
41 ------------------------------------------------------------------------------
42
43 with Interfaces.C;
44
45 package Terminal_Interface.Curses.Terminfo is
46    pragma Preelaborate (Terminal_Interface.Curses.Terminfo);
47
48    --  |=====================================================================
49    --  | Man page curs_terminfo.3x
50    --  |=====================================================================
51    --  Not implemented:  setupterm, setterm, set_curterm, del_curterm,
52    --                    restartterm, tparm, putp, vidputs,  vidattr,
53    --                    mvcur
54
55    type Terminfo_String is new String;
56
57    --  |
58    procedure Get_String (Name   : String;
59                          Value  : out Terminfo_String;
60                          Result : out Boolean);
61    function Has_String (Name : String) return Boolean;
62    --  AKA: tigetstr()
63
64    --  |
65    function Get_Flag (Name : String) return Boolean;
66    --  AKA: tigetflag()
67
68    --  |
69    function Get_Number (Name : String) return Integer;
70    --  AKA: tigetnum()
71
72    type putctype is access function (c : Interfaces.C.int)
73                                     return Interfaces.C.int;
74    pragma Convention (C, putctype);
75
76    --  |
77    procedure Put_String (Str    : Terminfo_String;
78                          affcnt : Natural := 1;
79                          putc   : putctype := null);
80    --  AKA: tputs()
81
82 end Terminal_Interface.Curses.Terminfo;