1 /****************************************************************************
2 * Copyright (c) 1998-2011,2015 Free Software Foundation, Inc. *
4 * Permission is hereby granted, free of charge, to any person obtaining a *
5 * copy of this software and associated documentation files (the *
6 * "Software"), to deal in the Software without restriction, including *
7 * without limitation the rights to use, copy, modify, merge, publish, *
8 * distribute, distribute with modifications, sublicense, and/or sell *
9 * copies of the Software, and to permit persons to whom the Software is *
10 * furnished to do so, subject to the following conditions: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
16 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
18 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
21 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 * Except as contained in this notice, the name(s) of the above copyright *
24 * holders shall not be used in advertising or otherwise to promote the *
25 * sale, use or other dealings in this Software without prior written *
27 ****************************************************************************/
29 /****************************************************************************
30 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
31 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
32 * and: Thomas E. Dickey 1996 on *
33 * and: Juergen Pfeifer 2009 *
34 ****************************************************************************/
36 #include <curses.priv.h>
41 #define CUR SP_TERMTYPE
44 MODULE_ID("$Id: lib_screen.c,v 1.74 2015/04/04 14:00:34 tom Exp $")
46 #define MAX_SIZE 0x3fff /* 16k is big enough for a window or pad */
55 * Use 0x8888 as the magic number for new-format files, since it cannot be
56 * mistaken for the _cury/_curx pair of 16-bit numbers which start the old
57 * format. It happens to be unused in the file 5.22 database (2015/03/07).
59 static const char my_magic[] =
60 {'\210', '\210', '\210', '\210'};
62 #if NCURSES_EXT_PUTWIN
69 ,pSIZE /* NCURSES_SIZE_T */
87 #define DATA(name) { { #name }, A_##name }
88 static const SCR_ATTRS scr_attrs[] =
113 #define sizeof2(type,name) sizeof(((type *)0)->name)
114 #define DATA(name, type) { { #name }, type, sizeof2(WINDOW, name), offsetof(WINDOW, name) }
116 static const SCR_PARAMS scr_params[] =
124 DATA(_flags, pSHORT),
127 DATA(_notimeout, pBOOL),
129 DATA(_leaveok, pBOOL),
130 DATA(_scroll, pBOOL),
135 DATA(_use_keypad, pBOOL),
137 DATA(_regtop, pSIZE),
138 DATA(_regbottom, pSIZE),
139 DATA(_pad._pad_y, pSIZE),
140 DATA(_pad._pad_x, pSIZE),
141 DATA(_pad._pad_top, pSIZE),
142 DATA(_pad._pad_left, pSIZE),
143 DATA(_pad._pad_bottom, pSIZE),
144 DATA(_pad._pad_right, pSIZE),
145 DATA(_yoffset, pSIZE),
147 DATA(_bkgrnd, pCCHAR),
148 #if NCURSES_EXT_COLORS
155 static const NCURSES_CH_T blank = NewChar(BLANK_TEXT);
158 * Allocate and read a line of text. Caller must free it.
165 char *result = malloc(limit);
174 if (used + 2 >= limit) {
176 buffer = realloc(result, limit);
186 result[used++] = (char) ch;
188 } while (ch != '\n');
191 result[--used] = '\0';
192 T(("READ:%s", result));
193 } else if (used == 0) {
202 decode_attr(char *source, attr_t *target, int *color)
206 T(("decode_attr '%s'", source));
209 if (source[0] == MARKER && source[1] == L_CURL) {
212 } else if (source[0] == R_CURL) {
219 if (source[0] == GUTTER) {
221 } else if (*next == 'C') {
225 while (isdigit(UChar(*next))) {
226 value = value * 10 + (*next++ - '0');
229 pair = (unsigned) ((value > 256)
231 : COLOR_PAIR(value));
235 while (isalnum(UChar(*next))) {
238 for (n = 0; n < SIZEOF(scr_attrs); ++n) {
239 if ((size_t) (next - source) == strlen(scr_attrs[n].name)) {
240 if (scr_attrs[n].attr) {
241 *target |= scr_attrs[n].attr;
258 decode_char(char *source, int *target)
262 const char digits[] = "0123456789abcdef";
264 T(("decode_char '%s'", source));
297 while (limit-- > 0) {
298 char *find = strchr(digits, *source++);
299 int ch = (find != 0) ? (int) (find - digits) : -1;
301 if (ch >= 0 && ch < base) {
315 decode_chtype(char *source, chtype fillin, chtype *target)
317 attr_t attr = ChAttrOf(fillin);
318 int color = PAIR_NUMBER((int) attr);
321 T(("decode_chtype '%s'", source));
322 source = decode_attr(source, &attr, &color);
323 source = decode_char(source, &value);
324 *target = (ChCharOf(value) | attr | (chtype) COLOR_PAIR(color));
325 /* FIXME - ignore combining characters */
331 decode_cchar(char *source, cchar_t *fillin, cchar_t *target)
334 attr_t attr = fillin->attr;
335 wchar_t chars[CCHARW_MAX];
339 T(("decode_cchar '%s'", source));
341 #if NCURSES_EXT_COLORS
342 color = fillin->ext_color;
344 color = (int) PAIR_NUMBER(attr);
346 source = decode_attr(source, &attr, &color);
347 memset(chars, 0, sizeof(chars));
348 source = decode_char(source, &value);
349 chars[0] = (wchar_t) value;
350 /* handle combining characters */
351 while (source[0] == MARKER && source[1] == APPEND) {
353 source = decode_char(source, &value);
354 if (append++ < CCHARW_MAX) {
355 chars[append] = (wchar_t) value;
358 setcchar(target, chars, attr, (short) color, NULL);
364 read_win(WINDOW *win, FILE *fp)
377 memset(win, 0, sizeof(WINDOW));
382 if (!strcmp(txt, "rows:")) {
387 if ((value = strchr(txt, '=')) == 0) {
392 name = !strcmp(txt, "flag") ? value : txt;
393 for (n = 0; n < SIZEOF(scr_params); ++n) {
394 if (!strcmp(name, scr_params[n].name)) {
395 void *data = (void *) ((char *) win + scr_params[n].offset);
397 switch (scr_params[n].type) {
399 (void) decode_attr(value, data, &color);
402 *(bool *) data = TRUE;
406 decode_chtype(value, prior2, data);
409 *(int *) data = atoi(value);
412 *(short *) data = (short) atoi(value);
415 *(NCURSES_SIZE_T *) data = (NCURSES_SIZE_T) atoi(value);
420 decode_cchar(value, &prior, data);
433 read_row(char *source, NCURSES_CH_T * prior, NCURSES_CH_T * target, int length)
435 while (*source != '\0' && length > 0) {
438 source = decode_cchar(source, prior, target);
439 len = wcwidth(target->chars[0]);
441 SetWidecExt(CHDEREF(target), 0);
442 for (n = 1; n < len; ++n) {
443 target[n] = target[0];
444 SetWidecExt(CHDEREF(target), n);
450 source = decode_chtype(source, *prior, target);
456 while (length-- > 0) {
459 /* FIXME - see what error conditions should apply if I need to return ERR */
462 #endif /* NCURSES_EXT_PUTWIN */
465 * Originally, getwin/putwin used fread/fwrite, because they used binary data.
466 * The new format uses printable ASCII, which does not have as predictable
467 * sizes. Consequently, we use buffered I/O, e.g., fgetc/fprintf, which need
468 * special handling if we want to read screen dumps from an older library.
471 read_block(void *target, size_t length, FILE *fp)
474 char *buffer = target;
477 while (length-- != 0) {
483 *buffer++ = (char) ch;
488 NCURSES_EXPORT(WINDOW *)
489 NCURSES_SP_NAME(getwin) (NCURSES_SP_DCLx FILE *filep)
493 bool old_format = FALSE;
495 T((T_CALLED("getwin(%p)"), (void *) filep));
502 * Read the first 4 bytes to determine first if this is an old-format
503 * screen-dump, or new-format.
505 if (read_block(&tmp, 4, filep) < 0) {
509 * If this is a new-format file, and we do not support it, give up.
511 if (!memcmp(&tmp, my_magic, 4)) {
512 #if NCURSES_EXT_PUTWIN
513 if (read_win(&tmp, filep) < 0)
516 } else if (read_block(((char *) &tmp) + 4, sizeof(WINDOW) - 4, filep) < 0) {
523 * Check the window-size:
525 if (tmp._maxy == 0 ||
526 tmp._maxy > MAX_SIZE ||
528 tmp._maxx > MAX_SIZE) {
532 if (tmp._flags & _ISPAD) {
533 nwin = NCURSES_SP_NAME(newpad) (NCURSES_SP_ARGx
537 nwin = NCURSES_SP_NAME(newwin) (NCURSES_SP_ARGx
539 tmp._maxx + 1, 0, 0);
543 * We deliberately do not restore the _parx, _pary, or _parent
544 * fields, because the window hierarchy within which they
545 * made sense is probably gone.
548 size_t linesize = sizeof(NCURSES_CH_T) * (size_t) (tmp._maxx + 1);
550 nwin->_curx = tmp._curx;
551 nwin->_cury = tmp._cury;
552 nwin->_maxy = tmp._maxy;
553 nwin->_maxx = tmp._maxx;
554 nwin->_begy = tmp._begy;
555 nwin->_begx = tmp._begx;
556 nwin->_yoffset = tmp._yoffset;
557 nwin->_flags = tmp._flags & ~(_SUBWIN);
559 WINDOW_ATTRS(nwin) = WINDOW_ATTRS(&tmp);
560 nwin->_nc_bkgd = tmp._nc_bkgd;
562 nwin->_notimeout = tmp._notimeout;
563 nwin->_clear = tmp._clear;
564 nwin->_leaveok = tmp._leaveok;
565 nwin->_idlok = tmp._idlok;
566 nwin->_idcok = tmp._idcok;
567 nwin->_immed = tmp._immed;
568 nwin->_scroll = tmp._scroll;
569 nwin->_sync = tmp._sync;
570 nwin->_use_keypad = tmp._use_keypad;
571 nwin->_delay = tmp._delay;
573 nwin->_regtop = tmp._regtop;
574 nwin->_regbottom = tmp._regbottom;
576 if (tmp._flags & _ISPAD)
577 nwin->_pad = tmp._pad;
580 T(("reading old-format screen dump"));
581 for (n = 0; n <= nwin->_maxy; n++) {
582 if (read_block(nwin->_line[n].text, linesize, filep) < 0) {
588 #if NCURSES_EXT_PUTWIN
592 NCURSES_CH_T prior = blank;
594 T(("reading new-format screen dump"));
595 for (n = 0; n <= nwin->_maxy; n++) {
599 if ((txt = read_txt(filep)) == 0) {
600 T(("...failed to read string for row %d", n + 1));
604 row = strtol(txt, &next, 10);
605 if (row != (n + 1) || *next != ':') {
606 T(("...failed to read row-number %d", n + 1));
611 if (read_row(++next, &prior, nwin->_line[n].text, tmp._maxx
613 T(("...failed to read cells for row %d", n + 1));
634 NCURSES_EXPORT(WINDOW *)
637 return NCURSES_SP_NAME(getwin) (CURRENT_SCREEN, filep);
641 #if NCURSES_EXT_PUTWIN
643 encode_attr(char *target, attr_t source, attr_t prior)
645 source &= ~A_CHARTEXT;
646 prior &= ~A_CHARTEXT;
649 if (source != prior) {
656 for (n = 0; n < SIZEOF(scr_attrs); ++n) {
657 if ((source & scr_attrs[n].attr) != 0 ||
658 ((source & ALL_BUT_COLOR) == 0 &&
659 (scr_attrs[n].attr == A_NORMAL))) {
665 strcpy(target, scr_attrs[n].name);
666 target += strlen(target);
669 if ((source & A_COLOR) != (prior & A_COLOR)) {
672 sprintf(target, "C%d", PAIR_NUMBER((int) source));
673 target += strlen(target);
682 encode_cell(char *target, CARG_CH_T source, CARG_CH_T previous)
688 if (previous->attr != source->attr) {
689 encode_attr(target, source->attr, previous->attr);
691 target += strlen(target);
692 #if NCURSES_EXT_COLORS
693 if (previous->ext_color != source->ext_color) {
694 sprintf(target, "%c%cC%d%c", MARKER, L_CURL, source->ext_color, R_CURL);
697 for (n = 0; n < SIZEOF(source->chars); ++n) {
698 unsigned uch = (unsigned) source->chars[n];
707 sprintf(target, "U%08x", uch);
708 } else if (uch > 0xff) {
709 sprintf(target, "u%04x", uch);
710 } else if (uch < 32 || uch >= 127) {
711 sprintf(target, "%03o", uch & 0xff);
722 sprintf(--target, "%c", uch);
726 target += strlen(target);
729 chtype ch = CharOfD(source);
732 if (AttrOfD(previous) != AttrOfD(source)) {
733 encode_attr(target, AttrOfD(source), AttrOfD(previous));
735 target += strlen(target);
737 if (ch < 32 || ch >= 127) {
738 sprintf(target, "%03o", ch);
749 sprintf(--target, "%c", ch);
753 target += strlen(target);
759 putwin(WINDOW *win, FILE *filep)
764 T((T_CALLED("putwin(%p,%p)"), (void *) win, (void *) filep));
766 #if NCURSES_EXT_PUTWIN
768 const char *version = curses_version();
770 NCURSES_CH_T last_cell;
772 memset(&last_cell, 0, sizeof(last_cell));
777 * Our magic number is technically nonprinting, but aside from that,
778 * all of the file is printable ASCII.
780 #define PUTS(s) if (fputs(s, filep) == EOF || ferror(filep)) returnCode(code)
784 for (y = 0; y < (int) SIZEOF(scr_params); ++y) {
785 const char *name = scr_params[y].name;
786 const char *data = (char *) win + scr_params[y].offset;
787 const void *dp = (const void *) data;
790 if (!strncmp(name, "_pad.", 5) && !(win->_flags & _ISPAD)) {
793 switch (scr_params[y].type) {
795 encode_attr(buffer, (*(const attr_t *) dp) & ~A_CHARTEXT, A_NORMAL);
798 if (!(*(const bool *) data)) {
801 strcpy(buffer, name);
805 encode_attr(buffer, *(const attr_t *) dp, A_NORMAL);
808 if (!(*(const int *) dp))
810 sprintf(buffer, "%d", *(const int *) dp);
813 if (!(*(const short *) dp))
815 sprintf(buffer, "%d", *(const short *) dp);
818 if (!(*(const NCURSES_SIZE_T *) dp))
820 sprintf(buffer, "%d", *(const NCURSES_SIZE_T *) dp);
824 encode_cell(buffer, (CARG_CH_T) dp, CHREF(last_cell));
829 * Only write non-default data.
831 if (*buffer != '\0') {
832 if (fprintf(filep, "%s=%s\n", name, buffer) <= 0
838 fprintf(filep, "rows:\n");
839 for (y = 0; y <= win->_maxy; y++) {
840 NCURSES_CH_T *data = win->_line[y].text;
842 if (fprintf(filep, "%d:", y + 1) <= 0
845 for (x = 0; x <= win->_maxx; x++) {
846 int len = wcwidth(data[x].chars[0]);
847 encode_cell(buffer, CHREF(data[x]), CHREF(last_cell));
858 * This is the original putwin():
859 * A straight binary dump is simple, but its format can depend on whether
860 * ncurses is compiled with wide-character support, and also may depend
861 * on the version of ncurses, e.g., if the WINDOW structure is extended.
864 size_t len = (size_t) (win->_maxx + 1);
867 if (fwrite(win, sizeof(WINDOW), (size_t) 1, filep) != 1
871 for (y = 0; y <= win->_maxy; y++) {
872 if (fwrite(win->_line[y].text,
873 sizeof(NCURSES_CH_T), len, filep) != len
885 NCURSES_SP_NAME(scr_restore) (NCURSES_SP_DCLx const char *file)
890 T((T_CALLED("scr_restore(%p,%s)"), (void *) SP_PARM, _nc_visbuf(file)));
892 if (_nc_access(file, R_OK) >= 0
893 && (fp = fopen(file, "rb")) != 0) {
894 delwin(NewScreen(SP_PARM));
895 NewScreen(SP_PARM) = getwin(fp);
897 newscr = NewScreen(SP_PARM);
900 if (NewScreen(SP_PARM) != 0) {
909 scr_restore(const char *file)
911 return NCURSES_SP_NAME(scr_restore) (CURRENT_SCREEN, file);
916 scr_dump(const char *file)
921 T((T_CALLED("scr_dump(%s)"), _nc_visbuf(file)));
923 if (_nc_access(file, W_OK) < 0
924 || (fp = fopen(file, "wb")) == 0) {
927 (void) putwin(newscr, fp);
935 NCURSES_SP_NAME(scr_init) (NCURSES_SP_DCLx const char *file)
940 T((T_CALLED("scr_init(%p,%s)"), (void *) SP_PARM, _nc_visbuf(file)));
943 #ifdef USE_TERM_DRIVER
944 InfoOf(SP_PARM).caninit
946 !(exit_ca_mode && non_rev_rmcup)
949 if (_nc_access(file, R_OK) >= 0
950 && (fp = fopen(file, "rb")) != 0) {
951 delwin(CurScreen(SP_PARM));
952 CurScreen(SP_PARM) = getwin(fp);
954 curscr = CurScreen(SP_PARM);
957 if (CurScreen(SP_PARM) != 0) {
967 scr_init(const char *file)
969 return NCURSES_SP_NAME(scr_init) (CURRENT_SCREEN, file);
974 NCURSES_SP_NAME(scr_set) (NCURSES_SP_DCLx const char *file)
978 T((T_CALLED("scr_set(%p,%s)"), (void *) SP_PARM, _nc_visbuf(file)));
980 if (NCURSES_SP_NAME(scr_init) (NCURSES_SP_ARGx file) == OK) {
981 delwin(NewScreen(SP_PARM));
982 NewScreen(SP_PARM) = dupwin(curscr);
984 newscr = NewScreen(SP_PARM);
986 if (NewScreen(SP_PARM) != 0) {
995 scr_set(const char *file)
997 return NCURSES_SP_NAME(scr_set) (CURRENT_SCREEN, file);