ncurses 5.0
[ncurses.git] / Ada95 / html / index.html
1 <!DOCTYPE HTML
2  PUBLIC "-//IETF//DTD HTML 3.0//EN">
3 <HTML>
4
5 <HEAD>
6 <TITLE>Ada95 Binding for ncurses</Title>
7 </HEAD>
8 <BODY BGCOLOR="#99ccbb" TEXT="#000000" LINK="#4060b0" VLINK="#000080" ALINK="#ff4040">
9 <H1>Ada95 Binding for ncurses</H1>
10 The ncurses Ada95 binding is &copy; 1996-1999 by 
11 <A HREF="mailto:juergen.pfeifer@gmx.net">J&uuml;rgen Pfeifer</A>.
12 <P>
13                                                                          
14 Permission is hereby granted to reproduce and distribute this
15 binding by any means and for any fee, whether alone or as part 
16 of a larger distribution, in source or in binary form, PROVIDED        
17 this notice is included with any such distribution, and is not    
18 removed from any of its header files. Mention of ncurses and the
19 author of this binding in any applications linked with it is 
20 highly appreciated.<BR>                
21                                                                          
22 This binding comes AS IS with no warranty, implied or expressed.       
23 <P>
24 <HR SIZE=3 NOSHADE>
25 <H2>General Remarks</H2>
26 <UL>
27 <LI>This document describes Version 01.00 of the binding.</LI>
28 <LI>The functionality is modelled to be compatible with the ncurses
29 package, a clone of the SVr4 curses model.<BR>
30 I did the development on an Intel box running 
31 <A HREF="http://www.linux.org">Linux</A> 1.3.x, 2.0, 2.2
32 ncurses-4.x and the 
33 <A HREF="http://www.gnat.com">GNU Ada Translator</A>
34 gnat versions 3.10p to 3.11p. For any older versions of ncurses and gnat
35 it is not guaranteed to work.</LI>
36 <LI>You must have the m4 macroprocessor to build this package.
37 If you don't have this program, you can get the FSF version
38 <A HREF="ftp://prep.ai.mit.edu/pub/gnu/">here</A>.</LI>
39 <LI>Ada programs are supposed to be readable. One of my
40 favourite methods to make code readable is to use expressive
41 names for the identifiers. You can find a list of a mapping
42 of the cryptic curses names to the Ada names in this <A HREF="table.html">table</A>.</LI>
43 <LI>This is not a typical one-2-one interface mapping. It is 
44 close to one-2-one on the functional level. Each (n)curses function
45 has it's counterpart with a more or less similar formal parameter list
46 in the binding. It is not one-2-one with respect to the datatypes.
47 I tried to make records out of the flat chtype and similar structures,
48 so you don't have to do bit operations to mark an attributed character
49 as bold. Just make the boolean member <STRONG>bold</STRONG> of the record 
50 true. The binding also hides the structures like WINDOW, PANEL, MENU, FORM
51 etc. ! It's a pure functional API.</LI>
52 <LI>I try to do as much error checking as possible and feasible
53 in the binding. I will raise an Ada exception when something
54 went wrong in the low-level curses. This has the effect that - at least
55 first time in my life - (n)curses programs have now a very rigid error
56 checking, but - thanks to Ada - you don't have to code the orgiastic
57 error checking style of C.</LI>
58 <LI>Support for wide characters is currently not in the binding, as it
59 is not really in ncurses at this point in time.</LI>
60 </UL>
61 <P>
62       
63 <H2>Limitations</H2>
64 <UL>
65 <LI>I provide no SCREEN datatype and functions to set a new screen.
66 If you need this (mostly for debugging I guess), write a small
67 C routine doing all this and import it into your Ada program.</LI>
68 <LI>I provide no functions to switch on/off curses tracing options.
69 Same suggestion as above.</LI>
70 <LI>Although Ada95 is an OO Language, this binding doesn't provide
71 an OO abstraction of the (n)curses functionality. As mentioned above
72 it's a thin binding for the (n)curses functions. But without any
73 doubt it would be nice to build on top of this an OO abstraction
74 of (n)curses functionality.<BR>
75 The only exception is the method how fieldtypes are represented in
76 this Binding. We provide an abstract tagged type Field_Type from
77 which the various fieldtypes are derived.</LI>
78 <LI>I currently do not support the link_fieldtype functionality of the
79 forms subsystem.</LI>
80 <LI>The *_IO packages are currently output only.</LI>
81 </UL>
82          
83
84 <H2>Hierarchy of packages</H2>
85 <UL>
86 <LI><A HREF="ada/terminal_interface__ads.htm">Terminal_Interface</A>
87     <UL><LI><A HREF="ada/terminal_interface-curses__ads.htm">Curses</A>
88         <UL><LI><A HREF="ada/terminal_interface-curses-mouse__ads.htm">Mouse</A>
89             <LI><A HREF="ada/terminal_interface-curses-panels__ads.htm">Panels</A>
90             <UL><LI><A HREF="ada/terminal_interface-curses-panels-user_data__ads.htm">User_Data</A>
91             </UL>
92             <LI><A HREF="ada/terminal_interface-curses-menus__ads.htm">Menus</A>
93                 <UL><LI><A HREF="ada/terminal_interface-curses-menus-menu_user_data__ads.htm">Menu_User_Data</A>
94                     <LI><A HREF="ada/terminal_interface-curses-menus-item_user_data__ads.htm">Item_User_Data</A>
95                 </UL>    
96             <LI><A HREF="ada/terminal_interface-curses-forms__ads.htm">Forms</A>
97                 <UL><LI><A HREF="ada/terminal_interface-curses-forms-form_user_data__ads.htm">Form_User_Data</A>
98                     <LI><A HREF="ada/terminal_interface-curses-forms-field_user_data__ads.htm">Field_User_Data</A>
99                     <LI><A HREF="ada/terminal_interface-curses-forms-field_types__ads.htm">Field_Types</A>                   
100                     <UL><LI><A HREF="ada/terminal_interface-curses-forms-field_types-alpha__ads.htm">Alpha</A>
101                         <LI><A HREF="ada/terminal_interface-curses-forms-field_types-alphanumeric__ads.htm">AlphaNumeric</A>
102                         <LI><A HREF="ada/terminal_interface-curses-forms-field_types-intfield__ads.htm">IntField</A>
103                         <LI><A HREF="ada/terminal_interface-curses-forms-field_types-numeric__ads.htm">Numeric</A>
104                         <LI><A HREF="ada/terminal_interface-curses-forms-field_types-regexp__ads.htm">RegExp</A>
105                         <LI><A HREF="ada/terminal_interface-curses-forms-field_types-ipv4_address__ads.htm">IPV4_Address</A>
106                         <LI><A HREF="ada/terminal_interface-curses-forms-field_types-enumeration__ads.htm">Enumeration</A>
107                         <UL><LI><A HREF="ada/terminal_interface-curses-forms-field_types-enumeration-ada__ads.htm">Ada</A>
108                         </UL>
109                         <LI><A HREF="ada/terminal_interface-curses-forms-field_types-user__ads.htm">User</A>
110                         <UL><LI><A HREF="ada/terminal_interface-curses-forms-field_types-user-choice__ads.htm">Choice</A>
111                         </UL>
112                      </UL>   
113                 </UL>   
114             <LI><A HREF="ada/terminal_interface-curses-text_io__ads.htm">Text_IO</A>
115                 <UL><LI><A HREF="ada/terminal_interface-curses-text_io-integer_io__ads.htm">Integer_IO</A>
116                     <LI><A HREF="ada/terminal_interface-curses-text_io-float_io__ads.htm">Float_IO</A>
117                     <LI><A HREF="ada/terminal_interface-curses-text_io-fixed_io__ads.htm">Fixed_IO</A>
118                     <LI><A HREF="ada/terminal_interface-curses-text_io-decimal_io__ads.htm">Decimal_IO</A>
119                     <LI><A HREF="ada/terminal_interface-curses-text_io-modular_io__ads.htm">Modular_IO</A>
120                     <LI><A HREF="ada/terminal_interface-curses-text_io-enumeration_io__ads.htm">Enumeration_IO</A>
121                     <LI><A HREF="ada/terminal_interface-curses-text_io-complex_io__ads.htm">Complex_IO</A>
122                 </UL>
123          </UL>
124      </UL>        
125 </UL>
126 If you want to navigate through the html pages of the package specs, click <A HREF="ada/index.htm">here</A>.
127 <H2>Implementation Details</H2>
128 <H4>Behind the abstraction</H4>
129 All the new types like <STRONG>Window</STRONG>, <STRONG>Panel</STRONG>,
130 <STRONG>Menu</STRONG>, <STRONG>Form</STRONG> etc. are just
131 opaque representations of the pointers to the corresponding 
132 low level (n)curses structures like 
133 <STRONG>WINDOW *</STRONG>, <STRONG>PANEL *</STRONG>,
134 <STRONG>MENU *</STRONG> or <STRONG>FORM *</STRONG>.
135 So you can safely pass them to C routines that expect a pointer
136 to one of those structures.
137 <H4>Extended ripoffline() usage</H4>
138 The official documentation of (n)curses says, that the line parameter
139 determines only whether or not exactly <STRONG>one</STRONG> line is
140 stolen from the top or bottom of the screen. So essentially only the
141 sign of the parameter is evaluated. ncurses has internally implemented
142 it in a way, that uses the line parameter also to control the amount of
143 lines to steal. This mechanism is used in the <STRONG>Rip_Off_Lines</STRONG>
144 routine of the binding.
145 <A NAME="userpointer">
146 <H4>How user defined field types work</H4>
147 TBD
148 <H4>Enumeration fields handling</H4>
149 The (n)curses documentation says, that the String arrays to be passed to
150 an TYPE_ENUM fieldtype must not be automatic variables. This is not true
151 in this binding, because it is internally arranged to safely copy these
152 values.
153 <A NAME="compiler">
154 <H4>Using other Ada compilers</H4>
155 This should basically not be a problem.
156 <H4>Port to other curses implementations</H4>
157 Basically it should not be too hard to make all this run on a regular SVr4
158 implementation of curses. The problems are probably these:<BR>
159 <UL>
160 <LI>ncurses has some additional features which are presented in this binding. You
161 have two choices to deal with this:
162 <UL>
163 <LI>Emulate the feature in this binding</LI>
164 <LI>Raise an exception for non implemented features</LI>
165 </UL>
166 Most likely you will follow a mixed approach. Some features are easy to simulate,
167 others will be hard if not impossible.</LI>
168 </UL>
169 I'm quite sure I forgot something.<P>
170 </BODY>
171 </HTML>