ncurses 6.2 - patch 20200627
[ncurses.git] / Ada95 / src / terminal_interface-curses-forms-field_types-user.ads
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                           GNAT ncurses Binding                           --
4 --                                                                          --
5 --               Terminal_Interface.Curses.Forms.Field_Types.User           --
6 --                                                                          --
7 --                                 S P E C                                  --
8 --                                                                          --
9 ------------------------------------------------------------------------------
10 -- Copyright 2020 Thomas E. Dickey                                          --
11 -- Copyright 1999-2009,2011 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.16 $
40 --  $Date: 2020/02/02 23:34:34 $
41 --  Binding Version 01.00
42 ------------------------------------------------------------------------------
43 with Interfaces.C;
44
45 package Terminal_Interface.Curses.Forms.Field_Types.User is
46    pragma Preelaborate (Terminal_Interface.Curses.Forms.Field_Types.User);
47    subtype C_Int is Interfaces.C.int;
48
49    type User_Defined_Field_Type is abstract new Field_Type with null record;
50    --  This is the root of the mechanism we use to create field types in
51    --  Ada95. You should your own type derive from this one and implement
52    --  the Field_Check and Character_Check functions for your own type.
53
54    type User_Defined_Field_Type_Access is access all
55      User_Defined_Field_Type'Class;
56
57    function Field_Check
58      (Fld : Field;
59       Typ : User_Defined_Field_Type) return Boolean
60       is abstract;
61    --  If True is returned, the field is considered valid, otherwise it is
62    --  invalid.
63
64    function Character_Check
65      (Ch  : Character;
66       Typ : User_Defined_Field_Type) return Boolean
67       is abstract;
68    --  If True is returned, the character is considered as valid for the
69    --  field, otherwise as invalid.
70
71    procedure Set_Field_Type (Fld : Field;
72                              Typ : User_Defined_Field_Type);
73    --  This should work for all types derived from User_Defined_Field_Type.
74    --  No need to reimplement it for your derived type.
75
76    --  +----------------------------------------------------------------------
77    --  | Private Part.
78    --  | Used by the Choice child package.
79 private
80    function C_Generic_Type   return C_Field_Type;
81
82    function Generic_Field_Check (Fld : Field;
83                                  Usr : System.Address) return Curses_Bool;
84    pragma Convention (C, Generic_Field_Check);
85    --  This is the generic Field_Check_Function for the low-level fieldtype
86    --  representing all the User_Defined_Field_Type derivatives. It routes
87    --  the call to the Field_Check implementation for the type.
88
89    function Generic_Char_Check (Ch  : C_Int;
90                                 Usr : System.Address) return Curses_Bool;
91    pragma Convention (C, Generic_Char_Check);
92    --  This is the generic Char_Check_Function for the low-level fieldtype
93    --  representing all the User_Defined_Field_Type derivatives. It routes
94    --  the call to the Character_Check implementation for the type.
95
96 end Terminal_Interface.Curses.Forms.Field_Types.User;