From eb51b1ea1f75a0ec17c9c5937cb28df1e8eeec56 Mon Sep 17 00:00:00 2001 From: "Thomas E. Dickey" Date: Sun, 9 Apr 2023 00:08:25 +0000 Subject: [PATCH] ncurses 6.4 - patch 20230408 + document limitations of tparm, and error-returns in curs_terminfo.3x + document limitations of tgoto, and error-returns in curs_termcap.3x + add xterm+focus to alacritty+common (patch by Christian Duerr). + add "-v" option to tput, to show warnings. > improve checks for malformed terminfo data (report/analysis by Jonathan Bar Or, Michael Pearse, Emanuele Cozzi). + make the parameter type/count checks in _nc_tiparm() more stringent + update tgoto() to account for _nc_tiparm() changes + add checks in tparm() and tiparm() for misuse of string parameters + add special cases in tput to handle extensions Cs/Ms parameters + ignore compiled-terminfo where the array sizes exceed the standard --- NEWS | 15 ++- VERSION | 2 +- dist.mk | 4 +- doc/html/man/adacurses6-config.1.html | 2 +- doc/html/man/captoinfo.1m.html | 2 +- doc/html/man/clear.1.html | 2 +- doc/html/man/curs_termcap.3x.html | 141 +++++++++++++++----------- doc/html/man/curs_terminfo.3x.html | 41 +++++++- doc/html/man/form.3x.html | 2 +- doc/html/man/infocmp.1m.html | 2 +- doc/html/man/infotocap.1m.html | 2 +- doc/html/man/menu.3x.html | 2 +- doc/html/man/ncurses.3x.html | 2 +- doc/html/man/ncurses6-config.1.html | 2 +- doc/html/man/panel.3x.html | 2 +- doc/html/man/tabs.1.html | 2 +- doc/html/man/terminfo.5.html | 2 +- doc/html/man/tic.1m.html | 2 +- doc/html/man/toe.1m.html | 2 +- doc/html/man/tput.1.html | 2 +- doc/html/man/tset.1.html | 2 +- man/curs_termcap.3x | 26 ++++- man/curs_terminfo.3x | 41 +++++++- misc/terminfo.src | 9 +- ncurses/tinfo/lib_tgoto.c | 14 ++- ncurses/tinfo/lib_tparm.c | 120 +++++++++++++++++++--- ncurses/tinfo/read_entry.c | 7 +- package/debian-mingw/changelog | 4 +- package/debian-mingw64/changelog | 4 +- package/debian/changelog | 4 +- package/mingw-ncurses.nsi | 4 +- package/mingw-ncurses.spec | 2 +- package/ncurses.spec | 2 +- package/ncursest.spec | 2 +- progs/tic.c | 10 +- progs/tparm_type.c | 13 ++- progs/tparm_type.h | 6 +- progs/tput.c | 61 +++++++++-- 38 files changed, 427 insertions(+), 137 deletions(-) diff --git a/NEWS b/NEWS index f3b7e0c2..964fb643 100644 --- a/NEWS +++ b/NEWS @@ -26,7 +26,7 @@ -- sale, use or other dealings in this Software without prior written -- -- authorization. -- ------------------------------------------------------------------------------- --- $Id: NEWS,v 1.3923 2023/04/01 23:29:48 tom Exp $ +-- $Id: NEWS,v 1.3929 2023/04/08 22:24:09 tom Exp $ ------------------------------------------------------------------------------- This is a log of changes that ncurses has gone through since Zeyd started @@ -46,6 +46,19 @@ See the AUTHORS file for the corresponding full names. Changes through 1.9.9e did not credit all contributions; it is not possible to add this information. +20230408 + + document limitations of tparm, and error-returns in curs_terminfo.3x + + document limitations of tgoto, and error-returns in curs_termcap.3x + + add xterm+focus to alacritty+common (patch by Christian Duerr). + + add "-v" option to tput, to show warnings. + > improve checks for malformed terminfo data (report/analysis by + Jonathan Bar Or, Michael Pearse, Emanuele Cozzi). + + make the parameter type/count checks in _nc_tiparm() more stringent + + update tgoto() to account for _nc_tiparm() changes + + add checks in tparm() and tiparm() for misuse of string parameters + + add special cases in tput to handle extensions Cs/Ms parameters + + ignore compiled-terminfo where the array sizes exceed the standard + 20230401 + modify experimental Windows driver to work with xterm mouse protocol. + remove DECCOLM+DECSCLM from foot (patch by Daniel Ekloef). diff --git a/VERSION b/VERSION index 34c01e4d..78269eab 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -5:0:10 6.4 20230401 +5:0:10 6.4 20230408 diff --git a/dist.mk b/dist.mk index d0c7cd8b..99a74f8c 100644 --- a/dist.mk +++ b/dist.mk @@ -26,7 +26,7 @@ # use or other dealings in this Software without prior written # # authorization. # ############################################################################## -# $Id: dist.mk,v 1.1533 2023/04/01 11:05:21 tom Exp $ +# $Id: dist.mk,v 1.1534 2023/04/08 13:33:20 tom Exp $ # Makefile for creating ncurses distributions. # # This only needs to be used directly as a makefile by developers, but @@ -38,7 +38,7 @@ SHELL = /bin/sh # These define the major/minor/patch versions of ncurses. NCURSES_MAJOR = 6 NCURSES_MINOR = 4 -NCURSES_PATCH = 20230401 +NCURSES_PATCH = 20230408 # We don't append the patch to the version, since this only applies to releases VERSION = $(NCURSES_MAJOR).$(NCURSES_MINOR) diff --git a/doc/html/man/adacurses6-config.1.html b/doc/html/man/adacurses6-config.1.html index b699b0b5..fe563fe2 100644 --- a/doc/html/man/adacurses6-config.1.html +++ b/doc/html/man/adacurses6-config.1.html @@ -126,7 +126,7 @@

SEE ALSO

        curses(3x)
 
-       This describes ncurses version 6.4 (patch 20230311).
+       This describes ncurses version 6.4 (patch 20230408).
 
 
 
diff --git a/doc/html/man/captoinfo.1m.html b/doc/html/man/captoinfo.1m.html
index d7c30af4..2c914951 100644
--- a/doc/html/man/captoinfo.1m.html
+++ b/doc/html/man/captoinfo.1m.html
@@ -199,7 +199,7 @@
 

SEE ALSO

        infocmp(1m), curses(3x), terminfo(5)
 
-       This describes ncurses version 6.4 (patch 20230311).
+       This describes ncurses version 6.4 (patch 20230408).
 
 
 

AUTHOR

diff --git a/doc/html/man/clear.1.html b/doc/html/man/clear.1.html
index 30ec2052..243d57ed 100644
--- a/doc/html/man/clear.1.html
+++ b/doc/html/man/clear.1.html
@@ -150,7 +150,7 @@
 

SEE ALSO

        tput(1), terminfo(5), xterm(1).
 
-       This describes ncurses version 6.4 (patch 20230311).
+       This describes ncurses version 6.4 (patch 20230408).
 
 
 
diff --git a/doc/html/man/curs_termcap.3x.html b/doc/html/man/curs_termcap.3x.html
index 9cd555ec..32699b3c 100644
--- a/doc/html/man/curs_termcap.3x.html
+++ b/doc/html/man/curs_termcap.3x.html
@@ -1,6 +1,6 @@
 
 
 
@@ -148,27 +148,32 @@
            first parameter is merely a placeholder.
 
        o   Normally the ncurses library is compiled with terminfo support.  In
-           that case, tgoto uses tparm(3x) (a more capable formatter).
+           that  case, tgoto uses an internal version of tparm(3x) (a more ca-
+           pable formatter).
 
-           However,  tparm  is not a termcap feature, and portable termcap ap-
+           With terminfo support, tgoto is able to use some  of  the  terminfo
+           features,  but  not all.  In particular, it allows only numeric pa-
+           rameters; tparm supports string parameters.
+
+           However, tparm is not a termcap feature, and portable  termcap  ap-
            plications should not rely upon its availability.
 
-       The tputs routine is described on the  curs_terminfo(3x)  manual  page.
+       The  tputs  routine  is described on the curs_terminfo(3x) manual page.
        It can retrieve capabilities by either termcap or terminfo name.
 
 
 

Global Variables

-       The  variables PC, UP and BC are set by tgetent to the terminfo entry's
+       The variables PC, UP and BC are set by tgetent to the terminfo  entry's
        data for pad_char, cursor_up and backspace_if_not_bs, respectively.  UP
-       is  not used by ncurses.  PC is used in the tdelay_output function.  BC
-       is used in the tgoto emulation.  The variable ospeed is set by  ncurses
+       is not used by ncurses.  PC is used in the tdelay_output function.   BC
+       is  used in the tgoto emulation.  The variable ospeed is set by ncurses
        in a system-specific coding to reflect the terminal speed.
 
 
 

Releasing Memory

-       The  termcap  functions  provide  no  means for freeing memory, because
-       legacy termcap implementations used only the buffer areas  provided  by
-       the  caller  via tgetent and tgetstr.  Those buffers are unused in ter-
+       The termcap functions provide no  means  for  freeing  memory,  because
+       legacy  termcap  implementations used only the buffer areas provided by
+       the caller via tgetent and tgetstr.  Those buffers are unused  in  ter-
        minfo.
 
        On the other hand, terminfo allocates memory.  It uses setupterm to re-
@@ -178,41 +183,55 @@
             del_curterm(cur_term);
 
 
-       to free this memory, but  there  is  an  additional  complication  with
-       ncurses.   It uses a fixed-size pool of storage locations, one per set-
-       ting of the TERM variable when tgetent is called.  The  screen(1)  pro-
+       to  free  this  memory,  but  there  is an additional complication with
+       ncurses.  It uses a fixed-size pool of storage locations, one per  set-
+       ting  of  the TERM variable when tgetent is called.  The screen(1) pro-
        gram relies upon this arrangement, to improve its performance.
 
-       An  application  which  uses only the low-level termcap functions could
+       An application which uses only the low-level  termcap  functions  could
        free the memory using del_curterm, because the pool is freed using oth-
        er functions (see curs_memleaks(3x)).
 
 
 

RETURN VALUE

-       Except  where  explicitly noted, routines that return an integer return
-       ERR upon failure and OK (SVr4 only specifies "an  integer  value  other
+       Except where explicitly noted, routines that return an  integer  return
+       ERR  upon  failure  and OK (SVr4 only specifies "an integer value other
        than ERR") upon successful completion.
 
        Routines that return pointers return NULL on error.
 
+       A few special cases apply:
+
+       o   If the terminal database has not been initialized, these return  an
+           error.
+
+       o   The  calls  with  a  string  parameter  (tgoto, tputs) check if the
+           string is null, or cancelled.  Those return an error.
+
+       o   A call to tgoto using a capability with string parameters is an er-
+           ror.
+
+       o   A call to tgoto using a capability with no parameters, or more than
+           two is an error.
+
 
 

BUGS

-       If  you  call tgetstr to fetch ca or any other parameterized string, be
-       aware that it will be returned in terminfo notation, not the older  and
+       If you call tgetstr to fetch ca or any other parameterized  string,  be
+       aware  that it will be returned in terminfo notation, not the older and
        not-quite-compatible termcap notation.  This will not cause problems if
-       all you do with it is call tgoto or tparm, which both expand  terminfo-
-       style  strings as terminfo.  (The tgoto function, if configured to sup-
-       port termcap, will check if the  string  is  indeed  terminfo-style  by
-       looking  for  "%p"  parameters or "$<..>" delays, and invoke a termcap-
+       all  you do with it is call tgoto or tparm, which both expand terminfo-
+       style strings as terminfo.  (The tgoto function, if configured to  sup-
+       port  termcap,  will  check  if  the string is indeed terminfo-style by
+       looking for "%p" parameters or "$<..>" delays, and  invoke  a  termcap-
        style parser if the string does not appear to be terminfo).
 
-       Because terminfo conventions for representing padding in  string  capa-
+       Because  terminfo  conventions for representing padding in string capa-
        bilities differ from termcap's, users can be surprised:
 
        o   tputs("50") in a terminfo system will put out a literal "50" rather
            than busy-waiting for 50 milliseconds.
 
-       o   However, if ncurses is configured to support termcap, it  may  also
+       o   However,  if  ncurses is configured to support termcap, it may also
            have been configured to support the BSD-style padding.
 
            In that case, tputs inspects strings passed to it, looking for dig-
@@ -221,9 +240,9 @@
            tputs("50") in a termcap system may wait for 50 milliseconds rather
            than put out a literal "50"
 
-       Note  that termcap has nothing analogous to terminfo's sgr string.  One
-       consequence of this is that termcap applications  assume  me  (terminfo
-       sgr0)  does not reset the alternate character set.  This implementation
+       Note that termcap has nothing analogous to terminfo's sgr string.   One
+       consequence  of  this  is that termcap applications assume me (terminfo
+       sgr0) does not reset the alternate character set.  This  implementation
        checks for, and modifies the data shown to the termcap interface to ac-
        commodate termcap's limitation in this respect.
 
@@ -231,22 +250,22 @@
 

PORTABILITY

 
 

Standards

-       These  functions  are  provided for supporting legacy applications, and
+       These functions are provided for supporting  legacy  applications,  and
        should not be used in new programs:
 
        o   The XSI Curses standard, Issue 4 describes these functions.  Howev-
-           er,  they  are  marked TO BE WITHDRAWN and may be removed in future
+           er, they are marked TO BE WITHDRAWN and may be  removed  in  future
            versions.
 
        o   X/Open Curses, Issue 5 (December 2007) marked the termcap interface
            (along with vwprintw and vwscanw) as withdrawn.
 
-       Neither  the  XSI Curses standard nor the SVr4 man pages documented the
-       return values of tgetent correctly, though all three were in  fact  re-
-       turned  ever  since SVr1.  In particular, an omission in the XSI Curses
-       documentation has been misinterpreted to mean that tgetent  returns  OK
-       or  ERR.  Because the purpose of these functions is to provide compati-
-       bility with the termcap library, that is a defect in XCurses, Issue  4,
+       Neither the XSI Curses standard nor the SVr4 man pages  documented  the
+       return  values  of tgetent correctly, though all three were in fact re-
+       turned ever since SVr1.  In particular, an omission in the  XSI  Curses
+       documentation  has  been misinterpreted to mean that tgetent returns OK
+       or ERR.  Because the purpose of these functions is to provide  compati-
+       bility  with the termcap library, that is a defect in XCurses, Issue 4,
        Version 2 rather than in ncurses.
 
 
@@ -254,68 +273,68 @@
        External variables are provided for support of certain termcap applica-
        tions.  However, termcap applications' use of those variables is poorly
        documented, e.g., not distinguishing between input and output.  In par-
-       ticular, some applications are reported to declare  and/or  modify  os-
+       ticular,  some  applications  are reported to declare and/or modify os-
        peed.
 
-       The  comment that only the first two characters of the id parameter are
+       The comment that only the first two characters of the id parameter  are
        used escapes many application developers.  The original BSD 4.2 termcap
        library (and historical relics thereof) did not require a trailing null
-       NUL on the parameter name passed  to  tgetstr,  tgetnum  and  tgetflag.
-       Some  applications  assume  that the termcap interface does not require
+       NUL  on  the  parameter  name  passed to tgetstr, tgetnum and tgetflag.
+       Some applications assume that the termcap interface  does  not  require
        the trailing NUL for the parameter name.  Taking into account these is-
        sues:
 
-       o   As  a  special  case,  tgetflag  matched against a single-character
-           identifier provided that was at the end of  the  terminal  descrip-
+       o   As a special case,  tgetflag  matched  against  a  single-character
+           identifier  provided  that  was at the end of the terminal descrip-
            tion.  You should not rely upon this behavior in portable programs.
-           This implementation disallows matches against single-character  ca-
+           This  implementation disallows matches against single-character ca-
            pability names.
 
-       o   This  implementation  disallows  matches  by  the termcap interface
+       o   This implementation disallows  matches  by  the  termcap  interface
            against extended capability names which are longer than two charac-
            ters.
 
        The BSD termcap function tgetent returns the text of a termcap entry in
-       the buffer passed as an argument.  This library  (like  other  terminfo
+       the  buffer  passed  as an argument.  This library (like other terminfo
        implementations) does not store terminal descriptions as text.  It sets
        the buffer contents to a null-terminated string.
 
 
 

Other Compatibility

-       This library includes a termcap.h header, for compatibility with  other
-       implementations.   But  the header is rarely used because the other im-
+       This  library includes a termcap.h header, for compatibility with other
+       implementations.  But the header is rarely used because the  other  im-
        plementations are not strictly compatible.
 
        The original BSD termcap (through 4.3BSD) had no header file which gave
        function prototypes, because that was a feature of ANSI C.  BSD termcap
-       was written several years before C was  standardized.   However,  there
+       was  written  several  years before C was standardized.  However, there
        were two different termcap.h header files in the BSD sources:
 
-       o   One  was used internally by the jove editor in 2BSD through 4.4BSD.
+       o   One was used internally by the jove editor in 2BSD through  4.4BSD.
            It defined global symbols for the termcap variables which it used.
 
-       o   The other appeared in 4.4BSD Lite Release 2 (mid-1993) as  part  of
+       o   The  other  appeared in 4.4BSD Lite Release 2 (mid-1993) as part of
            libedit (also known as the editline library).  The CSRG source his-
-           tory shows that this was added in  mid-1992.   The  libedit  header
-           file  was used internally, as a convenience for compiling the edit-
+           tory  shows  that  this  was added in mid-1992.  The libedit header
+           file was used internally, as a convenience for compiling the  edit-
            line library.  It declared function prototypes, but no global vari-
            ables.
 
-       The  header  file from libedit was added to NetBSD's termcap library in
+       The header file from libedit was added to NetBSD's termcap  library  in
        mid-1994.
 
-       Meanwhile, GNU termcap was under development, starting  in  1990.   The
-       first  release  (termcap 1.0) in 1991 included a termcap.h header.  The
-       second release (termcap 1.1) in September 1992 modified the  header  to
+       Meanwhile,  GNU  termcap  was under development, starting in 1990.  The
+       first release (termcap 1.0) in 1991 included a termcap.h  header.   The
+       second  release  (termcap 1.1) in September 1992 modified the header to
        use const for the function prototypes in the header where one would ex-
-       pect the parameters to be read-only.  This was a difference versus  the
-       original  BSD  termcap.   The prototype for tputs also differed, but in
+       pect  the parameters to be read-only.  This was a difference versus the
+       original BSD termcap.  The prototype for tputs also  differed,  but  in
        that instance, it was libedit which differed from BSD termcap.
 
        A copy of GNU termcap 1.3 was bundled with bash in mid-1993, to support
        the readline(3) library.
 
-       A  termcap.h  file was provided in ncurses 1.8.1 (November 1993).  That
+       A termcap.h file was provided in ncurses 1.8.1 (November  1993).   That
        reflected influence by emacs(1) (rather than jove(1)) and GNU termcap:
 
        o   it provided declarations for a few global symbols used by emacs
@@ -325,8 +344,8 @@
        o   a prototype for tparam (a GNU termcap feature) was provided.
 
        Later (in mid-1996) the tparam function was removed from ncurses.  As a
-       result,  there are differences between any of the four implementations,
-       which must be taken into account by programs which can  work  with  all
+       result, there are differences between any of the four  implementations,
+       which  must  be  taken into account by programs which can work with all
        termcap library interfaces.
 
 
diff --git a/doc/html/man/curs_terminfo.3x.html b/doc/html/man/curs_terminfo.3x.html
index c50d7db3..480cafce 100644
--- a/doc/html/man/curs_terminfo.3x.html
+++ b/doc/html/man/curs_terminfo.3x.html
@@ -1,6 +1,6 @@