1 // * this is for making emacs happy: -*-Mode: C++;-*-
2 /****************************************************************************
3 * Copyright (c) 2007-2011,2012 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 ****************************************************************************/
35 * The NCursesWindow class was originally based on a file written by
36 * Eric Newton, later modified by Ulrich Drepper and Anatoly Ivasyuk.
37 * However, aside from the compatible interface definition, no trace
38 * of the original code remains in this version: it consists only of
39 * changes introduced since 1995.
45 MODULE_ID("$Id: cursesw.cc,v 1.53 2012/12/08 22:06:41 tom Exp $")
47 #define COLORS_NEED_INITIALIZATION -1
48 #define COLORS_NOT_INITIALIZED 0
49 #define COLORS_MONOCHROME 1
50 #define COLORS_ARE_REALLY_THERE 2
52 #define HaveColors() (colorInitialized == COLORS_ARE_REALLY_THERE)
54 // declare static variables for the class
55 long NCursesWindow::count = 0L;
56 bool NCursesWindow::b_initialized = FALSE;
59 NCursesWindow::scanw(const char* fmt, ...)
65 result = ::vw_scanw (w, const_cast<NCURSES_CONST char *>(fmt), args);
73 NCursesWindow::scanw(int y, int x, const char* fmt, ...)
77 if (::wmove(w, y, x) != ERR) {
80 result = ::vw_scanw (w, const_cast<NCURSES_CONST char *>(fmt), args);
88 NCursesWindow::scanw(const char* fmt, va_list args)
92 result = ::vw_scanw (w, const_cast<NCURSES_CONST char *>(fmt), args);
99 NCursesWindow::scanw(int y, int x, const char* fmt, va_list args)
103 if (::wmove(w, y, x) != ERR) {
104 result = ::vw_scanw (w, const_cast<NCURSES_CONST char *>(fmt), args);
111 NCursesWindow::printw(const char * fmt, ...)
115 int result = ::vw_printw(w, fmt, args);
122 NCursesWindow::printw(int y, int x, const char * fmt, ...)
126 int result = ::wmove(w, y, x);
128 result = ::vw_printw(w, fmt, args);
136 NCursesWindow::printw(const char * fmt, va_list args)
138 int result = ::vw_printw(w, fmt, args);
144 NCursesWindow::printw(int y, int x, const char * fmt, va_list args)
146 int result = ::wmove(w, y, x);
148 result = ::vw_printw(w, fmt, args);
155 NCursesWindow::set_keyboard(void)
162 NCursesWindow::err_handler(const char *msg) const THROWS(NCursesException)
164 THROW(new NCursesException(msg));
168 NCursesWindow::initialize()
170 if (!b_initialized) {
172 b_initialized = TRUE;
173 if (colorInitialized == COLORS_NEED_INITIALIZATION) {
174 colorInitialized = COLORS_NOT_INITIALIZED;
183 NCursesWindow::constructing()
189 NCursesWindow::NCursesWindow()
190 : w(0), alloced(FALSE), par(0), subwins(0), sib(0)
194 w = static_cast<WINDOW *>(0);
197 NCursesWindow::NCursesWindow(int nlines, int ncols, int begin_y, int begin_x)
198 : w(0), alloced(TRUE), par(0), subwins(0), sib(0)
202 w = ::newwin(nlines, ncols, begin_y, begin_x);
204 err_handler("Cannot construct window");
209 NCursesWindow::NCursesWindow(WINDOW* window)
210 : w(0), alloced(FALSE), par(0), subwins(0), sib(0)
214 // We used to use a reference on the "window" parameter, but we cannot do
215 // that with an opaque pointer (see NCURSES_OPAQUE). If the parameter was
216 // "::stdscr", that is first set via the "constructing() call, and is null
217 // up to that point. So we allow a null pointer here as meaning the "same"
219 w = window ? window : ::stdscr;
223 NCursesWindow::NCursesWindow(NCursesWindow& win, int ny, int nx,
224 int begin_y, int begin_x, char absrel)
225 : w(0), alloced(TRUE), par(0), subwins(0), sib(0)
228 if (absrel == 'a') { // absolute origin
229 begin_y -= win.begy();
230 begin_x -= win.begx();
233 // Link this window into its parent's list of subwindows.
234 // We use derwin(), since this also works for pads.
235 w = ::derwin(win.w, ny, nx, begin_y, begin_x);
237 err_handler("Cannot construct subwindow");
245 NCursesWindow::NCursesWindow(NCursesWindow& win,
246 bool do_box NCURSES_PARAM_INIT(TRUE))
247 : w(0), alloced(TRUE), par(0), subwins(0), sib(0)
250 int myHeight = win.height();
251 int myWidth = win.width();
252 w = :: derwin(win.w, myHeight - 2, myWidth - 2, 1, 1);
254 err_handler("Cannot construct subwindow");
268 NCursesWindow NCursesWindow::Clone()
270 WINDOW *d = ::dupwin(w);
279 typedef int (*RIPOFFINIT)(NCursesWindow&);
280 static RIPOFFINIT R_INIT[5]; // There can't be more
281 static int r_init_idx = 0;
282 static RIPOFFINIT* prip = R_INIT;
284 NCursesWindow::NCursesWindow(WINDOW *win, int ncols)
285 : w(0), alloced(FALSE), par(0), subwins(0), sib(0)
292 int _nc_xx_ripoff_init(WINDOW *w, int ncols)
297 RIPOFFINIT init = *prip++;
299 res = init(*(new NCursesWindow(w,ncols)));
304 int NCursesWindow::ripoffline(int ripoff_lines,
305 int (*init)(NCursesWindow& win))
307 int code = ::_nc_ripoffline(ripoff_lines,_nc_xx_ripoff_init);
308 if (code == OK && init && ripoff_lines) {
309 R_INIT[r_init_idx++] = init;
315 NCursesWindow::isDescendant(NCursesWindow& win)
319 for (NCursesWindow* p = subwins; p != NULL; p = p->sib) {
320 if (p == &win || p->isDescendant(win)) {
329 NCursesWindow::kill_subwindows()
331 NCursesWindow* p = subwins;
335 NCursesWindow* q = p->sib;
336 p->kill_subwindows();
347 NCursesWindow::~NCursesWindow()
352 // Remove this window from the parent's list of subwindows.
353 NCursesWindow * next = par->subwins;
354 NCursesWindow * prev = 0;
358 prev->sib = next->sib;
360 par->subwins = next->sib;
369 if (alloced && w != 0)
376 } else if (count < 0) { // cannot happen!
377 err_handler("Too many windows destroyed");
382 // ---------------------------------------------------------------------
385 int NCursesWindow::colorInitialized = COLORS_NOT_INITIALIZED;
388 NCursesWindow::useColors(void)
390 if (colorInitialized == COLORS_NOT_INITIALIZED) {
392 if (::has_colors()) {
394 colorInitialized = COLORS_ARE_REALLY_THERE;
396 colorInitialized = COLORS_MONOCHROME;
399 colorInitialized = COLORS_NEED_INITIALIZATION;
405 NCursesWindow::getPair() const
407 return static_cast<short>(PAIR_NUMBER(getattrs(w)));
411 NCursesWindow::getcolor(int getback) const
416 if (::pair_content(getPair(), &fore, &back) == ERR)
417 err_handler("Can't get color pair");
419 // Monochrome means white on black
423 return getback ? back : fore;
426 int NCursesWindow::NumberOfColors()
428 return (HaveColors()) ? COLORS : 1;
432 NCursesWindow::getcolor() const
434 return (HaveColors()) ? getPair() : 0;
438 NCursesWindow::setpalette(short fore, short back, short pair)
440 return (HaveColors()) ? ::init_pair(pair, fore, back) : OK;
444 NCursesWindow::setpalette(short fore, short back)
446 return setpalette(fore, back, getPair());
451 NCursesWindow::setcolor(short pair)
454 if ((pair < 1) || (pair > COLOR_PAIRS))
455 err_handler("Can't set color pair");
458 attrset(COLOR_PAIR(pair));
464 bool NCursesWindow::has_mouse() const
466 return ((::has_key(KEY_MOUSE) || ::has_mouse())