1 // * This makes emacs happy -*-Mode: C++;-*-
2 /****************************************************************************
3 * Copyright (c) 1998-2001,2004 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.30 2004/02/08 00:11:54 tom Exp $
39 #if HAVE_STRSTREAM_H && (USE_STRSTREAM_VSCAN||USE_STRSTREAM_VSCAN_CAST)
40 #include <strstream.h>
47 /* SCO 3.2v4 curses.h includes term.h, which defines lines as a macro.
48 Undefine it here, because NCursesWindow uses lines as a method. */
51 /* "Convert" macros to inlines. We'll define it as another symbol to avoid
52 * conflict with library symbols.
55 #define UNDEF(name) CUR_ ##name
58 inline int UNDEF(addch)(chtype ch) { return addch(ch); }
60 #define addch UNDEF(addch)
64 inline int UNDEF(echochar)(chtype ch) { return echochar(ch); }
66 #define echochar UNDEF(echochar)
70 inline int UNDEF(insdelln)(int n) { return insdelln(n); }
72 #define insdelln UNDEF(insdelln)
76 inline int UNDEF(addstr)(const char * str) { return addstr(str); }
78 #define addstr UNDEF(addstr)
82 inline int UNDEF(attron)(chtype at) { return attron(at); }
84 #define attron UNDEF(attron)
88 inline int UNDEF(attroff)(chtype at) { return attroff(at); }
90 #define attroff UNDEF(attroff)
94 inline chtype UNDEF(attrset)(chtype at) { return attrset(at); }
96 #define attrset UNDEF(attrset)
100 inline chtype UNDEF(color_set)(short p, void* opts) { return color_set(p, opts); }
102 #define color_set UNDEF(color_set)
106 inline int UNDEF(border)(chtype ls, chtype rs, chtype ts, chtype bs, chtype tl, chtype tr, chtype bl, chtype br)
107 { return border(ls, rs, ts, bs, tl, tr, bl, br); }
109 #define border UNDEF(border)
113 inline int UNDEF(box)(WINDOW *win, int v, int h) { return box(win, v, h); }
115 #define box UNDEF(box)
119 inline int UNDEF(mvwhline)(WINDOW *win, int y, int x, chtype c, int n) {
120 return mvwhline(win, y, x, c, n); }
122 #define mvwhline UNDEF(mvwhline)
126 inline int UNDEF(mvwvline)(WINDOW *win, int y, int x, chtype c, int n) {
127 return mvwvline(win, y, x, c, n); }
129 #define mvwvline UNDEF(mvwvline)
133 inline int UNDEF(clear)() { return clear(); }
135 #define clear UNDEF(clear)
139 inline int UNDEF(clearok)(WINDOW* win, bool bf) { return clearok(win, bf); }
141 #define clearok UNDEF(clearok)
143 extern "C" NCURSES_IMPEXP int NCURSES_API clearok(WINDOW*, bool);
147 inline int UNDEF(clrtobot)() { return clrtobot(); }
149 #define clrtobot UNDEF(clrtobot)
153 inline int UNDEF(clrtoeol)() { return clrtoeol(); }
155 #define clrtoeol UNDEF(clrtoeol)
159 inline int UNDEF(delch)() { return delch(); }
161 #define delch UNDEF(delch)
165 inline int UNDEF(deleteln)() { return deleteln(); }
167 #define deleteln UNDEF(deleteln)
171 inline int UNDEF(erase)() { return erase(); }
173 #define erase UNDEF(erase)
177 inline int UNDEF(flushok)(WINDOW* _win, bool _bf) {
178 return flushok(_win, _bf); }
180 #define flushok UNDEF(flushok)
186 inline int UNDEF(getch)() { return getch(); }
188 #define getch UNDEF(getch)
192 inline int UNDEF(getstr)(char *_str) { return getstr(_str); }
194 #define getstr UNDEF(getstr)
198 inline int UNDEF(instr)(char *_str) { return instr(_str); }
200 #define instr UNDEF(instr)
204 inline int UNDEF(innstr)(char *_str, int n) { return innstr(_str, n); }
206 #define innstr UNDEF(innstr)
210 inline int UNDEF(mvwinnstr)(WINDOW *win, int y, int x, char *_str, int n) {
211 return mvwinnstr(win, y, x, _str, n); }
213 #define mvwinnstr UNDEF(mvwinnstr)
217 inline int UNDEF(mvinnstr)(int y, int x, char *_str, int n) {
218 return mvinnstr(y, x, _str, n); }
220 #define mvinnstr UNDEF(mvinnstr)
224 inline int UNDEF(winsstr)(WINDOW *w, const char *_str) {
225 return winsstr(w, _str); }
227 #define winsstr UNDEF(winsstr)
231 inline int UNDEF(mvwinsstr)(WINDOW *w, int y, int x, const char *_str) {
232 return mvwinsstr(w, y, x, _str); }
234 #define mvwinsstr UNDEF(mvwinsstr)
238 inline int UNDEF(insstr)(const char *_str) {
239 return insstr(_str); }
241 #define insstr UNDEF(insstr)
245 inline int UNDEF(mvinsstr)(int y, int x, const char *_str) {
246 return mvinsstr(y, x, _str); }
248 #define mvinsstr UNDEF(mvinsstr)
252 inline int UNDEF(insnstr)(const char *_str, int n) {
253 return insnstr(_str, n); }
255 #define insnstr UNDEF(insnstr)
259 inline int UNDEF(mvwinsnstr)(WINDOW *w, int y, int x, const char *_str, int n) {
260 return mvwinsnstr(w, y, x, _str, n); }
262 #define mvwinsnstr UNDEF(mvwinsnstr)
266 inline int UNDEF(mvinsnstr)(int y, int x, const char *_str, int n) {
267 return mvinsnstr(y, x, _str, n); }
269 #define mvinsnstr UNDEF(mvinsnstr)
273 inline int UNDEF(getnstr)(char *_str, int n) { return getnstr(_str, n); }
275 #define getnstr UNDEF(getnstr)
279 inline void UNDEF(getyx)(const WINDOW* win, int& y, int& x) {
282 #define getyx UNDEF(getyx)
286 inline void UNDEF(getbegyx)(WINDOW* win, int& y, int& x) { getbegyx(win, y, x); }
288 #define getbegyx UNDEF(getbegyx)
292 inline void UNDEF(getmaxyx)(WINDOW* win, int& y, int& x) { getmaxyx(win, y, x); }
294 #define getmaxyx UNDEF(getmaxyx)
298 inline int UNDEF(hline)(chtype ch, int n) { return hline(ch, n); }
300 #define hline UNDEF(hline)
304 inline chtype UNDEF(inch)() { return inch(); }
306 #define inch UNDEF(inch)
310 inline int UNDEF(insch)(char c) { return insch(c); }
312 #define insch UNDEF(insch)
316 inline int UNDEF(insertln)() { return insertln(); }
318 #define insertln UNDEF(insertln)
322 inline int UNDEF(leaveok)(WINDOW* win, bool bf) { return leaveok(win, bf); }
324 #define leaveok UNDEF(leaveok)
326 extern "C" NCURSES_IMPEXP int NCURSES_API leaveok(WINDOW* win, bool bf);
330 inline int UNDEF(move)(int x, int y) { return move(x, y); }
332 #define move UNDEF(move)
336 inline int UNDEF(refresh)() { return refresh(); }
338 #define refresh UNDEF(refresh)
342 inline int UNDEF(redrawwin)(WINDOW *win) { return redrawwin(win); }
344 #define redrawwin UNDEF(redrawwin)
348 inline int UNDEF(scrl)(int l) { return scrl(l); }
350 #define scrl UNDEF(scrl)
354 inline int UNDEF(scroll)(WINDOW *win) { return scroll(win); }
356 #define scroll UNDEF(scroll)
360 inline int UNDEF(scrollok)(WINDOW* win, bool bf) { return scrollok(win, bf); }
362 #define scrollok UNDEF(scrollok)
364 #if defined(__NCURSES_H)
365 extern "C" NCURSES_IMPEXP int NCURSES_API scrollok(WINDOW*, bool);
367 extern "C" NCURSES_IMPEXP int NCURSES_API scrollok(WINDOW*, char);
372 inline int UNDEF(setscrreg)(int t, int b) { return setscrreg(t, b); }
374 #define setscrreg UNDEF(setscrreg)
378 inline int UNDEF(standend)() { return standend(); }
380 #define standend UNDEF(standend)
384 inline int UNDEF(standout)() { return standout(); }
386 #define standout UNDEF(standout)
390 inline WINDOW *UNDEF(subpad)(WINDOW *p, int l, int c, int y, int x)
391 { return derwin(p, l, c, y, x); }
393 #define subpad UNDEF(subpad)
397 inline void UNDEF(timeout)(int delay) { timeout(delay); }
399 #define timeout UNDEF(timeout)
403 inline int UNDEF(touchline)(WINDOW *win, int s, int c)
404 { return touchline(win, s, c); }
406 #define touchline UNDEF(touchline)
410 inline int UNDEF(touchwin)(WINDOW *win) { return touchwin(win); }
412 #define touchwin UNDEF(touchwin)
416 inline int UNDEF(untouchwin)(WINDOW *win) { return untouchwin(win); }
418 #define untouchwin UNDEF(untouchwin)
422 inline int UNDEF(vline)(chtype ch, int n) { return vline(ch, n); }
424 #define vline UNDEF(vline)
428 inline int UNDEF(waddstr)(WINDOW *win, char *str) { return waddstr(win, str); }
430 #define waddstr UNDEF(waddstr)
434 inline int UNDEF(waddchstr)(WINDOW *win, chtype *at) { return waddchstr(win, at); }
436 #define waddchstr UNDEF(waddchstr)
440 inline int UNDEF(wstandend)(WINDOW *win) { return wstandend(win); }
442 #define wstandend UNDEF(wstandend)
446 inline int UNDEF(wstandout)(WINDOW *win) { return wstandout(win); }
448 #define wstandout UNDEF(wstandout)
453 inline int UNDEF(wattroff)(WINDOW *win, int att) { return wattroff(win, att); }
455 #define wattroff UNDEF(wattroff)
459 inline int UNDEF(chgat)(int n, attr_t attr, short color, const void *opts) {
460 return chgat(n, attr, color, opts); }
462 #define chgat UNDEF(chgat)
466 inline int UNDEF(mvchgat)(int y, int x, int n,
467 attr_t attr, short color, const void *opts) {
468 return mvchgat(y, x, n, attr, color, opts); }
470 #define mvchgat UNDEF(mvchgat)
474 inline int UNDEF(mvwchgat)(WINDOW *win, int y, int x, int n,
475 attr_t attr, short color, const void *opts) {
476 return mvwchgat(win, y, x, n, attr, color, opts); }
478 #define mvwchgat UNDEF(mvwchgat)
482 inline int UNDEF(wattrset)(WINDOW *win, int att) { return wattrset(win, att); }
484 #define wattrset UNDEF(wattrset)
488 inline chtype UNDEF(winch)(const WINDOW* win) { return winch(win); }
490 #define winch UNDEF(winch)
494 inline int UNDEF(mvwaddch)(WINDOW *win, int y, int x, const chtype ch)
495 { return mvwaddch(win, y, x, ch); }
497 #define mvwaddch UNDEF(mvwaddch)
501 inline int UNDEF(mvwaddchnstr)(WINDOW *win, int y, int x, chtype *str, int n)
502 { return mvwaddchnstr(win, y, x, str, n); }
504 #define mvwaddchnstr UNDEF(mvwaddchnstr)
508 inline int UNDEF(mvwaddchstr)(WINDOW *win, int y, int x, chtype *str)
509 { return mvwaddchstr(win, y, x, str); }
511 #define mvwaddchstr UNDEF(mvwaddchstr)
515 inline int UNDEF(addnstr)(const char *str, int n)
516 { return addnstr(str, n); }
518 #define addnstr UNDEF(addnstr)
522 inline int UNDEF(mvwaddnstr)(WINDOW *win, int y, int x, const char *str, int n)
523 { return mvwaddnstr(win, y, x, str, n); }
525 #define mvwaddnstr UNDEF(mvwaddnstr)
529 inline int UNDEF(mvwaddstr)(WINDOW *win, int y, int x, const char * str)
530 { return mvwaddstr(win, y, x, str); }
532 #define mvwaddstr UNDEF(mvwaddstr)
536 inline int UNDEF(mvwdelch)(WINDOW *win, int y, int x)
537 { return mvwdelch(win, y, x); }
539 #define mvwdelch UNDEF(mvwdelch)
543 inline int UNDEF(mvwgetch)(WINDOW *win, int y, int x) { return mvwgetch(win, y, x);}
545 #define mvwgetch UNDEF(mvwgetch)
549 inline int UNDEF(mvwgetstr)(WINDOW *win, int y, int x, char *str)
550 {return mvwgetstr(win, y, x, str);}
552 #define mvwgetstr UNDEF(mvwgetstr)
556 inline int UNDEF(mvwgetnstr)(WINDOW *win, int y, int x, char *str, int n)
557 {return mvwgetnstr(win, y, x, str, n);}
559 #define mvwgetnstr UNDEF(mvwgetnstr)
563 inline chtype UNDEF(mvwinch)(WINDOW *win, int y, int x) {
564 return mvwinch(win, y, x);}
566 #define mvwinch UNDEF(mvwinch)
570 inline int UNDEF(mvwinsch)(WINDOW *win, int y, int x, char c)
571 { return mvwinsch(win, y, x, c); }
573 #define mvwinsch UNDEF(mvwinsch)
577 inline int UNDEF(mvaddch)(int y, int x, chtype ch)
578 { return mvaddch(y, x, ch); }
580 #define mvaddch UNDEF(mvaddch)
584 inline int UNDEF(mvaddnstr)(int y, int x, const char *str, int n)
585 { return mvaddnstr(y, x, str, n); }
587 #define mvaddnstr UNDEF(mvaddnstr)
591 inline int UNDEF(mvaddstr)(int y, int x, const char * str)
592 { return mvaddstr(y, x, str); }
594 #define mvaddstr UNDEF(mvaddstr)
598 inline int UNDEF(mvdelch)(int y, int x) { return mvdelch(y, x);}
600 #define mvdelch UNDEF(mvdelch)
604 inline int UNDEF(mvgetch)(int y, int x) { return mvgetch(y, x);}
606 #define mvgetch UNDEF(mvgetch)
610 inline int UNDEF(mvgetstr)(int y, int x, char *str) {return mvgetstr(y, x, str);}
612 #define mvgetstr UNDEF(mvgetstr)
616 inline int UNDEF(mvgetnstr)(int y, int x, char *str, int n) {
617 return mvgetnstr(y, x, str, n);}
619 #define mvgetnstr UNDEF(mvgetnstr)
623 inline chtype UNDEF(mvinch)(int y, int x) { return mvinch(y, x);}
625 #define mvinch UNDEF(mvinch)
629 inline int UNDEF(mvinsch)(int y, int x, char c)
630 { return mvinsch(y, x, c); }
632 #define mvinsch UNDEF(mvinsch)
636 inline void UNDEF(napms)(unsigned long x) { napms(x); }
638 #define napms UNDEF(napms)
642 inline int UNDEF(fixterm)(void) { return fixterm(); }
644 #define fixterm UNDEF(fixterm)
648 inline int UNDEF(resetterm)(void) { return resetterm(); }
650 #define resetterm UNDEF(resetterm)
654 inline int UNDEF(saveterm)(void) { return saveterm(); }
656 #define saveterm UNDEF(saveterm)
660 inline int UNDEF(crmode)(void) { return crmode(); }
662 #define crmode UNDEF(crmode)
666 inline int UNDEF(nocrmode)(void) { return nocrmode(); }
668 #define nocrmode UNDEF(nocrmode)
672 inline chtype UNDEF(getbkgd)(const WINDOW *win) { return getbkgd(win); }
674 #define getbkgd UNDEF(getbkgd)
678 inline int UNDEF(bkgd)(chtype ch) { return bkgd(ch); }
680 #define bkgd UNDEF(bkgd)
684 inline void UNDEF(bkgdset)(chtype ch) { bkgdset(ch); }
686 #define bkgdset UNDEF(bkgdset)
691 * C++ class for windows.
696 class NCURSES_IMPEXP NCursesWindow
698 friend class NCursesMenu;
699 friend class NCursesForm;
702 static bool b_initialized;
703 static void initialize();
704 static int ripoff_init(WINDOW *, int);
708 short getcolor(int getback) const;
710 static int setpalette(short fore, short back, short pair);
711 static int colorInitialized;
713 // This private constructor is only used during the initialization
714 // of windows generated by ripoffline() calls.
715 NCursesWindow(WINDOW* win, int cols);
718 void err_handler(const char *) const THROWS(NCursesException);
719 // Signal an error with the given message text.
721 static long count; // count of all active windows:
722 // We rely on the c++ promise that
723 // all otherwise uninitialized
724 // static class vars are set to 0
726 WINDOW* w; // the curses WINDOW
728 bool alloced; // TRUE if we own the WINDOW
730 NCursesWindow* par; // parent, if subwindow
731 NCursesWindow* subwins; // head of subwindows list
732 NCursesWindow* sib; // next subwindow of parent
734 void kill_subwindows(); // disable all subwindows
735 // Destroy all subwindows.
737 /* Only for use by derived classes. They are then in charge to
738 fill the member variables correctly. */
742 NCursesWindow(WINDOW* &window); // useful only for stdscr
744 NCursesWindow(int lines, // number of lines
745 int cols, // number of columns
746 int begin_y, // line origin
747 int begin_x); // col origin
749 NCursesWindow(NCursesWindow& par,// parent window
750 int lines, // number of lines
751 int cols, // number of columns
752 int begin_y, // absolute or relative
753 int begin_x, // origins:
754 char absrel = 'a');// if `a', begin_y & begin_x are
755 // absolute screen pos, else if `r', they are relative to par origin
757 NCursesWindow(NCursesWindow& par,// parent window
759 // this is the very common case that we want to create the subwindow that
760 // is two lines and two columns smaller and begins at (1,1).
761 // We may automatically request the box around it.
763 virtual ~NCursesWindow();
765 NCursesWindow Clone();
766 // Make an exact copy of the window.
769 static void useColors(void);
770 // Call this routine very early if you want to have colors.
772 static int ripoffline(int ripoff_lines,
773 int (*init)(NCursesWindow& win));
774 // This function is used to generate a window of ripped-of lines.
775 // If the argument is positive, lines are removed from the top, if it
776 // is negative lines are removed from the bottom. This enhances the
777 // lowlevel ripoffline() function because it uses the internal
778 // implementation that allows to remove more than just a single line.
779 // This function must be called before any other ncurses function. The
780 // creation of the window is deferred until ncurses gets initialized.
781 // The initialization function is then called.
783 // -------------------------------------------------------------------------
785 // -------------------------------------------------------------------------
786 int lines() const { initialize(); return LINES; }
787 // Number of lines on terminal, *not* window
789 int cols() const { initialize(); return COLS; }
790 // Number of cols on terminal, *not* window
792 int tabsize() const { initialize(); return TABSIZE; }
793 // Size of a tab on terminal, *not* window
795 static int NumberOfColors();
796 // Number of available colors
798 int colors() const { return NumberOfColors(); }
799 // Number of available colors
801 // -------------------------------------------------------------------------
803 // -------------------------------------------------------------------------
804 int height() const { return maxy() + 1; }
805 // Number of lines in this window
807 int width() const { return maxx() + 1; }
808 // Number of columns in this window
810 int begx() const { return w->_begx; }
811 // Column of top left corner relative to stdscr
813 int begy() const { return w->_begy; }
814 // Line of top left corner relative to stdscr
816 int maxx() const { return w->_maxx; }
817 // Largest x coord in window
819 int maxy() const { return w->_maxy; }
820 // Largest y coord in window
822 short getcolor() const;
825 short foreground() const { return getcolor(0); }
826 // Actual foreground color
828 short background() const { return getcolor(1); }
829 // Actual background color
831 int setpalette(short fore, short back);
832 // Set color palette entry
834 int setcolor(short pair);
835 // Set actually used palette entry
837 // -------------------------------------------------------------------------
838 // window positioning
839 // -------------------------------------------------------------------------
840 virtual int mvwin(int begin_y, int begin_x) {
841 return ::mvwin(w, begin_y, begin_x); }
842 // Move window to new position with the new position as top left corner.
843 // This is virtual because it is redefined in NCursesPanel.
845 // -------------------------------------------------------------------------
846 // coordinate positioning
847 // -------------------------------------------------------------------------
848 int move(int y, int x) { return ::wmove(w, y, x); }
849 // Move cursor the this position
851 void getyx(int& y, int& x) const { ::getyx(w, y, x); }
852 // Get current position of the cursor
854 int mvcur(int oldrow, int oldcol, int newrow, int newcol) const {
855 return ::mvcur(oldrow, oldcol, newrow, newcol); }
856 // Perform lowlevel cursor motion that takes effect immediately.
858 // -------------------------------------------------------------------------
860 // -------------------------------------------------------------------------
861 int getch() { return ::wgetch(w); }
862 // Get a keystroke from the window.
864 int getch(int y, int x) { return ::mvwgetch(w, y, x); }
865 // Move cursor to position and get a keystroke from the window
867 int getstr(char* str, int n=-1) {
868 return ::wgetnstr(w, str, n); }
869 // Read a series of characters into str until a newline or carriage return
870 // is received. Read at most n characters. If n is negative, the limit is
873 int getstr(int y, int x, char* str, int n=-1) {
874 return ::mvwgetnstr(w, y, x, str, n); }
875 // Move the cursor to the requested position and then perform the getstr()
876 // as described above.
878 int instr(char *s, int n=-1) { return ::winnstr(w, s, n); }
879 // Get a string of characters from the window into the buffer s. Retrieve
880 // at most n characters, if n is negative retrieve all characters up to the
881 // end of the current line. Attributes are stripped from the characters.
883 int instr(int y, int x, char *s, int n=-1) {
884 return ::mvwinnstr(w, y, x, s, n); }
885 // Move the cursor to the requested position and then perform the instr()
886 // as described above.
888 int scanw(const char* fmt, ...)
889 // Perform a scanw function from the window.
891 __attribute__ ((format (scanf, 2, 3)));
896 int scanw(int y, int x, const char* fmt, ...)
897 // Move the cursor to the requested position and then perform a scanw
900 __attribute__ ((format (scanf, 4, 5)));
905 // -------------------------------------------------------------------------
907 // -------------------------------------------------------------------------
908 int addch(const chtype ch) { return ::waddch(w, ch); }
909 // Put attributed character to the window.
911 int addch(int y, int x, const chtype ch) {
912 return ::mvwaddch(w, y, x, ch); }
913 // Move cursor to the requested position and then put attributed character
916 int echochar(const chtype ch) { return ::wechochar(w, ch); }
917 // Put attributed character to the window and refresh it immediately.
919 int addstr(const char* str, int n=-1) {
920 return ::waddnstr(w, str, n); }
921 // Write the string str to the window, stop writing if the terminating
922 // NUL or the limit n is reached. If n is negative, it is ignored.
924 int addstr(int y, int x, const char * str, int n=-1) {
925 return ::mvwaddnstr(w, y, x, str, n); }
926 // Move the cursor to the requested position and then perform the addstr
927 // as described above.
929 int printw(const char* fmt, ...)
930 // Do a formatted print to the window.
931 #if (__GNUG__ >= 2) && !defined(printf)
932 __attribute__ ((format (printf, 2, 3)));
937 int printw(int y, int x, const char * fmt, ...)
938 // Move the cursor and then do a formatted print to the window.
939 #if (__GNUG__ >= 2) && !defined(printf)
940 __attribute__ ((format (printf, 4, 5)));
945 chtype inch() const { return ::winch(w); }
946 // Retrieve attributed character under the current cursor position.
948 chtype inch(int y, int x) { return ::mvwinch(w, y, x); }
949 // Move cursor to requested position and then retrieve attributed character
952 int insch(chtype ch) { return ::winsch(w, ch); }
953 // Insert attributed character into the window before current cursor
956 int insch(int y, int x, chtype ch) {
957 return ::mvwinsch(w, y, x, ch); }
958 // Move cursor to requested position and then insert the attributed
959 // character before that position.
961 int insertln() { return ::winsdelln(w, 1); }
962 // Insert an empty line above the current line.
964 int insdelln(int n=1) { return ::winsdelln(w, n); }
965 // If n>0 insert that many lines above the current line. If n<0 delete
966 // that many lines beginning with the current line.
968 int insstr(const char *s, int n=-1) {
969 return ::winsnstr(w, s, n); }
970 // Insert the string into the window before the current cursor position.
971 // Insert stops at end of string or when the limit n is reached. If n is
972 // negative, it is ignored.
974 int insstr(int y, int x, const char *s, int n=-1) {
975 return ::mvwinsnstr(w, y, x, s, n); }
976 // Move the cursor to the requested position and then perform the insstr()
977 // as described above.
979 int attron (chtype at) { return ::wattron (w, at); }
980 // Switch on the window attributes;
982 int attroff(chtype at) { return ::wattroff(w, (int) at); }
983 // Switch off the window attributes;
985 int attrset(chtype at) { return ::wattrset(w, (int) at); }
986 // Set the window attributes;
988 int color_set(short color_pair_number, void* opts=NULL) {
989 return ::wcolor_set(w, color_pair_number, opts); }
990 // Set the window color attribute;
992 int chgat(int n, attr_t attr, short color, const void *opts=NULL) {
993 return ::wchgat(w, n, attr, color, opts); }
994 // Change the attributes of the next n characters in the current line. If
995 // n is negative or greater than the number of remaining characters in the
996 // line, the attributes will be changed up to the end of the line.
998 int chgat(int y, int x,
999 int n, attr_t attr, short color, const void *opts=NULL) {
1000 return ::mvwchgat(w, y, x, n, attr, color, opts); }
1001 // Move the cursor to the requested position and then perform chgat() as
1004 // -------------------------------------------------------------------------
1006 // -------------------------------------------------------------------------
1007 chtype getbkgd() const { return ::getbkgd(w); }
1008 // Get current background setting.
1010 int bkgd(const chtype ch) { return ::wbkgd(w, ch); }
1011 // Set the background property and apply it to the window.
1013 void bkgdset(chtype ch) { ::wbkgdset(w, ch); }
1014 // Set the background property.
1016 // -------------------------------------------------------------------------
1018 // -------------------------------------------------------------------------
1019 int box(chtype vert=0, chtype hor=0) {
1020 return ::wborder(w, vert, vert, hor, hor, 0, 0, 0, 0); }
1021 // Draw a box around the window with the given vertical and horizontal
1022 // drawing characters. If you specify a zero as character, curses will try
1023 // to find a "nice" character.
1025 int border(chtype left=0, chtype right=0,
1026 chtype top =0, chtype bottom=0,
1027 chtype top_left =0, chtype top_right=0,
1028 chtype bottom_left =0, chtype bottom_right=0) {
1029 return ::wborder(w, left, right, top, bottom, top_left, top_right,
1030 bottom_left, bottom_right); }
1031 // Draw a border around the window with the given characters for the
1032 // various parts of the border. If you pass zero for a character, curses
1033 // will try to find "nice" characters.
1035 // -------------------------------------------------------------------------
1037 // -------------------------------------------------------------------------
1038 int hline(int len, chtype ch=0) { return ::whline(w, ch, len); }
1039 // Draw a horizontal line of len characters with the given character. If
1040 // you pass zero for the character, curses will try to find a "nice" one.
1042 int hline(int y, int x, int len, chtype ch=0) {
1043 return ::mvwhline(w, y, x, ch, len); }
1044 // Move the cursor to the requested position and then draw a horizontal line.
1046 int vline(int len, chtype ch=0) { return ::wvline(w, ch, len); }
1047 // Draw a vertical line of len characters with the given character. If
1048 // you pass zero for the character, curses will try to find a "nice" one.
1050 int vline(int y, int x, int len, chtype ch=0) {
1051 return ::mvwvline(w, y, x, ch, len); }
1052 // Move the cursor to the requested position and then draw a vertical line.
1054 // -------------------------------------------------------------------------
1056 // -------------------------------------------------------------------------
1057 int erase() { return ::werase(w); }
1058 // Erase the window.
1060 int clear() { return ::wclear(w); }
1061 // Clear the window.
1063 int clearok(bool bf) { return ::clearok(w, bf); }
1064 // Set/Reset the clear flag. If set, the next refresh() will clear the
1067 int clrtobot() { return ::wclrtobot(w); }
1068 // Clear to the end of the window.
1070 int clrtoeol() { return ::wclrtoeol(w); }
1071 // Clear to the end of the line.
1073 int delch() { return ::wdelch(w); }
1074 // Delete character under the cursor.
1076 int delch(int y, int x) { return ::mvwdelch(w, y, x); }
1077 // Move cursor to requested position and delete the character under the
1080 int deleteln() { return ::winsdelln(w, -1); }
1081 // Delete the current line.
1083 // -------------------------------------------------------------------------
1085 // -------------------------------------------------------------------------
1086 int scroll(int amount=1) { return ::wscrl(w, amount); }
1087 // Scroll amount lines. If amount is positive, scroll up, otherwise
1090 int scrollok(bool bf) { return ::scrollok(w, bf); }
1091 // If bf is TRUE, window scrolls if cursor is moved off the bottom
1092 // edge of the window or a scrolling region, otherwise the cursor is left
1093 // at the bottom line.
1095 int setscrreg(int from, int to) {
1096 return ::wsetscrreg(w, from, to); }
1097 // Define a soft scrolling region.
1099 int idlok(bool bf) { return ::idlok(w, bf); }
1100 // If bf is TRUE, use insert/delete line hardware support if possible.
1101 // Otherwise do it in software.
1104 void idcok(bool bf) { ::idcok(w, bf); }
1105 // If bf is TRUE, use insert/delete character hardware support if possible.
1106 // Otherwise do it in software.
1108 int touchwin() { return ::wtouchln(w, 0, height(), 1); }
1109 // Mark the whole window as modified.
1111 int untouchwin() { return ::wtouchln(w, 0, height(), 0); }
1112 // Mark the whole window as unmodified.
1114 int touchln(int s, int cnt, bool changed=TRUE) {
1115 return ::wtouchln(w, s, cnt, (int)(changed?1:0)); }
1116 // Mark cnt lines beginning from line s as changed or unchanged, depending
1117 // on the value of the changed flag.
1119 bool is_linetouched(int line) const {
1120 return (::is_linetouched(w, line) ? TRUE:FALSE); }
1121 // Return TRUE if line is marked as changed, FALSE otherwise
1123 bool is_wintouched() const {
1124 return (::is_wintouched(w) ? TRUE:FALSE); }
1125 // Return TRUE if window is marked as changed, FALSE otherwise
1127 int leaveok(bool bf) { return ::leaveok(w, bf); }
1128 // If bf is TRUE, curses will leave the cursor after an update whereever
1129 // it is after the update.
1131 int redrawln(int from, int n) { return ::wredrawln(w, from, n); }
1132 // Redraw n lines starting from the requested line
1134 int redrawwin() { return ::wredrawln(w, 0, height()); }
1135 // Redraw the whole window
1137 int doupdate() { return ::doupdate(); }
1138 // Do all outputs to make the physical screen looking like the virtual one
1140 void syncdown() { ::wsyncdown(w); }
1141 // Propagate the changes down to all descendant windows
1143 void syncup() { ::wsyncup(w); }
1144 // Propagate the changes up in the hierarchy
1146 void cursyncup() { ::wcursyncup(w); }
1147 // Position the cursor in all ancestor windows corresponding to our setting
1149 int syncok(bool bf) { return ::syncok(w, bf); }
1150 // If called with bf=TRUE, syncup() is called whenever the window is changed
1153 int flushok(bool bf) { return ::flushok(w, bf); }
1156 void immedok(bool bf) { ::immedok(w, bf); }
1157 // If called with bf=TRUE, any change in the window will cause an
1158 // automatic immediate refresh()
1160 int keypad(bool bf) { return ::keypad(w, bf); }
1161 // If called with bf=TRUE, the application will interpret function keys.
1163 int meta(bool bf) { return ::meta(w, bf); }
1164 // If called with bf=TRUE, keys may generate 8-Bit characters. Otherwise
1165 // 7-Bit characters are generated.
1167 int standout() { return ::wstandout(w); }
1168 // Enable "standout" attributes
1170 int standend() { return ::wstandend(w); }
1171 // Disable "standout" attributes
1173 // -------------------------------------------------------------------------
1174 // The next two are virtual, because we redefine them in the
1175 // NCursesPanel class.
1176 // -------------------------------------------------------------------------
1177 virtual int refresh() { return ::wrefresh(w); }
1178 // Propagate the changes in this window to the virtual screen and call
1179 // doupdate(). This is redefined in NCursesPanel.
1181 virtual int noutrefresh() { return ::wnoutrefresh(w); }
1182 // Propagate the changes in this window to the virtual screen. This is
1183 // redefined in NCursesPanel.
1185 // -------------------------------------------------------------------------
1186 // multiple window control
1187 // -------------------------------------------------------------------------
1188 int overlay(NCursesWindow& win) {
1189 return ::overlay(w, win.w); }
1190 // Overlay this window over win.
1192 int overwrite(NCursesWindow& win) {
1193 return ::overwrite(w, win.w); }
1194 // Overwrite win with this window.
1196 int copywin(NCursesWindow& win,
1197 int sminrow, int smincol,
1198 int dminrow, int dmincol,
1199 int dmaxrow, int dmaxcol, bool overlay=TRUE) {
1200 return ::copywin(w, win.w, sminrow, smincol, dminrow, dmincol,
1201 dmaxrow, dmaxcol, (int)(overlay?1:0)); }
1202 // Overlay or overwrite the rectangle in win given by dminrow,dmincol,
1203 // dmaxrow,dmaxcol with the rectangle in this window beginning at
1206 // -------------------------------------------------------------------------
1208 // -------------------------------------------------------------------------
1209 bool has_mouse() const;
1210 // Return TRUE if terminal supports a mouse, FALSE otherwise
1212 // -------------------------------------------------------------------------
1213 // traversal support
1214 // -------------------------------------------------------------------------
1215 NCursesWindow* child() { return subwins; }
1216 // Get the first child window.
1218 NCursesWindow* sibling() { return sib; }
1219 // Get the next child of my parent.
1221 NCursesWindow* parent() { return par; }
1224 bool isDescendant(NCursesWindow& win);
1225 // Return TRUE if win is a descendant of this.
1228 // -------------------------------------------------------------------------
1229 // We leave this here for compatibility reasons.
1230 // -------------------------------------------------------------------------
1231 class NCURSES_IMPEXP NCursesColorWindow : public NCursesWindow {
1233 NCursesColorWindow(WINDOW* &window) // useful only for stdscr
1234 : NCursesWindow(window) {
1237 NCursesColorWindow(int lines, // number of lines
1238 int cols, // number of columns
1239 int begin_y, // line origin
1240 int begin_x) // col origin
1241 : NCursesWindow(lines, cols, begin_y, begin_x) {
1244 NCursesColorWindow(NCursesWindow& par,// parent window
1245 int lines, // number of lines
1246 int cols, // number of columns
1247 int begin_y, // absolute or relative
1248 int begin_x, // origins:
1249 char absrel = 'a') // if `a', by & bx are
1250 : NCursesWindow(par, lines, cols, // absolute screen pos,
1251 begin_y, begin_x, // else if `r', they are
1252 absrel ) { // relative to par origin
1256 // These enum definitions really belong inside the NCursesPad class, but only
1257 // recent compilers support that feature.
1260 REQ_PAD_REFRESH = KEY_MAX + 1,
1268 const Pad_Request PAD_LOW = REQ_PAD_REFRESH; // lowest op-code
1269 const Pad_Request PAD_HIGH = REQ_PAD_EXIT; // highest op-code
1271 // -------------------------------------------------------------------------
1272 // Pad Support. We allow an association of a pad with a "real" window
1273 // through which the pad may be viewed.
1274 // -------------------------------------------------------------------------
1275 class NCURSES_IMPEXP NCursesPad : public NCursesWindow {
1277 NCursesWindow* viewWin; // the "viewport" window
1278 NCursesWindow* viewSub; // the "viewport" subwindow
1280 int h_gridsize, v_gridsize;
1283 int min_row, min_col; // top left row/col of the pads display area
1285 NCursesWindow* Win(void) const {
1286 // Get the window into which the pad should be copied (if any)
1287 return (viewSub?viewSub:(viewWin?viewWin:0));
1290 NCursesWindow* getWindow(void) const {
1294 NCursesWindow* getSubWindow(void) const {
1298 virtual int driver (int key); // Virtualize keystroke key
1299 // The driver translates the keystroke c into an Pad_Request
1301 virtual void OnUnknownOperation(int pad_req) {
1304 // This is called if the driver returns an unknown op-code
1306 virtual void OnNavigationError(int pad_req) {
1309 // This is called if a navigation request couldn't be satisfied
1311 virtual void OnOperation(int pad_req) {
1313 // OnOperation is called if a Pad_Operation was executed and just before
1314 // the refresh() operation is done.
1317 NCursesPad(int lines, int cols);
1318 // create a pad with the given size
1320 virtual ~NCursesPad() {}
1322 int echochar(const chtype ch) { return ::pechochar(w, ch); }
1323 // Put the attributed character onto the pad and immediately do a
1327 // If a viewport is defined the pad is displayed in this window, otherwise
1330 int refresh(int pminrow, int pmincol,
1331 int sminrow, int smincol,
1332 int smaxrow, int smaxcol) {
1333 return ::prefresh(w, pminrow, pmincol,
1334 sminrow, smincol, smaxrow, smaxcol);
1336 // The coordinates sminrow,smincol,smaxrow,smaxcol describe a rectangle
1337 // on the screen. <b>refresh</b> copies a rectangle of this size beginning
1338 // with top left corner pminrow,pmincol onto the screen and calls doupdate().
1341 // If a viewport is defined the pad is displayed in this window, otherwise
1344 int noutrefresh(int pminrow, int pmincol,
1345 int sminrow, int smincol,
1346 int smaxrow, int smaxcol) {
1347 return ::pnoutrefresh(w, pminrow, pmincol,
1348 sminrow, smincol, smaxrow, smaxcol);
1350 // Does the same as refresh() but without calling doupdate().
1352 virtual void setWindow(NCursesWindow& view, int v_grid = 1, int h_grid = 1);
1353 // Add the window "view" as viewing window to the pad.
1355 virtual void setSubWindow(NCursesWindow& sub);
1356 // Use the subwindow "sub" of the viewport window for the actual viewing.
1357 // The full viewport window is usually used to provide some decorations
1358 // like frames, titles etc.
1360 virtual void operator() (void);
1361 // Perform Pad's operation
1364 // A FramedPad is constructed always with a viewport window. This viewport
1365 // will be framed (by a box() command) and the interior of the box is the
1366 // viewport subwindow. On the frame we display scrollbar sliders.
1367 class NCURSES_IMPEXP NCursesFramedPad : public NCursesPad {
1369 virtual void OnOperation(int pad_req);
1372 NCursesFramedPad(NCursesWindow& win, int lines, int cols,
1373 int v_grid = 1, int h_grid = 1)
1374 : NCursesPad(lines, cols) {
1375 NCursesPad::setWindow(win, v_grid, h_grid);
1376 NCursesPad::setSubWindow(*(new NCursesWindow(win)));
1378 // Construct the FramedPad with the given Window win as viewport.
1380 virtual ~NCursesFramedPad() {
1381 delete getSubWindow();
1384 void setWindow(NCursesWindow& view, int v_grid = 1, int h_grid = 1) {
1385 err_handler("Operation not allowed");
1387 // Disable this call; the viewport is already defined
1389 void setSubWindow(NCursesWindow& sub) {
1390 err_handler("Operation not allowed");
1392 // Disable this call; the viewport subwindow is already defined
1396 #endif // NCURSES_CURSESW_H_incl