]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - ncurses/tinfo/lib_tputs.c
ncurses 6.4 - patch 20240414
[ncurses.git] / ncurses / tinfo / lib_tputs.c
index a61597bc198685134773649be3db6c06f2853aa1..f834532c91936f24fcfb58ef637e73e8d9a5ae1a 100644 (file)
@@ -1,5 +1,6 @@
 /****************************************************************************
- * Copyright (c) 1998-2011,2012 Free Software Foundation, Inc.              *
+ * Copyright 2018-2022,2023 Thomas E. Dickey                                *
+ * Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
  *                                                                          *
  * Permission is hereby granted, free of charge, to any person obtaining a  *
  * copy of this software and associated documentation files (the            *
 #include <termcap.h>           /* ospeed */
 #include <tic.h>
 
-MODULE_ID("$Id: lib_tputs.c,v 1.84 2012/02/22 22:40:24 tom Exp $")
+MODULE_ID("$Id: lib_tputs.c,v 1.111 2023/09/16 16:05:15 tom Exp $")
 
 NCURSES_EXPORT_VAR(char) PC = 0;              /* used by termcap library */
 NCURSES_EXPORT_VAR(NCURSES_OSPEED) ospeed = 0;        /* used by termcap library */
 
-NCURSES_EXPORT_VAR(int) _nc_nulls_sent = 0;   /* used by 'tack' program */
+NCURSES_EXPORT_VAR(int) _nc_nulls_sent = 0;
 
 #if NCURSES_NO_PADDING
 NCURSES_EXPORT(void)
@@ -88,6 +89,9 @@ NCURSES_SP_NAME(delay_output) (NCURSES_SP_DCLx int ms)
 {
     T((T_CALLED("delay_output(%p,%d)"), (void *) SP_PARM, ms));
 
+    if (ms > MAX_DELAY_MSECS)
+       ms = MAX_DELAY_MSECS;
+
     if (!HasTInfoTerminal(SP_PARM))
        returnCode(ERR);
 
@@ -119,7 +123,43 @@ delay_output(int ms)
 NCURSES_EXPORT(void)
 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_DCL0)
 {
-    (void) fflush(NC_OUTPUT(SP_PARM));
+    T((T_CALLED("_nc_flush(%p)"), (void *) SP_PARM));
+    if (SP_PARM != 0 && SP_PARM->_ofd >= 0) {
+       TR(TRACE_CHARPUT, ("ofd:%d inuse:%lu buffer:%p",
+                          SP_PARM->_ofd,
+                          (unsigned long) SP_PARM->out_inuse,
+                          SP_PARM->out_buffer));
+       if (SP_PARM->out_inuse) {
+           char *buf = SP_PARM->out_buffer;
+           size_t amount = SP_PARM->out_inuse;
+
+           TR(TRACE_CHARPUT, ("flushing %ld/%ld bytes",
+                              (unsigned long) amount, _nc_outchars));
+           while (amount) {
+               ssize_t res = write(SP_PARM->_ofd, buf, amount);
+               if (res > 0) {
+                   /* if the write was incomplete, try again */
+                   amount -= (size_t) res;
+                   buf += res;
+               } else if (errno == EAGAIN) {
+                   continue;
+               } else if (errno == EINTR) {
+                   continue;
+               } else {
+                   break;      /* an error we can not recover from */
+               }
+           }
+       } else if (SP_PARM->out_buffer == 0) {
+           TR(TRACE_CHARPUT, ("flushing stdout"));
+           fflush(stdout);
+       }
+    } else {
+       TR(TRACE_CHARPUT, ("flushing stdout"));
+       fflush(stdout);
+    }
+    if (SP_PARM != 0)
+       SP_PARM->out_inuse = 0;
+    returnVoid;
 }
 
 #if NCURSES_SP_FUNCS
@@ -138,17 +178,23 @@ NCURSES_SP_NAME(_nc_outch) (NCURSES_SP_DCLx int ch)
     COUNT_OUTCHARS(1);
 
     if (HasTInfoTerminal(SP_PARM)
-       && SP_PARM != 0
-       && SP_PARM->_cleanup) {
-       char tmp = (char) ch;
-       /*
-        * POSIX says write() is safe in a signal handler, but the
-        * buffered I/O is not.
-        */
-       if (write(fileno(NC_OUTPUT(SP_PARM)), &tmp, (size_t) 1) == -1)
-           rc = ERR;
+       && SP_PARM != 0) {
+       if (SP_PARM->out_buffer != 0) {
+           if (SP_PARM->out_inuse + 1 >= SP_PARM->out_limit)
+               NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
+           SP_PARM->out_buffer[SP_PARM->out_inuse++] = (char) ch;
+       } else {
+           char tmp = (char) ch;
+           /*
+            * POSIX says write() is safe in a signal handler, but the
+            * buffered I/O is not.
+            */
+           if (write(fileno(NC_OUTPUT(SP_PARM)), &tmp, (size_t) 1) == -1)
+               rc = ERR;
+       }
     } else {
-       if (putc(ch, NC_OUTPUT(SP_PARM)) == EOF)
+       char tmp = (char) ch;
+       if (write(fileno(stdout), &tmp, (size_t) 1) == -1)
            rc = ERR;
     }
     return rc;
@@ -162,13 +208,48 @@ _nc_outch(int ch)
 }
 #endif
 
+/*
+ * This is used for the putp special case.
+ */
+NCURSES_EXPORT(int)
+NCURSES_SP_NAME(_nc_putchar) (NCURSES_SP_DCLx int ch)
+{
+    (void) SP_PARM;
+    return putchar(ch);
+}
+
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(int)
+_nc_putchar(int ch)
+{
+    return putchar(ch);
+}
+#endif
+
+/*
+ * putp is special - per documentation it calls tputs with putchar as the
+ * parameter for outputting characters.  This means that it uses stdio, which
+ * is not signal-safe.  Applications call this entrypoint; we do not call it
+ * from within the library.
+ */
 NCURSES_EXPORT(int)
 NCURSES_SP_NAME(putp) (NCURSES_SP_DCLx const char *string)
 {
     return NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
-                                  string, 1, NCURSES_SP_NAME(_nc_outch));
+                                  string, 1, NCURSES_SP_NAME(_nc_putchar));
 }
 
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(int)
+putp(const char *string)
+{
+    return NCURSES_SP_NAME(putp) (CURRENT_SCREEN, string);
+}
+#endif
+
+/*
+ * Use these entrypoints rather than "putp" within the library.
+ */
 NCURSES_EXPORT(int)
 NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_DCLx
                           const char *name GCC_UNUSED,
@@ -178,18 +259,13 @@ NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_DCLx
 
     if (string != 0) {
        TPUTS_TRACE(name);
-       rc = NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx string);
+       rc = NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
+                                    string, 1, NCURSES_SP_NAME(_nc_outch));
     }
     return rc;
 }
 
 #if NCURSES_SP_FUNCS
-NCURSES_EXPORT(int)
-putp(const char *string)
-{
-    return NCURSES_SP_NAME(putp) (CURRENT_SCREEN, string);
-}
-
 NCURSES_EXPORT(int)
 _nc_putp(const char *name, const char *string)
 {
@@ -204,21 +280,24 @@ NCURSES_SP_NAME(tputs) (NCURSES_SP_DCLx
                        NCURSES_SP_OUTC outc)
 {
     NCURSES_SP_OUTC my_outch = GetOutCh();
-    bool always_delay;
-    bool normal_delay;
+    bool always_delay = FALSE;
+    bool normal_delay = FALSE;
     int number;
 #if BSD_TPUTS
     int trailpad;
 #endif /* BSD_TPUTS */
 
 #ifdef TRACE
-    char addrbuf[32];
-
     if (USE_TRACEF(TRACE_TPUTS)) {
-       if (outc == NCURSES_SP_NAME(_nc_outch))
+       char addrbuf[32];
+       TR_FUNC_BFR(1);
+
+       if (outc == NCURSES_SP_NAME(_nc_outch)) {
            _nc_STRCPY(addrbuf, "_nc_outch", sizeof(addrbuf));
-       else
-           _nc_SPRINTF(addrbuf, _nc_SLIMIT(sizeof(addrbuf)) "%p", outc);
+       } else {
+           _nc_SPRINTF(addrbuf, _nc_SLIMIT(sizeof(addrbuf)) "%s",
+                       TR_FUNC_ARG(0, outc));
+       }
        if (_nc_tputs_trace) {
            _tracef("tputs(%s = %s, %d, %s) called", _nc_tputs_trace,
                    _nc_visbuf(string), affcnt, addrbuf);
@@ -230,32 +309,30 @@ NCURSES_SP_NAME(tputs) (NCURSES_SP_DCLx
     }
 #endif /* TRACE */
 
-    if (SP_PARM != 0 && !HasTInfoTerminal(SP_PARM))
-       return ERR;
-
     if (!VALID_STRING(string))
        return ERR;
 
-    if (
+    if (SP_PARM != 0 && HasTInfoTerminal(SP_PARM)) {
+       if (
 #if NCURSES_SP_FUNCS
-          (SP_PARM != 0 && SP_PARM->_term == 0)
+              (SP_PARM != 0 && SP_PARM->_term == 0)
 #else
-          cur_term == 0
+              cur_term == 0
 #endif
-       ) {
-       always_delay = FALSE;
-       normal_delay = TRUE;
-    } else {
-       always_delay = (string == bell) || (string == flash_screen);
-       normal_delay =
-           !xon_xoff
-           && padding_baud_rate
+           ) {
+           always_delay = FALSE;
+           normal_delay = TRUE;
+       } else {
+           always_delay = (string == bell) || (string == flash_screen);
+           normal_delay =
+               !xon_xoff
+               && padding_baud_rate
 #if NCURSES_NO_PADDING
-           && !GetNoPadding(SP_PARM)
+               && !GetNoPadding(SP_PARM)
 #endif
-           && (_nc_baudrate(ospeed) >= padding_baud_rate);
+               && (_nc_baudrate(ospeed) >= padding_baud_rate);
+       }
     }
-
 #if BSD_TPUTS
     /*
      * This ugly kluge deals with the fact that some ancient BSD programs
@@ -354,7 +431,7 @@ NCURSES_SP_NAME(tputs) (NCURSES_SP_DCLx
      */
     if (trailpad > 0
        && (always_delay || normal_delay))
-       delay_output(trailpad / 10);
+       NCURSES_SP_NAME(delay_output) (NCURSES_SP_ARGx trailpad / 10);
 #endif /* BSD_TPUTS */
 
     SetOutCh(my_outch);
@@ -366,7 +443,7 @@ NCURSES_EXPORT(int)
 _nc_outc_wrapper(SCREEN *sp, int c)
 {
     if (0 == sp) {
-       return (ERR);
+       return fputc(c, stdout);
     } else {
        return sp->jump(c);
     }