Re: PATCH: make curses module not need wideness

[Clint Adams <clint@zsh.org>]

On Sun, Oct 14, 2007 at 09:26:46AM -0700, Bart Schaefer wrote:
> Is there any documentation for zcurses yet?  What is "zcurses -s"?

Oops. -s outputs strings to a window. Perhaps -c and -s should be
combined.

> As an aside, when I "zmodload zsh/curses" my terminal gets erased as
> if I'd invoked "zle clear-screen".  That seems a bit unfriendly.

We could delay the initscr() to the first invocation of the zcurses
builtin, but I'm not sure how much more friendly that is.

Index: Doc/Makefile.in
===================================================================
RCS file: /cvsroot/zsh/zsh/Doc/Makefile.in,v
retrieving revision 1.36
diff -u -r1.36 Makefile.in
--- Doc/Makefile.in	1 May 2007 22:05:04 -0000	1.36
+++ Doc/Makefile.in	14 Oct 2007 17:03:41 -0000
@@ -57,7 +57,7 @@
 MODDOCSRC = \
 Zsh/mod_cap.yo Zsh/mod_clone.yo \
 Zsh/mod_compctl.yo Zsh/mod_complete.yo Zsh/mod_complist.yo \
-Zsh/mod_computil.yo \
+Zsh/mod_computil.yo Zsh/mod_curses.yo \
 Zsh/mod_datetime.yo Zsh/mod_deltochar.yo \
 Zsh/mod_example.yo Zsh/mod_files.yo \
 Zsh/mod_mapfile.yo Zsh/mod_mathfunc.yo Zsh/mod_newuser.yo \
Index: Doc/Zsh/mod_curses.yo
===================================================================
RCS file: Doc/Zsh/mod_curses.yo
diff -N Doc/Zsh/mod_curses.yo
--- /dev/null	1 Jan 1970 00:00:00 -0000
+++ Doc/Zsh/mod_curses.yo	14 Oct 2007 17:03:41 -0000
@@ -0,0 +1,38 @@
+COMMENT(!MOD!zsh/curses
+curses windowing commands
+!MOD!)
+The tt(zsh/curses) module makes available one builtin command:
+
+startitem()
+findex(zcurses)
+cindex(windows, curses)
+xitem(tt(zcurses) tt(-a) var(nlines) var(ncols) var(begin_y) var(begin_x) var(targetwin) )
+xitem(tt(zcurses) tt(-d) var(targetwin) )
+xitem(tt(zcurses) tt(-r) var(targetwin) )
+xitem(tt(zcurses) tt(-m) var(targetwin) var(new_y) var(new_x) )
+xitem(tt(zcurses) tt(-c) var(targetwin) var(character) )
+xitem(tt(zcurses) tt(-s) var(targetwin) var(string) )
+item(tt(zcurses) tt(-b) var(targetwin) var(border) )(
+Manipulate curses windows.
+
+With tt(-a), create a window with var(nlines) lines and var(ncols) columns.
+Its upper left corner will be placed at row var(begin_y) and column
+var(begin_x) of the screen.  var(targetwin) must be an integer between 1
+and 9 inclusive, and refer to a window that is not currently assigned.
+
+Use tt(-d) to delete a window created with tt(-a).
+
+The tt(-r) command will refresh window var(targetwin); this is necessary to
+make any pending changes (such as characters you have prepared for output
+with tt(-c)) visible on the screen.
+
+tt(-m) moves var(targetwin) to new coordinates var(new_y) and var(new_x).
+
+Outputting characters and strings are achieved by tt(-c) and tt(-s)
+respectively.
+
+To draw a border around window var(targetwin), use tt(-b).
+)
+enditem()
+
+enditem()