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