Ada95/src/terminal_interface-curses-forms-field_types-enumeration.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                           GNAT ncurses Binding                           --
   4 --                                                                          --
   5 --           Terminal_Interface.Curses.Forms.Field_Types.Enumeration        --
   6 --                                                                          --
   7 --                                 S P E C                                  --
   8 --                                                                          --
   9 ------------------------------------------------------------------------------
  10 -- Copyright 2018,2020 Thomas E. Dickey                                     --
  11 -- Copyright 1999-2003,2009 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 --  Binding Version 01.00
  41 ------------------------------------------------------------------------------
  42 with Interfaces.C.Strings;
  43
  44 package Terminal_Interface.Curses.Forms.Field_Types.Enumeration is
  45    pragma Preelaborate
  46      (Terminal_Interface.Curses.Forms.Field_Types.Enumeration);
  47
  48    type String_Access is access String;
  49
  50    --  Type_Set is used by the child package Ada
  51    type Type_Set is (Lower_Case, Upper_Case, Mixed_Case);
  52
  53    type Enum_Array is array (Positive range <>)
  54      of String_Access;
  55
  56    type Enumeration_Info (C : Positive) is
  57       record
  58          Case_Sensitive       : Boolean := False;
  59          Match_Must_Be_Unique : Boolean := False;
  60          Names                : Enum_Array (1 .. C);
  61       end record;
  62
  63    type Enumeration_Field is new Field_Type with private;
  64
  65    function Create (Info : Enumeration_Info;
  66                     Auto_Release_Names : Boolean := False)
  67                     return Enumeration_Field;
  68    --  Make an fieldtype from the info. Enumerations are special, because
  69    --  they normally don't copy the enum values into a private store, so
  70    --  we have to care for the lifetime of the info we provide.
  71    --  The Auto_Release_Names flag may be used to automatically releases
  72    --  the strings in the Names array of the Enumeration_Info.
  73
  74    function Make_Enumeration_Type (Info : Enumeration_Info;
  75                                    Auto_Release_Names : Boolean := False)
  76                                    return Enumeration_Field renames Create;
  77
  78    procedure Release (Enum : in out Enumeration_Field);
  79    --  But we may want to release the field to release the memory allocated
  80    --  by it internally. After that the Enumeration field is no longer usable.
  81
  82    --  The next type definitions are all ncurses extensions. They are typically
  83    --  not available in other curses implementations.
  84
  85    procedure Set_Field_Type (Fld : Field;
  86                              Typ : Enumeration_Field);
  87    pragma Inline (Set_Field_Type);
  88
  89 private
  90    type CPA_Access is access Interfaces.C.Strings.chars_ptr_array;
  91
  92    type Enumeration_Field is new Field_Type with
  93       record
  94          Case_Sensitive       : Boolean := False;
  95          Match_Must_Be_Unique : Boolean := False;
  96          Arr                  : CPA_Access := null;
  97       end record;
  98
  99 end Terminal_Interface.Curses.Forms.Field_Types.Enumeration;