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