ncurses 6.1 - patch 20191102
[ncurses.git] / Ada95 / src / terminal_interface-curses-termcap.ads
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                           GNAT ncurses Binding                           --
4 --                                                                          --
5 --                     Terminal_Interface.Curses.Termcap                    --
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 package Terminal_Interface.Curses.Termcap is
43    pragma Preelaborate (Terminal_Interface.Curses.Termcap);
44
45    --  |=====================================================================
46    --  | Man page curs_termcap.3x
47    --  |=====================================================================
48    --  Not implemented:  tputs (see curs_terminfo)
49
50    type Termcap_String is new String;
51
52    --  |
53    function TGoto (Cap : String;
54                    Col : Column_Position;
55                    Row : Line_Position) return Termcap_String;
56    --  AKA: tgoto()
57
58    --  |
59    function Get_Entry (Name : String) return Boolean;
60    --  AKA: tgetent()
61
62    --  |
63    function Get_Flag (Name : String) return Boolean;
64    --  AKA: tgetflag()
65
66    --  |
67    procedure Get_Number (Name   : String;
68                          Value  : out Integer;
69                          Result : out Boolean);
70    --  AKA: tgetnum()
71
72    --  |
73    procedure Get_String (Name   : String;
74                          Value  : out String;
75                          Result : out Boolean);
76    function Get_String (Name : String) return Boolean;
77    --  Returns True if the string is found.
78    --  AKA: tgetstr()
79
80 end Terminal_Interface.Curses.Termcap;