a689447b723c2322355ab03c4a3ce11a949dad83
[ncurses.git] / TO-DO
1 -- $Id: TO-DO,v 1.43 2004/02/08 21:09:00 tom Exp $
2
3 SHORT-TERM TO-DO ITEMS:
4
5 Known Problems:
6
7 * The form/menu libraries do not use wide-character features.
8
9 * Some users would like to build a single version of libtinfo which can be
10   used from either libncursesw or libncurses.
11
12 * libtool does not work with GNAT.
13
14 * The screen optimization has been tested only in an ad hoc manner.  We should
15   develop a good set of regression tests to cover lib_doupdate.c and
16   lib_mvcur.c.
17
18 * Magic cookie support does not work, since the logic does not take into account
19   refresh.  Also, the initial optimize does not adjust the current location
20   when a cookie is emitted.
21
22 * Scrolling optimization has holes: for example, it forces repaints of the
23   screen between calls to refresh().
24
25 * SVr4 uses slightly different rules for determining when softkeys are shown.
26   For example, they are initially displayed (before the ncurses 'e' test
27   activates them), and a touchwin can apparently also force them to be
28   displayed.
29
30 * The code departs from perfect 8-bit cleanness in one respect; you cannot
31   specify a character \200 as part of a capability string, because the terminfo
32   library interprets \200 as a request to embed NUL (\000) at that point.  This
33   is a legacy terminfo property we can't mess with.
34
35 * The window classes defined in the c++ subdirectory need documentation.
36   Some C++ programmer could earn a lot of good karma by doing this...
37
38 * The resizeterm() function does not handle ripped-off lines such as that
39   done for the slk_XXX functions.
40
41 Portability (or lack thereof):
42
43 * Users of older System V UNIXes (but not Solaris, and probably not SVr4)
44   may trip over a known problem with the signal-handling code which causes
45   abrupt termination of ncurses applications following resume from a ^Z
46   suspend (this problem was first seen running lynx).  You will not see 
47   this problem if you are running Linux or one of the 4.4BSD derivatives
48   like FreeBSD, NetBSD, or BSDI.  For details, see the analysis in the
49   header comment of ncurses/tty/lib_tstp.c .
50
51 * In theory, vwprintw and vwscanf are supposed to use the older varargs.h
52   interface for handling variadic argument lists.  Linux doesn't have
53   varargs.h, it has the newer X/Open-standard stdargs.h equivalent. So
54   these functions use stdargs instead.  This is unlikely to be a problem 
55   unless you're building ncurses on a System V old enough to only have
56   varargs.h.  (Solaris 2.5.1 uses the stdarg.h binding as well).
57
58 * If you're using a BSD earlier than 4.4BSD, or a Linux old enough not to
59   have a native vsscanf(3) in its library, vwscanw() will not work.  You lose.
60   (It should work on any System V, however).  If you want to fix this, add
61   an implementation to ncurses/vsscanf.c.
62
63 * The C++ binding fails to build with a few C++ compilers, mainly with
64   configure script problems with vsscanf().
65
66 * terminfo.5 does not format with the SunOS (and most other platform's) tbl
67   utility because it relies on a diversion for each table entry.  Get the groff
68   package.
69
70 Untested features:
71
72 * The code for the HP color model using set_color_pair is untested.
73
74 * The code for handling soft labels on a terminal type with built-in support
75   for them (num_labels > 0, label_height, label_width, label_format, label_off,
76   label_on, plab_norm, lab_f*) has not been tested.  The label_format and
77   lab_f* capabilities aren't presently used.
78
79 LONGER-TERM TO-DO ITEMS:
80
81 1. Extended COSE conformance
82
83 There is an XPG4 standard recently released which describes a superset
84 of the SVr4 API.  The library is BASE conformant with this standard.
85 We would like to make ncurses fully conformant at the EXTENDED level
86 supporting internationalization.
87
88 2. DOS port
89
90 Only 16 of the 55 files in the library depend on the terminfo format.
91 It should be possible to further kernelize the package, then rewrite 
92 a small number of core files to produce a functionally-compatible
93 port that would do updates to a memory-mapped screen area.  The first
94 result of this would be a DOS port.
95
96 3. X port
97
98 It would be nice if ncurses could recognize when it was running under X and
99 maintain its own window.  With this feature, all ncurses programs would
100 automatically become X programs.  The challenge is to handle resize events
101 properly.
102
103 4. Unused capabilities
104
105 The currently unused capabilities fall naturally into several groups:
106
107 A. Status-line capabilities:
108
109         Booleans: has_status_line, status_line_esc_ok.
110         Numerics: width_status_line.
111         Strings: dis_status_line, from_status_line, to_status_line.
112
113 System V Release 1 curses made no use of these at all.  SVr4's use, if
114 any, is unknown.  From the AT&T termcap file it looks like curses, in general,
115 shouldn't use them; terminal variants with status lines have their line count
116 decremented by 1, suggesting that curses is supposed to leave the status line
117 alone.
118
119 B. Printer capabilities:
120
121         Boolean: col_addr_glitch, cr_cancels_micro_mode, has_print_wheel,
122                 row_addr_glitch, semi_auto_right_margin, cpi_changes_res,
123                 lpi_changes_res.
124         Numeric: buffer_capacity, dot_horz_spacing, dot_vert_spacing,
125                 max_micro_address, max_micro_jump, micro_col_size,
126                 micro_line_size, number_of_pins, output_res_char,
127                 output_res_line, output_res_horz_inch, print_rate,
128                 wide_char_size, bit_image_entwining, bit_image_type.
129         String: down_half_line, form_feed, up_half_line, set_left_margin,
130                 set_right_margin, clear_margins, change_char_pitch
131                 ... set_page_length (all the SVr4 printer caps),
132
133 Curses doesn't use these.
134
135 C. Printer-control capabilities:
136
137         Boolean: prtr_silent.
138         Strings: print_screen, prtr_on, prtr_off, prtr_non.
139
140 Curses doesn't use these.
141
142 D. Dialer strings:
143
144         Strings: hangup, dial_phone, quick_dial, tone, pulse, flash_hook,
145                 fixed_pause, wait_tone.
146
147 Curses doesn't use these.
148
149 E. Window and virtual-terminal capabilities:
150
151         Numerics: maximum_windows, virtual_terminal.
152         Strings: req_for_input, create_window, goto_window, set_window.
153
154 These seem to be fossils from some AT&T experiments on character-based
155 window systems that never escaped the lab.  The virtual_terminal cap had
156 something to do with building terminal emulations into tty line disciplines.
157
158 F. Unused VDT capabilities:
159
160         Booleans: erase_overstrike, has_meta_key, insert_null_glitch,
161                 move_insert, dest_tabs_magic_smso, transparent_underline,
162                 needs_xon_xoff, hard_cursor.
163         Numerics: lines_of_memory, buttons.
164         Strings: pkey_key, pkey_local, pkey_xmit, underline_char, 
165                 enter_xon_mode, exit_xon_mode, xon_character, xoff_character, 
166                 display_clock, remove_clock, user[0-5], display_pc_char,
167                 enter_scancode_mode, exit_scancode_mode, pc_term_options, 
168                 scancode_escape, alt_scancode_esc.
169
170 These are the potentially important ones for ncurses.  Notes:
171
172         i) ncurses doesn't need move_insert; it never uses cup/hpa/vpa while
173                 insert_mode is on.
174
175         ii) We probably don't care about dest_tabs_magic_smso; only
176                 Telerays used it and they're all long obsolete.