1 // * This makes emacs happy -*-Mode: C++;-*-
3 /****************************************************************************
4 * Copyright (c) 1998-2014,2017 Free Software Foundation, Inc. *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
29 ****************************************************************************/
31 #ifndef NCURSES_CURSESW_H_incl
32 #define NCURSES_CURSESW_H_incl 1
34 // $Id: cursesw.h,v 1.53 2017/11/21 00:37:23 tom Exp $
42 /* SCO 3.2v4 curses.h includes term.h, which defines lines as a macro.
43 Undefine it here, because NCursesWindow uses lines as a method. */
46 /* "Convert" macros to inlines. We'll define it as another symbol to avoid
47 * conflict with library symbols.
50 #define UNDEF(name) CUR_ ##name
53 inline int UNDEF(addch)(chtype ch) { return addch(ch); }
55 #define addch UNDEF(addch)
59 inline int UNDEF(addchstr)(chtype *at) { return addchstr(at); }
61 #define addchstr UNDEF(addchstr)
65 inline int UNDEF(addnstr)(const char *str, int n)
66 { return addnstr(str, n); }
68 #define addnstr UNDEF(addnstr)
72 inline int UNDEF(addstr)(const char * str) { return addstr(str); }
74 #define addstr UNDEF(addstr)
78 inline int UNDEF(attroff)(chtype at) { return attroff(at); }
80 #define attroff UNDEF(attroff)
84 inline int UNDEF(attron)(chtype at) { return attron(at); }
86 #define attron UNDEF(attron)
90 inline chtype UNDEF(attrset)(chtype at) { return attrset(at); }
92 #define attrset UNDEF(attrset)
96 inline int UNDEF(bkgd)(chtype ch) { return bkgd(ch); }
98 #define bkgd UNDEF(bkgd)
102 inline void UNDEF(bkgdset)(chtype ch) { bkgdset(ch); }
104 #define bkgdset UNDEF(bkgdset)
108 inline int UNDEF(border)(chtype ls, chtype rs, chtype ts, chtype bs, chtype tl, chtype tr, chtype bl, chtype br)
109 { return border(ls, rs, ts, bs, tl, tr, bl, br); }
111 #define border UNDEF(border)
115 inline int UNDEF(box)(WINDOW *win, int v, int h) { return box(win, v, h); }
117 #define box UNDEF(box)
121 inline int UNDEF(chgat)(int n, attr_t attr, NCURSES_PAIRS_T color, const void *opts) {
122 return chgat(n, attr, color, opts); }
124 #define chgat UNDEF(chgat)
128 inline int UNDEF(clear)() { return clear(); }
130 #define clear UNDEF(clear)
134 inline int UNDEF(clearok)(WINDOW* win, bool bf) { return clearok(win, bf); }
136 #define clearok UNDEF(clearok)
138 extern "C" NCURSES_IMPEXP int NCURSES_API clearok(WINDOW*, bool);
142 inline int UNDEF(clrtobot)() { return clrtobot(); }
144 #define clrtobot UNDEF(clrtobot)
148 inline int UNDEF(clrtoeol)() { return clrtoeol(); }
150 #define clrtoeol UNDEF(clrtoeol)
154 inline chtype UNDEF(color_set)(NCURSES_PAIRS_T p, void* opts) { return color_set(p, opts); }
156 #define color_set UNDEF(color_set)
160 inline int UNDEF(crmode)(void) { return crmode(); }
162 #define crmode UNDEF(crmode)
166 inline int UNDEF(delch)() { return delch(); }
168 #define delch UNDEF(delch)
172 inline int UNDEF(deleteln)() { return deleteln(); }
174 #define deleteln UNDEF(deleteln)
178 inline int UNDEF(echochar)(chtype ch) { return echochar(ch); }
180 #define echochar UNDEF(echochar)
184 inline int UNDEF(erase)() { return erase(); }
186 #define erase UNDEF(erase)
190 inline int UNDEF(fixterm)(void) { return fixterm(); }
192 #define fixterm UNDEF(fixterm)
196 inline int UNDEF(flushok)(WINDOW* _win, bool _bf) {
197 return flushok(_win, _bf); }
199 #define flushok UNDEF(flushok)
205 inline int UNDEF(getattrs)(WINDOW *win) { return getattrs(win); }
207 #define getattrs UNDEF(getattrs)
211 inline void UNDEF(getbegyx)(WINDOW* win, int& y, int& x) { getbegyx(win, y, x); }
213 #define getbegyx UNDEF(getbegyx)
217 inline chtype UNDEF(getbkgd)(const WINDOW *win) { return getbkgd(win); }
219 #define getbkgd UNDEF(getbkgd)
223 inline int UNDEF(getch)() { return getch(); }
225 #define getch UNDEF(getch)
229 inline void UNDEF(getmaxyx)(WINDOW* win, int& y, int& x) { getmaxyx(win, y, x); }
231 #define getmaxyx UNDEF(getmaxyx)
235 inline int UNDEF(getnstr)(char *_str, int n) { return getnstr(_str, n); }
237 #define getnstr UNDEF(getnstr)
241 inline void UNDEF(getparyx)(WINDOW* win, int& y, int& x) { getparyx(win, y, x); }
243 #define getparyx UNDEF(getparyx)
247 inline int UNDEF(getstr)(char *_str) { return getstr(_str); }
249 #define getstr UNDEF(getstr)
253 inline void UNDEF(getyx)(const WINDOW* win, int& y, int& x) {
256 #define getyx UNDEF(getyx)
260 inline int UNDEF(hline)(chtype ch, int n) { return hline(ch, n); }
262 #define hline UNDEF(hline)
266 inline chtype UNDEF(inch)() { return inch(); }
268 #define inch UNDEF(inch)
272 inline int UNDEF(inchstr)(chtype *str) { return inchstr(str); }
274 #define inchstr UNDEF(inchstr)
278 inline int UNDEF(innstr)(char *_str, int n) { return innstr(_str, n); }
280 #define innstr UNDEF(innstr)
284 inline int UNDEF(insch)(chtype c) { return insch(c); }
286 #define insch UNDEF(insch)
290 inline int UNDEF(insdelln)(int n) { return insdelln(n); }
292 #define insdelln UNDEF(insdelln)
296 inline int UNDEF(insertln)() { return insertln(); }
298 #define insertln UNDEF(insertln)
302 inline int UNDEF(insnstr)(const char *_str, int n) {
303 return insnstr(_str, n); }
305 #define insnstr UNDEF(insnstr)
309 inline int UNDEF(insstr)(const char *_str) {
310 return insstr(_str); }
312 #define insstr UNDEF(insstr)
316 inline int UNDEF(instr)(char *_str) { return instr(_str); }
318 #define instr UNDEF(instr)
322 inline void UNDEF(intrflush)(WINDOW *win, bool bf) { intrflush(); }
324 #define intrflush UNDEF(intrflush)
327 #ifdef is_linetouched
328 inline int UNDEF(is_linetouched)(WINDOW *w, int l) { return is_linetouched(w,l); }
329 #undef is_linetouched
330 #define is_linetouched UNDEF(is_linetouched)
334 inline int UNDEF(leaveok)(WINDOW* win, bool bf) { return leaveok(win, bf); }
336 #define leaveok UNDEF(leaveok)
338 extern "C" NCURSES_IMPEXP int NCURSES_API leaveok(WINDOW* win, bool bf);
342 inline int UNDEF(move)(int x, int y) { return move(x, y); }
344 #define move UNDEF(move)
348 inline int UNDEF(mvaddch)(int y, int x, chtype ch)
349 { return mvaddch(y, x, ch); }
351 #define mvaddch UNDEF(mvaddch)
355 inline int UNDEF(mvaddnstr)(int y, int x, const char *str, int n)
356 { return mvaddnstr(y, x, str, n); }
358 #define mvaddnstr UNDEF(mvaddnstr)
362 inline int UNDEF(mvaddstr)(int y, int x, const char * str)
363 { return mvaddstr(y, x, str); }
365 #define mvaddstr UNDEF(mvaddstr)
369 inline int UNDEF(mvchgat)(int y, int x, int n,
370 attr_t attr, NCURSES_PAIRS_T color, const void *opts) {
371 return mvchgat(y, x, n, attr, color, opts); }
373 #define mvchgat UNDEF(mvchgat)
377 inline int UNDEF(mvdelch)(int y, int x) { return mvdelch(y, x);}
379 #define mvdelch UNDEF(mvdelch)
383 inline int UNDEF(mvgetch)(int y, int x) { return mvgetch(y, x);}
385 #define mvgetch UNDEF(mvgetch)
389 inline int UNDEF(mvgetnstr)(int y, int x, char *str, int n) {
390 return mvgetnstr(y, x, str, n);}
392 #define mvgetnstr UNDEF(mvgetnstr)
396 inline int UNDEF(mvgetstr)(int y, int x, char *str) {return mvgetstr(y, x, str);}
398 #define mvgetstr UNDEF(mvgetstr)
402 inline chtype UNDEF(mvinch)(int y, int x) { return mvinch(y, x);}
404 #define mvinch UNDEF(mvinch)
408 inline int UNDEF(mvinnstr)(int y, int x, char *_str, int n) {
409 return mvinnstr(y, x, _str, n); }
411 #define mvinnstr UNDEF(mvinnstr)
415 inline int UNDEF(mvinsch)(int y, int x, chtype c)
416 { return mvinsch(y, x, c); }
418 #define mvinsch UNDEF(mvinsch)
422 inline int UNDEF(mvinsnstr)(int y, int x, const char *_str, int n) {
423 return mvinsnstr(y, x, _str, n); }
425 #define mvinsnstr UNDEF(mvinsnstr)
429 inline int UNDEF(mvinsstr)(int y, int x, const char *_str) {
430 return mvinsstr(y, x, _str); }
432 #define mvinsstr UNDEF(mvinsstr)
436 inline int UNDEF(mvwaddch)(WINDOW *win, int y, int x, const chtype ch)
437 { return mvwaddch(win, y, x, ch); }
439 #define mvwaddch UNDEF(mvwaddch)
443 inline int UNDEF(mvwaddchnstr)(WINDOW *win, int y, int x, const chtype *str, int n)
444 { return mvwaddchnstr(win, y, x, str, n); }
446 #define mvwaddchnstr UNDEF(mvwaddchnstr)
450 inline int UNDEF(mvwaddchstr)(WINDOW *win, int y, int x, const chtype *str)
451 { return mvwaddchstr(win, y, x, str); }
453 #define mvwaddchstr UNDEF(mvwaddchstr)
457 inline int UNDEF(mvwaddnstr)(WINDOW *win, int y, int x, const char *str, int n)
458 { return mvwaddnstr(win, y, x, str, n); }
460 #define mvwaddnstr UNDEF(mvwaddnstr)
464 inline int UNDEF(mvwaddstr)(WINDOW *win, int y, int x, const char * str)
465 { return mvwaddstr(win, y, x, str); }
467 #define mvwaddstr UNDEF(mvwaddstr)
471 inline int UNDEF(mvwchgat)(WINDOW *win, int y, int x, int n,
472 attr_t attr, NCURSES_PAIRS_T color, const void *opts) {
473 return mvwchgat(win, y, x, n, attr, color, opts); }
475 #define mvwchgat UNDEF(mvwchgat)
479 inline int UNDEF(mvwdelch)(WINDOW *win, int y, int x)
480 { return mvwdelch(win, y, x); }
482 #define mvwdelch UNDEF(mvwdelch)
486 inline int UNDEF(mvwgetch)(WINDOW *win, int y, int x) { return mvwgetch(win, y, x);}
488 #define mvwgetch UNDEF(mvwgetch)
492 inline int UNDEF(mvwgetnstr)(WINDOW *win, int y, int x, char *str, int n)
493 {return mvwgetnstr(win, y, x, str, n);}
495 #define mvwgetnstr UNDEF(mvwgetnstr)
499 inline int UNDEF(mvwgetstr)(WINDOW *win, int y, int x, char *str)
500 {return mvwgetstr(win, y, x, str);}
502 #define mvwgetstr UNDEF(mvwgetstr)
506 inline int UNDEF(mvwhline)(WINDOW *win, int y, int x, chtype c, int n) {
507 return mvwhline(win, y, x, c, n); }
509 #define mvwhline UNDEF(mvwhline)
513 inline chtype UNDEF(mvwinch)(WINDOW *win, int y, int x) {
514 return mvwinch(win, y, x);}
516 #define mvwinch UNDEF(mvwinch)
520 inline int UNDEF(mvwinchnstr)(WINDOW *win, int y, int x, chtype *str, int n) { return mvwinchnstr(win, y, x, str, n); }
522 #define mvwinchnstr UNDEF(mvwinchnstr)
526 inline int UNDEF(mvwinchstr)(WINDOW *win, int y, int x, chtype *str) { return mvwinchstr(win, y, x, str); }
528 #define mvwinchstr UNDEF(mvwinchstr)
532 inline int UNDEF(mvwinnstr)(WINDOW *win, int y, int x, char *_str, int n) {
533 return mvwinnstr(win, y, x, _str, n); }
535 #define mvwinnstr UNDEF(mvwinnstr)
539 inline int UNDEF(mvwinsch)(WINDOW *win, int y, int x, chtype c)
540 { return mvwinsch(win, y, x, c); }
542 #define mvwinsch UNDEF(mvwinsch)
546 inline int UNDEF(mvwinsnstr)(WINDOW *w, int y, int x, const char *_str, int n) {
547 return mvwinsnstr(w, y, x, _str, n); }
549 #define mvwinsnstr UNDEF(mvwinsnstr)
553 inline int UNDEF(mvwinsstr)(WINDOW *w, int y, int x, const char *_str) {
554 return mvwinsstr(w, y, x, _str); }
556 #define mvwinsstr UNDEF(mvwinsstr)
560 inline int UNDEF(mvwvline)(WINDOW *win, int y, int x, chtype c, int n) {
561 return mvwvline(win, y, x, c, n); }
563 #define mvwvline UNDEF(mvwvline)
567 inline void UNDEF(napms)(unsigned long x) { napms(x); }
569 #define napms UNDEF(napms)
573 inline int UNDEF(nocrmode)(void) { return nocrmode(); }
575 #define nocrmode UNDEF(nocrmode)
579 inline void UNDEF(nodelay)() { nodelay(); }
581 #define nodelay UNDEF(nodelay)
585 inline int UNDEF(redrawwin)(WINDOW *win) { return redrawwin(win); }
587 #define redrawwin UNDEF(redrawwin)
591 inline int UNDEF(refresh)() { return refresh(); }
593 #define refresh UNDEF(refresh)
597 inline int UNDEF(resetterm)(void) { return resetterm(); }
599 #define resetterm UNDEF(resetterm)
603 inline int UNDEF(saveterm)(void) { return saveterm(); }
605 #define saveterm UNDEF(saveterm)
609 inline int UNDEF(scrl)(int l) { return scrl(l); }
611 #define scrl UNDEF(scrl)
615 inline int UNDEF(scroll)(WINDOW *win) { return scroll(win); }
617 #define scroll UNDEF(scroll)
621 inline int UNDEF(scrollok)(WINDOW* win, bool bf) { return scrollok(win, bf); }
623 #define scrollok UNDEF(scrollok)
625 #if defined(__NCURSES_H)
626 extern "C" NCURSES_IMPEXP int NCURSES_API scrollok(WINDOW*, bool);
628 extern "C" NCURSES_IMPEXP int NCURSES_API scrollok(WINDOW*, char);
633 inline int UNDEF(setscrreg)(int t, int b) { return setscrreg(t, b); }
635 #define setscrreg UNDEF(setscrreg)
639 inline int UNDEF(standend)() { return standend(); }
641 #define standend UNDEF(standend)
645 inline int UNDEF(standout)() { return standout(); }
647 #define standout UNDEF(standout)
651 inline WINDOW *UNDEF(subpad)(WINDOW *p, int l, int c, int y, int x)
652 { return derwin(p, l, c, y, x); }
654 #define subpad UNDEF(subpad)
658 inline void UNDEF(timeout)(int delay) { timeout(delay); }
660 #define timeout UNDEF(timeout)
664 inline int UNDEF(touchline)(WINDOW *win, int s, int c)
665 { return touchline(win, s, c); }
667 #define touchline UNDEF(touchline)
671 inline int UNDEF(touchwin)(WINDOW *win) { return touchwin(win); }
673 #define touchwin UNDEF(touchwin)
677 inline int UNDEF(untouchwin)(WINDOW *win) { return untouchwin(win); }
679 #define untouchwin UNDEF(untouchwin)
683 inline int UNDEF(vline)(chtype ch, int n) { return vline(ch, n); }
685 #define vline UNDEF(vline)
689 inline int UNDEF(waddchstr)(WINDOW *win, chtype *at) { return waddchstr(win, at); }
691 #define waddchstr UNDEF(waddchstr)
695 inline int UNDEF(waddstr)(WINDOW *win, char *str) { return waddstr(win, str); }
697 #define waddstr UNDEF(waddstr)
701 inline int UNDEF(wattroff)(WINDOW *win, int att) { return wattroff(win, att); }
703 #define wattroff UNDEF(wattroff)
707 inline int UNDEF(wattrset)(WINDOW *win, int att) { return wattrset(win, att); }
709 #define wattrset UNDEF(wattrset)
713 inline chtype UNDEF(winch)(const WINDOW* win) { return winch(win); }
715 #define winch UNDEF(winch)
719 inline int UNDEF(winchnstr)(WINDOW *win, chtype *str, int n) { return winchnstr(win, str, n); }
721 #define winchnstr UNDEF(winchnstr)
725 inline int UNDEF(winchstr)(WINDOW *win, chtype *str) { return winchstr(win, str); }
727 #define winchstr UNDEF(winchstr)
731 inline int UNDEF(winsstr)(WINDOW *w, const char *_str) {
732 return winsstr(w, _str); }
734 #define winsstr UNDEF(winsstr)
738 inline int UNDEF(wstandend)(WINDOW *win) { return wstandend(win); }
740 #define wstandend UNDEF(wstandend)
744 inline int UNDEF(wstandout)(WINDOW *win) { return wstandout(win); }
746 #define wstandout UNDEF(wstandout)
751 * C++ class for windows.
755 extern "C" int _nc_ripoffline(int, int (*init)(WINDOW*, int));
756 extern "C" int _nc_xx_ripoff_init(WINDOW *, int);
757 extern "C" int _nc_has_mouse(void);
759 class NCURSES_IMPEXP NCursesWindow
761 friend class NCursesMenu;
762 friend class NCursesForm;
765 static bool b_initialized;
766 static void initialize();
768 friend int _nc_xx_ripoff_init(WINDOW *, int);
772 NCURSES_COLOR_T getcolor(int getback) const;
773 NCURSES_PAIRS_T getPair() const;
775 static int setpalette(NCURSES_COLOR_T fore, NCURSES_COLOR_T back, NCURSES_PAIRS_T pair);
776 static int colorInitialized;
778 // This private constructor is only used during the initialization
779 // of windows generated by ripoffline() calls.
780 NCursesWindow(WINDOW* win, int ncols);
783 virtual void err_handler(const char *) const THROWS(NCursesException);
784 // Signal an error with the given message text.
786 static long count; // count of all active windows:
787 // We rely on the c++ promise that
788 // all otherwise uninitialized
789 // static class vars are set to 0
791 WINDOW* w; // the curses WINDOW
793 bool alloced; // TRUE if we own the WINDOW
795 NCursesWindow* par; // parent, if subwindow
796 NCursesWindow* subwins; // head of subwindows list
797 NCursesWindow* sib; // next subwindow of parent
799 void kill_subwindows(); // disable all subwindows
800 // Destroy all subwindows.
802 /* Only for use by derived classes. They are then in charge to
803 fill the member variables correctly. */
807 NCursesWindow(WINDOW* window); // useful only for stdscr
809 NCursesWindow(int nlines, // number of lines
810 int ncols, // number of columns
811 int begin_y, // line origin
812 int begin_x); // col origin
814 NCursesWindow(NCursesWindow& par,// parent window
815 int nlines, // number of lines
816 int ncols, // number of columns
817 int begin_y, // absolute or relative
818 int begin_x, // origins:
819 char absrel = 'a');// if `a', begin_y & begin_x are
820 // absolute screen pos, else if `r', they are relative to par origin
822 NCursesWindow(NCursesWindow& par,// parent window
824 // this is the very common case that we want to create the subwindow that
825 // is two lines and two columns smaller and begins at (1,1).
826 // We may automatically request the box around it.
828 NCursesWindow& operator=(const NCursesWindow& rhs)
835 NCursesWindow(const NCursesWindow& rhs)
836 : w(rhs.w), alloced(rhs.alloced), par(rhs.par), subwins(rhs.subwins), sib(rhs.sib)
840 virtual ~NCursesWindow();
842 NCursesWindow Clone();
843 // Make an exact copy of the window.
846 static void useColors(void);
847 // Call this routine very early if you want to have colors.
849 static int ripoffline(int ripoff_lines,
850 int (*init)(NCursesWindow& win));
851 // This function is used to generate a window of ripped-of lines.
852 // If the argument is positive, lines are removed from the top, if it
853 // is negative lines are removed from the bottom. This enhances the
854 // lowlevel ripoffline() function because it uses the internal
855 // implementation that allows to remove more than just a single line.
856 // This function must be called before any other ncurses function. The
857 // creation of the window is deferred until ncurses gets initialized.
858 // The initialization function is then called.
860 // -------------------------------------------------------------------------
862 // -------------------------------------------------------------------------
863 int lines() const { initialize(); return LINES; }
864 // Number of lines on terminal, *not* window
866 int cols() const { initialize(); return COLS; }
867 // Number of cols on terminal, *not* window
869 int tabsize() const { initialize(); return TABSIZE; }
870 // Size of a tab on terminal, *not* window
872 static int NumberOfColors();
873 // Number of available colors
875 int colors() const { return NumberOfColors(); }
876 // Number of available colors
878 // -------------------------------------------------------------------------
880 // -------------------------------------------------------------------------
881 int height() const { return maxy() + 1; }
882 // Number of lines in this window
884 int width() const { return maxx() + 1; }
885 // Number of columns in this window
887 int begx() const { return getbegx(w); }
888 // Column of top left corner relative to stdscr
890 int begy() const { return getbegy(w); }
891 // Line of top left corner relative to stdscr
893 int curx() const { return getcurx(w); }
894 // Column of top left corner relative to stdscr
896 int cury() const { return getcury(w); }
897 // Line of top left corner relative to stdscr
899 int maxx() const { return getmaxx(w) == ERR ? ERR : getmaxx(w)-1; }
900 // Largest x coord in window
902 int maxy() const { return getmaxy(w) == ERR ? ERR : getmaxy(w)-1; }
903 // Largest y coord in window
905 NCURSES_PAIRS_T getcolor() const;
908 NCURSES_COLOR_T foreground() const { return getcolor(0); }
909 // Actual foreground color
911 NCURSES_COLOR_T background() const { return getcolor(1); }
912 // Actual background color
914 int setpalette(NCURSES_COLOR_T fore, NCURSES_COLOR_T back);
915 // Set color palette entry
917 int setcolor(NCURSES_PAIRS_T pair);
918 // Set actually used palette entry
920 // -------------------------------------------------------------------------
921 // window positioning
922 // -------------------------------------------------------------------------
923 virtual int mvwin(int begin_y, int begin_x) {
924 return ::mvwin(w, begin_y, begin_x); }
925 // Move window to new position with the new position as top left corner.
926 // This is virtual because it is redefined in NCursesPanel.
928 // -------------------------------------------------------------------------
929 // coordinate positioning
930 // -------------------------------------------------------------------------
931 int move(int y, int x) { return ::wmove(w, y, x); }
932 // Move cursor the this position
934 void getyx(int& y, int& x) const { ::getyx(w, y, x); }
935 // Get current position of the cursor
937 void getbegyx(int& y, int& x) const { ::getbegyx(w, y, x); }
938 // Get beginning of the window
940 void getmaxyx(int& y, int& x) const { ::getmaxyx(w, y, x); }
941 // Get size of the window
943 void getparyx(int& y, int& x) const { ::getparyx(w, y, x); }
944 // Get parent's beginning of the window
946 int mvcur(int oldrow, int oldcol, int newrow, int newcol) const {
947 return ::mvcur(oldrow, oldcol, newrow, newcol); }
948 // Perform lowlevel cursor motion that takes effect immediately.
950 // -------------------------------------------------------------------------
952 // -------------------------------------------------------------------------
953 int getch() { return ::wgetch(w); }
954 // Get a keystroke from the window.
956 int getch(int y, int x) { return ::mvwgetch(w, y, x); }
957 // Move cursor to position and get a keystroke from the window
959 int getstr(char* str, int n=-1) {
960 return ::wgetnstr(w, str, n); }
961 // Read a series of characters into str until a newline or carriage return
962 // is received. Read at most n characters. If n is negative, the limit is
965 int getstr(int y, int x, char* str, int n=-1) {
966 return ::mvwgetnstr(w, y, x, str, n); }
967 // Move the cursor to the requested position and then perform the getstr()
968 // as described above.
970 int instr(char *s, int n=-1) { return ::winnstr(w, s, n); }
971 // Get a string of characters from the window into the buffer s. Retrieve
972 // at most n characters, if n is negative retrieve all characters up to the
973 // end of the current line. Attributes are stripped from the characters.
975 int instr(int y, int x, char *s, int n=-1) {
976 return ::mvwinnstr(w, y, x, s, n); }
977 // Move the cursor to the requested position and then perform the instr()
978 // as described above.
980 int scanw(const char* fmt, ...)
981 // Perform a scanw function from the window.
983 __attribute__ ((format (scanf, 2, 3)));
988 int scanw(const char*, va_list);
989 // Perform a scanw function from the window.
991 int scanw(int y, int x, const char* fmt, ...)
992 // Move the cursor to the requested position and then perform a scanw
995 __attribute__ ((format (scanf, 4, 5)));
1000 int scanw(int y, int x, const char* fmt, va_list);
1001 // Move the cursor to the requested position and then perform a scanw
1004 // -------------------------------------------------------------------------
1006 // -------------------------------------------------------------------------
1007 int addch(const chtype ch) { return ::waddch(w, ch); }
1008 // Put attributed character to the window.
1010 int addch(int y, int x, const chtype ch) {
1011 return ::mvwaddch(w, y, x, ch); }
1012 // Move cursor to the requested position and then put attributed character
1015 int echochar(const chtype ch) { return ::wechochar(w, ch); }
1016 // Put attributed character to the window and refresh it immediately.
1018 int addstr(const char* str, int n=-1) {
1019 return ::waddnstr(w, str, n); }
1020 // Write the string str to the window, stop writing if the terminating
1021 // NUL or the limit n is reached. If n is negative, it is ignored.
1023 int addstr(int y, int x, const char * str, int n=-1) {
1024 return ::mvwaddnstr(w, y, x, str, n); }
1025 // Move the cursor to the requested position and then perform the addchstr
1026 // as described above.
1028 int addchstr(const chtype* str, int n=-1) {
1029 return ::waddchnstr(w, str, n); }
1030 // Write the string str to the window, stop writing if the terminating
1031 // NUL or the limit n is reached. If n is negative, it is ignored.
1033 int addchstr(int y, int x, const chtype * str, int n=-1) {
1034 return ::mvwaddchnstr(w, y, x, str, n); }
1035 // Move the cursor to the requested position and then perform the addchstr
1036 // as described above.
1038 int printw(const char* fmt, ...)
1039 // Do a formatted print to the window.
1040 #if (__GNUG__ >= 2) && !defined(printf)
1041 __attribute__ ((format (printf, 2, 3)));
1046 int printw(int y, int x, const char * fmt, ...)
1047 // Move the cursor and then do a formatted print to the window.
1048 #if (__GNUG__ >= 2) && !defined(printf)
1049 __attribute__ ((format (printf, 4, 5)));
1054 int printw(const char* fmt, va_list args);
1055 // Do a formatted print to the window.
1057 int printw(int y, int x, const char * fmt, va_list args);
1058 // Move the cursor and then do a formatted print to the window.
1060 chtype inch() const { return ::winch(w); }
1061 // Retrieve attributed character under the current cursor position.
1063 chtype inch(int y, int x) { return ::mvwinch(w, y, x); }
1064 // Move cursor to requested position and then retrieve attributed character
1065 // at this position.
1067 int inchstr(chtype* str, int n=-1) {
1068 return ::winchnstr(w, str, n); }
1069 // Read the string str from the window, stop reading if the terminating
1070 // NUL or the limit n is reached. If n is negative, it is ignored.
1072 int inchstr(int y, int x, chtype * str, int n=-1) {
1073 return ::mvwinchnstr(w, y, x, str, n); }
1074 // Move the cursor to the requested position and then perform the inchstr
1075 // as described above.
1077 int insch(chtype ch) { return ::winsch(w, ch); }
1078 // Insert attributed character into the window before current cursor
1081 int insch(int y, int x, chtype ch) {
1082 return ::mvwinsch(w, y, x, ch); }
1083 // Move cursor to requested position and then insert the attributed
1084 // character before that position.
1086 int insertln() { return ::winsdelln(w, 1); }
1087 // Insert an empty line above the current line.
1089 int insdelln(int n=1) { return ::winsdelln(w, n); }
1090 // If n>0 insert that many lines above the current line. If n<0 delete
1091 // that many lines beginning with the current line.
1093 int insstr(const char *s, int n=-1) {
1094 return ::winsnstr(w, s, n); }
1095 // Insert the string into the window before the current cursor position.
1096 // Insert stops at end of string or when the limit n is reached. If n is
1097 // negative, it is ignored.
1099 int insstr(int y, int x, const char *s, int n=-1) {
1100 return ::mvwinsnstr(w, y, x, s, n); }
1101 // Move the cursor to the requested position and then perform the insstr()
1102 // as described above.
1104 int attron (chtype at) { return ::wattron (w, at); }
1105 // Switch on the window attributes;
1107 int attroff(chtype at) { return ::wattroff(w, static_cast<int>(at)); }
1108 // Switch off the window attributes;
1110 int attrset(chtype at) { return ::wattrset(w, static_cast<int>(at)); }
1111 // Set the window attributes;
1113 chtype attrget() { return ::getattrs(w); }
1114 // Get the window attributes;
1116 int color_set(NCURSES_PAIRS_T color_pair_number, void* opts=NULL) {
1117 return ::wcolor_set(w, color_pair_number, opts); }
1118 // Set the window color attribute;
1120 int chgat(int n, attr_t attr, NCURSES_PAIRS_T color, const void *opts=NULL) {
1121 return ::wchgat(w, n, attr, color, opts); }
1122 // Change the attributes of the next n characters in the current line. If
1123 // n is negative or greater than the number of remaining characters in the
1124 // line, the attributes will be changed up to the end of the line.
1126 int chgat(int y, int x,
1127 int n, attr_t attr, NCURSES_PAIRS_T color, const void *opts=NULL) {
1128 return ::mvwchgat(w, y, x, n, attr, color, opts); }
1129 // Move the cursor to the requested position and then perform chgat() as
1132 // -------------------------------------------------------------------------
1134 // -------------------------------------------------------------------------
1135 chtype getbkgd() const { return ::getbkgd(w); }
1136 // Get current background setting.
1138 int bkgd(const chtype ch) { return ::wbkgd(w, ch); }
1139 // Set the background property and apply it to the window.
1141 void bkgdset(chtype ch) { ::wbkgdset(w, ch); }
1142 // Set the background property.
1144 // -------------------------------------------------------------------------
1146 // -------------------------------------------------------------------------
1147 int box(chtype vert=0, chtype hor=0) {
1148 return ::wborder(w, vert, vert, hor, hor, 0, 0, 0, 0); }
1149 // Draw a box around the window with the given vertical and horizontal
1150 // drawing characters. If you specify a zero as character, curses will try
1151 // to find a "nice" character.
1153 int border(chtype left=0, chtype right=0,
1154 chtype top =0, chtype bottom=0,
1155 chtype top_left =0, chtype top_right=0,
1156 chtype bottom_left =0, chtype bottom_right=0) {
1157 return ::wborder(w, left, right, top, bottom, top_left, top_right,
1158 bottom_left, bottom_right); }
1159 // Draw a border around the window with the given characters for the
1160 // various parts of the border. If you pass zero for a character, curses
1161 // will try to find "nice" characters.
1163 // -------------------------------------------------------------------------
1165 // -------------------------------------------------------------------------
1166 int hline(int len, chtype ch=0) { return ::whline(w, ch, len); }
1167 // Draw a horizontal line of len characters with the given character. If
1168 // you pass zero for the character, curses will try to find a "nice" one.
1170 int hline(int y, int x, int len, chtype ch=0) {
1171 return ::mvwhline(w, y, x, ch, len); }
1172 // Move the cursor to the requested position and then draw a horizontal line.
1174 int vline(int len, chtype ch=0) { return ::wvline(w, ch, len); }
1175 // Draw a vertical line of len characters with the given character. If
1176 // you pass zero for the character, curses will try to find a "nice" one.
1178 int vline(int y, int x, int len, chtype ch=0) {
1179 return ::mvwvline(w, y, x, ch, len); }
1180 // Move the cursor to the requested position and then draw a vertical line.
1182 // -------------------------------------------------------------------------
1184 // -------------------------------------------------------------------------
1185 int erase() { return ::werase(w); }
1186 // Erase the window.
1188 int clear() { return ::wclear(w); }
1189 // Clear the window.
1191 int clearok(bool bf) { return ::clearok(w, bf); }
1192 // Set/Reset the clear flag. If set, the next refresh() will clear the
1195 int clrtobot() { return ::wclrtobot(w); }
1196 // Clear to the end of the window.
1198 int clrtoeol() { return ::wclrtoeol(w); }
1199 // Clear to the end of the line.
1201 int delch() { return ::wdelch(w); }
1202 // Delete character under the cursor.
1204 int delch(int y, int x) { return ::mvwdelch(w, y, x); }
1205 // Move cursor to requested position and delete the character under the
1208 int deleteln() { return ::winsdelln(w, -1); }
1209 // Delete the current line.
1211 // -------------------------------------------------------------------------
1213 // -------------------------------------------------------------------------
1214 int scroll(int amount=1) { return ::wscrl(w, amount); }
1215 // Scroll amount lines. If amount is positive, scroll up, otherwise
1218 int scrollok(bool bf) { return ::scrollok(w, bf); }
1219 // If bf is TRUE, window scrolls if cursor is moved off the bottom
1220 // edge of the window or a scrolling region, otherwise the cursor is left
1221 // at the bottom line.
1223 int setscrreg(int from, int to) {
1224 return ::wsetscrreg(w, from, to); }
1225 // Define a soft scrolling region.
1227 int idlok(bool bf) { return ::idlok(w, bf); }
1228 // If bf is TRUE, use insert/delete line hardware support if possible.
1229 // Otherwise do it in software.
1231 void idcok(bool bf) { ::idcok(w, bf); }
1232 // If bf is TRUE, use insert/delete character hardware support if possible.
1233 // Otherwise do it in software.
1235 int touchline(int s, int c) { return ::touchline(w, s, c); }
1236 // Mark the given lines as modified.
1238 int touchwin() { return ::wtouchln(w, 0, height(), 1); }
1239 // Mark the whole window as modified.
1241 int untouchwin() { return ::wtouchln(w, 0, height(), 0); }
1242 // Mark the whole window as unmodified.
1244 int touchln(int s, int cnt, bool changed=TRUE) {
1245 return ::wtouchln(w, s, cnt, static_cast<int>(changed ? 1 : 0)); }
1246 // Mark cnt lines beginning from line s as changed or unchanged, depending
1247 // on the value of the changed flag.
1249 bool is_linetouched(int line) const {
1250 return (::is_linetouched(w, line) == TRUE ? TRUE:FALSE); }
1251 // Return TRUE if line is marked as changed, FALSE otherwise
1253 bool is_wintouched() const {
1254 return (::is_wintouched(w) ? TRUE:FALSE); }
1255 // Return TRUE if window is marked as changed, FALSE otherwise
1257 int leaveok(bool bf) { return ::leaveok(w, bf); }
1258 // If bf is TRUE, curses will leave the cursor after an update whereever
1259 // it is after the update.
1261 int redrawln(int from, int n) { return ::wredrawln(w, from, n); }
1262 // Redraw n lines starting from the requested line
1264 int redrawwin() { return ::wredrawln(w, 0, height()); }
1265 // Redraw the whole window
1267 int doupdate() { return ::doupdate(); }
1268 // Do all outputs to make the physical screen looking like the virtual one
1270 void syncdown() { ::wsyncdown(w); }
1271 // Propagate the changes down to all descendant windows
1273 void syncup() { ::wsyncup(w); }
1274 // Propagate the changes up in the hierarchy
1276 void cursyncup() { ::wcursyncup(w); }
1277 // Position the cursor in all ancestor windows corresponding to our setting
1279 int syncok(bool bf) { return ::syncok(w, bf); }
1280 // If called with bf=TRUE, syncup() is called whenever the window is changed
1283 int flushok(bool bf) { return ::flushok(w, bf); }
1286 void immedok(bool bf) { ::immedok(w, bf); }
1287 // If called with bf=TRUE, any change in the window will cause an
1288 // automatic immediate refresh()
1290 int intrflush(bool bf) { return ::intrflush(w, bf); }
1292 int keypad(bool bf) { return ::keypad(w, bf); }
1293 // If called with bf=TRUE, the application will interpret function keys.
1295 int nodelay(bool bf) { return ::nodelay(w, bf); }
1297 int meta(bool bf) { return ::meta(w, bf); }
1298 // If called with bf=TRUE, keys may generate 8-Bit characters. Otherwise
1299 // 7-Bit characters are generated.
1301 int standout() { return ::wstandout(w); }
1302 // Enable "standout" attributes
1304 int standend() { return ::wstandend(w); }
1305 // Disable "standout" attributes
1307 // -------------------------------------------------------------------------
1308 // The next two are virtual, because we redefine them in the
1309 // NCursesPanel class.
1310 // -------------------------------------------------------------------------
1311 virtual int refresh() { return ::wrefresh(w); }
1312 // Propagate the changes in this window to the virtual screen and call
1313 // doupdate(). This is redefined in NCursesPanel.
1315 virtual int noutrefresh() { return ::wnoutrefresh(w); }
1316 // Propagate the changes in this window to the virtual screen. This is
1317 // redefined in NCursesPanel.
1319 // -------------------------------------------------------------------------
1320 // multiple window control
1321 // -------------------------------------------------------------------------
1322 int overlay(NCursesWindow& win) {
1323 return ::overlay(w, win.w); }
1324 // Overlay this window over win.
1326 int overwrite(NCursesWindow& win) {
1327 return ::overwrite(w, win.w); }
1328 // Overwrite win with this window.
1330 int copywin(NCursesWindow& win,
1331 int sminrow, int smincol,
1332 int dminrow, int dmincol,
1333 int dmaxrow, int dmaxcol, bool overlaywin=TRUE) {
1334 return ::copywin(w, win.w, sminrow, smincol, dminrow, dmincol,
1335 dmaxrow, dmaxcol, static_cast<int>(overlaywin ? 1 : 0)); }
1336 // Overlay or overwrite the rectangle in win given by dminrow,dmincol,
1337 // dmaxrow,dmaxcol with the rectangle in this window beginning at
1340 // -------------------------------------------------------------------------
1341 // Extended functions
1342 // -------------------------------------------------------------------------
1343 #if defined(NCURSES_EXT_FUNCS) && (NCURSES_EXT_FUNCS != 0)
1344 int wresize(int newLines, int newColumns) {
1345 return ::wresize(w, newLines, newColumns); }
1348 // -------------------------------------------------------------------------
1350 // -------------------------------------------------------------------------
1351 bool has_mouse() const;
1352 // Return TRUE if terminal supports a mouse, FALSE otherwise
1354 // -------------------------------------------------------------------------
1355 // traversal support
1356 // -------------------------------------------------------------------------
1357 NCursesWindow* child() { return subwins; }
1358 // Get the first child window.
1360 NCursesWindow* sibling() { return sib; }
1361 // Get the next child of my parent.
1363 NCursesWindow* parent() { return par; }
1366 bool isDescendant(NCursesWindow& win);
1367 // Return TRUE if win is a descendant of this.
1370 // -------------------------------------------------------------------------
1371 // We leave this here for compatibility reasons.
1372 // -------------------------------------------------------------------------
1373 class NCURSES_IMPEXP NCursesColorWindow : public NCursesWindow
1376 NCursesColorWindow(WINDOW* &window) // useful only for stdscr
1377 : NCursesWindow(window) {
1380 NCursesColorWindow(int nlines, // number of lines
1381 int ncols, // number of columns
1382 int begin_y, // line origin
1383 int begin_x) // col origin
1384 : NCursesWindow(nlines, ncols, begin_y, begin_x) {
1387 NCursesColorWindow(NCursesWindow& parentWin,// parent window
1388 int nlines, // number of lines
1389 int ncols, // number of columns
1390 int begin_y, // absolute or relative
1391 int begin_x, // origins:
1392 char absrel = 'a') // if `a', by & bx are
1393 : NCursesWindow(parentWin,
1394 nlines, ncols, // absolute screen pos,
1395 begin_y, begin_x, // else if `r', they are
1396 absrel ) { // relative to par origin
1400 // These enum definitions really belong inside the NCursesPad class, but only
1401 // recent compilers support that feature.
1404 REQ_PAD_REFRESH = KEY_MAX + 1,
1412 const Pad_Request PAD_LOW = REQ_PAD_REFRESH; // lowest op-code
1413 const Pad_Request PAD_HIGH = REQ_PAD_EXIT; // highest op-code
1415 // -------------------------------------------------------------------------
1416 // Pad Support. We allow an association of a pad with a "real" window
1417 // through which the pad may be viewed.
1418 // -------------------------------------------------------------------------
1419 class NCURSES_IMPEXP NCursesPad : public NCursesWindow
1422 NCursesWindow* viewWin; // the "viewport" window
1423 NCursesWindow* viewSub; // the "viewport" subwindow
1425 int h_gridsize, v_gridsize;
1428 int min_row, min_col; // top left row/col of the pads display area
1430 NCursesWindow* Win(void) const {
1431 // Get the window into which the pad should be copied (if any)
1432 return (viewSub?viewSub:(viewWin?viewWin:0));
1435 NCursesWindow* getWindow(void) const {
1439 NCursesWindow* getSubWindow(void) const {
1443 virtual int driver (int key); // Virtualize keystroke key
1444 // The driver translates the keystroke c into an Pad_Request
1446 virtual void OnUnknownOperation(int pad_req) {
1450 // This is called if the driver returns an unknown op-code
1452 virtual void OnNavigationError(int pad_req) {
1456 // This is called if a navigation request couldn't be satisfied
1458 virtual void OnOperation(int pad_req) {
1461 // OnOperation is called if a Pad_Operation was executed and just before
1462 // the refresh() operation is done.
1465 NCursesPad(int nlines, int ncols);
1466 // create a pad with the given size
1468 NCursesPad& operator=(const NCursesPad& rhs)
1472 NCursesWindow::operator=(rhs);
1477 NCursesPad(const NCursesPad& rhs)
1478 : NCursesWindow(rhs),
1479 viewWin(rhs.viewWin),
1480 viewSub(rhs.viewSub),
1481 h_gridsize(rhs.h_gridsize),
1482 v_gridsize(rhs.v_gridsize),
1483 min_row(rhs.min_row),
1484 min_col(rhs.min_col)
1488 virtual ~NCursesPad() {}
1490 int echochar(const chtype ch) { return ::pechochar(w, ch); }
1491 // Put the attributed character onto the pad and immediately do a
1495 // If a viewport is defined the pad is displayed in this window, otherwise
1498 int refresh(int pminrow, int pmincol,
1499 int sminrow, int smincol,
1500 int smaxrow, int smaxcol) {
1501 return ::prefresh(w, pminrow, pmincol,
1502 sminrow, smincol, smaxrow, smaxcol);
1504 // The coordinates sminrow,smincol,smaxrow,smaxcol describe a rectangle
1505 // on the screen. <b>refresh</b> copies a rectangle of this size beginning
1506 // with top left corner pminrow,pmincol onto the screen and calls doupdate().
1509 // If a viewport is defined the pad is displayed in this window, otherwise
1512 int noutrefresh(int pminrow, int pmincol,
1513 int sminrow, int smincol,
1514 int smaxrow, int smaxcol) {
1515 return ::pnoutrefresh(w, pminrow, pmincol,
1516 sminrow, smincol, smaxrow, smaxcol);
1518 // Does the same as refresh() but without calling doupdate().
1520 virtual void setWindow(NCursesWindow& view, int v_grid = 1, int h_grid = 1);
1521 // Add the window "view" as viewing window to the pad.
1523 virtual void setSubWindow(NCursesWindow& sub);
1524 // Use the subwindow "sub" of the viewport window for the actual viewing.
1525 // The full viewport window is usually used to provide some decorations
1526 // like frames, titles etc.
1528 virtual void operator() (void);
1529 // Perform Pad's operation
1532 // A FramedPad is constructed always with a viewport window. This viewport
1533 // will be framed (by a box() command) and the interior of the box is the
1534 // viewport subwindow. On the frame we display scrollbar sliders.
1535 class NCURSES_IMPEXP NCursesFramedPad : public NCursesPad
1538 virtual void OnOperation(int pad_req);
1541 NCursesFramedPad(NCursesWindow& win, int nlines, int ncols,
1542 int v_grid = 1, int h_grid = 1)
1543 : NCursesPad(nlines, ncols) {
1544 NCursesPad::setWindow(win, v_grid, h_grid);
1545 NCursesPad::setSubWindow(*(new NCursesWindow(win)));
1547 // Construct the FramedPad with the given Window win as viewport.
1549 virtual ~NCursesFramedPad() {
1550 delete getSubWindow();
1553 void setWindow(NCursesWindow& view, int v_grid = 1, int h_grid = 1) {
1557 err_handler("Operation not allowed");
1559 // Disable this call; the viewport is already defined
1561 void setSubWindow(NCursesWindow& sub) {
1563 err_handler("Operation not allowed");
1565 // Disable this call; the viewport subwindow is already defined
1569 #endif /* NCURSES_CURSESW_H_incl */