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