@@ -65,8 +64,8 @@ package.
the original BSD curses and System V curses.
in the ncurses API between platforms.
autoconf(1) as a tool to deal with portability issues.
+We use GNU autoconf(1) as a tool to deal with portability issues.
The right way to leverage an OS-specific feature is to modify the autoconf
specification files (configure.in and aclocal.m4) to set up a new feature
macro, which you then use to condition your code. -
-
The reporting address for bugs is
bug-ncurses@gnu.org.
This is a majordomo list; to join, write
-to ncurses-request@gnu.org with a message containing the line:
+to bug-ncurses-request@gnu.org with a message containing the line:
subscribe <name>@<host.domain>
@@ -210,7 +187,7 @@ The ncurses code is maintained by a small group of
volunteers. While we try our best to fix bugs promptly, we simply
don't have a lot of hours to spend on elementary hand-holding. We rely
on intelligent cooperation from our users. If you think you have
-found a bug in ncurses, there are some steps you can take
+found a bug in ncurses, there are some steps you can take
before contacting us that will help get the bug fixed quickly. In order to use our bug-fixing time efficiently, we put people who @@ -241,7 +218,7 @@ problem reproduces on other terminal types. Usually you'll have both a console type and xterm available; please tell us whether or not your bug reproduces on both.
-If you have xterm available, it is also good to collect xterm reports for +If you have xterm available, it is also good to collect xterm reports for different window sizes. This is especially true if you normally use an unusual xterm window size -- a surprising number of the bugs we've seen are either triggered or masked by these.
@@ -332,62 +309,160 @@ Most of the library is superstructure -- fairly trivial convenience
interfaces to a small set of basic functions and data structures used
to manipulate the virtual screen (in particular, none of this code
does any I/O except through calls to more fundamental modules
-described below). The files lib_addch.c,
-lib_bkgnd.c, lib_box.c, lib_clear.c,
-lib_clrbot.c, lib_clreol.c, lib_data.c,
-lib_delch.c, lib_delwin.c, lib_erase.c,
-lib_getstr.c, lib_inchstr.c, lib_insch.c,
-lib_insdel.c, lib_insstr.c, lib_instr.c,
-lib_isendwin.c, lib_keyname.c, lib_move.c,
-lib_mvwin.c, lib_overlay.c, lib_pad.c,
-lib_printw.c, lib_scanw.c, lib_screen.c,
-lib_scroll.c, lib_scrreg.c, lib_set_term.c,
-lib_slk.c, lib_touch.c, lib_unctrl.c, and
-lib_window.c are all in this category. They are very
+described below). The files
+
+
+lib_addch.c
+lib_bkgd.c
+lib_box.c
+lib_chgat.c
+lib_clear.c
+lib_clearok.c
+lib_clrbot.c
+lib_clreol.c
+lib_colorset.c
+lib_data.c
+lib_delch.c
+lib_delwin.c
+lib_echo.c
+lib_erase.c
+lib_gen.c
+lib_getstr.c
+lib_hline.c
+lib_immedok.c
+lib_inchstr.c
+lib_insch.c
+lib_insdel.c
+lib_insstr.c
+lib_instr.c
+lib_isendwin.c
+lib_keyname.c
+lib_leaveok.c
+lib_move.c
+lib_mvwin.c
+lib_overlay.c
+lib_pad.c
+lib_printw.c
+lib_redrawln.c
+lib_scanw.c
+lib_screen.c
+lib_scroll.c
+lib_scrollok.c
+lib_scrreg.c
+lib_set_term.c
+lib_slk.c
+lib_slkatr_set.c
+lib_slkatrof.c
+lib_slkatron.c
+lib_slkatrset.c
+lib_slkattr.c
+lib_slkclear.c
+lib_slkcolor.c
+lib_slkinit.c
+lib_slklab.c
+lib_slkrefr.c
+lib_slkset.c
+lib_slktouch.c
+lib_touch.c
+lib_unctrl.c
+lib_vline.c
+lib_wattroff.c
+lib_wattron.c
+lib_window.c
+
+
+are all in this category. They are very
unlikely to need change, barring bugs or some fundamental
reorganization in the underlying data structures.
-The lib_trace.c, lib_traceatr.c, and
-lib_tracechr.c file are used only for debugging support.
+These files are used only for debugging support:
+
+lib_trace.c
+lib_traceatr.c
+lib_tracebits.c
+lib_tracechr.c
+lib_tracedmp.c
+lib_tracemse.c
+trace_buf.c
+
There is another group of files that do direct I/O via tputs(),
computations on the terminal capabilities, or queries to the OS
environment, but nevertheless have only fairly low complexity. These
-include: lib_acs.c, lib_beep.c,
-lib_color.c, lib_endwin.c, lib_initscr.c,
-lib_longname.c, lib_newterm.c,
-lib_options.c, lib_termcap.c, lib_ti.c,
-lib_tparm.c, lib_tputs.c, lib_vidattr.c,
-and read_entry.c. These are likely to need revision only if
+include:
+
+lib_acs.c
+lib_beep.c
+lib_color.c
+lib_endwin.c
+lib_initscr.c
+lib_longname.c
+lib_newterm.c
+lib_options.c
+lib_termcap.c
+lib_ti.c
+lib_tparm.c
+lib_tputs.c
+lib_vidattr.c
+read_entry.c.
+
-The files lib_kernel.c, lib_baudrate.c, lib_raw.c,
-lib_tstp.c, and lib_twait.c have serious hooks into
-the tty driver and signal facilities. If you run into porting snafus
+These files
+have serious hooks into
+the tty driver and signal facilities:
+
+lib_kernel.c
+lib_baudrate.c
+lib_raw.c
+lib_tstp.c
+lib_twait.c
+lib_print.c uses sleep(2) and also
+of these files.
+The file lib_print.c uses sleep(2) and also
falls in this category.
-Almost all of the real work is done in the files
-hashmap.c, hardscroll.c,
-lib_addch.c, lib_doupdate.c, lib_mvcur.c,
-lib_getch.c, lib_mouse.c, lib_refresh.c,
-and lib_setup.c. Most of the algorithmic complexity in the
-library lives in these files. If there is a real bug in ncurses
-itself, it's probably here. We'll tour some of these files in detail
+Almost all of the real work is done in the files
+
+hardscroll.c
+hashmap.c
+lib_addch.c
+lib_doupdate.c
+lib_getch.c
+lib_mouse.c
+lib_mvcur.c
+lib_refresh.c
+lib_setup.c
+lib_vidattr.c
+
Finally, there is a group of files that is actually most of the
terminfo compiler. The reason this code lives in the ncurses
library is to support fallback to /etc/termcap. These files include
-alloc_entry.c, captoinfo.c, comp_captab.c,
-comp_error.c, comp_hash.c, comp_parse.c,
-comp_scan.c, and parse_entry.c,
-read_termcap.c, and write_entry.c. We'll discuss these
-in the compiler tour.
+
+alloc_entry.c
+captoinfo.c
+comp_captab.c
+comp_error.c
+comp_hash.c
+comp_parse.c
+comp_scan.c
+parse_entry.c
+read_termcap.c
+write_entry.c
+
wgetnstr()
-call (which simulates cooked-mode line editing in an ncurses window),
+call (which simulates cooked-mode line editing in an ncurses window),
the library normally does all its output at refresh time.
The main job is to go from the current state of the screen (as represented
-in the curscr window structure) to the desired new state (as
+in the curscr window structure) to the desired new state (as
represented in the newscr window structure), while doing as
little I/O as possible.
@@ -483,7 +558,7 @@ insertion, and deletion operations to make the indices match. It calls
Then lib_doupdate.c goes to work. Its job is to do line-by-line
transformations of curscr lines to newscr lines. Its main
tool is the routine mvcur() in lib_mvcur.c. This routine
-does cursor-movement optimization, attempting to get from given screen
+does cursor-movement optimization, attempting to get from given screen
location A to given location B in the fewest output characters posible.
If you want to work on screen optimizations, you should use the fact @@ -538,8 +613,8 @@ and controls interpretation of the value.
One possibly interesting aspect of the implementation is the way the
compiler tables are initialized. All the tables are generated by various
-awk/sed/sh scripts from a master table include/Caps; these
-scripts actually write C initializers which are linked to the compiler.
+awk/sed/sh scripts from a master table include/Caps; these
+scripts actually write C initializers which are linked to the compiler.
Furthermore, the hash table is generated in the same way, so it doesn't
have to be generated at compiler startup time (another benefit of this
organization is that the hash table can be in shareable text space).
@@ -553,7 +628,7 @@ Translation.
The background problem that makes tic tricky isn't the capability translation itself, it's the resolution of use capabilities. Older -versions would not handle forward use references for this reason +versions would not handle forward use references for this reason (that is, a using terminal always had to follow its use target in the source file). By doing this, they got away with a simple implementation tactic; compile everything as it blows by, then resolve uses from compiled @@ -564,7 +639,7 @@ compilation process has to be embeddable in the ncurses library so that it can be called by the startup code to translate termcap entries on the fly. The embedded version can't go promiscuously writing everything it translates out to disk -- for one thing, it will typically -be running with non-root permissions.
+be running with non-root permissions.
So our tic is designed to parse an entire terminfo file into a doubly-linked circular list of entry structures in-core, and then do @@ -614,7 +689,7 @@ format.
The include/Caps file has a header comment describing ways you
can specify source translations for nonstandard capabilities just by
-altering the master table. It's possible to set up capability aliasing
+altering the master table. It's possible to set up capability aliasing
or tell the compiler to plain ignore a given capability without writing
any C code at all.
@@ -633,7 +708,7 @@ function passed in to dump_entry() to control which
capabilities are dumped. This is necessary in order to handle both
the ordinary De-compilation case and entry difference reporting.
-The tput and clear utilities just do an entry load
+The tput and clear utilities just do an entry load
followed by a tputs() of a selected capability.
-
+
lib_addch.c
lib_addstr.c
lib_bkgd.c
@@ -710,28 +785,28 @@ lib_tparm.c
lib_tputs.c
lib_unctrl.c
lib_window.c
-panel.c
-
+panel.c
+
This module is pure curses, but calls outstr():
-
+
lib_getstr.c
-
+
These modules are pure curses, except that they use tputs()
and putp():
-
+
lib_beep.c
-lib_endwin.c
lib_color.c
+lib_endwin.c
lib_options.c
lib_slk.c
lib_vidattr.c
-
+
This modules assist in POSIX emulation on non-POSIX systems:
@@ -743,7 +818,8 @@ This modules assist in POSIX emulation on non-POSIX systems:
The following source files will not be needed for a single-terminal-type port.
-
+
+alloc_entry.c
captoinfo.c
clear.c
comp_captab.c
@@ -752,24 +828,23 @@ comp_hash.c
comp_main.c
comp_parse.c
comp_scan.c
-alloc_entry.c
dump_entry.c
+infocmp.c
parse_entry.c
read_entry.c
-write_entry.c
-infocmp.c
tput.c
-
+write_entry.c
+
The following modules will use open()/read()/write()/close()/lseek() on files, but no other OS calls.
@@ -777,76 +852,29 @@ Modules that would have to be modified for a port start here:
The following modules are `pure curses' but contain assumptions inappropriate for a memory-mapped port.
-
-lib_longname.c -- assumes there may be multiple terminals - longname() -- return long name of terminal -lib_acs.c -- assumes acs_map as a double indirection - init_acs() -- initialize acs map -lib_mvcur.c -- assumes cursor moves have variable cost - mvcur_init() -- initialize - mvcur() -- do physical cursor move - mvcur_wrap() -- wrap - scrolln() -- do physical scrolling -lib_termcap.c -- assumes there may be multiple terminals - tgetent() -- load entry - tgetflag() -- get boolean capability - tgetnum() -- get numeric capability - tgetstr() -- get string capability -lib_ti.c -- assumes there may be multiple terminals - tigetent() -- load entry - tigetflag() -- get boolean capability - tigetnum() -- get numeric capability - tigetstr() -- get string capability +
+