1 // * This makes emacs happy -*-Mode: C++;-*-
2 /****************************************************************************
3 * Copyright (c) 1998-2004,2005 Free Software Foundation, Inc. *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
28 ****************************************************************************/
30 #ifndef NCURSES_CURSESW_H_incl
31 #define NCURSES_CURSESW_H_incl 1
33 // $Id: cursesw.h,v 1.38 2005/07/23 20:51:39 tom Exp $
40 #if HAVE_STRSTREAM_H && (USE_STRSTREAM_VSCAN||USE_STRSTREAM_VSCAN_CAST)
41 #include <strstream.h>
48 /* SCO 3.2v4 curses.h includes term.h, which defines lines as a macro.
49 Undefine it here, because NCursesWindow uses lines as a method. */
52 /* "Convert" macros to inlines. We'll define it as another symbol to avoid
53 * conflict with library symbols.
56 #define UNDEF(name) CUR_ ##name
59 inline int UNDEF(addch)(chtype ch) { return addch(ch); }
61 #define addch UNDEF(addch)
65 inline int UNDEF(echochar)(chtype ch) { return echochar(ch); }
67 #define echochar UNDEF(echochar)
71 inline int UNDEF(insdelln)(int n) { return insdelln(n); }
73 #define insdelln UNDEF(insdelln)
77 inline int UNDEF(addstr)(const char * str) { return addstr(str); }
79 #define addstr UNDEF(addstr)
83 inline int UNDEF(attron)(chtype at) { return attron(at); }
85 #define attron UNDEF(attron)
89 inline int UNDEF(attroff)(chtype at) { return attroff(at); }
91 #define attroff UNDEF(attroff)
95 inline chtype UNDEF(attrset)(chtype at) { return attrset(at); }
97 #define attrset UNDEF(attrset)
101 inline chtype UNDEF(color_set)(short p, void* opts) { return color_set(p, opts); }
103 #define color_set UNDEF(color_set)
107 inline int UNDEF(border)(chtype ls, chtype rs, chtype ts, chtype bs, chtype tl, chtype tr, chtype bl, chtype br)
108 { return border(ls, rs, ts, bs, tl, tr, bl, br); }
110 #define border UNDEF(border)
114 inline int UNDEF(box)(WINDOW *win, int v, int h) { return box(win, v, h); }
116 #define box UNDEF(box)
120 inline int UNDEF(mvwhline)(WINDOW *win, int y, int x, chtype c, int n) {
121 return mvwhline(win, y, x, c, n); }
123 #define mvwhline UNDEF(mvwhline)
127 inline int UNDEF(mvwvline)(WINDOW *win, int y, int x, chtype c, int n) {
128 return mvwvline(win, y, x, c, n); }
130 #define mvwvline UNDEF(mvwvline)
134 inline int UNDEF(clear)() { return clear(); }
136 #define clear UNDEF(clear)
140 inline int UNDEF(clearok)(WINDOW* win, bool bf) { return clearok(win, bf); }
142 #define clearok UNDEF(clearok)
144 extern "C" NCURSES_IMPEXP int NCURSES_API clearok(WINDOW*, bool);
148 inline int UNDEF(clrtobot)() { return clrtobot(); }
150 #define clrtobot UNDEF(clrtobot)
154 inline int UNDEF(clrtoeol)() { return clrtoeol(); }
156 #define clrtoeol UNDEF(clrtoeol)
160 inline int UNDEF(delch)() { return delch(); }
162 #define delch UNDEF(delch)
166 inline int UNDEF(deleteln)() { return deleteln(); }
168 #define deleteln UNDEF(deleteln)
172 inline int UNDEF(erase)() { return erase(); }
174 #define erase UNDEF(erase)
178 inline int UNDEF(flushok)(WINDOW* _win, bool _bf) {
179 return flushok(_win, _bf); }
181 #define flushok UNDEF(flushok)
187 inline int UNDEF(getch)() { return getch(); }
189 #define getch UNDEF(getch)
193 inline int UNDEF(getstr)(char *_str) { return getstr(_str); }
195 #define getstr UNDEF(getstr)
199 inline int UNDEF(instr)(char *_str) { return instr(_str); }
201 #define instr UNDEF(instr)
205 inline int UNDEF(innstr)(char *_str, int n) { return innstr(_str, n); }
207 #define innstr UNDEF(innstr)
211 inline int UNDEF(mvwinnstr)(WINDOW *win, int y, int x, char *_str, int n) {
212 return mvwinnstr(win, y, x, _str, n); }
214 #define mvwinnstr UNDEF(mvwinnstr)
218 inline int UNDEF(mvinnstr)(int y, int x, char *_str, int n) {
219 return mvinnstr(y, x, _str, n); }
221 #define mvinnstr UNDEF(mvinnstr)
225 inline int UNDEF(winsstr)(WINDOW *w, const char *_str) {
226 return winsstr(w, _str); }
228 #define winsstr UNDEF(winsstr)
232 inline int UNDEF(mvwinsstr)(WINDOW *w, int y, int x, const char *_str) {
233 return mvwinsstr(w, y, x, _str); }
235 #define mvwinsstr UNDEF(mvwinsstr)
239 inline int UNDEF(insstr)(const char *_str) {
240 return insstr(_str); }
242 #define insstr UNDEF(insstr)
246 inline int UNDEF(mvinsstr)(int y, int x, const char *_str) {
247 return mvinsstr(y, x, _str); }
249 #define mvinsstr UNDEF(mvinsstr)
253 inline int UNDEF(insnstr)(const char *_str, int n) {
254 return insnstr(_str, n); }
256 #define insnstr UNDEF(insnstr)
260 inline int UNDEF(mvwinsnstr)(WINDOW *w, int y, int x, const char *_str, int n) {
261 return mvwinsnstr(w, y, x, _str, n); }
263 #define mvwinsnstr UNDEF(mvwinsnstr)
267 inline int UNDEF(mvinsnstr)(int y, int x, const char *_str, int n) {
268 return mvinsnstr(y, x, _str, n); }
270 #define mvinsnstr UNDEF(mvinsnstr)
274 inline int UNDEF(getnstr)(char *_str, int n) { return getnstr(_str, n); }
276 #define getnstr UNDEF(getnstr)
280 inline void UNDEF(getyx)(const WINDOW* win, int& y, int& x) {
283 #define getyx UNDEF(getyx)
287 inline void UNDEF(getbegyx)(WINDOW* win, int& y, int& x) { getbegyx(win, y, x); }
289 #define getbegyx UNDEF(getbegyx)
293 inline void UNDEF(getmaxyx)(WINDOW* win, int& y, int& x) { getmaxyx(win, y, x); }
295 #define getmaxyx UNDEF(getmaxyx)
299 inline int UNDEF(hline)(chtype ch, int n) { return hline(ch, n); }
301 #define hline UNDEF(hline)
305 inline chtype UNDEF(inch)() { return inch(); }
307 #define inch UNDEF(inch)
311 inline int UNDEF(insch)(chtype c) { return insch(c); }
313 #define insch UNDEF(insch)
317 inline int UNDEF(insertln)() { return insertln(); }
319 #define insertln UNDEF(insertln)
323 inline int UNDEF(leaveok)(WINDOW* win, bool bf) { return leaveok(win, bf); }
325 #define leaveok UNDEF(leaveok)
327 extern "C" NCURSES_IMPEXP int NCURSES_API leaveok(WINDOW* win, bool bf);
331 inline int UNDEF(move)(int x, int y) { return move(x, y); }
333 #define move UNDEF(move)
337 inline int UNDEF(refresh)() { return refresh(); }
339 #define refresh UNDEF(refresh)
343 inline int UNDEF(redrawwin)(WINDOW *win) { return redrawwin(win); }
345 #define redrawwin UNDEF(redrawwin)
349 inline int UNDEF(scrl)(int l) { return scrl(l); }
351 #define scrl UNDEF(scrl)
355 inline int UNDEF(scroll)(WINDOW *win) { return scroll(win); }
357 #define scroll UNDEF(scroll)
361 inline int UNDEF(scrollok)(WINDOW* win, bool bf) { return scrollok(win, bf); }
363 #define scrollok UNDEF(scrollok)
365 #if defined(__NCURSES_H)
366 extern "C" NCURSES_IMPEXP int NCURSES_API scrollok(WINDOW*, bool);
368 extern "C" NCURSES_IMPEXP int NCURSES_API scrollok(WINDOW*, char);
373 inline int UNDEF(setscrreg)(int t, int b) { return setscrreg(t, b); }
375 #define setscrreg UNDEF(setscrreg)
379 inline int UNDEF(standend)() { return standend(); }
381 #define standend UNDEF(standend)
385 inline int UNDEF(standout)() { return standout(); }
387 #define standout UNDEF(standout)
391 inline WINDOW *UNDEF(subpad)(WINDOW *p, int l, int c, int y, int x)
392 { return derwin(p, l, c, y, x); }
394 #define subpad UNDEF(subpad)
398 inline void UNDEF(timeout)(int delay) { timeout(delay); }
400 #define timeout UNDEF(timeout)
404 inline int UNDEF(touchline)(WINDOW *win, int s, int c)
405 { return touchline(win, s, c); }
407 #define touchline UNDEF(touchline)
411 inline int UNDEF(touchwin)(WINDOW *win) { return touchwin(win); }
413 #define touchwin UNDEF(touchwin)
417 inline int UNDEF(untouchwin)(WINDOW *win) { return untouchwin(win); }
419 #define untouchwin UNDEF(untouchwin)
423 inline int UNDEF(vline)(chtype ch, int n) { return vline(ch, n); }
425 #define vline UNDEF(vline)
429 inline int UNDEF(waddstr)(WINDOW *win, char *str) { return waddstr(win, str); }
431 #define waddstr UNDEF(waddstr)
435 inline int UNDEF(waddchstr)(WINDOW *win, chtype *at) { return waddchstr(win, at); }
437 #define waddchstr UNDEF(waddchstr)
441 inline int UNDEF(wstandend)(WINDOW *win) { return wstandend(win); }
443 #define wstandend UNDEF(wstandend)
447 inline int UNDEF(wstandout)(WINDOW *win) { return wstandout(win); }
449 #define wstandout UNDEF(wstandout)
454 inline int UNDEF(wattroff)(WINDOW *win, int att) { return wattroff(win, att); }
456 #define wattroff UNDEF(wattroff)
460 inline int UNDEF(chgat)(int n, attr_t attr, short color, const void *opts) {
461 return chgat(n, attr, color, opts); }
463 #define chgat UNDEF(chgat)
467 inline int UNDEF(mvchgat)(int y, int x, int n,
468 attr_t attr, short color, const void *opts) {
469 return mvchgat(y, x, n, attr, color, opts); }
471 #define mvchgat UNDEF(mvchgat)
475 inline int UNDEF(mvwchgat)(WINDOW *win, int y, int x, int n,
476 attr_t attr, short color, const void *opts) {
477 return mvwchgat(win, y, x, n, attr, color, opts); }
479 #define mvwchgat UNDEF(mvwchgat)
483 inline int UNDEF(wattrset)(WINDOW *win, int att) { return wattrset(win, att); }
485 #define wattrset UNDEF(wattrset)
489 inline chtype UNDEF(winch)(const WINDOW* win) { return winch(win); }
491 #define winch UNDEF(winch)
495 inline int UNDEF(mvwaddch)(WINDOW *win, int y, int x, const chtype ch)
496 { return mvwaddch(win, y, x, ch); }
498 #define mvwaddch UNDEF(mvwaddch)
502 inline int UNDEF(mvwaddchnstr)(WINDOW *win, int y, int x, chtype *str, int n)
503 { return mvwaddchnstr(win, y, x, str, n); }
505 #define mvwaddchnstr UNDEF(mvwaddchnstr)
509 inline int UNDEF(mvwaddchstr)(WINDOW *win, int y, int x, chtype *str)
510 { return mvwaddchstr(win, y, x, str); }
512 #define mvwaddchstr UNDEF(mvwaddchstr)
516 inline int UNDEF(addnstr)(const char *str, int n)
517 { return addnstr(str, n); }
519 #define addnstr UNDEF(addnstr)
523 inline int UNDEF(mvwaddnstr)(WINDOW *win, int y, int x, const char *str, int n)
524 { return mvwaddnstr(win, y, x, str, n); }
526 #define mvwaddnstr UNDEF(mvwaddnstr)
530 inline int UNDEF(mvwaddstr)(WINDOW *win, int y, int x, const char * str)
531 { return mvwaddstr(win, y, x, str); }
533 #define mvwaddstr UNDEF(mvwaddstr)
537 inline int UNDEF(mvwdelch)(WINDOW *win, int y, int x)
538 { return mvwdelch(win, y, x); }
540 #define mvwdelch UNDEF(mvwdelch)
544 inline int UNDEF(mvwgetch)(WINDOW *win, int y, int x) { return mvwgetch(win, y, x);}
546 #define mvwgetch UNDEF(mvwgetch)
550 inline int UNDEF(mvwgetstr)(WINDOW *win, int y, int x, char *str)
551 {return mvwgetstr(win, y, x, str);}
553 #define mvwgetstr UNDEF(mvwgetstr)
557 inline int UNDEF(mvwgetnstr)(WINDOW *win, int y, int x, char *str, int n)
558 {return mvwgetnstr(win, y, x, str, n);}
560 #define mvwgetnstr UNDEF(mvwgetnstr)
564 inline chtype UNDEF(mvwinch)(WINDOW *win, int y, int x) {
565 return mvwinch(win, y, x);}
567 #define mvwinch UNDEF(mvwinch)
571 inline int UNDEF(mvwinsch)(WINDOW *win, int y, int x, chtype c)
572 { return mvwinsch(win, y, x, c); }
574 #define mvwinsch UNDEF(mvwinsch)
578 inline int UNDEF(mvaddch)(int y, int x, chtype ch)
579 { return mvaddch(y, x, ch); }
581 #define mvaddch UNDEF(mvaddch)
585 inline int UNDEF(mvaddnstr)(int y, int x, const char *str, int n)
586 { return mvaddnstr(y, x, str, n); }
588 #define mvaddnstr UNDEF(mvaddnstr)
592 inline int UNDEF(mvaddstr)(int y, int x, const char * str)
593 { return mvaddstr(y, x, str); }
595 #define mvaddstr UNDEF(mvaddstr)
599 inline int UNDEF(mvdelch)(int y, int x) { return mvdelch(y, x);}
601 #define mvdelch UNDEF(mvdelch)
605 inline int UNDEF(mvgetch)(int y, int x) { return mvgetch(y, x);}
607 #define mvgetch UNDEF(mvgetch)
611 inline int UNDEF(mvgetstr)(int y, int x, char *str) {return mvgetstr(y, x, str);}
613 #define mvgetstr UNDEF(mvgetstr)
617 inline int UNDEF(mvgetnstr)(int y, int x, char *str, int n) {
618 return mvgetnstr(y, x, str, n);}
620 #define mvgetnstr UNDEF(mvgetnstr)
624 inline chtype UNDEF(mvinch)(int y, int x) { return mvinch(y, x);}
626 #define mvinch UNDEF(mvinch)
630 inline int UNDEF(mvinsch)(int y, int x, chtype c)
631 { return mvinsch(y, x, c); }
633 #define mvinsch UNDEF(mvinsch)
637 inline void UNDEF(napms)(unsigned long x) { napms(x); }
639 #define napms UNDEF(napms)
643 inline int UNDEF(fixterm)(void) { return fixterm(); }
645 #define fixterm UNDEF(fixterm)
649 inline int UNDEF(resetterm)(void) { return resetterm(); }
651 #define resetterm UNDEF(resetterm)
655 inline int UNDEF(saveterm)(void) { return saveterm(); }
657 #define saveterm UNDEF(saveterm)
661 inline int UNDEF(crmode)(void) { return crmode(); }
663 #define crmode UNDEF(crmode)
667 inline int UNDEF(nocrmode)(void) { return nocrmode(); }
669 #define nocrmode UNDEF(nocrmode)
673 inline chtype UNDEF(getbkgd)(const WINDOW *win) { return getbkgd(win); }
675 #define getbkgd UNDEF(getbkgd)
679 inline int UNDEF(bkgd)(chtype ch) { return bkgd(ch); }
681 #define bkgd UNDEF(bkgd)
685 inline void UNDEF(bkgdset)(chtype ch) { bkgdset(ch); }
687 #define bkgdset UNDEF(bkgdset)
692 * C++ class for windows.
696 extern "C" int _nc_ripoffline(int, int (*init)(WINDOW*, int));
697 extern "C" int _nc_xx_ripoff_init(WINDOW *, int);
698 extern "C" int _nc_has_mouse(void);
700 class NCURSES_IMPEXP NCursesWindow
702 friend class NCursesMenu;
703 friend class NCursesForm;
706 static bool b_initialized;
707 static void initialize();
708 friend int _nc_xx_ripoff_init(WINDOW *, int);
712 short getcolor(int getback) const;
714 static int setpalette(short fore, short back, short pair);
715 static int colorInitialized;
717 // This private constructor is only used during the initialization
718 // of windows generated by ripoffline() calls.
719 NCursesWindow(WINDOW* win, int ncols);
722 virtual void err_handler(const char *) const THROWS(NCursesException);
723 // Signal an error with the given message text.
725 static long count; // count of all active windows:
726 // We rely on the c++ promise that
727 // all otherwise uninitialized
728 // static class vars are set to 0
730 WINDOW* w; // the curses WINDOW
732 bool alloced; // TRUE if we own the WINDOW
734 NCursesWindow* par; // parent, if subwindow
735 NCursesWindow* subwins; // head of subwindows list
736 NCursesWindow* sib; // next subwindow of parent
738 void kill_subwindows(); // disable all subwindows
739 // Destroy all subwindows.
741 /* Only for use by derived classes. They are then in charge to
742 fill the member variables correctly. */
746 NCursesWindow(WINDOW* &window); // useful only for stdscr
748 NCursesWindow(int nlines, // number of lines
749 int ncols, // number of columns
750 int begin_y, // line origin
751 int begin_x); // col origin
753 NCursesWindow(NCursesWindow& par,// parent window
754 int nlines, // number of lines
755 int ncols, // number of columns
756 int begin_y, // absolute or relative
757 int begin_x, // origins:
758 char absrel = 'a');// if `a', begin_y & begin_x are
759 // absolute screen pos, else if `r', they are relative to par origin
761 NCursesWindow(NCursesWindow& par,// parent window
763 // this is the very common case that we want to create the subwindow that
764 // is two lines and two columns smaller and begins at (1,1).
765 // We may automatically request the box around it.
767 NCursesWindow& operator=(const NCursesWindow& rhs)
774 NCursesWindow(const NCursesWindow& rhs)
775 : w(rhs.w), alloced(rhs.alloced), par(rhs.par), subwins(rhs.subwins), sib(rhs.sib)
779 virtual ~NCursesWindow();
781 NCursesWindow Clone();
782 // Make an exact copy of the window.
785 static void useColors(void);
786 // Call this routine very early if you want to have colors.
788 static int ripoffline(int ripoff_lines,
789 int (*init)(NCursesWindow& win));
790 // This function is used to generate a window of ripped-of lines.
791 // If the argument is positive, lines are removed from the top, if it
792 // is negative lines are removed from the bottom. This enhances the
793 // lowlevel ripoffline() function because it uses the internal
794 // implementation that allows to remove more than just a single line.
795 // This function must be called before any other ncurses function. The
796 // creation of the window is deferred until ncurses gets initialized.
797 // The initialization function is then called.
799 // -------------------------------------------------------------------------
801 // -------------------------------------------------------------------------
802 int lines() const { initialize(); return LINES; }
803 // Number of lines on terminal, *not* window
805 int cols() const { initialize(); return COLS; }
806 // Number of cols on terminal, *not* window
808 int tabsize() const { initialize(); return TABSIZE; }
809 // Size of a tab on terminal, *not* window
811 static int NumberOfColors();
812 // Number of available colors
814 int colors() const { return NumberOfColors(); }
815 // Number of available colors
817 // -------------------------------------------------------------------------
819 // -------------------------------------------------------------------------
820 int height() const { return maxy() + 1; }
821 // Number of lines in this window
823 int width() const { return maxx() + 1; }
824 // Number of columns in this window
826 int begx() const { return w->_begx; }
827 // Column of top left corner relative to stdscr
829 int begy() const { return w->_begy; }
830 // Line of top left corner relative to stdscr
832 int maxx() const { return w->_maxx; }
833 // Largest x coord in window
835 int maxy() const { return w->_maxy; }
836 // Largest y coord in window
838 short getcolor() const;
841 short foreground() const { return getcolor(0); }
842 // Actual foreground color
844 short background() const { return getcolor(1); }
845 // Actual background color
847 int setpalette(short fore, short back);
848 // Set color palette entry
850 int setcolor(short pair);
851 // Set actually used palette entry
853 // -------------------------------------------------------------------------
854 // window positioning
855 // -------------------------------------------------------------------------
856 virtual int mvwin(int begin_y, int begin_x) {
857 return ::mvwin(w, begin_y, begin_x); }
858 // Move window to new position with the new position as top left corner.
859 // This is virtual because it is redefined in NCursesPanel.
861 // -------------------------------------------------------------------------
862 // coordinate positioning
863 // -------------------------------------------------------------------------
864 int move(int y, int x) { return ::wmove(w, y, x); }
865 // Move cursor the this position
867 void getyx(int& y, int& x) const { ::getyx(w, y, x); }
868 // Get current position of the cursor
870 int mvcur(int oldrow, int oldcol, int newrow, int newcol) const {
871 return ::mvcur(oldrow, oldcol, newrow, newcol); }
872 // Perform lowlevel cursor motion that takes effect immediately.
874 // -------------------------------------------------------------------------
876 // -------------------------------------------------------------------------
877 int getch() { return ::wgetch(w); }
878 // Get a keystroke from the window.
880 int getch(int y, int x) { return ::mvwgetch(w, y, x); }
881 // Move cursor to position and get a keystroke from the window
883 int getstr(char* str, int n=-1) {
884 return ::wgetnstr(w, str, n); }
885 // Read a series of characters into str until a newline or carriage return
886 // is received. Read at most n characters. If n is negative, the limit is
889 int getstr(int y, int x, char* str, int n=-1) {
890 return ::mvwgetnstr(w, y, x, str, n); }
891 // Move the cursor to the requested position and then perform the getstr()
892 // as described above.
894 int instr(char *s, int n=-1) { return ::winnstr(w, s, n); }
895 // Get a string of characters from the window into the buffer s. Retrieve
896 // at most n characters, if n is negative retrieve all characters up to the
897 // end of the current line. Attributes are stripped from the characters.
899 int instr(int y, int x, char *s, int n=-1) {
900 return ::mvwinnstr(w, y, x, s, n); }
901 // Move the cursor to the requested position and then perform the instr()
902 // as described above.
904 int scanw(const char* fmt, ...)
905 // Perform a scanw function from the window.
907 __attribute__ ((format (scanf, 2, 3)));
912 int scanw(int y, int x, const char* fmt, ...)
913 // Move the cursor to the requested position and then perform a scanw
916 __attribute__ ((format (scanf, 4, 5)));
921 // -------------------------------------------------------------------------
923 // -------------------------------------------------------------------------
924 int addch(const chtype ch) { return ::waddch(w, ch); }
925 // Put attributed character to the window.
927 int addch(int y, int x, const chtype ch) {
928 return ::mvwaddch(w, y, x, ch); }
929 // Move cursor to the requested position and then put attributed character
932 int echochar(const chtype ch) { return ::wechochar(w, ch); }
933 // Put attributed character to the window and refresh it immediately.
935 int addstr(const char* str, int n=-1) {
936 return ::waddnstr(w, str, n); }
937 // Write the string str to the window, stop writing if the terminating
938 // NUL or the limit n is reached. If n is negative, it is ignored.
940 int addstr(int y, int x, const char * str, int n=-1) {
941 return ::mvwaddnstr(w, y, x, str, n); }
942 // Move the cursor to the requested position and then perform the addstr
943 // as described above.
945 int printw(const char* fmt, ...)
946 // Do a formatted print to the window.
947 #if (__GNUG__ >= 2) && !defined(printf)
948 __attribute__ ((format (printf, 2, 3)));
953 int printw(int y, int x, const char * fmt, ...)
954 // Move the cursor and then do a formatted print to the window.
955 #if (__GNUG__ >= 2) && !defined(printf)
956 __attribute__ ((format (printf, 4, 5)));
961 chtype inch() const { return ::winch(w); }
962 // Retrieve attributed character under the current cursor position.
964 chtype inch(int y, int x) { return ::mvwinch(w, y, x); }
965 // Move cursor to requested position and then retrieve attributed character
968 int insch(chtype ch) { return ::winsch(w, ch); }
969 // Insert attributed character into the window before current cursor
972 int insch(int y, int x, chtype ch) {
973 return ::mvwinsch(w, y, x, ch); }
974 // Move cursor to requested position and then insert the attributed
975 // character before that position.
977 int insertln() { return ::winsdelln(w, 1); }
978 // Insert an empty line above the current line.
980 int insdelln(int n=1) { return ::winsdelln(w, n); }
981 // If n>0 insert that many lines above the current line. If n<0 delete
982 // that many lines beginning with the current line.
984 int insstr(const char *s, int n=-1) {
985 return ::winsnstr(w, s, n); }
986 // Insert the string into the window before the current cursor position.
987 // Insert stops at end of string or when the limit n is reached. If n is
988 // negative, it is ignored.
990 int insstr(int y, int x, const char *s, int n=-1) {
991 return ::mvwinsnstr(w, y, x, s, n); }
992 // Move the cursor to the requested position and then perform the insstr()
993 // as described above.
995 int attron (chtype at) { return ::wattron (w, at); }
996 // Switch on the window attributes;
998 int attroff(chtype at) { return ::wattroff(w, static_cast<int>(at)); }
999 // Switch off the window attributes;
1001 int attrset(chtype at) { return ::wattrset(w, static_cast<int>(at)); }
1002 // Set the window attributes;
1004 int color_set(short color_pair_number, void* opts=NULL) {
1005 return ::wcolor_set(w, color_pair_number, opts); }
1006 // Set the window color attribute;
1008 int chgat(int n, attr_t attr, short color, const void *opts=NULL) {
1009 return ::wchgat(w, n, attr, color, opts); }
1010 // Change the attributes of the next n characters in the current line. If
1011 // n is negative or greater than the number of remaining characters in the
1012 // line, the attributes will be changed up to the end of the line.
1014 int chgat(int y, int x,
1015 int n, attr_t attr, short color, const void *opts=NULL) {
1016 return ::mvwchgat(w, y, x, n, attr, color, opts); }
1017 // Move the cursor to the requested position and then perform chgat() as
1020 // -------------------------------------------------------------------------
1022 // -------------------------------------------------------------------------
1023 chtype getbkgd() const { return ::getbkgd(w); }
1024 // Get current background setting.
1026 int bkgd(const chtype ch) { return ::wbkgd(w, ch); }
1027 // Set the background property and apply it to the window.
1029 void bkgdset(chtype ch) { ::wbkgdset(w, ch); }
1030 // Set the background property.
1032 // -------------------------------------------------------------------------
1034 // -------------------------------------------------------------------------
1035 int box(chtype vert=0, chtype hor=0) {
1036 return ::wborder(w, vert, vert, hor, hor, 0, 0, 0, 0); }
1037 // Draw a box around the window with the given vertical and horizontal
1038 // drawing characters. If you specify a zero as character, curses will try
1039 // to find a "nice" character.
1041 int border(chtype left=0, chtype right=0,
1042 chtype top =0, chtype bottom=0,
1043 chtype top_left =0, chtype top_right=0,
1044 chtype bottom_left =0, chtype bottom_right=0) {
1045 return ::wborder(w, left, right, top, bottom, top_left, top_right,
1046 bottom_left, bottom_right); }
1047 // Draw a border around the window with the given characters for the
1048 // various parts of the border. If you pass zero for a character, curses
1049 // will try to find "nice" characters.
1051 // -------------------------------------------------------------------------
1053 // -------------------------------------------------------------------------
1054 int hline(int len, chtype ch=0) { return ::whline(w, ch, len); }
1055 // Draw a horizontal line of len characters with the given character. If
1056 // you pass zero for the character, curses will try to find a "nice" one.
1058 int hline(int y, int x, int len, chtype ch=0) {
1059 return ::mvwhline(w, y, x, ch, len); }
1060 // Move the cursor to the requested position and then draw a horizontal line.
1062 int vline(int len, chtype ch=0) { return ::wvline(w, ch, len); }
1063 // Draw a vertical line of len characters with the given character. If
1064 // you pass zero for the character, curses will try to find a "nice" one.
1066 int vline(int y, int x, int len, chtype ch=0) {
1067 return ::mvwvline(w, y, x, ch, len); }
1068 // Move the cursor to the requested position and then draw a vertical line.
1070 // -------------------------------------------------------------------------
1072 // -------------------------------------------------------------------------
1073 int erase() { return ::werase(w); }
1074 // Erase the window.
1076 int clear() { return ::wclear(w); }
1077 // Clear the window.
1079 int clearok(bool bf) { return ::clearok(w, bf); }
1080 // Set/Reset the clear flag. If set, the next refresh() will clear the
1083 int clrtobot() { return ::wclrtobot(w); }
1084 // Clear to the end of the window.
1086 int clrtoeol() { return ::wclrtoeol(w); }
1087 // Clear to the end of the line.
1089 int delch() { return ::wdelch(w); }
1090 // Delete character under the cursor.
1092 int delch(int y, int x) { return ::mvwdelch(w, y, x); }
1093 // Move cursor to requested position and delete the character under the
1096 int deleteln() { return ::winsdelln(w, -1); }
1097 // Delete the current line.
1099 // -------------------------------------------------------------------------
1101 // -------------------------------------------------------------------------
1102 int scroll(int amount=1) { return ::wscrl(w, amount); }
1103 // Scroll amount lines. If amount is positive, scroll up, otherwise
1106 int scrollok(bool bf) { return ::scrollok(w, bf); }
1107 // If bf is TRUE, window scrolls if cursor is moved off the bottom
1108 // edge of the window or a scrolling region, otherwise the cursor is left
1109 // at the bottom line.
1111 int setscrreg(int from, int to) {
1112 return ::wsetscrreg(w, from, to); }
1113 // Define a soft scrolling region.
1115 int idlok(bool bf) { return ::idlok(w, bf); }
1116 // If bf is TRUE, use insert/delete line hardware support if possible.
1117 // Otherwise do it in software.
1120 void idcok(bool bf) { ::idcok(w, bf); }
1121 // If bf is TRUE, use insert/delete character hardware support if possible.
1122 // Otherwise do it in software.
1124 int touchwin() { return ::wtouchln(w, 0, height(), 1); }
1125 // Mark the whole window as modified.
1127 int untouchwin() { return ::wtouchln(w, 0, height(), 0); }
1128 // Mark the whole window as unmodified.
1130 int touchln(int s, int cnt, bool changed=TRUE) {
1131 return ::wtouchln(w, s, cnt, static_cast<int>(changed ? 1 : 0)); }
1132 // Mark cnt lines beginning from line s as changed or unchanged, depending
1133 // on the value of the changed flag.
1135 bool is_linetouched(int line) const {
1136 return (::is_linetouched(w, line) ? TRUE:FALSE); }
1137 // Return TRUE if line is marked as changed, FALSE otherwise
1139 bool is_wintouched() const {
1140 return (::is_wintouched(w) ? TRUE:FALSE); }
1141 // Return TRUE if window is marked as changed, FALSE otherwise
1143 int leaveok(bool bf) { return ::leaveok(w, bf); }
1144 // If bf is TRUE, curses will leave the cursor after an update whereever
1145 // it is after the update.
1147 int redrawln(int from, int n) { return ::wredrawln(w, from, n); }
1148 // Redraw n lines starting from the requested line
1150 int redrawwin() { return ::wredrawln(w, 0, height()); }
1151 // Redraw the whole window
1153 int doupdate() { return ::doupdate(); }
1154 // Do all outputs to make the physical screen looking like the virtual one
1156 void syncdown() { ::wsyncdown(w); }
1157 // Propagate the changes down to all descendant windows
1159 void syncup() { ::wsyncup(w); }
1160 // Propagate the changes up in the hierarchy
1162 void cursyncup() { ::wcursyncup(w); }
1163 // Position the cursor in all ancestor windows corresponding to our setting
1165 int syncok(bool bf) { return ::syncok(w, bf); }
1166 // If called with bf=TRUE, syncup() is called whenever the window is changed
1169 int flushok(bool bf) { return ::flushok(w, bf); }
1172 void immedok(bool bf) { ::immedok(w, bf); }
1173 // If called with bf=TRUE, any change in the window will cause an
1174 // automatic immediate refresh()
1176 int keypad(bool bf) { return ::keypad(w, bf); }
1177 // If called with bf=TRUE, the application will interpret function keys.
1179 int meta(bool bf) { return ::meta(w, bf); }
1180 // If called with bf=TRUE, keys may generate 8-Bit characters. Otherwise
1181 // 7-Bit characters are generated.
1183 int standout() { return ::wstandout(w); }
1184 // Enable "standout" attributes
1186 int standend() { return ::wstandend(w); }
1187 // Disable "standout" attributes
1189 // -------------------------------------------------------------------------
1190 // The next two are virtual, because we redefine them in the
1191 // NCursesPanel class.
1192 // -------------------------------------------------------------------------
1193 virtual int refresh() { return ::wrefresh(w); }
1194 // Propagate the changes in this window to the virtual screen and call
1195 // doupdate(). This is redefined in NCursesPanel.
1197 virtual int noutrefresh() { return ::wnoutrefresh(w); }
1198 // Propagate the changes in this window to the virtual screen. This is
1199 // redefined in NCursesPanel.
1201 // -------------------------------------------------------------------------
1202 // multiple window control
1203 // -------------------------------------------------------------------------
1204 int overlay(NCursesWindow& win) {
1205 return ::overlay(w, win.w); }
1206 // Overlay this window over win.
1208 int overwrite(NCursesWindow& win) {
1209 return ::overwrite(w, win.w); }
1210 // Overwrite win with this window.
1212 int copywin(NCursesWindow& win,
1213 int sminrow, int smincol,
1214 int dminrow, int dmincol,
1215 int dmaxrow, int dmaxcol, bool overlaywin=TRUE) {
1216 return ::copywin(w, win.w, sminrow, smincol, dminrow, dmincol,
1217 dmaxrow, dmaxcol, static_cast<int>(overlaywin ? 1 : 0)); }
1218 // Overlay or overwrite the rectangle in win given by dminrow,dmincol,
1219 // dmaxrow,dmaxcol with the rectangle in this window beginning at
1222 // -------------------------------------------------------------------------
1224 // -------------------------------------------------------------------------
1225 bool has_mouse() const;
1226 // Return TRUE if terminal supports a mouse, FALSE otherwise
1228 // -------------------------------------------------------------------------
1229 // traversal support
1230 // -------------------------------------------------------------------------
1231 NCursesWindow* child() { return subwins; }
1232 // Get the first child window.
1234 NCursesWindow* sibling() { return sib; }
1235 // Get the next child of my parent.
1237 NCursesWindow* parent() { return par; }
1240 bool isDescendant(NCursesWindow& win);
1241 // Return TRUE if win is a descendant of this.
1244 // -------------------------------------------------------------------------
1245 // We leave this here for compatibility reasons.
1246 // -------------------------------------------------------------------------
1247 class NCURSES_IMPEXP NCursesColorWindow : public NCursesWindow
1250 NCursesColorWindow(WINDOW* &window) // useful only for stdscr
1251 : NCursesWindow(window) {
1254 NCursesColorWindow(int nlines, // number of lines
1255 int ncols, // number of columns
1256 int begin_y, // line origin
1257 int begin_x) // col origin
1258 : NCursesWindow(nlines, ncols, begin_y, begin_x) {
1261 NCursesColorWindow(NCursesWindow& parentWin,// parent window
1262 int nlines, // number of lines
1263 int ncols, // number of columns
1264 int begin_y, // absolute or relative
1265 int begin_x, // origins:
1266 char absrel = 'a') // if `a', by & bx are
1267 : NCursesWindow(parentWin,
1268 nlines, ncols, // absolute screen pos,
1269 begin_y, begin_x, // else if `r', they are
1270 absrel ) { // relative to par origin
1274 // These enum definitions really belong inside the NCursesPad class, but only
1275 // recent compilers support that feature.
1278 REQ_PAD_REFRESH = KEY_MAX + 1,
1286 const Pad_Request PAD_LOW = REQ_PAD_REFRESH; // lowest op-code
1287 const Pad_Request PAD_HIGH = REQ_PAD_EXIT; // highest op-code
1289 // -------------------------------------------------------------------------
1290 // Pad Support. We allow an association of a pad with a "real" window
1291 // through which the pad may be viewed.
1292 // -------------------------------------------------------------------------
1293 class NCURSES_IMPEXP NCursesPad : public NCursesWindow
1296 NCursesWindow* viewWin; // the "viewport" window
1297 NCursesWindow* viewSub; // the "viewport" subwindow
1299 int h_gridsize, v_gridsize;
1302 int min_row, min_col; // top left row/col of the pads display area
1304 NCursesWindow* Win(void) const {
1305 // Get the window into which the pad should be copied (if any)
1306 return (viewSub?viewSub:(viewWin?viewWin:0));
1309 NCursesWindow* getWindow(void) const {
1313 NCursesWindow* getSubWindow(void) const {
1317 virtual int driver (int key); // Virtualize keystroke key
1318 // The driver translates the keystroke c into an Pad_Request
1320 virtual void OnUnknownOperation(int pad_req) {
1323 // This is called if the driver returns an unknown op-code
1325 virtual void OnNavigationError(int pad_req) {
1328 // This is called if a navigation request couldn't be satisfied
1330 virtual void OnOperation(int pad_req) {
1332 // OnOperation is called if a Pad_Operation was executed and just before
1333 // the refresh() operation is done.
1336 NCursesPad(int nlines, int ncols);
1337 // create a pad with the given size
1339 NCursesPad& operator=(const NCursesPad& rhs)
1343 NCursesWindow::operator=(rhs);
1348 NCursesPad(const NCursesPad& rhs)
1349 : NCursesWindow(rhs),
1350 viewWin(rhs.viewWin),
1351 viewSub(rhs.viewSub),
1352 h_gridsize(rhs.h_gridsize),
1353 v_gridsize(rhs.v_gridsize),
1354 min_row(rhs.min_row),
1355 min_col(rhs.min_col)
1359 virtual ~NCursesPad() {}
1361 int echochar(const chtype ch) { return ::pechochar(w, ch); }
1362 // Put the attributed character onto the pad and immediately do a
1366 // If a viewport is defined the pad is displayed in this window, otherwise
1369 int refresh(int pminrow, int pmincol,
1370 int sminrow, int smincol,
1371 int smaxrow, int smaxcol) {
1372 return ::prefresh(w, pminrow, pmincol,
1373 sminrow, smincol, smaxrow, smaxcol);
1375 // The coordinates sminrow,smincol,smaxrow,smaxcol describe a rectangle
1376 // on the screen. <b>refresh</b> copies a rectangle of this size beginning
1377 // with top left corner pminrow,pmincol onto the screen and calls doupdate().
1380 // If a viewport is defined the pad is displayed in this window, otherwise
1383 int noutrefresh(int pminrow, int pmincol,
1384 int sminrow, int smincol,
1385 int smaxrow, int smaxcol) {
1386 return ::pnoutrefresh(w, pminrow, pmincol,
1387 sminrow, smincol, smaxrow, smaxcol);
1389 // Does the same as refresh() but without calling doupdate().
1391 virtual void setWindow(NCursesWindow& view, int v_grid = 1, int h_grid = 1);
1392 // Add the window "view" as viewing window to the pad.
1394 virtual void setSubWindow(NCursesWindow& sub);
1395 // Use the subwindow "sub" of the viewport window for the actual viewing.
1396 // The full viewport window is usually used to provide some decorations
1397 // like frames, titles etc.
1399 virtual void operator() (void);
1400 // Perform Pad's operation
1403 // A FramedPad is constructed always with a viewport window. This viewport
1404 // will be framed (by a box() command) and the interior of the box is the
1405 // viewport subwindow. On the frame we display scrollbar sliders.
1406 class NCURSES_IMPEXP NCursesFramedPad : public NCursesPad
1409 virtual void OnOperation(int pad_req);
1412 NCursesFramedPad(NCursesWindow& win, int nlines, int ncols,
1413 int v_grid = 1, int h_grid = 1)
1414 : NCursesPad(nlines, ncols) {
1415 NCursesPad::setWindow(win, v_grid, h_grid);
1416 NCursesPad::setSubWindow(*(new NCursesWindow(win)));
1418 // Construct the FramedPad with the given Window win as viewport.
1420 virtual ~NCursesFramedPad() {
1421 delete getSubWindow();
1424 void setWindow(NCursesWindow& view, int v_grid = 1, int h_grid = 1) {
1425 err_handler("Operation not allowed");
1427 // Disable this call; the viewport is already defined
1429 void setSubWindow(NCursesWindow& sub) {
1430 err_handler("Operation not allowed");
1432 // Disable this call; the viewport subwindow is already defined
1436 #endif /* NCURSES_CURSESW_H_incl */