terminal_interface-curses-forms.ads.m4 [plain text]
define(`HTMLNAME',`terminal_interface-curses-forms__ads.htm')dnl
include(M4MACRO)dnl
include(`Form_Base_Defs')
with System;
with Ada.Characters.Latin_1;
package Terminal_Interface.Curses.Forms is
pragma Preelaborate (Terminal_Interface.Curses.Forms);
include(`Form_Linker_Options')dnl
include(`Linker_Options')
Space : Character renames Ada.Characters.Latin_1.Space;
type Field is private;
type Form is private;
Null_Field : constant Field;
Null_Form : constant Form;
type Field_Justification is (None,
Left,
Center,
Right);
pragma Warnings (Off);
include(`Field_Rep')Dnl
pragma Warnings (On);
function Default_Field_Options return Field_Option_Set;
pragma Inline (Default_Field_Options);
pragma Warnings (Off);
include(`Form_Opt_Rep')Dnl
pragma Warnings (On);
function Default_Form_Options return Form_Option_Set;
pragma Inline (Default_Form_Options);
type Buffer_Number is new Natural;
type Field_Array is array (Positive range <>) of aliased Field;
pragma Convention (C, Field_Array);
type Field_Array_Access is access Field_Array;
procedure Free (FA : in out Field_Array_Access;
Free_Fields : in Boolean := False);
subtype Form_Request_Code is Key_Code range (Key_Max + 1) .. (Key_Max + 57);
F_Next_Page : constant Form_Request_Code := Key_Max + 1;
F_Previous_Page : constant Form_Request_Code := Key_Max + 2;
F_First_Page : constant Form_Request_Code := Key_Max + 3;
F_Last_Page : constant Form_Request_Code := Key_Max + 4;
F_Next_Field : constant Form_Request_Code := Key_Max + 5;
F_Previous_Field : constant Form_Request_Code := Key_Max + 6;
F_First_Field : constant Form_Request_Code := Key_Max + 7;
F_Last_Field : constant Form_Request_Code := Key_Max + 8;
F_Sorted_Next_Field : constant Form_Request_Code := Key_Max + 9;
F_Sorted_Previous_Field : constant Form_Request_Code := Key_Max + 10;
F_Sorted_First_Field : constant Form_Request_Code := Key_Max + 11;
F_Sorted_Last_Field : constant Form_Request_Code := Key_Max + 12;
F_Left_Field : constant Form_Request_Code := Key_Max + 13;
F_Right_Field : constant Form_Request_Code := Key_Max + 14;
F_Up_Field : constant Form_Request_Code := Key_Max + 15;
F_Down_Field : constant Form_Request_Code := Key_Max + 16;
F_Next_Char : constant Form_Request_Code := Key_Max + 17;
F_Previous_Char : constant Form_Request_Code := Key_Max + 18;
F_Next_Line : constant Form_Request_Code := Key_Max + 19;
F_Previous_Line : constant Form_Request_Code := Key_Max + 20;
F_Next_Word : constant Form_Request_Code := Key_Max + 21;
F_Previous_Word : constant Form_Request_Code := Key_Max + 22;
F_Begin_Field : constant Form_Request_Code := Key_Max + 23;
F_End_Field : constant Form_Request_Code := Key_Max + 24;
F_Begin_Line : constant Form_Request_Code := Key_Max + 25;
F_End_Line : constant Form_Request_Code := Key_Max + 26;
F_Left_Char : constant Form_Request_Code := Key_Max + 27;
F_Right_Char : constant Form_Request_Code := Key_Max + 28;
F_Up_Char : constant Form_Request_Code := Key_Max + 29;
F_Down_Char : constant Form_Request_Code := Key_Max + 30;
F_New_Line : constant Form_Request_Code := Key_Max + 31;
F_Insert_Char : constant Form_Request_Code := Key_Max + 32;
F_Insert_Line : constant Form_Request_Code := Key_Max + 33;
F_Delete_Char : constant Form_Request_Code := Key_Max + 34;
F_Delete_Previous : constant Form_Request_Code := Key_Max + 35;
F_Delete_Line : constant Form_Request_Code := Key_Max + 36;
F_Delete_Word : constant Form_Request_Code := Key_Max + 37;
F_Clear_EOL : constant Form_Request_Code := Key_Max + 38;
F_Clear_EOF : constant Form_Request_Code := Key_Max + 39;
F_Clear_Field : constant Form_Request_Code := Key_Max + 40;
F_Overlay_Mode : constant Form_Request_Code := Key_Max + 41;
F_Insert_Mode : constant Form_Request_Code := Key_Max + 42;
F_ScrollForward_Line : constant Form_Request_Code := Key_Max + 43;
F_ScrollBackward_Line : constant Form_Request_Code := Key_Max + 44;
F_ScrollForward_Page : constant Form_Request_Code := Key_Max + 45;
F_ScrollBackward_Page : constant Form_Request_Code := Key_Max + 46;
F_ScrollForward_HalfPage : constant Form_Request_Code := Key_Max + 47;
F_ScrollBackward_HalfPage : constant Form_Request_Code := Key_Max + 48;
F_HScrollForward_Char : constant Form_Request_Code := Key_Max + 49;
F_HScrollBackward_Char : constant Form_Request_Code := Key_Max + 50;
F_HScrollForward_Line : constant Form_Request_Code := Key_Max + 51;
F_HScrollBackward_Line : constant Form_Request_Code := Key_Max + 52;
F_HScrollForward_HalfLine : constant Form_Request_Code := Key_Max + 53;
F_HScrollBackward_HalfLine : constant Form_Request_Code := Key_Max + 54;
F_Validate_Field : constant Form_Request_Code := Key_Max + 55;
F_Next_Choice : constant Form_Request_Code := Key_Max + 56;
F_Previous_Choice : constant Form_Request_Code := Key_Max + 57;
REQ_NEXT_PAGE : Form_Request_Code renames F_Next_Page;
REQ_PREV_PAGE : Form_Request_Code renames F_Previous_Page;
REQ_FIRST_PAGE : Form_Request_Code renames F_First_Page;
REQ_LAST_PAGE : Form_Request_Code renames F_Last_Page;
REQ_NEXT_FIELD : Form_Request_Code renames F_Next_Field;
REQ_PREV_FIELD : Form_Request_Code renames F_Previous_Field;
REQ_FIRST_FIELD : Form_Request_Code renames F_First_Field;
REQ_LAST_FIELD : Form_Request_Code renames F_Last_Field;
REQ_SNEXT_FIELD : Form_Request_Code renames F_Sorted_Next_Field;
REQ_SPREV_FIELD : Form_Request_Code renames F_Sorted_Previous_Field;
REQ_SFIRST_FIELD : Form_Request_Code renames F_Sorted_First_Field;
REQ_SLAST_FIELD : Form_Request_Code renames F_Sorted_Last_Field;
REQ_LEFT_FIELD : Form_Request_Code renames F_Left_Field;
REQ_RIGHT_FIELD : Form_Request_Code renames F_Right_Field;
REQ_UP_FIELD : Form_Request_Code renames F_Up_Field;
REQ_DOWN_FIELD : Form_Request_Code renames F_Down_Field;
REQ_NEXT_CHAR : Form_Request_Code renames F_Next_Char;
REQ_PREV_CHAR : Form_Request_Code renames F_Previous_Char;
REQ_NEXT_LINE : Form_Request_Code renames F_Next_Line;
REQ_PREV_LINE : Form_Request_Code renames F_Previous_Line;
REQ_NEXT_WORD : Form_Request_Code renames F_Next_Word;
REQ_PREV_WORD : Form_Request_Code renames F_Previous_Word;
REQ_BEG_FIELD : Form_Request_Code renames F_Begin_Field;
REQ_END_FIELD : Form_Request_Code renames F_End_Field;
REQ_BEG_LINE : Form_Request_Code renames F_Begin_Line;
REQ_END_LINE : Form_Request_Code renames F_End_Line;
REQ_LEFT_CHAR : Form_Request_Code renames F_Left_Char;
REQ_RIGHT_CHAR : Form_Request_Code renames F_Right_Char;
REQ_UP_CHAR : Form_Request_Code renames F_Up_Char;
REQ_DOWN_CHAR : Form_Request_Code renames F_Down_Char;
REQ_NEW_LINE : Form_Request_Code renames F_New_Line;
REQ_INS_CHAR : Form_Request_Code renames F_Insert_Char;
REQ_INS_LINE : Form_Request_Code renames F_Insert_Line;
REQ_DEL_CHAR : Form_Request_Code renames F_Delete_Char;
REQ_DEL_PREV : Form_Request_Code renames F_Delete_Previous;
REQ_DEL_LINE : Form_Request_Code renames F_Delete_Line;
REQ_DEL_WORD : Form_Request_Code renames F_Delete_Word;
REQ_CLR_EOL : Form_Request_Code renames F_Clear_EOL;
REQ_CLR_EOF : Form_Request_Code renames F_Clear_EOF;
REQ_CLR_FIELD : Form_Request_Code renames F_Clear_Field;
REQ_OVL_MODE : Form_Request_Code renames F_Overlay_Mode;
REQ_INS_MODE : Form_Request_Code renames F_Insert_Mode;
REQ_SCR_FLINE : Form_Request_Code renames F_ScrollForward_Line;
REQ_SCR_BLINE : Form_Request_Code renames F_ScrollBackward_Line;
REQ_SCR_FPAGE : Form_Request_Code renames F_ScrollForward_Page;
REQ_SCR_BPAGE : Form_Request_Code renames F_ScrollBackward_Page;
REQ_SCR_FHPAGE : Form_Request_Code renames F_ScrollForward_HalfPage;
REQ_SCR_BHPAGE : Form_Request_Code renames F_ScrollBackward_HalfPage;
REQ_SCR_FCHAR : Form_Request_Code renames F_HScrollForward_Char;
REQ_SCR_BCHAR : Form_Request_Code renames F_HScrollBackward_Char;
REQ_SCR_HFLINE : Form_Request_Code renames F_HScrollForward_Line;
REQ_SCR_HBLINE : Form_Request_Code renames F_HScrollBackward_Line;
REQ_SCR_HFHALF : Form_Request_Code renames F_HScrollForward_HalfLine;
REQ_SCR_HBHALF : Form_Request_Code renames F_HScrollBackward_HalfLine;
REQ_VALIDATION : Form_Request_Code renames F_Validate_Field;
REQ_NEXT_CHOICE : Form_Request_Code renames F_Next_Choice;
REQ_PREV_CHOICE : Form_Request_Code renames F_Previous_Choice;
procedure Request_Name (Key : in Form_Request_Code;
Name : out String);
function Request_Name (Key : Form_Request_Code) return String;
pragma Inline (Request_Name);
Form_Exception : exception;
function Create (Height : Line_Count;
Width : Column_Count;
Top : Line_Position;
Left : Column_Position;
Off_Screen : Natural := 0;
More_Buffers : Buffer_Number := Buffer_Number'First)
return Field;
function New_Field (Height : Line_Count;
Width : Column_Count;
Top : Line_Position;
Left : Column_Position;
Off_Screen : Natural := 0;
More_Buffers : Buffer_Number := Buffer_Number'First)
return Field renames Create;
pragma Inline (New_Field);
procedure Delete (Fld : in out Field);
function Duplicate (Fld : Field;
Top : Line_Position;
Left : Column_Position) return Field;
pragma Inline (Duplicate);
function Link (Fld : Field;
Top : Line_Position;
Left : Column_Position) return Field;
pragma Inline (Link);
procedure Set_Justification (Fld : in Field;
Just : in Field_Justification := None);
pragma Inline (Set_Justification);
function Get_Justification (Fld : Field) return Field_Justification;
pragma Inline (Get_Justification);
procedure Set_Buffer
(Fld : in Field;
Buffer : in Buffer_Number := Buffer_Number'First;
Str : in String);
procedure Get_Buffer
(Fld : in Field;
Buffer : in Buffer_Number := Buffer_Number'First;
Str : out String);
function Get_Buffer
(Fld : in Field;
Buffer : in Buffer_Number := Buffer_Number'First) return String;
pragma Inline (Get_Buffer);
procedure Set_Status (Fld : in Field;
Status : in Boolean := True);
pragma Inline (Set_Status);
function Changed (Fld : Field) return Boolean;
pragma Inline (Changed);
procedure Set_Maximum_Size (Fld : in Field;
Max : in Natural := 0);
pragma Inline (Set_Maximum_Size);
procedure Set_Options (Fld : in Field;
Options : in Field_Option_Set);
procedure Switch_Options (Fld : in Field;
Options : in Field_Option_Set;
On : Boolean := True);
procedure Get_Options (Fld : in Field;
Options : out Field_Option_Set);
function Get_Options (Fld : Field := Null_Field)
return Field_Option_Set;
procedure Set_Foreground
(Fld : in Field;
Fore : in Character_Attribute_Set := Normal_Video;
Color : in Color_Pair := Color_Pair'First);
pragma Inline (Set_Foreground);
procedure Foreground (Fld : in Field;
Fore : out Character_Attribute_Set);
procedure Foreground (Fld : in Field;
Fore : out Character_Attribute_Set;
Color : out Color_Pair);
pragma Inline (Foreground);
procedure Set_Background
(Fld : in Field;
Back : in Character_Attribute_Set := Normal_Video;
Color : in Color_Pair := Color_Pair'First);
pragma Inline (Set_Background);
procedure Background (Fld : in Field;
Back : out Character_Attribute_Set);
procedure Background (Fld : in Field;
Back : out Character_Attribute_Set;
Color : out Color_Pair);
pragma Inline (Background);
procedure Set_Pad_Character (Fld : in Field;
Pad : in Character := Space);
pragma Inline (Set_Pad_Character);
procedure Pad_Character (Fld : in Field;
Pad : out Character);
pragma Inline (Pad_Character);
procedure Info (Fld : in Field;
Lines : out Line_Count;
Columns : out Column_Count;
First_Row : out Line_Position;
First_Column : out Column_Position;
Off_Screen : out Natural;
Additional_Buffers : out Buffer_Number);
pragma Inline (Info);
procedure Dynamic_Info (Fld : in Field;
Lines : out Line_Count;
Columns : out Column_Count;
Max : out Natural);
pragma Inline (Dynamic_Info);
procedure Set_Window (Frm : in Form;
Win : in Window);
pragma Inline (Set_Window);
function Get_Window (Frm : Form) return Window;
pragma Inline (Get_Window);
procedure Set_Sub_Window (Frm : in Form;
Win : in Window);
pragma Inline (Set_Sub_Window);
function Get_Sub_Window (Frm : Form) return Window;
pragma Inline (Get_Sub_Window);
procedure Scale (Frm : in Form;
Lines : out Line_Count;
Columns : out Column_Count);
pragma Inline (Scale);
type Form_Hook_Function is access procedure (Frm : in Form);
pragma Convention (C, Form_Hook_Function);
procedure Set_Field_Init_Hook (Frm : in Form;
Proc : in Form_Hook_Function);
pragma Inline (Set_Field_Init_Hook);
procedure Set_Field_Term_Hook (Frm : in Form;
Proc : in Form_Hook_Function);
pragma Inline (Set_Field_Term_Hook);
procedure Set_Form_Init_Hook (Frm : in Form;
Proc : in Form_Hook_Function);
pragma Inline (Set_Form_Init_Hook);
procedure Set_Form_Term_Hook (Frm : in Form;
Proc : in Form_Hook_Function);
pragma Inline (Set_Form_Term_Hook);
function Get_Field_Init_Hook (Frm : Form) return Form_Hook_Function;
pragma Import (C, Get_Field_Init_Hook, "field_init");
function Get_Field_Term_Hook (Frm : Form) return Form_Hook_Function;
pragma Import (C, Get_Field_Term_Hook, "field_term");
function Get_Form_Init_Hook (Frm : Form) return Form_Hook_Function;
pragma Import (C, Get_Form_Init_Hook, "form_init");
function Get_Form_Term_Hook (Frm : Form) return Form_Hook_Function;
pragma Import (C, Get_Form_Term_Hook, "form_term");
procedure Redefine (Frm : in Form;
Flds : in Field_Array_Access);
pragma Inline (Redefine);
procedure Set_Fields (Frm : in Form;
Flds : in Field_Array_Access) renames Redefine;
function Fields (Frm : Form;
Index : Positive) return Field;
pragma Inline (Fields);
function Field_Count (Frm : Form) return Natural;
pragma Inline (Field_Count);
procedure Move (Fld : in Field;
Line : in Line_Position;
Column : in Column_Position);
pragma Inline (Move);
function Create (Fields : Field_Array_Access) return Form;
pragma Inline (Create);
function New_Form (Fields : Field_Array_Access) return Form
renames Create;
procedure Delete (Frm : in out Form);
pragma Inline (Delete);
procedure Set_Options (Frm : in Form;
Options : in Form_Option_Set);
pragma Inline (Set_Options);
procedure Switch_Options (Frm : in Form;
Options : in Form_Option_Set;
On : Boolean := True);
pragma Inline (Switch_Options);
procedure Get_Options (Frm : in Form;
Options : out Form_Option_Set);
function Get_Options (Frm : Form := Null_Form) return Form_Option_Set;
pragma Inline (Get_Options);
procedure Post (Frm : in Form;
Post : in Boolean := True);
pragma Inline (Post);
procedure Position_Cursor (Frm : Form);
pragma Inline (Position_Cursor);
function Data_Ahead (Frm : Form) return Boolean;
pragma Inline (Data_Ahead);
function Data_Behind (Frm : Form) return Boolean;
pragma Inline (Data_Behind);
type Driver_Result is (Form_Ok,
Request_Denied,
Unknown_Request,
Invalid_Field);
function Driver (Frm : Form;
Key : Key_Code) return Driver_Result;
type Page_Number is new Natural;
procedure Set_Current (Frm : in Form;
Fld : in Field);
pragma Inline (Set_Current);
function Current (Frm : in Form) return Field;
pragma Inline (Current);
procedure Set_Page (Frm : in Form;
Page : in Page_Number := Page_Number'First);
pragma Inline (Set_Page);
function Page (Frm : Form) return Page_Number;
pragma Inline (Page);
function Get_Index (Fld : Field) return Positive;
pragma Inline (Get_Index);
procedure Set_New_Page (Fld : in Field;
New_Page : in Boolean := True);
pragma Inline (Set_New_Page);
function Is_New_Page (Fld : Field) return Boolean;
pragma Inline (Is_New_Page);
private
type Field is new System.Storage_Elements.Integer_Address;
type Form is new System.Storage_Elements.Integer_Address;
Null_Field : constant Field := 0;
Null_Form : constant Form := 0;
end Terminal_Interface.Curses.Forms;