e62ead7ac07a7efb7f8bc16bccb99b89dc2756ec
[ncurses.git] / doc / html / ncurses-intro.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3.0//EN">
2 <!--
3   $Id: ncurses-intro.html,v 1.41 2005/12/24 15:47:05 tom Exp $
4   ****************************************************************************
5   * Copyright (c) 1998-2004,2005 Free Software Foundation, Inc.              *
6   *                                                                          *
7   * Permission is hereby granted, free of charge, to any person obtaining a  *
8   * copy of this software and associated documentation files (the            *
9   * "Software"), to deal in the Software without restriction, including      *
10   * without limitation the rights to use, copy, modify, merge, publish,      *
11   * distribute, distribute with modifications, sublicense, and/or sell       *
12   * copies of the Software, and to permit persons to whom the Software is    *
13   * furnished to do so, subject to the following conditions:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25   *                                                                          *
26   * Except as contained in this notice, the name(s) of the above copyright   *
27   * holders shall not be used in advertising or otherwise to promote the     *
28   * sale, use or other dealings in this Software without prior written       *
29   * authorization.                                                           *
30   ****************************************************************************
31 -->
32 <HTML>
33 <HEAD>
34 <TITLE>Writing Programs with NCURSES</TITLE>
35 <link rev="made" href="mailto:bugs-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
37 </HEAD>
38 <BODY>
39
40 <H1>Writing Programs with NCURSES</H1>
41
42 <BLOCKQUOTE>
43 by Eric S. Raymond and Zeyd M. Ben-Halim<BR>
44 updates since release 1.9.9e by Thomas Dickey
45 </BLOCKQUOTE>
46
47 <H1>Contents</H1>
48 <UL>
49 <LI><A HREF="#introduction">Introduction</A>
50 <UL>
51 <LI><A HREF="#history">A Brief History of Curses</A>
52 <LI><A HREF="#scope">Scope of This Document</A>
53 <LI><A HREF="#terminology">Terminology</A>
54 </UL>
55 <LI><A HREF="#curses">The Curses Library</A>
56 <UL>
57 <LI><A HREF="#overview">An Overview of Curses</A>
58 <UL>
59 <LI><A HREF="#compiling">Compiling Programs using Curses</A>
60 <LI><A HREF="#updating">Updating the Screen</A>
61 <LI><A HREF="#stdscr">Standard Windows and Function Naming Conventions</A>
62 <LI><A HREF="#variables">Variables</A>
63 </UL>
64 <LI><A HREF="#using">Using the Library</A>
65 <UL>
66 <LI><A HREF="#starting">Starting up</A>
67 <LI><A HREF="#output">Output</A>
68 <LI><A HREF="#input">Input</A>
69 <LI><A HREF="#formschars">Using Forms Characters</A>
70 <LI><A HREF="#attributes">Character Attributes and Color</A>
71 <LI><A HREF="#mouse">Mouse Interfacing</A>
72 <LI><A HREF="#finishing">Finishing Up</A>
73 </UL>
74 <LI><A HREF="#functions">Function Descriptions</A>
75 <UL>
76 <LI><A HREF="#init">Initialization and Wrapup</A>
77 <LI><A HREF="#flush">Causing Output to the Terminal</A>
78 <LI><A HREF="#lowlevel">Low-Level Capability Access</A>
79 <LI><A HREF="#debugging">Debugging</A>
80 </UL>
81 <LI><A HREF="#hints">Hints, Tips, and Tricks</A>
82 <UL>
83 <LI><A HREF="#caution">Some Notes of Caution</A>
84 <LI><A HREF="#leaving">Temporarily Leaving ncurses Mode</A>
85 <LI><A HREF="#xterm">Using <CODE>ncurses</CODE> under <CODE>xterm</CODE></A>
86 <LI><A HREF="#screens">Handling Multiple Terminal Screens</A>
87 <LI><A HREF="#testing">Testing for Terminal Capabilities</A>
88 <LI><A HREF="#tuning">Tuning for Speed</A>
89 <LI><A HREF="#special">Special Features of <CODE>ncurses</CODE></A>
90 </UL>
91 <LI><A HREF="#compat">Compatibility with Older Versions</A>
92 <UL>
93 <LI><A HREF="#refbug">Refresh of Overlapping Windows</A>
94 <LI><A HREF="#backbug">Background Erase</A>
95 </UL>
96 <LI><A HREF="#xsifuncs">XSI Curses Conformance</A>
97 </UL>
98 <LI><A HREF="#panels">The Panels Library</A>
99 <UL>
100 <LI><A HREF="#pcompile">Compiling With the Panels Library</A>
101 <LI><A HREF="#poverview">Overview of Panels</A>
102 <LI><A HREF="#pstdscr">Panels, Input, and the Standard Screen</A>
103 <LI><A HREF="#hiding">Hiding Panels</A>
104 <LI><A HREF="#pmisc">Miscellaneous Other Facilities</A>
105 </UL>
106 <LI><A HREF="#menu">The Menu Library</A>
107 <UL>
108 <LI><A HREF="#mcompile">Compiling with the menu Library</A>
109 <LI><A HREF="#moverview">Overview of Menus</A>
110 <LI><A HREF="#mselect">Selecting items</A>
111 <LI><A HREF="#mdisplay">Menu Display</A>
112 <LI><A HREF="#mwindows">Menu Windows</A>
113 <LI><A HREF="#minput">Processing Menu Input</A>
114 <LI><A HREF="#mmisc">Miscellaneous Other Features</A>
115 </UL>
116 <LI><A HREF="#form">The Forms Library</A>
117 <UL>
118 <LI><A HREF="#fcompile">Compiling with the forms Library</A>
119 <LI><A HREF="#foverview">Overview of Forms</A>
120 <LI><A HREF="#fcreate">Creating and Freeing Fields and Forms</A>
121 <LI><A HREF="#fattributes">Fetching and Changing Field Attributes</A>
122 <UL>
123 <LI><A HREF="#fsizes">Fetching Size and Location Data</A>
124 <LI><A HREF="#flocation">Changing the Field Location</A>
125 <LI><A HREF="#fjust">The Justification Attribute</A>
126 <LI><A HREF="#fdispatts">Field Display Attributes</A>
127 <LI><A HREF="#foptions">Field Option Bits</A>
128 <LI><A HREF="#fstatus">Field Status</A>
129 <LI><A HREF="#fuser">Field User Pointer</A>
130 </UL>
131 <LI><A HREF="#fdynamic">Variable-Sized Fields</A>
132 <LI><A HREF="#fvalidation">Field Validation</A>
133 <UL>
134 <LI><A HREF="#ftype_alpha">TYPE_ALPHA</A>
135 <LI><A HREF="#ftype_alnum">TYPE_ALNUM</A>
136 <LI><A HREF="#ftype_enum">TYPE_ENUM</A>
137 <LI><A HREF="#ftype_integer">TYPE_INTEGER</A>
138 <LI><A HREF="#ftype_numeric">TYPE_NUMERIC</A>
139 <LI><A HREF="#ftype_regexp">TYPE_REGEXP</A>
140 </UL>
141 <LI><A HREF="#fbuffer">Direct Field Buffer Manipulation</A>
142 <LI><A HREF="#formattrs">Attributes of Forms</A>
143 <LI><A HREF="#fdisplay">Control of Form Display</A>
144 <LI><A HREF="#fdriver">Input Processing in the Forms Driver</A>
145 <UL>
146 <LI><A HREF="#fpage">Page Navigation Requests</A>
147 <LI><A HREF="#ffield">Inter-Field Navigation Requests</A>
148 <LI><A HREF="#fifield">Intra-Field Navigation Requests</A>
149 <LI><A HREF="#fscroll">Scrolling Requests</A>
150 <LI><A HREF="#fedit">Field Editing Requests</A>
151 <LI><A HREF="#forder">Order Requests</A>
152 <LI><A HREF="#fappcmds">Application Commands</A>
153 </UL>
154 <LI><A HREF="#fhooks">Field Change Hooks</A>
155 <LI><A HREF="#ffocus">Field Change Commands</A>
156 <LI><A HREF="#frmoptions">Form Options</A>
157 <LI><A HREF="#fcustom">Custom Validation Types</A>
158 <UL>
159 <LI><A HREF="#flinktypes">Union Types</A>
160 <LI><A HREF="#fnewtypes">New Field Types</A>
161 <LI><A HREF="#fcheckargs">Validation Function Arguments</A>
162 <LI><A HREF="#fcustorder">Order Functions For Custom Types</A>
163 <LI><A HREF="#fcustprobs">Avoiding Problems</A>
164 </UL>
165 </UL>
166 </UL>
167
168 <HR>
169 <H1><A NAME="introduction">Introduction</A></H1>
170
171 This document is an introduction to programming with <CODE>curses</CODE>. It is
172 not an exhaustive reference for the curses Application Programming Interface
173 (API); that role is filled by the <CODE>curses</CODE> manual pages.  Rather, it
174 is intended to help C programmers ease into using the package. <P>
175
176 This document is aimed at C applications programmers not yet specifically
177 familiar with ncurses.  If you are already an experienced <CODE>curses</CODE>
178 programmer, you should nevertheless read the sections on
179 <A HREF="#mouse">Mouse Interfacing</A>, <A HREF="#debugging">Debugging</A>,
180 <A HREF="#compat">Compatibility with Older Versions</A>,
181 and <A HREF="#hints">Hints, Tips, and Tricks</A>.  These will bring you up
182 to speed on the special features and quirks of the <CODE>ncurses</CODE>
183 implementation.  If you are not so experienced, keep reading. <P>
184
185 The <CODE>curses</CODE> package is a subroutine library for
186 terminal-independent screen-painting and input-event handling which
187 presents a high level screen model to the programmer, hiding differences
188 between terminal types and doing automatic optimization of output to change
189 one screen full of text into another.  <CODE>Curses</CODE> uses terminfo, which
190 is a database format that can describe the capabilities of thousands of
191 different terminals. <P>
192
193 The <CODE>curses</CODE> API may seem something of an archaism on UNIX desktops
194 increasingly dominated by X, Motif, and Tcl/Tk.  Nevertheless, UNIX still
195 supports tty lines and X supports <EM>xterm(1)</EM>; the <CODE>curses</CODE>
196 API has the advantage of (a) back-portability to character-cell terminals,
197 and (b) simplicity.  For an application that does not require bit-mapped
198 graphics and multiple fonts, an interface implementation using <CODE>curses</CODE>
199 will typically be a great deal simpler and less expensive than one using an
200 X toolkit.
201
202 <H2><A NAME="history">A Brief History of Curses</A></H2>
203
204 Historically, the first ancestor of <CODE>curses</CODE> was the routines written to
205 provide screen-handling for the game <CODE>rogue</CODE>; these used the
206 already-existing <CODE>termcap</CODE> database facility for describing terminal
207 capabilities.  These routines were abstracted into a documented library and
208 first released with the early BSD UNIX versions. <P>
209
210 System III UNIX from Bell Labs featured a rewritten and much-improved
211 <CODE>curses</CODE> library.  It introduced the terminfo format.  Terminfo is based
212 on Berkeley's termcap database, but contains a number of improvements and
213 extensions. Parameterized capabilities strings were introduced, making it
214 possible to describe multiple video attributes, and colors and to handle far
215 more unusual terminals than possible with termcap.  In the later AT&amp;T
216 System V releases, <CODE>curses</CODE> evolved to use more facilities and offer
217 more capabilities, going far beyond BSD curses in power and flexibility.
218
219 <H2><A NAME="scope">Scope of This Document</A></H2>
220
221 This document describes <CODE>ncurses</CODE>, a free implementation of
222 the System V <CODE>curses</CODE> API with some clearly marked extensions.
223 It includes the following System V curses features:
224 <UL>
225 <LI>Support for multiple screen highlights (BSD curses could only
226 handle one `standout' highlight, usually reverse-video).
227 <LI>Support for line- and box-drawing using forms characters.
228 <LI>Recognition of function keys on input.
229 <LI>Color support.
230 <LI>Support for pads (windows of larger than screen size on which the
231 screen or a subwindow defines a viewport).
232 </UL>
233
234 Also, this package makes use of the insert and delete line and character
235 features of terminals so equipped, and determines how to optimally use these
236 features with no help from the programmer.  It allows arbitrary combinations of
237 video attributes to be displayed, even on terminals that leave ``magic
238 cookies'' on the screen to mark changes in attributes. <P>
239
240 The <CODE>ncurses</CODE> package can also capture and use event reports from a
241 mouse in some environments (notably, xterm under the X window system).  This
242 document includes tips for using the mouse. <P>
243
244 The <CODE>ncurses</CODE> package was originated by Pavel Curtis.  The original
245 maintainer of this package is
246 <A HREF="mailto:zmbenhal@netcom.com">Zeyd Ben-Halim</A>
247 &lt;zmbenhal@netcom.com&gt;.
248 <A HREF="mailto:esr@snark.thyrsus.com">Eric S. Raymond</A>
249 &lt;esr@snark.thyrsus.com&gt;
250 wrote many of the new features in versions after 1.8.1
251 and wrote most of this introduction.
252 J&uuml;rgen Pfeifer
253 wrote all of the menu and forms code as well as the
254 <A HREF="http://www.adahome.com">Ada95</A> binding.
255 Ongoing work is being done by
256 <A HREF="mailto:dickey@invisible-island.net">Thomas Dickey</A> (maintainer).
257 Contact the current maintainers at
258 <A HREF="mailto:bug-ncurses@gnu.org">bug-ncurses@gnu.org</A>.
259 <P>
260
261 This document also describes the <A HREF="#panels">panels</A> extension library,
262 similarly modeled on the SVr4 panels facility.  This library allows you to
263 associate backing store with each of a stack or deck of overlapping windows,
264 and provides operations for moving windows around in the stack that change
265 their visibility in the natural way (handling window overlaps). <P>
266
267 Finally, this document describes in detail the <A HREF="#menu">menus</A> and <A
268 HREF="#form">forms</A> extension libraries, also cloned from System V,
269 which support easy construction and sequences of menus and fill-in
270 forms.
271
272
273 <H2><A NAME="terminology">Terminology</A></H2>
274
275 In this document, the following terminology is used with reasonable
276 consistency:
277
278 <DL>
279 <DT> window
280 <DD>
281 A data structure describing a sub-rectangle of the screen (possibly the
282 entire screen).  You can write to a window as though it were a miniature
283 screen, scrolling independently of other windows on the physical screen.
284 <DT> screens
285 <DD>
286 A subset of windows which are as large as the terminal screen, i.e., they start
287 at the upper left hand corner and encompass the lower right hand corner.  One
288 of these, <CODE>stdscr</CODE>, is automatically provided for the programmer.
289 <DT> terminal screen
290 <DD>
291 The package's idea of what the terminal display currently looks like, i.e.,
292 what the user sees now.  This is a special screen.
293 </DL>
294
295 <H1><A NAME="curses">The Curses Library</A></H1>
296
297 <H2><A NAME="overview">An Overview of Curses</A></H2>
298
299 <H3><A NAME="compiling">Compiling Programs using Curses</A></H3>
300
301 In order to use the library, it is necessary to have certain types and
302 variables defined.  Therefore, the programmer must have a line:
303
304 <PRE>
305           #include &lt;curses.h&gt;
306 </PRE>
307
308 at the top of the program source.  The screen package uses the Standard I/O
309 library, so <CODE>&lt;curses.h&gt;</CODE> includes
310 <CODE>&lt;stdio.h&gt;</CODE>. <CODE>&lt;curses.h&gt;</CODE> also includes
311 <CODE>&lt;termios.h&gt;</CODE>, <CODE>&lt;termio.h&gt;</CODE>, or
312 <CODE>&lt;sgtty.h&gt;</CODE> depending on your system.  It is redundant (but
313 harmless) for the programmer to do these includes, too. In linking with
314 <CODE>curses</CODE> you need to have <CODE>-lncurses</CODE> in your LDFLAGS or on the
315 command line.  There is no need for any other libraries.
316
317 <H3><A NAME="updating">Updating the Screen</A></H3>
318
319 In order to update the screen optimally, it is necessary for the routines to
320 know what the screen currently looks like and what the programmer wants it to
321 look like next. For this purpose, a data type (structure) named WINDOW is
322 defined which describes a window image to the routines, including its starting
323 position on the screen (the (y, x) coordinates of the upper left hand corner)
324 and its size.  One of these (called <CODE>curscr</CODE>, for current screen) is a
325 screen image of what the terminal currently looks like.  Another screen (called
326 <CODE>stdscr</CODE>, for standard screen) is provided by default to make changes
327 on. <P>
328
329 A window is a purely internal representation. It is used to build and store a
330 potential image of a portion of the terminal.  It doesn't bear any necessary
331 relation to what is really on the terminal screen; it's more like a
332 scratchpad or write buffer. <P>
333
334 To make the section of physical screen corresponding to a window reflect the
335 contents of the window structure, the routine <CODE>refresh()</CODE> (or
336 <CODE>wrefresh()</CODE> if the window is not <CODE>stdscr</CODE>) is called. <P>
337
338 A given physical screen section may be within the scope of any number of
339 overlapping windows.  Also, changes can be made to windows in any order,
340 without regard to motion efficiency.  Then, at will, the programmer can
341 effectively say ``make it look like this,'' and let the package implementation
342 determine the most efficient way to repaint the screen.
343
344 <H3><A NAME="stdscr">Standard Windows and Function Naming Conventions</A></H3>
345
346 As hinted above, the routines can use several windows, but two are
347 automatically given: <CODE>curscr</CODE>, which knows what the terminal looks like,
348 and <CODE>stdscr</CODE>, which is what the programmer wants the terminal to look
349 like next.  The user should never actually access <CODE>curscr</CODE> directly.
350 Changes should be made to through the API, and then the routine
351 <CODE>refresh()</CODE> (or <CODE>wrefresh()</CODE>) called. <P>
352
353 Many functions are defined to use <CODE>stdscr</CODE> as a default screen.  For
354 example, to add a character to <CODE>stdscr</CODE>, one calls <CODE>addch()</CODE> with
355 the desired character as argument.  To write to a different window. use the
356 routine <CODE>waddch()</CODE> (for `w'indow-specific addch()) is provided.  This
357 convention of prepending function names with a `w' when they are to be
358 applied to specific windows is consistent.  The only routines which do not
359 follow it are those for which a window must always be specified. <P>
360
361 In order to move the current (y, x) coordinates from one point to another, the
362 routines <CODE>move()</CODE> and <CODE>wmove()</CODE> are provided.  However, it is
363 often desirable to first move and then perform some I/O operation.  In order to
364 avoid clumsiness, most I/O routines can be preceded by the prefix 'mv' and
365 the desired (y, x) coordinates prepended to the arguments to the function.  For
366 example, the calls
367
368 <PRE>
369           move(y, x);
370           addch(ch);
371 </PRE>
372
373 can be replaced by
374
375 <PRE>
376           mvaddch(y, x, ch);
377 </PRE>
378
379 and
380
381 <PRE>
382           wmove(win, y, x);
383           waddch(win, ch);
384 </PRE>
385
386 can be replaced by
387
388 <PRE>
389           mvwaddch(win, y, x, ch);
390 </PRE>
391
392 Note that the window description pointer (win) comes before the added (y, x)
393 coordinates.  If a function requires a window pointer, it is always the first
394 parameter passed.
395
396 <H3><A NAME="variables">Variables</A></H3>
397
398 The <CODE>curses</CODE> library sets some variables describing the terminal
399 capabilities.
400
401 <PRE>
402       type   name      description
403       ------------------------------------------------------------------
404       int    LINES     number of lines on the terminal
405       int    COLS      number of columns on the terminal
406 </PRE>
407
408 The <CODE>curses.h</CODE> also introduces some <CODE>#define</CODE> constants and types
409 of general usefulness:
410
411 <DL>
412 <DT> <CODE>bool</CODE>
413 <DD> boolean type, actually a `char' (e.g., <CODE>bool doneit;</CODE>)
414 <DT> <CODE>TRUE</CODE>
415 <DD> boolean `true' flag (1).
416 <DT> <CODE>FALSE</CODE>
417 <DD> boolean `false' flag (0).
418 <DT> <CODE>ERR</CODE>
419 <DD> error flag returned by routines on a failure (-1).
420 <DT> <CODE>OK</CODE>
421 <DD> error flag returned by routines when things go right.
422 </DL>
423
424 <H2><A NAME="using">Using the Library</A></H2>
425
426 Now we describe how to actually use the screen package.  In it, we assume all
427 updating, reading, etc. is applied to <CODE>stdscr</CODE>.  These instructions will
428 work on any window, providing you change the function names and parameters as
429 mentioned above. <P>
430
431 Here is a sample program to motivate the discussion:
432
433 <PRE>
434 #include &lt;curses.h&gt;
435 #include &lt;signal.h&gt;
436
437 static void finish(int sig);
438
439 int
440 main(int argc, char *argv[])
441 {
442     int num = 0;
443
444     /* initialize your non-curses data structures here */
445
446     (void) signal(SIGINT, finish);      /* arrange interrupts to terminate */
447
448     (void) initscr();      /* initialize the curses library */
449     keypad(stdscr, TRUE);  /* enable keyboard mapping */
450     (void) nonl();         /* tell curses not to do NL-&gt;CR/NL on output */
451     (void) cbreak();       /* take input chars one at a time, no wait for \n */
452     (void) echo();         /* echo input - in color */
453
454     if (has_colors())
455     {
456         start_color();
457
458         /*
459          * Simple color assignment, often all we need.  Color pair 0 cannot
460          * be redefined.  This example uses the same value for the color
461          * pair as for the foreground color, though of course that is not
462          * necessary:
463          */
464         init_pair(1, COLOR_RED,     COLOR_BLACK);
465         init_pair(2, COLOR_GREEN,   COLOR_BLACK);
466         init_pair(3, COLOR_YELLOW,  COLOR_BLACK);
467         init_pair(4, COLOR_BLUE,    COLOR_BLACK);
468         init_pair(5, COLOR_CYAN,    COLOR_BLACK);
469         init_pair(6, COLOR_MAGENTA, COLOR_BLACK);
470         init_pair(7, COLOR_WHITE,   COLOR_BLACK);
471     }
472
473     for (;;)
474     {
475         int c = getch();     /* refresh, accept single keystroke of input */
476         attrset(COLOR_PAIR(num % 8));
477         num++;
478
479         /* process the command keystroke */
480     }
481
482     finish(0);               /* we're done */
483 }
484
485 static void finish(int sig)
486 {
487     endwin();
488
489     /* do your non-curses wrapup here */
490
491     exit(0);
492 }
493 </PRE>
494
495 <H3><A NAME="starting">Starting up</A></H3>
496
497 In order to use the screen package, the routines must know about terminal
498 characteristics, and the space for <CODE>curscr</CODE> and <CODE>stdscr</CODE> must be
499 allocated.  These function <CODE>initscr()</CODE> does both these things. Since it
500 must allocate space for the windows, it can overflow memory when attempting to
501 do so. On the rare occasions this happens, <CODE>initscr()</CODE> will terminate
502 the program with an error message.  <CODE>initscr()</CODE> must always be called
503 before any of the routines which affect windows are used.  If it is not, the
504 program will core dump as soon as either <CODE>curscr</CODE> or <CODE>stdscr</CODE> are
505 referenced.  However, it is usually best to wait to call it until after you are
506 sure you will need it, like after checking for startup errors.  Terminal status
507 changing routines like <CODE>nl()</CODE> and <CODE>cbreak()</CODE> should be called
508 after <CODE>initscr()</CODE>. <P>
509
510 Once the screen windows have been allocated, you can set them up for
511 your program.  If you want to, say, allow a screen to scroll, use
512 <CODE>scrollok()</CODE>.  If you want the cursor to be left in place after
513 the last change, use <CODE>leaveok()</CODE>.  If this isn't done,
514 <CODE>refresh()</CODE> will move the cursor to the window's current (y, x)
515 coordinates after updating it. <P>
516
517 You can create new windows of your own using the functions <CODE>newwin()</CODE>,
518 <CODE>derwin()</CODE>, and <CODE>subwin()</CODE>.  The routine <CODE>delwin()</CODE> will
519 allow you to get rid of old windows.  All the options described above can be
520 applied to any window.
521
522 <H3><A NAME="output">Output</A></H3>
523
524 Now that we have set things up, we will want to actually update the terminal.
525 The basic functions used to change what will go on a window are
526 <CODE>addch()</CODE> and <CODE>move()</CODE>.  <CODE>addch()</CODE> adds a character at the
527 current (y, x) coordinates.  <CODE>move()</CODE> changes the current (y, x)
528 coordinates to whatever you want them to be.  It returns <CODE>ERR</CODE> if you
529 try to move off the window.  As mentioned above, you can combine the two into
530 <CODE>mvaddch()</CODE> to do both things at once. <P>
531
532 The other output functions, such as <CODE>addstr()</CODE> and <CODE>printw()</CODE>,
533 all call <CODE>addch()</CODE> to add characters to the window. <P>
534
535 After you have put on the window what you want there, when you want the portion
536 of the terminal covered by the window to be made to look like it, you must call
537 <CODE>refresh()</CODE>.  In order to optimize finding changes, <CODE>refresh()</CODE>
538 assumes that any part of the window not changed since the last
539 <CODE>refresh()</CODE> of that window has not been changed on the terminal, i.e.,
540 that you have not refreshed a portion of the terminal with an overlapping
541 window.  If this is not the case, the routine <CODE>touchwin()</CODE> is provided
542 to make it look like the entire window has been changed, thus making
543 <CODE>refresh()</CODE> check the whole subsection of the terminal for changes. <P>
544
545 If you call <CODE>wrefresh()</CODE> with <CODE>curscr</CODE> as its argument, it will
546 make the screen look like <CODE>curscr</CODE> thinks it looks like.  This is useful
547 for implementing a command which would redraw the screen in case it get messed
548 up.
549
550 <H3><A NAME="input">Input</A></H3>
551
552 The complementary function to <CODE>addch()</CODE> is <CODE>getch()</CODE> which, if
553 echo is set, will call <CODE>addch()</CODE> to echo the character.  Since the
554 screen package needs to know what is on the terminal at all times, if
555 characters are to be echoed, the tty must be in raw or cbreak mode.  Since
556 initially the terminal has echoing enabled and is in ordinary ``cooked'' mode,
557 one or the other has to changed before calling <CODE>getch()</CODE>; otherwise,
558 the program's output will be unpredictable. <P>
559
560 When you need to accept line-oriented input in a window, the functions
561 <CODE>wgetstr()</CODE> and friends are available.  There is even a <CODE>wscanw()</CODE>
562 function that can do <CODE>scanf()</CODE>(3)-style multi-field parsing on window
563 input.  These pseudo-line-oriented functions turn on echoing while they
564 execute. <P>
565
566 The example code above uses the call <CODE>keypad(stdscr, TRUE)</CODE> to enable
567 support for function-key mapping.  With this feature, the <CODE>getch()</CODE> code
568 watches the input stream for character sequences that correspond to arrow and
569 function keys.  These sequences are returned as pseudo-character values.  The
570 <CODE>#define</CODE> values returned are listed in the <CODE>curses.h</CODE> The
571 mapping from sequences to <CODE>#define</CODE> values is determined by
572 <CODE>key_</CODE> capabilities in the terminal's terminfo entry.
573
574 <H3><A NAME="formschars">Using Forms Characters</A></H3>
575
576 The <CODE>addch()</CODE> function (and some others, including <CODE>box()</CODE> and
577 <CODE>border()</CODE>) can accept some pseudo-character arguments which are specially
578 defined by <CODE>ncurses</CODE>.  These are <CODE>#define</CODE> values set up in
579 the <CODE>curses.h</CODE> header; see there for a complete list (look for
580 the prefix <CODE>ACS_</CODE>). <P>
581
582 The most useful of the ACS defines are the forms-drawing characters.  You can
583 use these to draw boxes and simple graphs on the screen.  If the terminal
584 does not have such characters, <CODE>curses.h</CODE> will map them to a
585 recognizable (though ugly) set of ASCII defaults.
586
587 <H3><A NAME="attributes">Character Attributes and Color</A></H3>
588
589 The <CODE>ncurses</CODE> package supports screen highlights including standout,
590 reverse-video, underline, and blink.  It also supports color, which is treated
591 as another kind of highlight. <P>
592
593 Highlights are encoded, internally, as high bits of the pseudo-character type
594 (<CODE>chtype</CODE>) that <CODE>curses.h</CODE> uses to represent the contents of a
595 screen cell.  See the <CODE>curses.h</CODE> header file for a complete list of
596 highlight mask values (look for the prefix <CODE>A_</CODE>).<P>
597
598 There are two ways to make highlights.  One is to logical-or the value of the
599 highlights you want into the character argument of an <CODE>addch()</CODE> call,
600 or any other output call that takes a <CODE>chtype</CODE> argument. <P>
601
602 The other is to set the current-highlight value.  This is logical-or'ed with
603 any highlight you specify the first way.  You do this with the functions
604 <CODE>attron()</CODE>, <CODE>attroff()</CODE>, and <CODE>attrset()</CODE>; see the manual
605 pages for details.
606
607 Color is a special kind of highlight.  The package actually thinks in terms
608 of color pairs, combinations of foreground and background colors.  The sample
609 code above sets up eight color pairs, all of the guaranteed-available colors
610 on black.  Note that each color pair is, in effect, given the name of its
611 foreground color.  Any other range of eight non-conflicting values could
612 have been used as the first arguments of the <CODE>init_pair()</CODE> values. <P>
613
614 Once you've done an <CODE>init_pair()</CODE> that creates color-pair N, you can
615 use <CODE>COLOR_PAIR(N)</CODE> as a highlight that invokes that particular
616 color combination.  Note that <CODE>COLOR_PAIR(N)</CODE>, for constant N,
617 is itself a compile-time constant and can be used in initializers.
618
619 <H3><A NAME="mouse">Mouse Interfacing</A></H3>
620
621 The <CODE>ncurses</CODE> library also provides a mouse interface.
622 <!-- The 'note' tag is not portable enough -->
623 <blockquote>
624 <strong>NOTE:</strong> this facility is specific to <CODE>ncurses</CODE>, it is not part of either
625 the XSI Curses standard, nor of System V Release 4, nor BSD curses.
626 System V Release 4 curses contains code with similar interface definitions,
627 however it is not documented.  Other than by disassembling the library, we
628 have no way to determine exactly how that mouse code works.
629 Thus, we recommend that you wrap mouse-related code in an #ifdef using the
630 feature macro NCURSES_MOUSE_VERSION so it will not be compiled and linked
631 on non-ncurses systems.
632 </blockquote>
633
634 Presently, mouse event reporting works in the following environments:
635 <ul>
636 <li>xterm and similar programs such as rxvt.
637 <li>Linux console, when configured with <CODE>gpm</CODE>(1), Alessandro
638 Rubini's mouse server.
639 <li>FreeBSD sysmouse (console)
640 <li>OS/2 EMX
641 </ul>
642 <P>
643 The mouse interface is very simple.  To activate it, you use the function
644 <CODE>mousemask()</CODE>, passing it as first argument a bit-mask that specifies
645 what kinds of events you want your program to be able to see.  It will
646 return the bit-mask of events that actually become visible, which may differ
647 from the argument if the mouse device is not capable of reporting some of
648 the event types you specify. <P>
649
650 Once the mouse is active, your application's command loop should watch
651 for a return value of <CODE>KEY_MOUSE</CODE> from <CODE>wgetch()</CODE>.  When
652 you see this, a mouse event report has been queued.  To pick it off
653 the queue, use the function <CODE>getmouse()</CODE> (you must do this before
654 the next <CODE>wgetch()</CODE>, otherwise another mouse event might come
655 in and make the first one inaccessible). <P>
656
657 Each call to <CODE>getmouse()</CODE> fills a structure (the address of which you'll
658 pass it) with mouse event data.  The event data includes zero-origin,
659 screen-relative character-cell coordinates of the mouse pointer.  It also
660 includes an event mask.  Bits in this mask will be set, corresponding
661 to the event type being reported. <P>
662
663 The mouse structure contains two additional fields which may be
664 significant in the future as ncurses interfaces to new kinds of
665 pointing device.  In addition to x and y coordinates, there is a slot
666 for a z coordinate; this might be useful with touch-screens that can
667 return a pressure or duration parameter.  There is also a device ID
668 field, which could be used to distinguish between multiple pointing
669 devices. <P>
670
671 The class of visible events may be changed at any time via <CODE>mousemask()</CODE>.
672 Events that can be reported include presses, releases, single-, double- and
673 triple-clicks (you can set the maximum button-down time for clicks).  If
674 you don't make clicks visible, they will be reported as press-release
675 pairs.  In some environments, the event mask may include bits reporting
676 the state of shift, alt, and ctrl keys on the keyboard during the event. <P>
677
678 A function to check whether a mouse event fell within a given window is
679 also supplied.  You can use this to see whether a given window should
680 consider a mouse event relevant to it. <P>
681
682 Because mouse event reporting will not be available in all
683 environments, it would be unwise to build <CODE>ncurses</CODE>
684 applications that <EM>require</EM> the use of a mouse.  Rather, you should
685 use the mouse as a shortcut for point-and-shoot commands your application
686 would normally accept from the keyboard.  Two of the test games in the
687 <CODE>ncurses</CODE> distribution (<CODE>bs</CODE> and <CODE>knight</CODE>) contain
688 code that illustrates how this can be done. <P>
689
690 See the manual page <CODE>curs_mouse(3X)</CODE> for full details of the
691 mouse-interface functions.
692
693 <H3><A NAME="finishing">Finishing Up</A></H3>
694
695 In order to clean up after the <CODE>ncurses</CODE> routines, the routine
696 <CODE>endwin()</CODE> is provided.  It restores tty modes to what they were when
697 <CODE>initscr()</CODE> was first called, and moves the cursor down to the
698 lower-left corner.  Thus, anytime after the call to initscr, <CODE>endwin()</CODE>
699 should be called before exiting.
700
701 <H2><A NAME="functions">Function Descriptions</A></H2>
702
703 We describe the detailed behavior of some important curses functions here, as a
704 supplement to the manual page descriptions.
705
706 <H3><A NAME="init">Initialization and Wrapup</A></H3>
707
708 <DL>
709 <DT> <CODE>initscr()</CODE>
710 <DD> The first function called should almost always be <CODE>initscr()</CODE>.
711 This will determine the terminal type and
712 initialize curses data structures. <CODE>initscr()</CODE> also arranges that
713 the first call to <CODE>refresh()</CODE> will clear the screen.  If an error
714 occurs a message is written to standard error and the program
715 exits. Otherwise it returns a pointer to stdscr.  A few functions may be
716 called before initscr (<CODE>slk_init()</CODE>, <CODE>filter()</CODE>,
717 <CODE>ripoffline()</CODE>, <CODE>use_env()</CODE>, and, if you are using multiple
718 terminals, <CODE>newterm()</CODE>.)
719 <DT> <CODE>endwin()</CODE>
720 <DD> Your program should always call <CODE>endwin()</CODE> before exiting or
721 shelling out of the program. This function will restore tty modes,
722 move the cursor to the lower left corner of the screen, reset the
723 terminal into the proper non-visual mode.  Calling <CODE>refresh()</CODE>
724 or <CODE>doupdate()</CODE> after a temporary escape from the program will
725 restore the ncurses screen from before the escape.
726 <DT> <CODE>newterm(type, ofp, ifp)</CODE>
727 <DD> A program which outputs to more than one terminal should use
728 <CODE>newterm()</CODE> instead of <CODE>initscr()</CODE>.  <CODE>newterm()</CODE> should
729 be called once for each terminal.  It returns a variable of type
730 <CODE>SCREEN *</CODE> which should be saved as a reference to that
731 terminal.
732 (NOTE: a SCREEN variable is not a <em>screen</em> in the sense we
733 are describing in this introduction, but a collection of 
734 parameters used to assist in optimizing the display.)
735 The arguments are the type of the terminal (a string) and
736 <CODE>FILE</CODE> pointers for the output and input of the terminal.  If
737 type is NULL then the environment variable <CODE>$TERM</CODE> is used.
738 <CODE>endwin()</CODE> should called once at wrapup time for each terminal
739 opened using this function.
740 <DT> <CODE>set_term(new)</CODE>
741 <DD> This function is used to switch to a different terminal previously
742 opened by <CODE>newterm()</CODE>.  The screen reference for the new terminal
743 is passed as the parameter.  The previous terminal is returned by the
744 function.  All other calls affect only the current terminal.
745 <DT> <CODE>delscreen(sp)</CODE>
746 <DD> The inverse of <CODE>newterm()</CODE>; deallocates the data structures
747 associated with a given <CODE>SCREEN</CODE> reference.
748 </DL>
749
750 <H3><A NAME="flush">Causing Output to the Terminal</A></H3>
751
752 <DL>
753 <DT> <CODE>refresh()</CODE> and <CODE>wrefresh(win)</CODE>
754 <DD> These functions must be called to actually get any output on
755 the  terminal,  as  other  routines  merely  manipulate data
756 structures.  <CODE>wrefresh()</CODE> copies the named window  to the physical
757 terminal screen,  taking  into account  what is already
758 there in  order to  do optimizations.  <CODE>refresh()</CODE> does a
759 refresh of <CODE>stdscr</CODE>.   Unless <CODE>leaveok()</CODE> has been
760 enabled, the physical cursor of the terminal is left at  the
761 location of the window's cursor.
762 <DT> <CODE>doupdate()</CODE> and <CODE>wnoutrefresh(win)</CODE>
763 <DD> These two functions allow multiple updates with more efficiency
764 than wrefresh.  To use them, it is important to understand how curses
765 works.  In addition to all the window structures, curses keeps two
766 data structures representing the terminal screen: a physical screen,
767 describing what is actually on the screen, and a virtual screen,
768 describing what the programmer wants to have on the screen.  wrefresh
769 works by first copying the named window to the virtual screen
770 (<CODE>wnoutrefresh()</CODE>), and then calling the routine to update the
771 screen (<CODE>doupdate()</CODE>).  If the programmer wishes to output
772 several windows at once, a series of calls to <CODE>wrefresh</CODE> will result
773 in alternating calls to <CODE>wnoutrefresh()</CODE> and <CODE>doupdate()</CODE>,
774 causing several bursts of output to the screen.  By calling
775 <CODE>wnoutrefresh()</CODE> for each window, it is then possible to call
776 <CODE>doupdate()</CODE> once, resulting in only one burst of output, with
777 fewer total characters transmitted (this also avoids a visually annoying
778 flicker at each update).
779 </DL>
780
781 <H3><A NAME="lowlevel">Low-Level Capability Access</A></H3>
782
783 <DL>
784 <DT> <CODE>setupterm(term, filenum, errret)</CODE>
785 <DD> This routine is called to initialize a terminal's description, without setting
786 up the curses screen structures or changing the tty-driver mode bits.
787 <CODE>term</CODE> is the character string representing the name of the terminal
788 being used.  <CODE>filenum</CODE> is the UNIX file descriptor of the terminal to
789 be used for output.  <CODE>errret</CODE> is a pointer to an integer, in which a
790 success or failure indication is returned.  The values returned can be 1 (all
791 is well), 0 (no such terminal), or -1 (some problem locating the terminfo
792 database). <P>
793
794 The value of <CODE>term</CODE> can be given as NULL, which will cause the value of
795 <CODE>TERM</CODE> in the environment to be used.  The <CODE>errret</CODE> pointer can
796 also be given as NULL, meaning no error code is wanted.  If <CODE>errret</CODE> is
797 defaulted, and something goes wrong, <CODE>setupterm()</CODE> will print an
798 appropriate error message and exit, rather than returning.  Thus, a simple
799 program can call setupterm(0, 1, 0) and not worry about initialization
800 errors. <P>
801
802 After the call to <CODE>setupterm()</CODE>, the global variable <CODE>cur_term</CODE> is
803 set to point to the current structure of terminal capabilities. By calling
804 <CODE>setupterm()</CODE> for each terminal, and saving and restoring
805 <CODE>cur_term</CODE>, it is possible for a program to use two or more terminals at
806 once.  <CODE>Setupterm()</CODE> also stores the names section of the terminal
807 description in the global character array <CODE>ttytype[]</CODE>.  Subsequent calls
808 to <CODE>setupterm()</CODE> will overwrite this array, so you'll have to save it
809 yourself if need be.
810 </DL>
811
812 <H3><A NAME="debugging">Debugging</A></H3>
813
814 <!-- The 'note' tag is not portable enough -->
815 <blockquote>
816 <strong>NOTE:</strong> These functions are not part of the standard curses API!
817 </blockquote>
818
819 <DL>
820 <DT> <CODE>trace()</CODE>
821 <DD>
822 This function can be used to explicitly set a trace level.  If the
823 trace level is nonzero, execution of your program will generate a file
824 called `trace' in the current working directory containing a report on
825 the library's actions.  Higher trace levels enable more detailed (and
826 verbose) reporting -- see comments attached to <CODE>TRACE_</CODE> defines
827 in the <CODE>curses.h</CODE> file for details.  (It is also possible to set
828 a trace level by assigning a trace level value to the environment variable
829 <CODE>NCURSES_TRACE</CODE>).
830 <DT> <CODE>_tracef()</CODE>
831 <DD>
832 This function can be used to output your own debugging information.  It is only
833 available only if you link with -lncurses_g.  It can be used the same way as
834 <CODE>printf()</CODE>, only it outputs a newline after the end of arguments.
835 The output goes to a file called <CODE>trace</CODE> in the current directory.
836 </DL>
837
838 Trace logs can be difficult to interpret due to the sheer volume of
839 data dumped in them.  There is a script called <STRONG>tracemunch</STRONG>
840 included with the <CODE>ncurses</CODE> distribution that can alleviate
841 this problem somewhat; it compacts long sequences of similar operations into
842 more succinct single-line pseudo-operations. These pseudo-ops can be
843 distinguished by the fact that they are named in capital letters.
844
845 <H2><A NAME="hints">Hints, Tips, and Tricks</A></H2>
846
847 The <CODE>ncurses</CODE> manual pages are a complete reference for this library.
848 In the remainder of this document, we discuss various useful methods that
849 may not be obvious from the manual page descriptions.
850
851 <H3><A NAME="caution">Some Notes of Caution</A></H3>
852
853 If you find yourself thinking you need to use <CODE>noraw()</CODE> or
854 <CODE>nocbreak()</CODE>, think again and move carefully.  It's probably
855 better design to use <CODE>getstr()</CODE> or one of its relatives to
856 simulate cooked mode.  The <CODE>noraw()</CODE> and <CODE>nocbreak()</CODE>
857 functions try to restore cooked mode, but they may end up clobbering
858 some control bits set before you started your application.  Also, they
859 have always been poorly documented, and are likely to hurt your
860 application's usability with other curses libraries. <P>
861
862 Bear in mind that <CODE>refresh()</CODE> is a synonym for <CODE>wrefresh(stdscr)</CODE>.
863 Don't try to mix use of <CODE>stdscr</CODE> with use of windows declared
864 by <CODE>newwin()</CODE>; a <CODE>refresh()</CODE> call will blow them off the
865 screen.  The right way to handle this is to use <CODE>subwin()</CODE>, or
866 not touch <CODE>stdscr</CODE> at all and tile your screen with declared
867 windows which you then <CODE>wnoutrefresh()</CODE> somewhere in your program
868 event loop, with a single <CODE>doupdate()</CODE> call to trigger actual
869 repainting. <P>
870
871 You are much less likely to run into problems if you design your screen
872 layouts to use tiled rather than overlapping windows.  Historically,
873 curses support for overlapping windows has been weak, fragile, and poorly
874 documented.  The <CODE>ncurses</CODE> library is not yet an exception to this
875 rule. <P>
876
877 There is a panels library included in the <CODE>ncurses</CODE>
878 distribution that does a pretty good job of strengthening the
879 overlapping-windows facilities. <P>
880
881 Try to avoid using the global variables LINES and COLS.  Use
882 <CODE>getmaxyx()</CODE> on the <CODE>stdscr</CODE> context instead.  Reason:
883 your code may be ported to run in an environment with window resizes,
884 in which case several screens could be open with different sizes.
885
886 <H3><A NAME="leaving">Temporarily Leaving NCURSES Mode</A></H3>
887
888 Sometimes you will want to write a program that spends most of its time in
889 screen mode, but occasionally returns to ordinary `cooked' mode.  A common
890 reason for this is to support shell-out.  This behavior is simple to arrange
891 in <CODE>ncurses</CODE>. <P>
892
893 To leave <CODE>ncurses</CODE> mode, call <CODE>endwin()</CODE> as you would if you
894 were intending to terminate the program.  This will take the screen back to
895 cooked mode; you can do your shell-out.  When you want to return to
896 <CODE>ncurses</CODE> mode, simply call <CODE>refresh()</CODE> or <CODE>doupdate()</CODE>.
897 This will repaint the screen. <P>
898
899 There is a boolean function, <CODE>isendwin()</CODE>, which code can use to
900 test whether <CODE>ncurses</CODE> screen mode is active.  It returns <CODE>TRUE</CODE>
901 in the interval between an <CODE>endwin()</CODE> call and the following
902 <CODE>refresh()</CODE>, <CODE>FALSE</CODE> otherwise.  <P>
903
904 Here is some sample code for shellout:
905
906 <PRE>
907     addstr("Shelling out...");
908     def_prog_mode();           /* save current tty modes */
909     endwin();                  /* restore original tty modes */
910     system("sh");              /* run shell */
911     addstr("returned.\n");     /* prepare return message */
912     refresh();                 /* restore save modes, repaint screen */
913 </PRE>
914
915 <H3><A NAME="xterm">Using NCURSES under XTERM</A></H3>
916
917 A resize operation in X sends SIGWINCH to the application running under xterm.
918 The <CODE>ncurses</CODE> library provides an experimental signal
919 handler, but in general does not catch this signal, because it cannot
920 know how you want the screen re-painted.  You will usually have to write the
921 SIGWINCH handler yourself.  Ncurses can give you some help. <P>
922
923 The easiest way to code your SIGWINCH handler is to have it do an
924 <CODE>endwin</CODE>, followed by an <CODE>refresh</CODE> and a screen repaint you code
925 yourself.  The <CODE>refresh</CODE> will pick up the new screen size from the
926 xterm's environment. <P>
927
928 That is the standard way, of course (it even works with some vendor's curses
929 implementations).
930 Its drawback is that it clears the screen to reinitialize the display, and does
931 not resize subwindows which must be shrunk.
932 <CODE>Ncurses</CODE> provides an extension which works better, the
933 <CODE>resizeterm</CODE> function.  That function ensures that all windows
934 are limited to the new screen dimensions, and pads <CODE>stdscr</CODE>
935 with blanks if the screen is larger. <P>
936
937 Finally, ncurses can be configured to provide its own SIGWINCH handler,
938 based on <CODE>resizeterm</CODE>.
939
940 <H3><A NAME="screens">Handling Multiple Terminal Screens</A></H3>
941
942 The <CODE>initscr()</CODE> function actually calls a function named
943 <CODE>newterm()</CODE> to do most of its work.  If you are writing a program that
944 opens multiple terminals, use <CODE>newterm()</CODE> directly. <P>
945
946 For each call, you will have to specify a terminal type and a pair of file
947 pointers; each call will return a screen reference, and <CODE>stdscr</CODE> will be
948 set to the last one allocated.  You will switch between screens with the
949 <CODE>set_term</CODE> call.  Note that you will also have to call
950 <CODE>def_shell_mode</CODE> and <CODE>def_prog_mode</CODE> on each tty yourself.
951
952 <H3><A NAME="testing">Testing for Terminal Capabilities</A></H3>
953
954 Sometimes you may want to write programs that test for the presence of various
955 capabilities before deciding whether to go into <CODE>ncurses</CODE> mode.  An easy
956 way to do this is to call <CODE>setupterm()</CODE>, then use the functions
957 <CODE>tigetflag()</CODE>, <CODE>tigetnum()</CODE>, and <CODE>tigetstr()</CODE> to do your
958 testing. <P>
959
960 A particularly useful case of this often comes up when you want to
961 test whether a given terminal type should be treated as `smart'
962 (cursor-addressable) or `stupid'.  The right way to test this is to see
963 if the return value of <CODE>tigetstr("cup")</CODE> is non-NULL.  Alternatively,
964 you can include the <CODE>term.h</CODE> file and test the value of the
965 macro <CODE>cursor_address</CODE>.
966
967 <H3><A NAME="tuning">Tuning for Speed</A></H3>
968
969 Use the <CODE>addchstr()</CODE> family of functions for fast
970 screen-painting of text when you know the text doesn't contain any
971 control characters.  Try to make attribute changes infrequent on your
972 screens.  Don't use the <CODE>immedok()</CODE> option!
973
974 <H3><A NAME="special">Special Features of NCURSES</A></H3>
975
976 The <CODE>wresize()</CODE> function allows you to resize a window in place.
977 The associated <CODE>resizeterm()</CODE> function simplifies the construction
978 of <a HREF="#xterm">SIGWINCH</a> handlers, for resizing all windows.  <P>
979
980 The <CODE>define_key()</CODE> function allows you
981 to define at runtime function-key control sequences which are not in the
982 terminal description.
983 The <CODE>keyok()</CODE> function allows you to temporarily
984 enable or disable interpretation of any function-key control sequence. <P>
985
986 The <CODE>use_default_colors()</CODE> function allows you to construct
987 applications which can use the terminal's default foreground and
988 background colors as an additional "default" color.
989 Several terminal emulators support this feature, which is based on ISO 6429. <P>
990
991 Ncurses supports up 16 colors, unlike SVr4 curses which defines only 8.
992 While most terminals which provide color allow only 8 colors, about
993 a quarter (including XFree86 xterm) support 16 colors.
994
995 <H2><A NAME="compat">Compatibility with Older Versions</A></H2>
996
997 Despite our best efforts, there are some differences between <CODE>ncurses</CODE>
998 and the (undocumented!) behavior of older curses implementations.  These arise
999 from ambiguities or omissions in the documentation of the API.
1000
1001 <H3><A NAME="refbug">Refresh of Overlapping Windows</A></H3>
1002
1003 If you define two windows A and B that overlap, and then alternately scribble
1004 on and refresh them, the changes made to the overlapping region under historic
1005 <CODE>curses</CODE> versions were often not documented precisely. <P>
1006
1007 To understand why this is a problem, remember that screen updates are
1008 calculated between two representations of the <EM>entire</EM> display. The
1009 documentation says that when you refresh a window, it is first copied to the
1010 virtual screen, and then changes are calculated to update the physical screen
1011 (and applied to the terminal).  But "copied to" is not very specific, and
1012 subtle differences in how copying works can produce different behaviors in the
1013 case where two overlapping windows are each being refreshed at unpredictable
1014 intervals. <P>
1015
1016 What happens to the overlapping region depends on what <CODE>wnoutrefresh()</CODE>
1017 does with its argument -- what portions of the argument window it copies to the
1018 virtual screen.  Some implementations do "change copy", copying down only
1019 locations in the window that have changed (or been marked changed with
1020 <CODE>wtouchln()</CODE> and friends).  Some implementations do  "entire copy",
1021 copying <EM>all</EM> window locations to the virtual screen whether or not
1022 they have changed. <P>
1023
1024 The <CODE>ncurses</CODE> library itself has not always been consistent on this
1025 score.  Due to a bug, versions 1.8.7 to 1.9.8a did entire copy.  Versions
1026 1.8.6 and older, and versions 1.9.9 and newer, do change copy. <P>
1027
1028 For most commercial curses implementations, it is not documented and not known
1029 for sure (at least not to the <CODE>ncurses</CODE> maintainers) whether they do
1030 change copy or entire copy.  We know that System V release 3 curses has logic
1031 in it that looks like an attempt to do change copy, but the surrounding logic
1032 and data representations are sufficiently complex, and our knowledge
1033 sufficiently indirect, that it's hard to know whether this is reliable.
1034
1035 It is not clear what the SVr4 documentation and XSI standard intend.  The XSI
1036 Curses standard barely mentions wnoutrefresh(); the SVr4 documents seem to be
1037 describing entire-copy, but it is possible with some effort and straining to
1038 read them the other way. <P>
1039
1040 It might therefore be unwise to rely on either behavior in programs that might
1041 have to be linked with other curses implementations.  Instead, you can do an
1042 explicit <CODE>touchwin()</CODE> before the <CODE>wnoutrefresh()</CODE> call to
1043 guarantee an entire-contents copy anywhere. <P>
1044
1045 The really clean way to handle this is to use the panels library.  If,
1046 when you want a screen update, you do <CODE>update_panels()</CODE>, it will
1047 do all the necessary <CODE>wnoutrefresh()</CODE> calls for whatever panel
1048 stacking order you have defined.  Then you can do one <CODE>doupdate()</CODE>
1049 and there will be a <EM>single</EM> burst of physical I/O that will do
1050 all your updates.
1051
1052 <H3><A NAME="backbug">Background Erase</A></H3>
1053
1054 If you have been using a very old versions of <CODE>ncurses</CODE> (1.8.7 or
1055 older) you may be surprised by the behavior of the erase functions.  In older
1056 versions, erased areas of a window were filled with a blank modified by the
1057 window's current attribute (as set by <STRONG>wattrset()</STRONG>, <STRONG>wattron()</STRONG>,
1058 <STRONG>wattroff()</STRONG> and friends). <P>
1059
1060 In newer versions, this is not so.  Instead, the attribute of erased blanks
1061 is normal unless and until it is modified by the functions <CODE>bkgdset()</CODE>
1062 or <CODE>wbkgdset()</CODE>. <P>
1063
1064 This change in behavior conforms <CODE>ncurses</CODE> to System V Release 4 and
1065 the XSI Curses standard.
1066
1067 <H2><A NAME="xsifuncs">XSI Curses Conformance</A></H2>
1068
1069 The <CODE>ncurses</CODE> library is intended to be base-level conformant with the
1070 XSI Curses standard from X/Open.  Many extended-level features (in fact, almost
1071 all features not directly concerned with wide characters and
1072 internationalization) are also supported. <P>
1073
1074 One effect of XSI conformance is the change in behavior described under
1075 <A HREF="#backbug">"Background Erase -- Compatibility with Old Versions"</A>. <P>
1076
1077 Also, <CODE>ncurses</CODE> meets the XSI requirement that every macro
1078 entry point have a corresponding function which may be linked (and
1079 will be prototype-checked) if the macro definition is disabled with
1080 <CODE>#undef</CODE>.
1081
1082 <H1><A NAME="panels">The Panels Library</A></H1>
1083
1084 The <CODE>ncurses</CODE> library by itself provides good support for screen
1085 displays in which the windows are tiled (non-overlapping).  In the more
1086 general case that windows may overlap, you have to use a series of
1087 <CODE>wnoutrefresh()</CODE> calls followed by a <CODE>doupdate()</CODE>, and be
1088 careful about the order you do the window refreshes in.  It has to be
1089 bottom-upwards, otherwise parts of windows that should be obscured will
1090 show through. <P>
1091
1092 When your interface design is such that windows may dive deeper into the
1093 visibility stack or pop to the top at runtime, the resulting book-keeping
1094 can be tedious and difficult to get right.  Hence the panels library. <P>
1095
1096 The <CODE>panel</CODE> library first appeared in AT&amp;T System V.  The
1097 version documented here is the <CODE>panel</CODE> code distributed
1098 with <CODE>ncurses</CODE>.
1099
1100 <H2><A NAME="pcompile">Compiling With the Panels Library</A></H2>
1101
1102 Your panels-using modules must import the panels library declarations with
1103
1104 <PRE>
1105           #include &lt;panel.h&gt;
1106 </PRE>
1107
1108 and must be linked explicitly with the panels library using an
1109 <CODE>-lpanel</CODE> argument.  Note that they must also link the
1110 <CODE>ncurses</CODE> library with <CODE>-lncurses</CODE>.  Many linkers
1111 are two-pass and will accept either order, but it is still good practice
1112 to put <CODE>-lpanel</CODE> first and <CODE>-lncurses</CODE> second.
1113
1114 <H2><A NAME="poverview">Overview of Panels</A></H2>
1115
1116 A panel object is a window that is implicitly treated as part of a
1117 <DFN>deck</DFN> including all other panel objects.  The deck has an implicit
1118 bottom-to-top visibility order.  The panels library includes an update
1119 function (analogous to <CODE>refresh()</CODE>) that displays all panels in the
1120 deck in the proper order to resolve overlaps.  The standard window,
1121 <CODE>stdscr</CODE>, is considered below all panels. <P>
1122
1123 Details on the panels functions are available in the man pages.  We'll just
1124 hit the highlights here. <P>
1125
1126 You create a panel from a window by calling <CODE>new_panel()</CODE> on a
1127 window pointer.  It then becomes the top of the deck.  The panel's window
1128 is available as the value of <CODE>panel_window()</CODE> called with the
1129 panel pointer as argument.<P>
1130
1131 You can delete a panel (removing it from the deck) with <CODE>del_panel</CODE>.
1132 This will not deallocate the associated window; you have to do that yourself.
1133
1134 You can replace a panel's window with a different window by calling
1135 <CODE>replace_window</CODE>.  The new window may be of different size;
1136 the panel code will re-compute all overlaps.  This operation doesn't
1137 change the panel's position in the deck. <P>
1138
1139 To move a panel's window, use <CODE>move_panel()</CODE>.  The
1140 <CODE>mvwin()</CODE> function on the panel's window isn't sufficient because it
1141 doesn't update the panels library's representation of where the windows are.
1142 This operation leaves the panel's depth, contents, and size unchanged. <P>
1143
1144 Two functions (<CODE>top_panel()</CODE>, <CODE>bottom_panel()</CODE>) are
1145 provided for rearranging the deck.  The first pops its argument window to the
1146 top of the deck; the second sends it to the bottom.  Either operation leaves
1147 the panel's screen location, contents, and size unchanged. <P>
1148
1149 The function <CODE>update_panels()</CODE> does all the
1150 <CODE>wnoutrefresh()</CODE> calls needed to prepare for
1151 <CODE>doupdate()</CODE> (which you must call yourself, afterwards). <P>
1152
1153 Typically, you will want to call <CODE>update_panels()</CODE> and
1154 <CODE>doupdate()</CODE> just before accepting command input, once in each cycle
1155 of interaction with the user.  If you call <CODE>update_panels()</CODE> after
1156 each and every panel write, you'll generate a lot of unnecessary refresh
1157 activity and screen flicker.
1158
1159 <H2><A NAME="pstdscr">Panels, Input, and the Standard Screen</A></H2>
1160
1161 You shouldn't mix <CODE>wnoutrefresh()</CODE> or <CODE>wrefresh()</CODE>
1162 operations with panels code; this will work only if the argument window
1163 is either in the top panel or unobscured by any other panels. <P>
1164
1165 The <CODE>stsdcr</CODE> window is a special case.  It is considered below all
1166 panels.  Because changes to panels may obscure parts of <CODE>stdscr</CODE>,
1167 though, you should call <CODE>update_panels()</CODE> before
1168 <CODE>doupdate()</CODE> even when you only change <CODE>stdscr</CODE>. <P>
1169
1170 Note that <CODE>wgetch</CODE> automatically calls <CODE>wrefresh</CODE>.
1171 Therefore, before requesting input from a panel window, you need to be sure
1172 that the panel is totally unobscured. <P>
1173
1174 There is presently no way to display changes to one obscured panel without
1175 repainting all panels.
1176
1177 <H2><A NAME="hiding">Hiding Panels</A></H2>
1178
1179 It's possible to remove a panel from the deck temporarily; use
1180 <CODE>hide_panel</CODE> for this.  Use <CODE>show_panel()</CODE> to render it
1181 visible again.  The predicate function <CODE>panel_hidden</CODE>
1182 tests whether or not a panel is hidden. <P>
1183
1184 The <CODE>panel_update</CODE> code ignores hidden panels.  You cannot do
1185 <CODE>top_panel()</CODE> or <CODE>bottom_panel</CODE> on a hidden panel().
1186 Other panels operations are applicable.
1187
1188 <H2><A NAME="pmisc">Miscellaneous Other Facilities</A></H2>
1189
1190 It's possible to navigate the deck using the functions
1191 <CODE>panel_above()</CODE> and <CODE>panel_below</CODE>.  Handed a panel
1192 pointer, they return the panel above or below that panel.  Handed
1193 <CODE>NULL</CODE>, they return the bottom-most or top-most panel. <P>
1194
1195 Every panel has an associated user pointer, not used by the panel code, to
1196 which you can attach application data.  See the man page documentation
1197 of <CODE>set_panel_userptr()</CODE> and <CODE>panel_userptr</CODE> for
1198 details.
1199
1200 <H1><A NAME="menu">The Menu Library</A></H1>
1201
1202 A menu is a screen display that assists the user to choose some subset
1203 of a given set of items.  The <CODE>menu</CODE> library is a curses
1204 extension that supports easy programming of menu hierarchies with a
1205 uniform but flexible interface. <P>
1206
1207 The <CODE>menu</CODE> library first appeared in AT&amp;T System V.  The
1208 version documented here is the <CODE>menu</CODE> code distributed
1209 with <CODE>ncurses</CODE>.
1210
1211 <H2><A NAME="mcompile">Compiling With the menu Library</A></H2>
1212
1213 Your menu-using modules must import the menu library declarations with
1214
1215 <PRE>
1216           #include &lt;menu.h&gt;
1217 </PRE>
1218
1219 and must be linked explicitly with the menus library using an
1220 <CODE>-lmenu</CODE> argument.  Note that they must also link the
1221 <CODE>ncurses</CODE> library with <CODE>-lncurses</CODE>.  Many linkers
1222 are two-pass and will accept either order, but it is still good practice
1223 to put <CODE>-lmenu</CODE> first and <CODE>-lncurses</CODE> second.
1224
1225 <H2><A NAME="moverview">Overview of Menus</A></H2>
1226
1227 The menus created by this library consist of collections of
1228 <DFN>items</DFN> including a name string part and a description string
1229 part.  To make menus, you create groups of these items and connect
1230 them with menu frame objects. <P>
1231
1232 The menu can then by <DFN>posted</DFN>, that is written to an
1233 associated window.  Actually, each menu has two associated windows; a
1234 containing window in which the programmer can scribble titles or
1235 borders, and a subwindow in which the menu items proper are displayed.
1236 If this subwindow is too small to display all the items, it will be a
1237 scrollable viewport on the collection of items. <P>
1238
1239 A menu may also be <DFN>unposted</DFN> (that is, undisplayed), and finally
1240 freed to make the storage associated with it and its items available for
1241 re-use. <P>
1242
1243 The general flow of control of a menu program looks like this:
1244
1245 <OL>
1246 <LI>Initialize <CODE>curses</CODE>.
1247 <LI>Create the menu items, using <CODE>new_item()</CODE>.
1248 <LI>Create the menu using <CODE>new_menu()</CODE>.
1249 <LI>Post the menu using <CODE>post_menu()</CODE>.
1250 <LI>Refresh the screen.
1251 <LI>Process user requests via an input loop.
1252 <LI>Unpost the menu using <CODE>unpost_menu()</CODE>.
1253 <LI>Free the menu, using <CODE>free_menu()</CODE>.
1254 <LI>Free the items using <CODE>free_item()</CODE>.
1255 <LI>Terminate <CODE>curses</CODE>.
1256 </OL>
1257
1258 <H2><A NAME="mselect">Selecting items</A></H2>
1259
1260 Menus may be multi-valued or (the default) single-valued (see the manual
1261 page <CODE>menu_opts(3x)</CODE> to see how to change the default).
1262 Both types always have a <DFN>current item</DFN>. <P>
1263
1264 From a single-valued menu you can read the selected value simply by looking
1265 at the current item.  From a multi-valued menu, you get the selected set
1266 by looping through the items applying the <CODE>item_value()</CODE>
1267 predicate function.  Your menu-processing code can use the function
1268 <CODE>set_item_value()</CODE> to flag the items in the select set. <P>
1269
1270 Menu items can be made unselectable using <CODE>set_item_opts()</CODE>
1271 or <CODE>item_opts_off()</CODE> with the <CODE>O_SELECTABLE</CODE>
1272 argument.  This is the only option so far defined for menus, but it
1273 is good practice to code as though other option bits might be on.
1274
1275 <H2><A NAME="mdisplay">Menu Display</A></H2>
1276
1277 The menu library calculates a minimum display size for your window, based
1278 on the following variables:
1279
1280 <UL>
1281 <LI>The number and maximum length of the menu items
1282 <LI>Whether the O_ROWMAJOR option is enabled
1283 <LI>Whether display of descriptions is enabled
1284 <LI>Whatever menu format may have been set by the programmer
1285 <LI>The length of the menu mark string used for highlighting selected items
1286 </UL>
1287
1288 The function <CODE>set_menu_format()</CODE> allows you to set the
1289 maximum size of the viewport or <DFN>menu page</DFN> that will be used
1290 to display menu items.  You can retrieve any format associated with a
1291 menu with <CODE>menu_format()</CODE>. The default format is rows=16,
1292 columns=1. <P>
1293
1294 The actual menu page may be smaller than the format size.  This depends
1295 on the item number and size and whether O_ROWMAJOR is on.  This option
1296 (on by default) causes menu items to be displayed in a `raster-scan'
1297 pattern, so that if more than one item will fit horizontally the first
1298 couple of items are side-by-side in the top row.  The alternative is
1299 column-major display, which tries to put the first several items in
1300 the first column. <P>
1301
1302 As mentioned above, a menu format not large enough to allow all items to fit
1303 on-screen will result in a menu display that is vertically scrollable. <P>
1304 You can scroll it with requests to the menu driver, which will be described
1305 in the section on <A HREF="#minput">menu input handling</A>. <P>
1306
1307 Each menu has a <DFN>mark string</DFN> used to visually tag selected items;
1308 see the <CODE>menu_mark(3x)</CODE> manual page for details.  The mark
1309 string length also influences the menu page size. <P>
1310
1311 The function <CODE>scale_menu()</CODE> returns the minimum display size
1312 that the menu code computes from all these factors.
1313
1314 There are other menu display attributes including a select attribute,
1315 an attribute for selectable items, an attribute for unselectable items,
1316 and a pad character used to separate item name text from description
1317 text.  These have reasonable defaults which the library allows you to
1318 change (see the <CODE>menu_attribs(3x)</CODE> manual page.
1319
1320 <H2><A NAME="mwindows">Menu Windows</A></H2>
1321
1322 Each menu has, as mentioned previously, a pair of associated windows.
1323 Both these windows are painted when the menu is posted and erased when
1324 the menu is unposted. <P>
1325
1326 The outer or frame window is not otherwise touched by the menu
1327 routines.  It exists so the programmer can associate a title, a
1328 border, or perhaps help text with the menu and have it properly
1329 refreshed or erased at post/unpost time.  The inner window or
1330 <DFN>subwindow</DFN> is where the current menu page is displayed. <P>
1331
1332 By default, both windows are <CODE>stdscr</CODE>.  You can set them with the
1333 functions in <CODE>menu_win(3x)</CODE>. <P>
1334
1335 When you call <CODE>post_menu()</CODE>, you write the menu to its
1336 subwindow.  When you call <CODE>unpost_menu()</CODE>, you erase the
1337 subwindow, However, neither of these actually modifies the screen.  To
1338 do that, call <CODE>wrefresh()</CODE> or some equivalent.
1339
1340 <H2><A NAME="minput">Processing Menu Input</A></H2>
1341
1342 The main loop of your menu-processing code should call
1343 <CODE>menu_driver()</CODE> repeatedly. The first argument of this routine
1344 is a menu pointer; the second is a menu command code.  You should write an
1345 input-fetching routine that maps input characters to menu command codes, and
1346 pass its output to <CODE>menu_driver()</CODE>.  The menu command codes are
1347 fully documented in <CODE>menu_driver(3x)</CODE>. <P>
1348
1349 The simplest group of command codes is <CODE>REQ_NEXT_ITEM</CODE>,
1350 <CODE>REQ_PREV_ITEM</CODE>, <CODE>REQ_FIRST_ITEM</CODE>,
1351 <CODE>REQ_LAST_ITEM</CODE>, <CODE>REQ_UP_ITEM</CODE>,
1352 <CODE>REQ_DOWN_ITEM</CODE>, <CODE>REQ_LEFT_ITEM</CODE>,
1353 <CODE>REQ_RIGHT_ITEM</CODE>.  These change the currently selected
1354 item.  These requests may cause scrolling of the menu page if it only
1355 partially displayed. <P>
1356
1357 There are explicit requests for scrolling which also change the
1358 current item (because the select location does not change, but the
1359 item there does).  These are <CODE>REQ_SCR_DLINE</CODE>,
1360 <CODE>REQ_SCR_ULINE</CODE>, <CODE>REQ_SCR_DPAGE</CODE>, and
1361 <CODE>REQ_SCR_UPAGE</CODE>. <P>
1362
1363 The <CODE>REQ_TOGGLE_ITEM</CODE> selects or deselects the current item.
1364 It is for use in multi-valued menus; if you use it with <CODE>O_ONEVALUE</CODE>
1365 on, you'll get an error return (<CODE>E_REQUEST_DENIED</CODE>). <P>
1366
1367 Each menu has an associated pattern buffer.  The
1368 <CODE>menu_driver()</CODE> logic tries to accumulate printable ASCII
1369 characters passed in in that buffer; when it matches a prefix of an
1370 item name, that item (or the next matching item) is selected.  If
1371 appending a character yields no new match, that character is deleted
1372 from the pattern buffer, and <CODE>menu_driver()</CODE> returns
1373 <CODE>E_NO_MATCH</CODE>. <P>
1374
1375 Some requests change the pattern buffer directly:
1376 <CODE>REQ_CLEAR_PATTERN</CODE>, <CODE>REQ_BACK_PATTERN</CODE>,
1377 <CODE>REQ_NEXT_MATCH</CODE>, <CODE>REQ_PREV_MATCH</CODE>.  The latter
1378 two are useful when pattern buffer input matches more than one item
1379 in a multi-valued menu. <P>
1380
1381 Each successful scroll or item navigation request clears the pattern
1382 buffer.  It is also possible to set the pattern buffer explicitly
1383 with <CODE>set_menu_pattern()</CODE>. <P>
1384
1385 Finally, menu driver requests above the constant <CODE>MAX_COMMAND</CODE>
1386 are considered application-specific commands.  The <CODE>menu_driver()</CODE>
1387 code ignores them and returns <CODE>E_UNKNOWN_COMMAND</CODE>.
1388
1389 <H2><A NAME="mmisc">Miscellaneous Other Features</A></H2>
1390
1391 Various menu options can affect the processing and visual appearance
1392 and input processing of menus.  See <CODE>menu_opts(3x) for
1393 details.</CODE> <P>
1394
1395 It is possible to change the current item from application code; this
1396 is useful if you want to write your own navigation requests.  It is
1397 also possible to explicitly set the top row of the menu display.  See
1398 <CODE>mitem_current(3x)</CODE>.
1399
1400 If your application needs to change the menu subwindow cursor for
1401 any reason, <CODE>pos_menu_cursor()</CODE> will restore it to the
1402 correct location for continuing menu driver processing. <P>
1403
1404 It is possible to set hooks to be called at menu initialization and
1405 wrapup time, and whenever the selected item changes.  See
1406 <CODE>menu_hook(3x)</CODE>. <P>
1407
1408 Each item, and each menu, has an associated user pointer on which you
1409 can hang application data.  See <CODE>mitem_userptr(3x)</CODE> and
1410 <CODE>menu_userptr(3x)</CODE>.
1411
1412 <H1><A NAME="form">The Forms Library</A></H1>
1413
1414 The <CODE>form</CODE> library is a curses extension that supports easy
1415 programming of on-screen forms for data entry and program control. <P>
1416
1417 The <CODE>form</CODE> library first appeared in AT&amp;T System V.  The
1418 version documented here is the <CODE>form</CODE> code distributed
1419 with <CODE>ncurses</CODE>.
1420
1421 <H2><A NAME="fcompile">Compiling With the form Library</A></H2>
1422
1423 Your form-using modules must import the form library declarations with
1424
1425 <PRE>
1426           #include &lt;form.h&gt;
1427 </PRE>
1428
1429 and must be linked explicitly with the forms library using an
1430 <CODE>-lform</CODE> argument.  Note that they must also link the
1431 <CODE>ncurses</CODE> library with <CODE>-lncurses</CODE>.  Many linkers
1432 are two-pass and will accept either order, but it is still good practice
1433 to put <CODE>-lform</CODE> first and <CODE>-lncurses</CODE> second.
1434
1435 <H2><A NAME="foverview">Overview of Forms</A></H2>
1436
1437 A form is a collection of fields; each field may be either a label
1438 (explanatory text) or a data-entry location.  Long forms may be
1439 segmented into pages; each entry to a new page clears the screen. <P>
1440 To make forms, you create groups of fields and connect them with form
1441 frame objects; the form library makes this relatively simple. <P>
1442
1443 Once defined, a form can be <DFN>posted</DFN>, that is written to an
1444 associated window.  Actually, each form has two associated windows; a
1445 containing window in which the programmer can scribble titles or
1446 borders, and a subwindow in which the form fields proper are displayed. <P>
1447
1448 As the form user fills out the posted form, navigation and editing
1449 keys support movement between fields, editing keys support modifying
1450 field, and plain text adds to or changes data in a current field.  The
1451 form library allows you (the forms designer) to bind each navigation
1452 and editing key to any keystroke accepted by <CODE>curses</CODE>
1453
1454 Fields may have validation conditions on them, so that they check input
1455 data for type and value.  The form library supplies a rich set of
1456 pre-defined field types, and makes it relatively easy to define new ones. <P>
1457
1458 Once its transaction is completed (or aborted), a form may be
1459 <DFN>unposted</DFN> (that is, undisplayed), and finally freed to make
1460 the storage associated with it and its items available for re-use. <P>
1461
1462 The general flow of control of a form program looks like this:
1463
1464 <OL>
1465 <LI>Initialize <CODE>curses</CODE>.
1466 <LI>Create the form fields, using <CODE>new_field()</CODE>.
1467 <LI>Create the form using <CODE>new_form()</CODE>.
1468 <LI>Post the form using <CODE>post_form()</CODE>.
1469 <LI>Refresh the screen.
1470 <LI>Process user requests via an input loop.
1471 <LI>Unpost the form using <CODE>unpost_form()</CODE>.
1472 <LI>Free the form, using <CODE>free_form()</CODE>.
1473 <LI>Free the fields using <CODE>free_field()</CODE>.
1474 <LI>Terminate <CODE>curses</CODE>.
1475 </OL>
1476
1477 Note that this looks much like a menu program; the form library handles
1478 tasks which are in many ways similar, and its interface was obviously
1479 designed to resemble that of the <A HREF="#menu">menu library</A>
1480 wherever possible. <P>
1481
1482 In forms programs, however, the `process user requests' is somewhat more
1483 complicated than for menus.  Besides menu-like navigation operations,
1484 the menu driver loop has to support field editing and data validation.
1485
1486 <H2><A NAME="fcreate">Creating and Freeing Fields and Forms</A></H2>
1487
1488 The basic function for creating fields is <CODE>new_field()</CODE>:
1489
1490 <PRE>
1491 FIELD *new_field(int height, int width,   /* new field size */
1492                  int top, int left,       /* upper left corner */
1493                  int offscreen,           /* number of offscreen rows */
1494                  int nbuf);               /* number of working buffers */
1495 </PRE>
1496
1497 Menu items always occupy a single row, but forms fields may have
1498 multiple rows.  So <CODE>new_field()</CODE> requires you to specify a
1499 width and height (the first two arguments, which mist both be greater
1500 than zero). <P>
1501
1502 You must also specify the location of the field's upper left corner on
1503 the screen (the third and fourth arguments, which must be zero or
1504 greater). Note that these coordinates are relative to the form
1505 subwindow, which will coincide with <CODE>stdscr</CODE> by default but
1506 need not be <CODE>stdscr</CODE> if you've done an explicit
1507 <CODE>set_form_win()</CODE> call. <P>
1508
1509 The fifth argument allows you to specify a number of off-screen rows.  If
1510 this is zero, the entire field will always be displayed.  If it is
1511 nonzero, the form will be scrollable, with only one screen-full (initially
1512 the top part) displayed at any given time.  If you make a field dynamic
1513 and grow it so it will no longer fit on the screen, the form will become
1514 scrollable even if the <CODE>offscreen</CODE> argument was initially zero. <P>
1515
1516 The forms library allocates one working buffer per field; the size of
1517 each buffer is <CODE>((height + offscreen)*width + 1</CODE>, one character
1518 for each position in the field plus a NUL terminator.  The sixth
1519 argument is the number of additional data buffers to allocate for the
1520 field; your application can use them for its own purposes.
1521
1522 <PRE>
1523 FIELD *dup_field(FIELD *field,            /* field to copy */
1524                  int top, int left);      /* location of new copy */
1525 </PRE>
1526
1527 The function <CODE>dup_field()</CODE> duplicates an existing field at a
1528 new location.  Size and buffering information are copied; some
1529 attribute flags and status bits are not (see the
1530 <CODE>form_field_new(3X)</CODE> for details).
1531
1532 <PRE>
1533 FIELD *link_field(FIELD *field,           /* field to copy */
1534                   int top, int left);     /* location of new copy */
1535 </PRE>
1536
1537 The function <CODE>link_field()</CODE> also duplicates an existing field
1538 at a new location.  The difference from <CODE>dup_field()</CODE> is that
1539 it arranges for the new field's buffer to be shared with the old one. <P>
1540
1541 Besides the obvious use in making a field editable from two different
1542 form pages, linked fields give you a way to hack in dynamic labels.  If
1543 you declare several fields linked to an original, and then make them
1544 inactive, changes from the original will still be propagated to the
1545 linked fields. <P>
1546
1547 As with duplicated fields, linked fields have attribute bits separate
1548 from the original. <P>
1549
1550 As you might guess, all these field-allocations return <CODE>NULL</CODE> if
1551 the field allocation is not possible due to an out-of-memory error or
1552 out-of-bounds arguments. <P>
1553
1554 To connect fields to a form, use
1555
1556 <PRE>
1557 FORM *new_form(FIELD **fields);
1558 </PRE>
1559
1560 This function expects to see a NULL-terminated array of field pointers.
1561 Said fields are connected to a newly-allocated form object; its address
1562 is returned (or else NULL if the allocation fails).   <P>
1563
1564 Note that <CODE>new_field()</CODE> does <EM>not</EM> copy the pointer array
1565 into private storage; if you modify the contents of the pointer array
1566 during forms processing, all manner of bizarre things might happen.  Also
1567 note that any given field may only be connected to one form. <P>
1568
1569 The functions <CODE>free_field()</CODE> and <CODE>free_form</CODE> are available
1570 to free field and form objects.  It is an error to attempt to free a field
1571 connected to a form, but not vice-versa; thus, you will generally free
1572 your form objects first.
1573
1574 <H2><A NAME="fattributes">Fetching and Changing Field Attributes</A></H2>
1575
1576 Each form field has a number of location and size attributes
1577 associated with it. There are other field attributes used to control
1578 display and editing of the field.  Some (for example, the <CODE>O_STATIC</CODE> bit)
1579 involve sufficient complications to be covered in sections of their own
1580 later on.  We cover the functions used to get and set several basic
1581 attributes here. <P>
1582
1583 When a field is created, the attributes not specified by the
1584 <CODE>new_field</CODE> function are copied from an invisible system
1585 default field.  In attribute-setting and -fetching functions, the
1586 argument NULL is taken to mean this field.  Changes to it persist
1587 as defaults until your forms application terminates.
1588
1589 <H3><A NAME="fsizes">Fetching Size and Location Data</A></H3>
1590
1591 You can retrieve field sizes and locations through:
1592
1593 <PRE>
1594 int field_info(FIELD *field,              /* field from which to fetch */
1595                int *height, *int width,   /* field size */
1596                int *top, int *left,       /* upper left corner */
1597                int *offscreen,            /* number of offscreen rows */
1598                int *nbuf);                /* number of working buffers */
1599 </PRE>
1600
1601 This function is a sort of inverse of <CODE>new_field()</CODE>; instead of
1602 setting size and location attributes of a new field, it fetches them
1603 from an existing one.
1604
1605 <H3><A NAME="flocation">Changing the Field Location</A></H3>
1606
1607 It is possible to move a field's location on the screen:
1608
1609 <PRE>
1610 int move_field(FIELD *field,              /* field to alter */
1611                int top, int left);        /* new upper-left corner */
1612 </PRE>
1613
1614 You can, of course. query the current location through <CODE>field_info()</CODE>.
1615
1616 <H3><A NAME="fjust">The Justification Attribute</A></H3>
1617
1618 One-line fields may be unjustified, justified right, justified left,
1619 or centered.  Here is how you manipulate this attribute:
1620
1621 <PRE>
1622 int set_field_just(FIELD *field,          /* field to alter */
1623                    int justmode);         /* mode to set */
1624
1625 int field_just(FIELD *field);             /* fetch mode of field */
1626 </PRE>
1627
1628 The mode values accepted and returned by this functions are
1629 preprocessor macros <CODE>NO_JUSTIFICATION</CODE>, <CODE>JUSTIFY_RIGHT</CODE>,
1630 <CODE>JUSTIFY_LEFT</CODE>, or <CODE>JUSTIFY_CENTER</CODE>.
1631
1632 <H3><A NAME="fdispatts">Field Display Attributes</A></H3>
1633
1634 For each field, you can set a foreground attribute for entered
1635 characters, a background attribute for the entire field, and a pad
1636 character for the unfilled portion of the field.  You can also
1637 control pagination of the form. <P>
1638
1639 This group of four field attributes controls the visual appearance
1640 of the field on the screen, without affecting in any way the data
1641 in the field buffer.
1642
1643 <PRE>
1644 int set_field_fore(FIELD *field,          /* field to alter */
1645                    chtype attr);          /* attribute to set */
1646
1647 chtype field_fore(FIELD *field);          /* field to query */
1648
1649 int set_field_back(FIELD *field,          /* field to alter */
1650                    chtype attr);          /* attribute to set */
1651
1652 chtype field_back(FIELD *field);          /* field to query */
1653
1654 int set_field_pad(FIELD *field,           /* field to alter */
1655                  int pad);                /* pad character to set */
1656
1657 chtype field_pad(FIELD *field);
1658
1659 int set_new_page(FIELD *field,            /* field to alter */
1660                  int flag);               /* TRUE to force new page */
1661
1662 chtype new_page(FIELD *field);            /* field to query */
1663 </PRE>
1664
1665 The attributes set and returned by the first four functions are normal
1666 <CODE>curses(3x)</CODE> display attribute values (<CODE>A_STANDOUT</CODE>,
1667 <CODE>A_BOLD</CODE>, <CODE>A_REVERSE</CODE> etc).
1668
1669 The page bit of a field controls whether it is displayed at the start of
1670 a new form screen.
1671
1672 <H3><A NAME="foptions">Field Option Bits</A></H3>
1673
1674 There is also a large collection of field option bits you can set to control
1675 various aspects of forms processing.  You can manipulate them with these
1676 functions:
1677
1678 <PRE>
1679 int set_field_opts(FIELD *field,          /* field to alter */
1680                    int attr);             /* attribute to set */
1681
1682 int field_opts_on(FIELD *field,           /* field to alter */
1683                   int attr);              /* attributes to turn on */
1684
1685 int field_opts_off(FIELD *field,          /* field to alter */
1686                    int attr);             /* attributes to turn off */
1687
1688 int field_opts(FIELD *field);             /* field to query */
1689 </PRE>
1690
1691 By default, all options are on.  Here are the available option bits:
1692 <DL>
1693 <DT> O_VISIBLE
1694 <DD> Controls whether the field is visible on the screen.  Can be used
1695 during form processing to hide or pop up fields depending on the value
1696 of parent fields.
1697 <DT> O_ACTIVE
1698 <DD> Controls whether the field is active during forms processing (i.e.
1699 visited by form navigation keys).  Can be used to make labels or derived
1700 fields with buffer values alterable by the forms application, not the user.
1701 <DT> O_PUBLIC
1702 <DD> Controls whether data is displayed during field entry.  If this option is
1703 turned off on a field, the library will accept and edit data in that field,
1704 but it will not be displayed and the visible field cursor will not move.
1705 You can turn off the O_PUBLIC bit to define password fields.
1706 <DT> O_EDIT
1707 <DD> Controls whether the field's data can be modified.  When this option is
1708 off, all editing requests except <CODE>REQ_PREV_CHOICE</CODE> and
1709 <CODE>REQ_NEXT_CHOICE</CODE> will fail.  Such read-only fields may be useful for
1710 help messages.
1711 <DT> O_WRAP
1712 <DD> Controls word-wrapping in multi-line fields.  Normally, when any
1713 character of a (blank-separated) word reaches the end of the current line, the
1714 entire word is wrapped to the next line (assuming there is one).  When this
1715 option is off, the word will be split across the line break.
1716 <DT> O_BLANK
1717 <DD> Controls field blanking.  When this option is on, entering a character at
1718 the first field position erases the entire field (except for the just-entered
1719 character).
1720 <DT> O_AUTOSKIP
1721 <DD> Controls automatic skip to next field when this one fills.  Normally,
1722 when the forms user tries to type more data into a field than will fit,
1723 the editing location jumps to next field.  When this option is off, the
1724 user's cursor will hang at the end of the field.  This option is ignored
1725 in dynamic fields that have not reached their size limit.
1726 <DT> O_NULLOK
1727 <DD> Controls whether <A HREF="#fvalidation">validation</A> is applied to
1728 blank fields.  Normally, it is not; the user can leave a field blank
1729 without invoking the usual validation check on exit.  If this option is
1730 off on a field, exit from it will invoke a validation check.
1731 <DT> O_PASSOK
1732 <DD> Controls whether validation occurs on every exit, or only after
1733 the field is modified.  Normally the latter is true.  Setting O_PASSOK
1734 may be useful if your field's validation function may change during
1735 forms processing.
1736 <DT> O_STATIC
1737 <DD> Controls whether the field is fixed to its initial dimensions.  If you
1738 turn this off, the field becomes <A HREF="#fdynamic">dynamic</A> and will
1739 stretch to fit entered data.
1740 </DL>
1741
1742 A field's options cannot be changed while the field is currently selected.
1743 However, options may be changed on posted fields that are not current. <P>
1744
1745 The option values are bit-masks and can be composed with logical-or in
1746 the obvious way.
1747
1748 <H2><A NAME="fstatus">Field Status</A></H2>
1749
1750 Every field has a status flag, which is set to FALSE when the field is
1751 created and TRUE when the value in field buffer 0 changes.  This flag can
1752 be queried and set directly:
1753
1754 <PRE>
1755 int set_field_status(FIELD *field,      /* field to alter */
1756                    int status);         /* mode to set */
1757
1758 int field_status(FIELD *field);         /* fetch mode of field */
1759 </PRE>
1760
1761 Setting this flag under program control can be useful if you use the same
1762 form repeatedly, looking for modified fields each time. <P>
1763
1764 Calling <CODE>field_status()</CODE> on a field not currently selected
1765 for input will return a correct value.  Calling <CODE>field_status()</CODE> on a
1766 field that is currently selected for input may not necessarily give a
1767 correct field status value, because entered data isn't necessarily copied to
1768 buffer zero before the exit validation check.
1769
1770 To guarantee that the returned status value reflects reality, call
1771 <CODE>field_status()</CODE> either (1) in the field's exit validation check
1772 routine, (2) from the field's or form's initialization or termination
1773 hooks, or (3) just after a <CODE>REQ_VALIDATION</CODE> request has been
1774 processed by the forms driver.
1775
1776 <H2><A NAME="fuser">Field User Pointer</A></H2>
1777
1778 Each field structure contains one character pointer slot that is not used
1779 by the forms library.  It is intended to be used by applications to store
1780 private per-field data.  You can manipulate it with:
1781
1782 <PRE>
1783 int set_field_userptr(FIELD *field,       /* field to alter */
1784                    char *userptr);        /* mode to set */
1785
1786 char *field_userptr(FIELD *field);        /* fetch mode of field */
1787 </PRE>
1788
1789 (Properly, this user pointer field ought to have <CODE>(void *)</CODE> type.
1790 The <CODE>(char *)</CODE> type is retained for System V compatibility.) <P>
1791
1792 It is valid to set the user pointer of the default field (with a
1793 <CODE>set_field_userptr()</CODE> call passed a NULL field pointer.)
1794 When a new field is created, the default-field user pointer is copied
1795 to initialize the new field's user pointer.
1796
1797 <H2><A NAME="fdynamic">Variable-Sized Fields</A></H2>
1798
1799 Normally, a field is fixed at the size specified for it at creation
1800 time.  If, however, you turn off its O_STATIC bit, it becomes
1801 <DFN>dynamic</DFN> and will automatically resize itself to accommodate
1802 data as it is entered.  If the field has extra buffers associated with it,
1803 they will grow right along with the main input buffer.  <P>
1804
1805 A one-line dynamic field will have a fixed height (1) but variable
1806 width, scrolling horizontally to display data within the field area as
1807 originally dimensioned and located.  A multi-line dynamic field will
1808 have a fixed width, but variable height (number of rows), scrolling
1809 vertically to display data within the field area as originally
1810 dimensioned and located. <P>
1811
1812 Normally, a dynamic field is allowed to grow without limit.  But it is
1813 possible to set an upper limit on the size of a dynamic field.  You do
1814 it with this function:
1815
1816 <PRE>
1817 int set_max_field(FIELD *field,     /* field to alter (may not be NULL) */
1818                    int max_size);   /* upper limit on field size */
1819 </PRE>
1820
1821 If the field is one-line, <CODE>max_size</CODE> is taken to be a column size
1822 limit; if it is multi-line, it is taken to be a line size limit.  To disable
1823 any limit, use an argument of zero.  The growth limit can be changed whether
1824 or not the O_STATIC bit is on, but has no effect until it is. <P>
1825
1826 The following properties of a field change when it becomes dynamic:
1827
1828 <UL>
1829 <LI>If there is no growth limit, there is no final position of the field;
1830 therefore <CODE>O_AUTOSKIP</CODE> and <CODE>O_NL_OVERLOAD</CODE> are ignored.
1831 <LI>Field justification will be ignored (though whatever justification is
1832 set up will be retained internally and can be queried).
1833 <LI>The <CODE>dup_field()</CODE> and <CODE>link_field()</CODE> calls copy
1834 dynamic-buffer sizes.  If the <CODE>O_STATIC</CODE> option is set on one of a
1835 collection of links, buffer resizing will occur only when the field is
1836 edited through that link.
1837 <LI>The call <CODE>field_info()</CODE> will retrieve the original static size of
1838 the field; use <CODE>dynamic_field_info()</CODE> to get the actual dynamic size.
1839 </UL>
1840
1841 <H2><A NAME="fvalidation">Field Validation</A></H2>
1842
1843 By default, a field will accept any data that will fit in its input buffer.
1844 However, it is possible to attach a validation type to a field.  If you do
1845 this, any attempt to leave the field while it contains data that doesn't
1846 match the validation type will fail.  Some validation types also have a
1847 character-validity check for each time a character is entered in the field. <P>
1848
1849 A field's validation check (if any) is not called when
1850 <CODE>set_field_buffer()</CODE> modifies the input buffer, nor when that buffer
1851 is changed through a linked field. <P>
1852
1853 The <CODE>form</CODE> library provides a rich set of pre-defined validation
1854 types, and gives you the capability to define custom ones of your own.  You
1855 can examine and change field validation attributes with the following
1856 functions:
1857
1858 <PRE>
1859 int set_field_type(FIELD *field,          /* field to alter */
1860                    FIELDTYPE *ftype,      /* type to associate */
1861                    ...);                  /* additional arguments*/
1862
1863 FIELDTYPE *field_type(FIELD *field);      /* field to query */
1864 </PRE>
1865
1866 The validation type of a field is considered an attribute of the field.  As
1867 with other field attributes, Also, doing <CODE>set_field_type()</CODE> with a
1868 <CODE>NULL</CODE> field default will change the system default for validation of
1869 newly-created fields. <P>
1870
1871 Here are the pre-defined validation types:
1872
1873 <H3><A NAME="ftype_alpha">TYPE_ALPHA</A></H3>
1874
1875 This field type accepts alphabetic data; no blanks, no digits, no special
1876 characters (this is checked at character-entry time).  It is set up with:
1877
1878 <PRE>
1879 int set_field_type(FIELD *field,          /* field to alter */
1880                    TYPE_ALPHA,            /* type to associate */
1881                    int width);            /* maximum width of field */
1882 </PRE>
1883
1884 The <CODE>width</CODE> argument sets a minimum width of data.  Typically
1885 you'll want to set this to the field width; if it's greater than the
1886 field width, the validation check will always fail.  A minimum width
1887 of zero makes field completion optional.
1888
1889 <H3><A NAME="ftype_alnum">TYPE_ALNUM</A></H3>
1890
1891 This field type accepts alphabetic data and digits; no blanks, no special
1892 characters (this is checked at character-entry time).  It is set up with:
1893
1894 <PRE>
1895 int set_field_type(FIELD *field,          /* field to alter */
1896                    TYPE_ALNUM,            /* type to associate */
1897                    int width);            /* maximum width of field */
1898 </PRE>
1899
1900 The <CODE>width</CODE> argument sets a minimum width of data.  As with
1901 TYPE_ALPHA, typically you'll want to set this to the field width; if it's
1902 greater than the field width, the validation check will always fail.  A
1903 minimum width of zero makes field completion optional.
1904
1905 <H3><A NAME="ftype_enum">TYPE_ENUM</A></H3>
1906
1907 This type allows you to restrict a field's values to be among a specified
1908 set of string values (for example, the two-letter postal codes for U.S.
1909 states).  It is set up with:
1910
1911 <PRE>
1912 int set_field_type(FIELD *field,          /* field to alter */
1913                    TYPE_ENUM,             /* type to associate */
1914                    char **valuelist;      /* list of possible values */
1915                    int checkcase;         /* case-sensitive? */
1916                    int checkunique);      /* must specify uniquely? */
1917 </PRE>
1918
1919 The <CODE>valuelist</CODE> parameter must point at a NULL-terminated list of
1920 valid strings.  The <CODE>checkcase</CODE> argument, if true, makes comparison
1921 with the string case-sensitive. <P>
1922
1923 When the user exits a TYPE_ENUM field, the validation procedure tries to
1924 complete the data in the buffer to a valid entry.  If a complete choice string
1925 has been entered, it is of course valid.  But it is also possible to enter a
1926 prefix of a valid string and have it completed for you. <P>
1927
1928 By default, if you enter such a prefix and it matches more than one value
1929 in the string list, the prefix will be completed to the first matching
1930 value.  But the <CODE>checkunique</CODE> argument, if true, requires prefix
1931 matches to be unique in order to be valid. <P>
1932
1933 The <CODE>REQ_NEXT_CHOICE</CODE> and <CODE>REQ_PREV_CHOICE</CODE> input requests
1934 can be particularly useful with these fields.
1935
1936 <H3><A NAME="ftype_integer">TYPE_INTEGER</A></H3>
1937
1938 This field type accepts an integer.  It is set up as follows:
1939
1940 <PRE>
1941 int set_field_type(FIELD *field,          /* field to alter */
1942                    TYPE_INTEGER,          /* type to associate */
1943                    int padding,           /* # places to zero-pad to */
1944                    int vmin, int vmax);   /* valid range */
1945 </PRE>
1946
1947 Valid characters consist of an optional leading minus and digits.
1948 The range check is performed on exit.  If the range maximum is less
1949 than or equal to the minimum, the range is ignored. <P>
1950
1951 If the value passes its range check, it is padded with as many leading
1952 zero digits as necessary to meet the padding argument. <P>
1953
1954 A <CODE>TYPE_INTEGER</CODE> value buffer can conveniently be interpreted
1955 with the C library function <CODE>atoi(3)</CODE>.
1956
1957 <H3><A NAME="ftype_numeric">TYPE_NUMERIC</A></H3>
1958
1959 This field type accepts a decimal number.  It is set up as follows:
1960
1961 <PRE>
1962 int set_field_type(FIELD *field,              /* field to alter */
1963                    TYPE_NUMERIC,              /* type to associate */
1964                    int padding,               /* # places of precision */
1965                    double vmin, double vmax); /* valid range */
1966 </PRE>
1967
1968 Valid characters consist of an optional leading minus and digits. possibly
1969 including a decimal point. If your system supports locale's, the decimal point
1970 character used must be the one defined by your locale. The range check is
1971 performed on exit. If the range maximum is less than or equal to the minimum,
1972 the range is ignored. <P>
1973
1974 If the value passes its range check, it is padded with as many trailing
1975 zero digits as necessary to meet the padding argument. <P>
1976
1977 A <CODE>TYPE_NUMERIC</CODE> value buffer can conveniently be interpreted
1978 with the C library function <CODE>atof(3)</CODE>.
1979
1980 <H3><A NAME="ftype_regexp">TYPE_REGEXP</A></H3>
1981
1982 This field type accepts data matching a regular expression.  It is set up
1983 as follows:
1984
1985 <PRE>
1986 int set_field_type(FIELD *field,          /* field to alter */
1987                    TYPE_REGEXP,           /* type to associate */
1988                    char *regexp);         /* expression to match */
1989 </PRE>
1990
1991 The syntax for regular expressions is that of <CODE>regcomp(3)</CODE>.
1992 The check for regular-expression match is performed on exit.
1993
1994 <H2><A NAME="fbuffer">Direct Field Buffer Manipulation</A></H2>
1995
1996 The chief attribute of a field is its buffer contents.  When a form has
1997 been completed, your application usually needs to know the state of each
1998 field buffer.  You can find this out with:
1999
2000 <PRE>
2001 char *field_buffer(FIELD *field,          /* field to query */
2002                    int bufindex);         /* number of buffer to query */
2003 </PRE>
2004
2005 Normally, the state of the zero-numbered buffer for each field is set by
2006 the user's editing actions on that field.  It's sometimes useful to be able
2007 to set the value of the zero-numbered (or some other) buffer from your
2008 application:
2009
2010 <PRE>
2011 int set_field_buffer(FIELD *field,        /* field to alter */
2012                    int bufindex,          /* number of buffer to alter */
2013                    char *value);          /* string value to set */
2014 </PRE>
2015
2016 If the field is not large enough and cannot be resized to a sufficiently
2017 large size to contain the specified value, the value will be truncated
2018 to fit. <P>
2019
2020 Calling <CODE>field_buffer()</CODE> with a null field pointer will raise an
2021 error.  Calling <CODE>field_buffer()</CODE> on a field not currently selected
2022 for input will return a correct value.  Calling <CODE>field_buffer()</CODE> on a
2023 field that is currently selected for input may not necessarily give a
2024 correct field buffer value, because entered data isn't necessarily copied to
2025 buffer zero before the exit validation check.
2026
2027 To guarantee that the returned buffer value reflects on-screen reality,
2028 call <CODE>field_buffer()</CODE> either (1) in the field's exit validation
2029 check routine, (2) from the field's or form's initialization or termination
2030 hooks, or (3) just after a <CODE>REQ_VALIDATION</CODE> request has been processed
2031 by the forms driver.
2032
2033 <H2><A NAME="formattrs">Attributes of Forms</A></H2>
2034
2035 As with field attributes, form attributes inherit a default from a
2036 system default form structure.  These defaults can be queried or set by
2037 of these functions using a form-pointer argument of <CODE>NULL</CODE>. <P>
2038
2039 The principal attribute of a form is its field list.  You can query
2040 and change this list with:
2041
2042 <PRE>
2043 int set_form_fields(FORM *form,           /* form to alter */
2044                     FIELD **fields);      /* fields to connect */
2045
2046 char *form_fields(FORM *form);            /* fetch fields of form */
2047
2048 int field_count(FORM *form);              /* count connect fields */
2049 </PRE>
2050
2051 The second argument of <CODE>set_form_fields()</CODE> may be a
2052 NULL-terminated field pointer array like the one required by
2053 <CODE>new_form()</CODE>. In that case, the old fields of the form are
2054 disconnected but not freed (and eligible to be connected to other
2055 forms), then the new fields are connected. <P>
2056
2057 It may also be null, in which case the old fields are disconnected
2058 (and not freed) but no new ones are connected. <P>
2059
2060 The <CODE>field_count()</CODE> function simply counts the number of fields
2061 connected to a given from.  It returns -1 if the form-pointer argument
2062 is NULL.
2063
2064 <H2><A NAME="fdisplay">Control of Form Display</A></H2>
2065
2066 In the overview section, you saw that to display a form you normally
2067 start by defining its size (and fields), posting it, and refreshing
2068 the screen.  There is an hidden step before posting, which is the
2069 association of the form with a frame window (actually, a pair of
2070 windows) within which it will be displayed.  By default, the forms
2071 library associates every form with the full-screen window
2072 <CODE>stdscr</CODE>. <P>
2073
2074 By making this step explicit, you can associate a form with a declared
2075 frame window on your screen display.  This can be useful if you want to
2076 adapt the form display to different screen sizes, dynamically tile
2077 forms on the screen, or use a form as part of an interface layout
2078 managed by <A HREF="#panels">panels</A>. <P>
2079
2080 The two windows associated with each form have the same functions as
2081 their analogues in the <A HREF="#menu">menu library</A>.  Both these
2082 windows are painted when the form is posted and erased when the form
2083 is unposted. <P>
2084
2085 The outer or frame window is not otherwise touched by the form
2086 routines.  It exists so the programmer can associate a title, a
2087 border, or perhaps help text with the form and have it properly
2088 refreshed or erased at post/unpost time. The inner window or subwindow
2089 is where the current form page is actually displayed. <P>
2090
2091 In order to declare your own frame window for a form, you'll need to
2092 know the size of the form's bounding rectangle.  You can get this
2093 information with:
2094
2095 <PRE>
2096 int scale_form(FORM *form,                /* form to query */
2097                int *rows,                 /* form rows */
2098                int *cols);                /* form cols */
2099 </PRE>
2100
2101 The form dimensions are passed back in the locations pointed to by
2102 the arguments.  Once you have this information, you can use it to
2103 declare of windows, then use one of these functions:
2104
2105 <PRE>
2106 int set_form_win(FORM *form,              /* form to alter */
2107                  WINDOW *win);            /* frame window to connect */
2108
2109 WINDOW *form_win(FORM *form);             /* fetch frame window of form */
2110
2111 int set_form_sub(FORM *form,              /* form to alter */
2112                  WINDOW *win);            /* form subwindow to connect */
2113
2114 WINDOW *form_sub(FORM *form);             /* fetch form subwindow of form */
2115 </PRE>
2116
2117 Note that curses operations, including <CODE>refresh()</CODE>, on the form,
2118 should be done on the frame window, not the form subwindow. <P>
2119
2120 It is possible to check from your application whether all of a
2121 scrollable field is actually displayed within the menu subwindow.  Use
2122 these functions:
2123
2124 <PRE>
2125 int data_ahead(FORM *form);               /* form to be queried */
2126
2127 int data_behind(FORM *form);              /* form to be queried */
2128 </PRE>
2129
2130 The function <CODE>data_ahead()</CODE> returns TRUE if (a) the current
2131 field is one-line and has undisplayed data off to the right, (b) the current
2132 field is multi-line and there is data off-screen below it. <P>
2133
2134 The function <CODE>data_behind()</CODE> returns TRUE if the first (upper
2135 left hand) character position is off-screen (not being displayed). <P>
2136
2137 Finally, there is a function to restore the form window's cursor to the
2138 value expected by the forms driver:
2139
2140 <PRE>
2141 int pos_form_cursor(FORM *)               /* form to be queried */
2142 </PRE>
2143
2144 If your application changes the form window cursor, call this function before
2145 handing control back to the forms driver in order to re-synchronize it.
2146
2147 <H2><A NAME="fdriver">Input Processing in the Forms Driver</A></H2>
2148
2149 The function <CODE>form_driver()</CODE> handles virtualized input requests
2150 for form navigation, editing, and validation requests, just as
2151 <CODE>menu_driver</CODE> does for menus (see the section on <A
2152 HREF="#minput">menu input handling</A>).
2153
2154 <PRE>
2155 int form_driver(FORM *form,               /* form to pass input to */
2156                 int request);             /* form request code */
2157 </PRE>
2158
2159 Your input virtualization function needs to take input and then convert it
2160 to either an alphanumeric character (which is treated as data to be
2161 entered in the currently-selected field), or a forms processing request. <P>
2162
2163 The forms driver provides hooks (through input-validation and
2164 field-termination functions) with which your application code can check
2165 that the input taken by the driver matched what was expected.
2166
2167 <H3><A NAME="fpage">Page Navigation Requests</A></H3>
2168
2169 These requests cause page-level moves through the form,
2170 triggering display of a new form screen.
2171
2172 <DL>
2173 <DT> <CODE>REQ_NEXT_PAGE</CODE>
2174 <DD> Move to the next form page.
2175 <DT> <CODE>REQ_PREV_PAGE</CODE>
2176 <DD> Move to the previous form page.
2177 <DT> <CODE>REQ_FIRST_PAGE</CODE>
2178 <DD> Move to the first form page.
2179 <DT> <CODE>REQ_LAST_PAGE</CODE>
2180 <DD> Move to the last form page.
2181 </DL>
2182
2183 These requests treat the list as cyclic; that is, <CODE>REQ_NEXT_PAGE</CODE>
2184 from the last page goes to the first, and <CODE>REQ_PREV_PAGE</CODE> from
2185 the first page goes to the last.
2186
2187 <H3><A NAME="#ffield">Inter-Field Navigation Requests</A></H3>
2188
2189 These requests handle navigation between fields on the same page.
2190
2191 <DL>
2192 <DT> <CODE>REQ_NEXT_FIELD</CODE>
2193 <DD> Move to next field.
2194 <DT> <CODE>REQ_PREV_FIELD</CODE>
2195 <DD> Move to previous field.
2196 <DT> <CODE>REQ_FIRST_FIELD</CODE>
2197 <DD> Move to the first field.
2198 <DT> <CODE>REQ_LAST_FIELD</CODE>
2199 <DD> Move to the last field.
2200 <DT> <CODE>REQ_SNEXT_FIELD</CODE>
2201 <DD> Move to sorted next field.
2202 <DT> <CODE>REQ_SPREV_FIELD</CODE>
2203 <DD> Move to sorted previous field.
2204 <DT> <CODE>REQ_SFIRST_FIELD</CODE>
2205 <DD> Move to the sorted first field.
2206 <DT> <CODE>REQ_SLAST_FIELD</CODE>
2207 <DD> Move to the sorted last field.
2208 <DT> <CODE>REQ_LEFT_FIELD</CODE>
2209 <DD> Move left to field.
2210 <DT> <CODE>REQ_RIGHT_FIELD</CODE>
2211 <DD> Move right to field.
2212 <DT> <CODE>REQ_UP_FIELD</CODE>
2213 <DD> Move up to field.
2214 <DT> <CODE>REQ_DOWN_FIELD</CODE>
2215 <DD> Move down to field.
2216 </DL>
2217
2218 These requests treat the list of fields on a page as cyclic; that is,
2219 <CODE>REQ_NEXT_FIELD</CODE> from the last field goes to the first, and
2220 <CODE>REQ_PREV_FIELD</CODE> from the first field goes to the last. The
2221 order of the fields for these (and the <CODE>REQ_FIRST_FIELD</CODE> and
2222 <CODE>REQ_LAST_FIELD</CODE> requests) is simply the order of the field
2223 pointers in the form array (as set up by <CODE>new_form()</CODE> or
2224 <CODE>set_form_fields()</CODE> <P>
2225
2226 It is also possible to traverse the fields as if they had been sorted in
2227 screen-position order, so the sequence goes left-to-right and top-to-bottom.
2228 To do this, use the second group of four sorted-movement requests.  <P>
2229
2230 Finally, it is possible to move between fields using visual directions up,
2231 down, right, and left.  To accomplish this, use the third group of four
2232 requests.  Note, however, that the position of a form for purposes of these
2233 requests is its upper-left corner. <P>
2234
2235 For example, suppose you have a multi-line field B, and two
2236 single-line fields A and C on the same line with B, with A to the left
2237 of B and C to the right of B.  A <CODE>REQ_MOVE_RIGHT</CODE> from A will
2238 go to B only if A, B, and C <EM>all</EM> share the same first line;
2239 otherwise it will skip over B to C.
2240
2241 <H3><A NAME="#fifield">Intra-Field Navigation Requests</A></H3>
2242
2243 These requests drive movement of the edit cursor within the currently
2244 selected field.
2245
2246 <DL>
2247 <DT> <CODE>REQ_NEXT_CHAR</CODE>
2248 <DD> Move to next character.
2249 <DT> <CODE>REQ_PREV_CHAR</CODE>
2250 <DD> Move to previous character.
2251 <DT> <CODE>REQ_NEXT_LINE</CODE>
2252 <DD> Move to next line.
2253 <DT> <CODE>REQ_PREV_LINE</CODE>
2254 <DD> Move to previous line.
2255 <DT> <CODE>REQ_NEXT_WORD</CODE>
2256 <DD> Move to next word.
2257 <DT> <CODE>REQ_PREV_WORD</CODE>
2258 <DD> Move to previous word.
2259 <DT> <CODE>REQ_BEG_FIELD</CODE>
2260 <DD> Move to beginning of field.
2261 <DT> <CODE>REQ_END_FIELD</CODE>
2262 <DD> Move to end of field.
2263 <DT> <CODE>REQ_BEG_LINE</CODE>
2264 <DD> Move to beginning of line.
2265 <DT> <CODE>REQ_END_LINE</CODE>
2266 <DD> Move to end of line.
2267 <DT> <CODE>REQ_LEFT_CHAR</CODE>
2268 <DD> Move left in field.
2269 <DT> <CODE>REQ_RIGHT_CHAR</CODE>
2270 <DD> Move right in field.
2271 <DT> <CODE>REQ_UP_CHAR</CODE>
2272 <DD> Move up in field.
2273 <DT> <CODE>REQ_DOWN_CHAR</CODE>
2274 <DD> Move down in field.
2275 </DL>
2276
2277 Each <EM>word</EM> is separated from the previous and next characters
2278 by whitespace.  The commands to move to beginning and end of line or field
2279 look for the first or last non-pad character in their ranges.
2280
2281 <H3><A NAME="fscroll">Scrolling Requests</A></H3>
2282
2283 Fields that are dynamic and have grown and fields explicitly created
2284 with offscreen rows are scrollable.  One-line fields scroll horizontally;
2285 multi-line fields scroll vertically.  Most scrolling is triggered by
2286 editing and intra-field movement (the library scrolls the field to keep the
2287 cursor visible).  It is possible to explicitly request scrolling with the
2288 following requests:
2289
2290 <DL>
2291 <DT> <CODE>REQ_SCR_FLINE</CODE>
2292 <DD> Scroll vertically forward a line.
2293 <DT> <CODE>REQ_SCR_BLINE</CODE>
2294 <DD> Scroll vertically backward a line.
2295 <DT> <CODE>REQ_SCR_FPAGE</CODE>
2296 <DD> Scroll vertically forward a page.
2297 <DT> <CODE>REQ_SCR_BPAGE</CODE>
2298 <DD> Scroll vertically backward a page.
2299 <DT> <CODE>REQ_SCR_FHPAGE</CODE>
2300 <DD> Scroll vertically forward half a page.
2301 <DT> <CODE>REQ_SCR_BHPAGE</CODE>
2302 <DD> Scroll vertically backward half a page.
2303 <DT> <CODE>REQ_SCR_FCHAR</CODE>
2304 <DD> Scroll horizontally forward a character.
2305 <DT> <CODE>REQ_SCR_BCHAR</CODE>
2306 <DD> Scroll horizontally backward a character.
2307 <DT> <CODE>REQ_SCR_HFLINE</CODE>
2308 <DD> Scroll horizontally one field width forward.
2309 <DT> <CODE>REQ_SCR_HBLINE</CODE>
2310 <DD> Scroll horizontally one field width backward.
2311 <DT> <CODE>REQ_SCR_HFHALF</CODE>
2312 <DD> Scroll horizontally one half field width forward.
2313 <DT> <CODE>REQ_SCR_HBHALF</CODE>
2314 <DD> Scroll horizontally one half field width backward.
2315 </DL>
2316
2317 For scrolling purposes, a <EM>page</EM> of a field is the height
2318 of its visible part.
2319
2320 <H3><A NAME="fedit">Editing Requests</A></H3>
2321
2322 When you pass the forms driver an ASCII character, it is treated as a
2323 request to add the character to the field's data buffer.  Whether this
2324 is an insertion or a replacement depends on the field's edit mode
2325 (insertion is the default. <P>
2326
2327 The following requests support editing the field and changing the edit
2328 mode:
2329
2330 <DL>
2331 <DT> <CODE>REQ_INS_MODE</CODE>
2332 <DD> Set insertion mode.
2333 <DT> <CODE>REQ_OVL_MODE</CODE>
2334 <DD> Set overlay mode.
2335 <DT> <CODE>REQ_NEW_LINE</CODE>
2336 <DD> New line request (see below for explanation).
2337 <DT> <CODE>REQ_INS_CHAR</CODE>
2338 <DD> Insert space at character location.
2339 <DT> <CODE>REQ_INS_LINE</CODE>
2340 <DD> Insert blank line at character location.
2341 <DT> <CODE>REQ_DEL_CHAR</CODE>
2342 <DD> Delete character at cursor.
2343 <DT> <CODE>REQ_DEL_PREV</CODE>
2344 <DD> Delete previous word at cursor.
2345 <DT> <CODE>REQ_DEL_LINE</CODE>
2346 <DD> Delete line at cursor.
2347 <DT> <CODE>REQ_DEL_WORD</CODE>
2348 <DD> Delete word at cursor.
2349 <DT> <CODE>REQ_CLR_EOL</CODE>
2350 <DD> Clear to end of line.
2351 <DT> <CODE>REQ_CLR_EOF</CODE>
2352 <DD> Clear to end of field.
2353 <DT> <CODE>REQ_CLEAR_FIELD</CODE>
2354 <DD> Clear entire field.
2355 </DL>
2356
2357 The behavior of the <CODE>REQ_NEW_LINE</CODE> and <CODE>REQ_DEL_PREV</CODE> requests
2358 is complicated and partly controlled by a pair of forms options.
2359 The special cases are triggered when the cursor is at the beginning of
2360 a field, or on the last line of the field. <P>
2361
2362 First, we consider <CODE>REQ_NEW_LINE</CODE>: <P>
2363
2364 The normal behavior of <CODE>REQ_NEW_LINE</CODE> in insert mode is to break the
2365 current line at the position of the edit cursor, inserting the portion of
2366 the current line after the cursor as a new line following the current
2367 and moving the cursor to the beginning of that new line (you may think
2368 of this as inserting a newline in the field buffer). <P>
2369
2370 The normal behavior of <CODE>REQ_NEW_LINE</CODE> in overlay mode is to clear the
2371 current line from the position of the edit cursor to end of line.
2372 The cursor is then moved to the beginning of the next line. <P>
2373
2374 However, <CODE>REQ_NEW_LINE</CODE> at the beginning of a field, or on the
2375 last line of a field, instead does a <CODE>REQ_NEXT_FIELD</CODE>.
2376 <CODE>O_NL_OVERLOAD</CODE> option is off, this special action is
2377 disabled. <P>
2378
2379 Now, let us consider <CODE>REQ_DEL_PREV</CODE>: <P>
2380
2381 The normal behavior of <CODE>REQ_DEL_PREV</CODE> is to delete the previous
2382 character.  If insert mode is on, and the cursor is at the start of a
2383 line, and the text on that line will fit on the previous one, it
2384 instead appends the contents of the current line to the previous one
2385 and deletes the current line (you may think of this as deleting a
2386 newline from the field buffer). <P>
2387
2388 However, <CODE>REQ_DEL_PREV</CODE> at the beginning of a field is instead
2389 treated as a <CODE>REQ_PREV_FIELD</CODE>. <P> If the
2390 <CODE>O_BS_OVERLOAD</CODE> option is off, this special action is
2391 disabled and the forms driver just returns <CODE>E_REQUEST_DENIED</CODE>. <P>
2392
2393 See <A HREF="#frmoptions">Form Options</A> for discussion of how to set
2394 and clear the overload options.
2395
2396 <H3><A NAME="forder">Order Requests</A></H3>
2397
2398 If the type of your field is ordered, and has associated functions
2399 for getting the next and previous values of the type from a given value,
2400 there are requests that can fetch that value into the field buffer:
2401
2402 <DL>
2403 <DT> <CODE>REQ_NEXT_CHOICE</CODE>
2404 <DD> Place the successor value of the current value in the buffer.
2405 <DT> <CODE>REQ_PREV_CHOICE</CODE>
2406 <DD> Place the predecessor value of the current value in the buffer.
2407 </DL>
2408
2409 Of the built-in field types, only <CODE>TYPE_ENUM</CODE> has built-in successor
2410 and predecessor functions.  When you define a field type of your own
2411 (see <A HREF="#fcustom">Custom Validation Types</A>), you can associate
2412 our own ordering functions.
2413
2414 <H3><A NAME="fappcmds">Application Commands</A></H3>
2415
2416 Form requests are represented as integers above the <CODE>curses</CODE> value
2417 greater than <CODE>KEY_MAX</CODE> and less than or equal to the constant
2418 <CODE>MAX_COMMAND</CODE>.  If your input-virtualization routine returns a
2419 value above <CODE>MAX_COMMAND</CODE>, the forms driver will ignore it.
2420
2421 <H2><A NAME="fhooks">Field Change Hooks</A></H2>
2422
2423 It is possible to set function hooks to be executed whenever the
2424 current field or form changes.  Here are the functions that support this:
2425
2426 <PRE>
2427 typedef void    (*HOOK)();       /* pointer to function returning void */
2428
2429 int set_form_init(FORM *form,    /* form to alter */
2430                   HOOK hook);    /* initialization hook */
2431
2432 HOOK form_init(FORM *form);      /* form to query */
2433
2434 int set_form_term(FORM *form,    /* form to alter */
2435                   HOOK hook);    /* termination hook */
2436
2437 HOOK form_term(FORM *form);      /* form to query */
2438
2439 int set_field_init(FORM *form,   /* form to alter */
2440                   HOOK hook);    /* initialization hook */
2441
2442 HOOK field_init(FORM *form);     /* form to query */
2443
2444 int set_field_term(FORM *form,   /* form to alter */
2445                   HOOK hook);    /* termination hook */
2446
2447 HOOK field_term(FORM *form);     /* form to query */
2448 </PRE>
2449
2450 These functions allow you to either set or query four different hooks.
2451 In each of the set functions, the second argument should be the
2452 address of a hook function.  These functions differ only in the timing
2453 of the hook call.
2454
2455 <DL>
2456 <DT> form_init
2457 <DD> This hook is called when the form is posted; also, just after
2458 each page change operation.
2459 <DT> field_init
2460 <DD> This hook is called when the form is posted; also, just after
2461 each field change
2462 <DT> field_term
2463 <DD> This hook is called just after field validation; that is, just before
2464 the field is altered.  It is also called when the form is unposted.
2465 <DT> form_term
2466 <DD> This hook is called when the form is unposted; also, just before
2467 each page change operation.
2468 </DL>
2469
2470 Calls to these hooks may be triggered
2471 <OL>
2472 <LI>When user editing requests are processed by the forms driver
2473 <LI>When the current page is changed by <CODE>set_current_field()</CODE> call
2474 <LI>When the current field is changed by a <CODE>set_form_page()</CODE> call
2475 </OL>
2476
2477 See <A NAME="ffocus">Field Change Commands</A> for discussion of the latter
2478 two cases. <P>
2479
2480 You can set a default hook for all fields by passing one of the set functions
2481 a NULL first argument. <P>
2482
2483 You can disable any of these hooks by (re)setting them to NULL, the default
2484 value.
2485
2486 <H2><A HREF="#ffocus">Field Change Commands</A></H2>
2487
2488 Normally, navigation through the form will be driven by the user's
2489 input requests.  But sometimes it is useful to be able to move the
2490 focus for editing and viewing under control of your application, or
2491 ask which field it currently is in.  The following functions help you
2492 accomplish this:
2493
2494 <PRE>
2495 int set_current_field(FORM *form,         /* form to alter */
2496                       FIELD *field);      /* field to shift to */
2497
2498 FIELD *current_field(FORM *form);         /* form to query */
2499
2500 int field_index(FORM *form,               /* form to query */
2501                 FIELD *field);            /* field to get index of */
2502 </PRE>
2503
2504 The function <CODE>field_index()</CODE> returns the index of the given field
2505 in the given form's field array (the array passed to <CODE>new_form()</CODE> or
2506 <CODE>set_form_fields()</CODE>). <P>
2507
2508 The initial current field of a form is the first active field on the
2509 first page. The function <CODE>set_form_fields()</CODE> resets this.<P>
2510
2511 It is also possible to move around by pages.
2512
2513 <PRE>
2514 int set_form_page(FORM *form,             /* form to alter */
2515                   int page);              /* page to go to (0-origin) */
2516
2517 int form_page(FORM *form);                /* return form's current page */
2518 </PRE>
2519
2520 The initial page of a newly-created form is 0.  The function
2521 <CODE>set_form_fields()</CODE> resets this.
2522
2523 <H2><A NAME="frmoptions">Form Options</A></H2>
2524
2525 Like fields, forms may have control option bits.  They can be changed
2526 or queried with these functions:
2527
2528 <PRE>
2529 int set_form_opts(FORM *form,             /* form to alter */
2530                   int attr);              /* attribute to set */
2531
2532 int form_opts_on(FORM *form,              /* form to alter */
2533                  int attr);               /* attributes to turn on */
2534
2535 int form_opts_off(FORM *form,             /* form to alter */
2536                   int attr);              /* attributes to turn off */
2537
2538 int form_opts(FORM *form);                /* form to query */
2539 </PRE>
2540
2541 By default, all options are on.  Here are the available option bits:
2542
2543 <DL>
2544 <DT> O_NL_OVERLOAD
2545 <DD> Enable overloading of <CODE>REQ_NEW_LINE</CODE> as described in <A
2546 href="#fedit">Editing Requests</A>.  The value of this option is
2547 ignored on dynamic fields that have not reached their size limit;
2548 these have no last line, so the circumstances for triggering a
2549 <CODE>REQ_NEXT_FIELD</CODE> never arise.
2550 <DT> O_BS_OVERLOAD
2551 <DD> Enable overloading of <CODE>REQ_DEL_PREV</CODE> as described in
2552 <A href="#fedit">Editing Requests</A>.
2553 </DL>
2554
2555 The option values are bit-masks and can be composed with logical-or in
2556 the obvious way.
2557
2558 <H2><A NAME="fcustom">Custom Validation Types</A></H2>
2559
2560 The <CODE>form</CODE> library gives you the capability to define custom
2561 validation types of your own.  Further, the optional additional arguments
2562 of <CODE>set_field_type</CODE> effectively allow you to parameterize validation
2563 types.  Most of the complications in the validation-type interface have to
2564 do with the handling of the additional arguments within custom validation
2565 functions.
2566
2567 <H3><A NAME="flinktypes">Union Types</A></H3>
2568
2569 The simplest way to create a custom data type is to compose it from two
2570 preexisting ones:
2571
2572 <PRE>
2573 FIELD *link_fieldtype(FIELDTYPE *type1,
2574                       FIELDTYPE *type2);
2575 </PRE>
2576
2577 This function creates a field type that will accept any of the values
2578 legal for either of its argument field types (which may be either
2579 predefined or programmer-defined).
2580
2581 If a <CODE>set_field_type()</CODE> call later requires arguments, the new
2582 composite type expects all arguments for the first type, than all arguments
2583 for the second.  Order functions (see <A HREF="#forder">Order Requests</A>)
2584 associated with the component types will work on the composite; what it does
2585 is check the validation function for the first type, then for the second, to
2586 figure what type the buffer contents should be treated as.
2587
2588 <H3><A NAME="fnewtypes">New Field Types</A></H3>
2589
2590 To create a field type from scratch, you need to specify one or both of the
2591 following things:
2592
2593 <UL>
2594 <LI>A character-validation function, to check each character as it is entered.
2595 <LI>A field-validation function to be applied on exit from the field.
2596 </UL>
2597
2598 Here's how you do that:
2599 <PRE>
2600 typedef int     (*HOOK)();       /* pointer to function returning int */
2601
2602 FIELDTYPE *new_fieldtype(HOOK f_validate, /* field validator */
2603                          HOOK c_validate) /* character validator */
2604
2605
2606 int free_fieldtype(FIELDTYPE *ftype);     /* type to free */
2607 </PRE>
2608
2609 At least one of the arguments of <CODE>new_fieldtype()</CODE> must be
2610 non-NULL.  The forms driver will automatically call the new type's
2611 validation functions at appropriate points in processing a field of
2612 the new type. <P>
2613
2614 The function <CODE>free_fieldtype()</CODE> deallocates the argument
2615 fieldtype, freeing all storage associated with it. <P>
2616
2617 Normally, a field validator is called when the user attempts to
2618 leave the field.  Its first argument is a field pointer, from which it
2619 can get to field buffer 0 and test it.  If the function returns TRUE,
2620 the operation succeeds; if it returns FALSE, the edit cursor stays in
2621 the field. <P>
2622
2623 A character validator gets the character passed in as a first argument.
2624 It too should return TRUE if the character is valid, FALSE otherwise.
2625
2626 <H3><A NAME="fcheckargs">Validation Function Arguments</A></H3>
2627
2628 Your field- and character- validation functions will be passed a
2629 second argument as well.  This second argument is the address of a
2630 structure (which we'll call a <EM>pile</EM>) built from any of the
2631 field-type-specific arguments passed to <CODE>set_field_type()</CODE>.  If
2632 no such arguments are defined for the field type, this pile pointer
2633 argument will be NULL. <P>
2634
2635 In order to arrange for such arguments to be passed to your validation
2636 functions, you must associate a small set of storage-management functions
2637 with the type.  The forms driver will use these to synthesize a pile
2638 from the trailing arguments of each <CODE>set_field_type()</CODE> argument, and
2639 a pointer to the pile will be passed to the validation functions. <P>
2640
2641 Here is how you make the association:
2642
2643 <PRE>
2644 typedef char    *(*PTRHOOK)();    /* pointer to function returning (char *) */
2645 typedef void    (*VOIDHOOK)();    /* pointer to function returning void */
2646
2647 int set_fieldtype_arg(FIELDTYPE *type,    /* type to alter */
2648                       PTRHOOK make_str,   /* make structure from args */
2649                       PTRHOOK copy_str,   /* make copy of structure */
2650                       VOIDHOOK free_str); /* free structure storage */
2651 </PRE>
2652
2653 Here is how the storage-management hooks are used:
2654
2655 <DL>
2656 <DT> <CODE>make_str</CODE>
2657 <DD> This function is called by <CODE>set_field_type()</CODE>.  It gets one
2658 argument, a <CODE>va_list</CODE> of the type-specific arguments passed to
2659 <CODE>set_field_type()</CODE>.  It is expected to return a pile pointer to a data
2660 structure that encapsulates those arguments.
2661 <DT> <CODE>copy_str</CODE>
2662 <DD> This function is called by form library functions that allocate new
2663 field instances.  It is expected to take a pile pointer, copy the pile
2664 to allocated storage, and return the address of the pile copy.
2665 <DT> <CODE>free_str</CODE>
2666 <DD> This function is called by field- and type-deallocation routines in the
2667 library.  It takes a pile pointer argument, and is expected to free the
2668 storage of that pile.
2669 </DL>
2670
2671 The <CODE>make_str</CODE> and <CODE>copy_str</CODE> functions may return NULL to
2672 signal allocation failure.  The library routines will that call them will
2673 return error indication when this happens.  Thus, your validation functions
2674 should never see a NULL file pointer and need not check specially for it.
2675
2676 <H3><A NAME="fcustorder">Order Functions For Custom Types</A></H3>
2677
2678 Some custom field types are simply ordered in the same well-defined way
2679 that <CODE>TYPE_ENUM</CODE> is.  For such types, it is possible to define
2680 successor and predecessor functions to support the <CODE>REQ_NEXT_CHOICE</CODE>
2681 and <CODE>REQ_PREV_CHOICE</CODE> requests. Here's how:
2682
2683 <PRE>
2684 typedef int     (*INTHOOK)();     /* pointer to function returning int */
2685
2686 int set_fieldtype_arg(FIELDTYPE *type,    /* type to alter */
2687                       INTHOOK succ,       /* get successor value */
2688                       INTHOOK pred);      /* get predecessor value */
2689 </PRE>
2690
2691 The successor and predecessor arguments will each be passed two arguments;
2692 a field pointer, and a pile pointer (as for the validation functions).  They
2693 are expected to use the function <CODE>field_buffer()</CODE> to read the
2694 current value, and <CODE>set_field_buffer()</CODE> on buffer 0 to set the next
2695 or previous value.  Either hook may return TRUE to indicate success (a
2696 legal next or previous value was set) or FALSE to indicate failure.
2697
2698 <H3><A NAME="fcustprobs">Avoiding Problems</A></H3>
2699
2700 The interface for defining custom types is complicated and tricky.
2701 Rather than attempting to create a custom type entirely from scratch,
2702 you should start by studying the library source code for whichever of
2703 the pre-defined types seems to be closest to what you want. <P>
2704
2705 Use that code as a model, and evolve it towards what you really want.
2706 You will avoid many problems and annoyances that way.  The code
2707 in the <CODE>ncurses</CODE> library has been specifically exempted from
2708 the package copyright to support this. <P>
2709
2710 If your custom type defines order functions, have do something intuitive
2711 with a blank field.  A useful convention is to make the successor of a
2712 blank field the types minimum value, and its predecessor the maximum.
2713 </BODY>
2714 </HTML>