Ada95/src/terminal_interface-curses-forms-field_types-user-choice.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                           GNAT ncurses Binding                           --
   4 --                                                                          --
   5 --           Terminal_Interface.Curses.Forms.Field_Types.User.Choice        --
   6 --                                                                          --
   7 --                                 S P E C                                  --
   8 --                                                                          --
   9 ------------------------------------------------------------------------------
  10 -- Copyright 2020 Thomas E. Dickey                                          --
  11 -- Copyright 1999-2008,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.15 $
  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.Choice is
  46    pragma Preelaborate
  47      (Terminal_Interface.Curses.Forms.Field_Types.User.Choice);
  48
  49    subtype C_Int is Interfaces.C.int;
  50
  51    type User_Defined_Field_Type_With_Choice is abstract new
  52      User_Defined_Field_Type with null record;
  53    --  This is the root of the mechanism we use to create field types in
  54    --  Ada95 that allow the prev/next mechanism. You should your own type
  55    --  derive from this one and implement the Field_Check, Character_Check
  56    --  Next and Previous functions for your own type.
  57
  58    type User_Defined_Field_Type_With_Choice_Access is access all
  59      User_Defined_Field_Type_With_Choice'Class;
  60
  61    function Next
  62      (Fld : Field;
  63       Typ : User_Defined_Field_Type_With_Choice) return Boolean
  64       is abstract;
  65    --  If True is returned, the function successfully generated a next
  66    --  value into the fields buffer.
  67
  68    function Previous
  69      (Fld : Field;
  70       Typ : User_Defined_Field_Type_With_Choice) return Boolean
  71       is abstract;
  72    --  If True is returned, the function successfully generated a previous
  73    --  value into the fields buffer.
  74
  75    --  +----------------------------------------------------------------------
  76    --  | Private Part.
  77    --  |
  78 private
  79    function C_Generic_Choice return C_Field_Type;
  80
  81    function Generic_Next (Fld : Field;
  82                           Usr : System.Address) return Curses_Bool;
  83    pragma Convention (C, Generic_Next);
  84    --  This is the generic next Choice_Function for the low-level fieldtype
  85    --  representing all the User_Defined_Field_Type derivatives. It routes
  86    --  the call to the Next implementation for the type.
  87
  88    function Generic_Prev (Fld : Field;
  89                           Usr : System.Address) return Curses_Bool;
  90    pragma Convention (C, Generic_Prev);
  91    --  This is the generic prev Choice_Function for the low-level fieldtype
  92    --  representing all the User_Defined_Field_Type derivatives. It routes
  93    --  the call to the Previous implementation for the type.
  94
  95 end Terminal_Interface.Curses.Forms.Field_Types.User.Choice;