/**************************************************************************** * apps/graphics/pdcurses/pdc_refresh.c * Public Domain Curses * RCSID("$Id: refresh.c,v 1.56 2008/07/13 16:08:18 wmcbrine Exp $") * * Copyright (C) 2017 Gregory Nutt. All rights reserved. * Adapted by: Gregory Nutt * * Adapted from the original public domain pdcurses by Gregory Nutt and * released as part of NuttX under the 3-clause BSD license: * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * 3. Neither the name NuttX nor the names of its contributors may be * used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************/ /* Name: refresh * * Synopsis: * int refresh(void); * int wrefresh(WINDOW *win); * int wnoutrefresh(WINDOW *win); * int doupdate(void); * int redrawwin(WINDOW *win); * int wredrawln(WINDOW *win, int beg_line, int num_lines); * * Description: * wrefresh() copies the named window to the physical terminal * screen, taking into account what is already there in order to * optimize cursor movement. refresh() does the same, using stdscr. * These routines must be called to get any output on the terminal, * as other routines only manipulate data structures. Unless * leaveok() has been enabled, the physical cursor of the terminal * is left at the location of the window's cursor. * * wnoutrefresh() and doupdate() allow multiple updates with more * efficiency than wrefresh() alone. wrefresh() works by first * calling wnoutrefresh(), which copies the named window to the * virtual screen. It then calls doupdate(), which compares the * virtual screen to the physical screen and does the actual * update. A series of calls to wrefresh() will result in * alternating calls to wnoutrefresh() and doupdate(), causing * several bursts of output to the screen. By first calling * wnoutrefresh() for each window, it is then possible to call * doupdate() only once. * * In PDCurses, redrawwin() is equivalent to touchwin(), and * wredrawln() is the same as touchline(). In some other curses * implementations, there's a subtle distinction, but it has no * meaning in PDCurses. * * Return Value: * All functions return OK on success and ERR on error. * * Portability X/Open BSD SYS V * refresh Y Y Y * wrefresh Y Y Y * wnoutrefresh Y Y Y * doupdate Y Y Y * redrawwin Y - 4.0 * wredrawln Y - 4.0 */ /**************************************************************************** * Included Files ****************************************************************************/ #include #include "curspriv.h" /**************************************************************************** * Public Functions ****************************************************************************/ int wnoutrefresh(WINDOW *win) { int begx; int begy; int i; int j; #ifdef CONFIG_PDCURSES_MULTITHREAD FAR struct pdc_context_s *ctx = PDC_ctx(); #endif PDC_LOG(("wnoutrefresh() - called: win=%p\n", win)); if (!win || (win->_flags & (_PAD | _SUBPAD))) { return ERR; } begy = win->_begy; begx = win->_begx; for (i = 0, j = begy; i < win->_maxy; i++, j++) { if (win->_firstch[i] != _NO_CHANGE) { chtype *src = win->_y[i]; chtype *dest = curscr->_y[j] + begx; int first = win->_firstch[i]; /* first changed */ int last = win->_lastch[i]; /* last changed */ /* Ignore areas on the outside that are marked as changed, but * really aren't. */ while (first <= last && src[first] == dest[first]) { first++; } while (last >= first && src[last] == dest[last]) { last--; } /* If any have really changed... */ if (first <= last) { memcpy(dest + first, src + first, (last - first + 1) * sizeof(chtype)); first += begx; last += begx; if (first < curscr->_firstch[j] || curscr->_firstch[j] == _NO_CHANGE) { curscr->_firstch[j] = first; } if (last > curscr->_lastch[j]) { curscr->_lastch[j] = last; } } win->_firstch[i] = _NO_CHANGE; /* updated now */ } win->_lastch[i] = _NO_CHANGE; /* updated now */ } if (win->_clear) { win->_clear = false; } if (!win->_leaveit) { curscr->_cury = win->_cury + begy; curscr->_curx = win->_curx + begx; } return OK; } int doupdate(void) { int y; bool clearall; #ifdef CONFIG_PDCURSES_MULTITHREAD FAR struct pdc_context_s *ctx = PDC_ctx(); #endif PDC_LOG(("doupdate() - called\n")); if (!curscr) { return ERR; } if (isendwin()) /* coming back after endwin() called */ { reset_prog_mode(); clearall = true; SP->alive = true; /* so isendwin() result is correct */ } else { clearall = curscr->_clear; } for (y = 0; y < SP->lines; y++) { PDC_LOG(("doupdate() - Transforming line %d of %d: %s\n", y, SP->lines, (curscr->_firstch[y] != _NO_CHANGE) ? "Yes" : "No")); if (clearall || curscr->_firstch[y] != _NO_CHANGE) { int first; int last; chtype *src = curscr->_y[y]; chtype *dest = pdc_lastscr->_y[y]; if (clearall) { first = 0; last = COLS - 1; } else { first = curscr->_firstch[y]; last = curscr->_lastch[y]; } while (first <= last) { int len = 0; /* Build up a run of changed cells; if two runs are separated by * a single unchanged cell, ignore the break. */ if (clearall) { len = last - first + 1; } else { while (first + len <= last && (src[first + len] != dest[first + len] || (len && first + len < last && src[first + len + 1] != dest[first + len + 1]))) { len++; } } /* Update the screen, and pdc_lastscr */ if (len) { PDC_transform_line(y, first, len, src + first); memcpy(dest + first, src + first, len * sizeof(chtype)); first += len; } /* skip over runs of unchanged cells */ while (first <= last && src[first] == dest[first]) { first++; } } curscr->_firstch[y] = _NO_CHANGE; curscr->_lastch[y] = _NO_CHANGE; } } curscr->_clear = false; if (SP->visibility) { PDC_gotoyx(curscr->_cury, curscr->_curx); } SP->cursrow = curscr->_cury; SP->curscol = curscr->_curx; return OK; } int wrefresh(WINDOW *win) { bool save_clear; #ifdef CONFIG_PDCURSES_MULTITHREAD FAR struct pdc_context_s *ctx = PDC_ctx(); #endif PDC_LOG(("wrefresh() - called\n")); if (!win || (win->_flags & (_PAD | _SUBPAD))) { return ERR; } save_clear = win->_clear; if (win == curscr) { curscr->_clear = true; } else { wnoutrefresh(win); } if (save_clear && win->_maxy == SP->lines && win->_maxx == SP->cols) { curscr->_clear = true; } return doupdate(); } int refresh(void) { #ifdef CONFIG_PDCURSES_MULTITHREAD FAR struct pdc_context_s *ctx = PDC_ctx(); #endif PDC_LOG(("refresh() - called\n")); return wrefresh(stdscr); } int wredrawln(WINDOW *win, int start, int num) { int i; PDC_LOG(("wredrawln() - called: win=%p start=%d num=%d\n", win, start, num)); if (!win || start > win->_maxy || start + num > win->_maxy) { return ERR; } for (i = start; i < start + num; i++) { win->_firstch[i] = 0; win->_lastch[i] = win->_maxx - 1; } return OK; } int redrawwin(WINDOW *win) { PDC_LOG(("redrawwin() - called: win=%p\n", win)); if (!win) { return ERR; } return wredrawln(win, 0, win->_maxy); }