doc/html/man/legacy_coding.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2020-2023,2024 Thomas E. Dickey                                *
   4   * Copyright 2005-2016,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   * Author: Thomas E. Dickey
  31   * @Id: legacy_coding.3x,v 1.28 2024/04/20 19:13:50 tom Exp @
  32 -->
  33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  34 <HTML>
  35 <HEAD>
  36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  38 <TITLE>legacy_coding 3x 2024-04-20 ncurses 6.4 Library calls</TITLE>
  39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  40
  41 </HEAD>
  42 <BODY>
  43 <H1 class="no-header">legacy_coding 3x 2024-04-20 ncurses 6.4 Library calls</H1>
  44 <PRE>
  45 <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>                Library calls               <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>
  46
  47
  48
  49
  50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>use_legacy_coding</STRONG> - override <EM>curses</EM> locale encoding checks
  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>use_legacy_coding(int</STRONG> <EM>level</EM><STRONG>);</STRONG>
  58
  59
  60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  61        <STRONG>use_legacy_coding</STRONG> is an extension to the <EM>curses</EM> library.  It allows the
  62        caller to change the result of <STRONG><A HREF="unctrl.3x.html">unctrl(3x)</A></STRONG>, suppressing <STRONG>isprint(3)</STRONG>-based
  63        checks  within  the  library  that  would  normally  cause  nonprinting
  64        characters to be rendered in visible form.  The alteration affects only
  65        eight-bit characters.
  66
  67        The <EM>level</EM> parameter controls the result.
  68
  69               <STRONG>0</STRONG>    The   library  functions  normally,  rendering  nonprinting
  70                    characters as described in <STRONG><A HREF="unctrl.3x.html">unctrl(3x)</A></STRONG>,
  71
  72               <STRONG>1</STRONG>    the library ignores <EM>isprint</EM> for codes in the range 160-255.
  73
  74               <STRONG>2</STRONG>    the library ignores <EM>isprint</EM> for codes in the range 128-255.
  75                    It also modifies the output of <STRONG><A HREF="unctrl.3x.html">unctrl(3x)</A></STRONG>, showing codes in
  76                    the range 128-159 as is.
  77
  78
  79 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  80        If the screen has not been initialized, or the <EM>level</EM> parameter  is  out
  81        of  range,  <STRONG>use_legacy_coding</STRONG>  returns  <STRONG>ERR</STRONG>.  Otherwise, it returns the
  82        previous level: <STRONG>0</STRONG>, <STRONG>1</STRONG>, or <STRONG>2</STRONG>.
  83
  84
  85 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  86        <STRONG>use_legacy_coding</STRONG> is specific to <EM>ncurses</EM>.   It  was  not  supported  on
  87        Version  7,  BSD  or  System V implementations.  Applications employing
  88        <EM>ncurses</EM> extensions should condition their use on the visibility of  the
  89        <STRONG>NCURSES_VERSION</STRONG> preprocessor macro.
  90
  91
  92 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
  93        Thomas Dickey (to support <STRONG>lynx(1)</STRONG>'s font-switching feature).
  94
  95
  96 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  97        <STRONG><A HREF="unctrl.3x.html">unctrl(3x)</A></STRONG>
  98
  99
 100
 101 ncurses 6.4                       2024-04-20                 <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>
 102 </PRE>
 103 <div class="nav">
 104 <ul>
 105 <li><a href="#h2-NAME">NAME</a></li>
 106 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 107 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 108 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 109 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 110 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 111 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 112 </ul>
 113 </div>
 114 </BODY>
 115 </HTML>