1 ------------------------------------------------------------------------------
3 -- GNAT ncurses Binding --
5 -- Terminal_Interface.Curses.Forms.Field_Types.Enumeration --
9 ------------------------------------------------------------------------------
10 -- Copyright 2018,2020 Thomas E. Dickey --
11 -- Copyright 1999-2003,2009 Free Software Foundation, Inc. --
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: --
21 -- The above copyright notice and this permission notice shall be included --
22 -- in all copies or substantial portions of the Software. --
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. --
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 --
36 ------------------------------------------------------------------------------
37 -- Author: Juergen Pfeifer, 1996
40 -- Binding Version 01.00
41 ------------------------------------------------------------------------------
42 with Interfaces.C.Strings;
44 package Terminal_Interface.Curses.Forms.Field_Types.Enumeration is
46 (Terminal_Interface.Curses.Forms.Field_Types.Enumeration);
48 type String_Access is access String;
50 -- Type_Set is used by the child package Ada
51 type Type_Set is (Lower_Case, Upper_Case, Mixed_Case);
53 type Enum_Array is array (Positive range <>)
56 type Enumeration_Info (C : Positive) is
58 Case_Sensitive : Boolean := False;
59 Match_Must_Be_Unique : Boolean := False;
60 Names : Enum_Array (1 .. C);
63 type Enumeration_Field is new Field_Type with private;
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.
74 function Make_Enumeration_Type (Info : Enumeration_Info;
75 Auto_Release_Names : Boolean := False)
76 return Enumeration_Field renames Create;
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.
82 -- The next type definitions are all ncurses extensions. They are typically
83 -- not available in other curses implementations.
85 procedure Set_Field_Type (Fld : Field;
86 Typ : Enumeration_Field);
87 pragma Inline (Set_Field_Type);
90 type CPA_Access is access Interfaces.C.Strings.chars_ptr_array;
92 type Enumeration_Field is new Field_Type with
94 Case_Sensitive : Boolean := False;
95 Match_Must_Be_Unique : Boolean := False;
96 Arr : CPA_Access := null;
99 end Terminal_Interface.Curses.Forms.Field_Types.Enumeration;