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