doc/html/man/curs_scr_dump.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2023,2024 Thomas E. Dickey                                *
   4   * Copyright 1998-2010,2017 Free Software Foundation, Inc.                  *
   5   *                                                                          *
   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:                 *
  13   *                                                                          *
  14   * The above copyright notice and this permission notice shall be included  *
  15   * in all copies or substantial portions of the Software.                   *
  16   *                                                                          *
  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.                               *
  24   *                                                                          *
  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       *
  28   * authorization.                                                           *
  29   ****************************************************************************
  30   * @Id: curs_scr_dump.3x,v 1.45 2024/06/01 22:29:45 tom Exp @
  31 -->
  32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  33 <HTML>
  34 <HEAD>
  35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>curs_scr_dump 3x 2024-06-01 ncurses 6.5 Library calls</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">curs_scr_dump 3x 2024-06-01 ncurses 6.5 Library calls</H1>
  43 <PRE>
  44 <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>                Library calls               <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>scr_dump</STRONG>,  <STRONG>scr_restore</STRONG>,  <STRONG>scr_init</STRONG>, <STRONG>scr_set</STRONG> - read/write a <EM>curses</EM> screen
  51        from/to a file
  52
  53
  54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  55        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  56
  57        <STRONG>int</STRONG> <STRONG>scr_dump(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <EM>filename</EM><STRONG>);</STRONG>
  58        <STRONG>int</STRONG> <STRONG>scr_restore(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <EM>filename</EM><STRONG>);</STRONG>
  59        <STRONG>int</STRONG> <STRONG>scr_init(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <EM>filename</EM><STRONG>);</STRONG>
  60        <STRONG>int</STRONG> <STRONG>scr_set(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <EM>filename</EM><STRONG>);</STRONG>
  61
  62
  63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  64        <EM>curses</EM> provides applications the ability to write the contents  of  the
  65        screen  to  a  file and read them back.  To read/write a window (rather
  66        than the whole screen) from/to a file, use <STRONG><A HREF="curs_util.3x.html">getwin(3x)</A></STRONG>  and  <STRONG><A HREF="curs_util.3x.html">putwin(3x)</A></STRONG>,
  67        respectively.
  68
  69
  70 </PRE><H3><a name="h3-scr_dump">scr_dump</a></H3><PRE>
  71        <STRONG>scr_dump</STRONG>  writes  to  <EM>filename</EM>  the contents of the virtual screen; see
  72        <STRONG><A HREF="curs_variables.3x.html">curscr(3x)</A></STRONG>.
  73
  74
  75 </PRE><H3><a name="h3-scr_restore">scr_restore</a></H3><PRE>
  76        <STRONG>scr_restore</STRONG> updates  the  virtual  screen  to  match  the  contents  of
  77        <EM>filename</EM> (if validly written with <STRONG>scr_dump</STRONG>).  <EM>curses</EM> does not perform a
  78        refresh;  after  making  any  desired  changes,  call  <STRONG><A HREF="curs_refresh.3x.html">doupdate(3x)</A></STRONG>  or
  79        similar.
  80
  81
  82 </PRE><H3><a name="h3-scr_init">scr_init</a></H3><PRE>
  83        <STRONG>scr_init</STRONG>  reads <EM>filename</EM>, using it to initialize <EM>curses</EM> data structures
  84        describing the state of  the  terminal  screen.   <EM>curses</EM>  then,  if  it
  85        decides  the  terminal  state  is  valid,  bases its next update of the
  86        screen on this information rather than clearing it  and  starting  from
  87        scratch.
  88
  89        <EM>curses</EM>  regards  the terminal being in an invalid state for computation
  90        of updates based on the contents of <EM>filename</EM> if
  91
  92        <STRONG>o</STRONG>   the terminal type supports the <EM>terminfo</EM>  capabilities  <STRONG>exit_ca_mode</STRONG>
  93            (<STRONG>rmcup</STRONG>) or <STRONG>non_rev_rmcup</STRONG> (<STRONG>nrrmc</STRONG>), or
  94
  95        <STRONG>o</STRONG>   <EM>curses</EM>  knows  that  the  terminal  has  been  written to since the
  96            preceding <STRONG>scr_dump</STRONG> call.
  97
  98        Either of the foregoing conditions means that <EM>curses</EM> cannot assume that
  99        the  terminal's  contents  match their representation in <EM>filename</EM>.  The
 100        former is due to  terminal  features  (such  as  <STRONG>xterm(1)</STRONG>'s  "alternate
 101        screen")  that  couple  cursor-positioning  mode  with a local cache of
 102        screen contents.  <EM>curses</EM> cannot know  whether  terminal  is  displaying
 103        from that local cache at the time the application calls <STRONG>scr_init</STRONG>, so it
 104        makes a pessimistic assumption that a  full  redraw  is  required;  see
 105        subsection "Cursor Motions" of <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
 106
 107        <STRONG>scr_init</STRONG>  could  be  used  after  <STRONG><A HREF="curs_initscr.3x.html">initscr(3x)</A></STRONG> or <STRONG>system(3)</STRONG> to share the
 108        screen with another process that has done a <STRONG>scr_dump</STRONG> after  <STRONG><A HREF="curs_initscr.3x.html">endwin(3x)</A></STRONG>.
 109        An   application  that  supports  suspending  its  state  on  exit  and
 110        subsequent resumption upon  later  execution  might  use  <STRONG>scr_dump</STRONG>  and
 111        <STRONG>scr_init</STRONG> thus.
 112
 113
 114 </PRE><H3><a name="h3-scr_set">scr_set</a></H3><PRE>
 115        <STRONG>scr_set</STRONG>  combines  <STRONG>scr_restore</STRONG> and <STRONG>scr_init</STRONG>, synchronizing the contents
 116        of <EM>filename</EM> with the virtual screen.  It can be regarded  as  a  screen
 117        inheritance function; consider a real-time screen-sharing application.
 118
 119
 120 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 121        These functions return <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG> on failure.
 122
 123        In  <EM>ncurses</EM>,  each  function  returns  <STRONG>ERR</STRONG>  if it cannot open <EM>filename</EM>.
 124        <STRONG>scr_init</STRONG>, <STRONG>scr_restore</STRONG>, and  <STRONG>scr_set</STRONG>  return  <STRONG>ERR</STRONG>  if  the  contents  of
 125        <EM>filename</EM> are invalid.
 126
 127
 128 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 129        <STRONG>scr_init</STRONG>, <STRONG>scr_restore</STRONG>, and <STRONG>scr_set</STRONG> may be implemented as macros.
 130
 131
 132 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 133        X/Open  Curses,  Issue  4  describes  these functions.  It specifies no
 134        error conditions for them.
 135
 136        SVr4 omitted the <EM>const</EM> qualifiers.
 137
 138        SVr4 documentation describes <STRONG>scr_init</STRONG> such that the dump data  is  also
 139        considered  invalid  "if the time-stamp of the tty is old" but does not
 140        define "old".
 141
 142
 143 </PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
 144        SVr3 (1987) introduced <STRONG>scr_dump</STRONG>,  <STRONG>scr_init</STRONG>,  and  <STRONG>scr_restore</STRONG>.   SVr3.1
 145        added <STRONG>scr_set</STRONG>.
 146
 147
 148 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 149        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,    <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>,    <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>,    <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>,
 150        <STRONG>system(3)</STRONG>, <STRONG><A HREF="scr_dump.5.html">scr_dump(5)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
 151
 152
 153
 154 ncurses 6.5                       2024-06-01                 <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>
 155 </PRE>
 156 <div class="nav">
 157 <ul>
 158 <li><a href="#h2-NAME">NAME</a></li>
 159 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 160 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
 161 <ul>
 162 <li><a href="#h3-scr_dump">scr_dump</a></li>
 163 <li><a href="#h3-scr_restore">scr_restore</a></li>
 164 <li><a href="#h3-scr_init">scr_init</a></li>
 165 <li><a href="#h3-scr_set">scr_set</a></li>
 166 </ul>
 167 </li>
 168 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 169 <li><a href="#h2-NOTES">NOTES</a></li>
 170 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 171 <li><a href="#h2-HISTORY">HISTORY</a></li>
 172 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 173 </ul>
 174 </div>
 175 </BODY>
 176 </HTML>