blob: 21719dbd99d8eeedaf843920d1df2bb91b78d206 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html>
<head>
<title>terminal_interface-curses-forms-field_types-enumeration.ads</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<style type="text/css">
*.comment {
color: green;
}
*.symbol {
color: red;
}
</style>
</head>
<body>
<hr><div style="text-align:center"><h1> File : terminal_interface-curses-forms-field_types-enumeration.ads </h1></div><hr>
<pre>
<span class="comment"><em>------------------------------------------------------------------------------</em></span>
<span class="comment"><em>-- --</em></span>
<span class="comment"><em>-- <strong>GNAT</strong> ncurses Binding --</em></span>
<span class="comment"><em>-- --</em></span>
<span class="comment"><em>-- Terminal_Interface.Curses.Forms.Field_Types.Enumeration --</em></span>
<span class="comment"><em>-- --</em></span>
<span class="comment"><em>-- S P E C --</em></span>
<span class="comment"><em>-- --</em></span>
<span class="comment"><em>------------------------------------------------------------------------------</em></span>
<span class="comment"><em>-- Copyright 2018,2020 Thomas E. Dickey --</em></span>
<span class="comment"><em>-- Copyright 1999-2003,2009 Free Software Foundation, Inc. --</em></span>
<span class="comment"><em>-- --</em></span>
<span class="comment"><em>-- Permission is hereby granted, free of charge, to any person obtaining a --</em></span>
<span class="comment"><em>-- copy of this software and associated documentation files (the --</em></span>
<span class="comment"><em>-- "Software"), to deal in the Software without restriction, including --</em></span>
<span class="comment"><em>-- without limitation the rights to use, copy, modify, merge, publish, --</em></span>
<span class="comment"><em>-- distribute, distribute with modifications, sublicense, and/or sell --</em></span>
<span class="comment"><em>-- copies of the Software, and to permit persons to whom the Software is --</em></span>
<span class="comment"><em>-- furnished to do so, subject to the following conditions: --</em></span>
<span class="comment"><em>-- --</em></span>
<span class="comment"><em>-- The above copyright notice and this permission notice shall be included --</em></span>
<span class="comment"><em>-- in all copies or substantial portions of the Software. --</em></span>
<span class="comment"><em>-- --</em></span>
<span class="comment"><em>-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS --</em></span>
<span class="comment"><em>-- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF --</em></span>
<span class="comment"><em>-- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. --</em></span>
<span class="comment"><em>-- IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, --</em></span>
<span class="comment"><em>-- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR --</em></span>
<span class="comment"><em>-- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR --</em></span>
<span class="comment"><em>-- THE USE OR OTHER DEALINGS IN THE SOFTWARE. --</em></span>
<span class="comment"><em>-- --</em></span>
<span class="comment"><em>-- Except as contained in this notice, the name(s) of the above copyright --</em></span>
<span class="comment"><em>-- holders shall not be used in advertising or otherwise to promote the --</em></span>
<span class="comment"><em>-- sale, use or other dealings in this Software without prior written --</em></span>
<span class="comment"><em>-- authorization. --</em></span>
<span class="comment"><em>------------------------------------------------------------------------------</em></span>
<span class="comment"><em>-- Author: Juergen Pfeifer, 1996</em></span>
<span class="comment"><em>-- Version Control:</em></span>
<span class="comment"><em>-- @Revision: 1.15 @</em></span>
<span class="comment"><em>-- Binding Version 01.00</em></span>
<span class="comment"><em>------------------------------------------------------------------------------</em></span>
<b>with</b> <a href="interfac__ads.htm#ref_38_9">Interfaces</a>.C.Strings;
<b>package</b> <a href="terminal_interface__ads.htm#ref_43_9">Terminal_Interface</a>.<a href="terminal_interface-curses__ads.htm#ref_48_28">Curses</a>.<a href="terminal_interface-curses-forms__ads.htm#ref_46_35">Forms</a>.<a href="terminal_interface-curses-forms-field_types__ads.htm#ref_45_41">Field_Types</a>.<span class="symbol"><a name="ref_44_53" href="terminal_interface-curses-forms-field_types-enumeration__adb.htm#ref_47_58">Enumeration</a></span> <b>is</b>
<b>pragma</b> Preelaborate
(<a href="terminal_interface__ads.htm#ref_43_9">Terminal_Interface</a>.<a href="terminal_interface-curses__ads.htm#ref_48_28">Curses</a>.<a href="terminal_interface-curses-forms__ads.htm#ref_46_35">Forms</a>.<a href="terminal_interface-curses-forms-field_types__ads.htm#ref_45_41">Field_Types</a>.<a href="terminal_interface-curses-forms-field_types-enumeration__ads.htm#ref_44_53">Enumeration</a>);
<b>type</b> <span class="symbol"><a name="ref_48_9">String_Access</a></span> <b>is</b> <b>access</b> String;
<span class="comment"><em>-- Type_Set is used by the child package Ada</em></span>
<b>type</b> <span class="symbol"><a name="ref_51_9">Type_Set</a></span> <b>is</b> (<span class="symbol"><a name="ref_51_22">Lower_Case</a></span>, <span class="symbol"><a name="ref_51_34">Upper_Case</a></span>, <span class="symbol"><a name="ref_51_46">Mixed_Case</a></span>);
<b>type</b> Enum_Array <b>is</b> <b>array</b> (Positive <b>range</b> &lt;&gt;)
<b>of</b> <a href="terminal_interface-curses-forms-field_types-enumeration__ads.htm#ref_48_9">String_Access</a>;
<b>type</b> <span class="symbol"><a name="ref_56_9">Enumeration_Info</a></span> (<span class="symbol"><a name="ref_56_27">C</a></span> : Positive) <b>is</b>
<b>record</b>
<span class="symbol"><a name="ref_58_10">Case_Sensitive</a></span> : Boolean := False;
<span class="symbol"><a name="ref_59_10">Match_Must_Be_Unique</a></span> : Boolean := False;
<span class="symbol"><a name="ref_60_10">Names</a></span> : Enum_Array (1 .. <a href="terminal_interface-curses-forms-field_types-enumeration__ads.htm#ref_56_27">C</a>);
<b>end</b> <b>record</b>;
<b>type</b> <span class="symbol"><a name="ref_63_9">Enumeration_Field</a></span> <b>is</b> <b>new</b> <a href="terminal_interface-curses-forms-field_types__ads.htm#ref_53_9">Field_Type</a> <b>with</b> <b>private</b>;
<b>function</b> <span class="symbol"><a name="ref_65_13" href="terminal_interface-curses-forms-field_types-enumeration__adb.htm#ref_49_13">Create</a></span> (<span class="symbol"><a name="ref_65_21" href="terminal_interface-curses-forms-field_types-enumeration__adb.htm#ref_49_21">Info</a></span> : <a href="terminal_interface-curses-forms-field_types-enumeration__ads.htm#ref_56_9">Enumeration_Info</a>;
<span class="symbol"><a name="ref_66_21" href="terminal_interface-curses-forms-field_types-enumeration__adb.htm#ref_50_21">Auto_Release_Names</a></span> : Boolean := False)
<b>return</b> <a href="terminal_interface-curses-forms-field_types-enumeration__ads.htm#ref_63_9">Enumeration_Field</a>;
<span class="comment"><em>-- Make an fieldtype from the info. Enumerations are special, because</em></span>
<span class="comment"><em>-- they normally don't copy the enum values into a private store, so</em></span>
<span class="comment"><em>-- we have to care for the lifetime of the info we provide.</em></span>
<span class="comment"><em>-- The Auto_Release_Names flag may be used to automatically releases</em></span>
<span class="comment"><em>-- the strings in the Names array of the Enumeration_Info.</em></span>
<b>function</b> Make_Enumeration_Type (<span class="symbol"><a name="ref_74_36">Info</a></span> : <a href="terminal_interface-curses-forms-field_types-enumeration__ads.htm#ref_56_9">Enumeration_Info</a>;
<span class="symbol"><a name="ref_75_36">Auto_Release_Names</a></span> : Boolean := False)
<b>return</b> <a href="terminal_interface-curses-forms-field_types-enumeration__ads.htm#ref_63_9">Enumeration_Field</a> <b>renames</b> <a href="terminal_interface-curses-forms-field_types-enumeration__ads.htm#ref_65_13">Create</a>;
<b>procedure</b> <span class="symbol"><a name="ref_78_14" href="terminal_interface-curses-forms-field_types-enumeration__adb.htm#ref_77_14">Release</a></span> (<span class="symbol"><a name="ref_78_23" href="terminal_interface-curses-forms-field_types-enumeration__adb.htm#ref_77_23">Enum</a></span> : <b>in</b> <b>out</b> <a href="terminal_interface-curses-forms-field_types-enumeration__ads.htm#ref_63_9">Enumeration_Field</a>);
<span class="comment"><em>-- But we may want to release the field to release the memory allocated</em></span>
<span class="comment"><em>-- by it internally. After that the Enumeration field is no longer usable.</em></span>
<span class="comment"><em>-- The next type definitions are all ncurses extensions. They are typically</em></span>
<span class="comment"><em>-- not available in other curses implementations.</em></span>
<b>procedure</b> <span class="symbol"><a name="ref_85_14" href="terminal_interface-curses-forms-field_types-enumeration__adb.htm#ref_92_14">Set_Field_Type</a></span> (<span class="symbol"><a name="ref_85_30" href="terminal_interface-curses-forms-field_types-enumeration__adb.htm#ref_92_30">Fld</a></span> : <a href="terminal_interface-curses-forms__ads.htm#ref_52_9">Field</a>;
<span class="symbol"><a name="ref_86_30" href="terminal_interface-curses-forms-field_types-enumeration__adb.htm#ref_93_30">Typ</a></span> : <a href="terminal_interface-curses-forms-field_types-enumeration__ads.htm#ref_63_9">Enumeration_Field</a>);
<b>pragma</b> Inline (Set_Field_Type);
<b>private</b>
<b>type</b> <span class="symbol"><a name="ref_90_9" href="terminal_interface-curses-forms-field_types-enumeration__ads.htm#ref_44_53">CPA_Access</a></span> <b>is</b> <b>access</b> <a href="interfac__ads.htm#ref_38_9">Interfaces</a>.C.Strings.chars_ptr_array;
<b>type</b> <a href="terminal_interface-curses-forms-field_types-enumeration__ads.htm#ref_63_9">Enumeration_Field</a> <b>is</b> <b>new</b> <a href="terminal_interface-curses-forms-field_types__ads.htm#ref_53_9">Field_Type</a> <b>with</b>
<b>record</b>
<span class="symbol"><a name="ref_94_10">Case_Sensitive</a></span> : Boolean := False;
<span class="symbol"><a name="ref_95_10">Match_Must_Be_Unique</a></span> : Boolean := False;
<span class="symbol"><a name="ref_96_10">Arr</a></span> : <a href="terminal_interface-curses-forms-field_types-enumeration__ads.htm#ref_90_9">CPA_Access</a> := <b>null</b>;
<b>end</b> <b>record</b>;
<b>end</b> <a href="terminal_interface__ads.htm#ref_43_9">Terminal_Interface</a>.<a href="terminal_interface-curses__ads.htm#ref_48_28">Curses</a>.<a href="terminal_interface-curses-forms__ads.htm#ref_46_35">Forms</a>.<a href="terminal_interface-curses-forms-field_types__ads.htm#ref_45_41">Field_Types</a>.<a href="terminal_interface-curses-forms-field_types-enumeration__ads.htm#ref_44_53">Enumeration</a>;
</pre></body></html>