ncurses 6.0 - patch 20170114
[ncurses.git] / ncurses / tinfo / lib_tputs.c
index d3fd46276e6ef7a443b240eefa71f82e6ec01f71..0d5cb5c654f119e3c4614886b10e788a296558b3 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
 /****************************************************************************
- * Copyright (c) 1998 Free Software Foundation, Inc.                        *
+ * Copyright (c) 1998-2015,2016 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            *
  *                                                                          *
  * Permission is hereby granted, free of charge, to any person obtaining a  *
  * copy of this software and associated documentation files (the            *
 /****************************************************************************
  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
 /****************************************************************************
  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
+ *     and: Thomas E. Dickey                        1996-on                 *
+ *     and: Juergen Pfeifer                         2009                    *
  ****************************************************************************/
 
  ****************************************************************************/
 
-
 /*
  *     tputs.c
  *             delay_output()
 /*
  *     tputs.c
  *             delay_output()
  */
 
 #include <curses.priv.h>
  */
 
 #include <curses.priv.h>
+
+#ifndef CUR
+#define CUR SP_TERMTYPE
+#endif
+
 #include <ctype.h>
 #include <ctype.h>
-#include <term.h>      /* padding_baud_rate, xon_xoff */
-#include <termcap.h>   /* ospeed */
+#include <termcap.h>           /* ospeed */
 #include <tic.h>
 
 #include <tic.h>
 
-MODULE_ID("$Id: lib_tputs.c,v 1.41 1999/10/22 23:31:24 tom Exp $")
+MODULE_ID("$Id: lib_tputs.c,v 1.99 2016/12/17 20:47:21 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 */
 
 
-char PC;               /* used by termcap library */
-speed_t ospeed;                /* used by termcap library */
+#if NCURSES_NO_PADDING
+NCURSES_EXPORT(void)
+_nc_set_no_padding(SCREEN *sp)
+{
+    bool no_padding = (getenv("NCURSES_NO_PADDING") != 0);
+
+    if (sp)
+       sp->_no_padding = no_padding;
+    else
+       _nc_prescreen._no_padding = no_padding;
 
 
-int _nc_nulls_sent;    /* used by 'tack' program */
+    TR(TRACE_CHARPUT | TRACE_MOVE, ("padding will%s be used",
+                                   GetNoPadding(sp) ? " not" : ""));
+}
+#endif
 
 
-static int (*my_outch)(int c) = _nc_outch;
+#if NCURSES_SP_FUNCS
+#define SetOutCh(func) if (SP_PARM) SP_PARM->_outch = func; else _nc_prescreen._outch = func
+#define GetOutCh()     (SP_PARM ? SP_PARM->_outch : _nc_prescreen._outch)
+#else
+#define SetOutCh(func) static_outch = func
+#define GetOutCh()     static_outch
+static NCURSES_SP_OUTC static_outch = NCURSES_SP_NAME(_nc_outch);
+#endif
 
 
-int delay_output(int ms)
+NCURSES_EXPORT(int)
+NCURSES_SP_NAME(delay_output) (NCURSES_SP_DCLx int ms)
 {
 {
-       T((T_CALLED("delay_output(%d)"), ms));
+    T((T_CALLED("delay_output(%p,%d)"), (void *) SP_PARM, ms));
 
 
-       if (no_pad_char)
-               napms(ms);
-       else {
-               register int    nullcount;
+    if (!HasTInfoTerminal(SP_PARM))
+       returnCode(ERR);
 
 
-               nullcount = (ms * _nc_baudrate(ospeed)) / 10000;
-               for (_nc_nulls_sent += nullcount; nullcount > 0; nullcount--)
-                       my_outch(PC);
-               if (my_outch == _nc_outch)
-                       _nc_flush();
+    if (no_pad_char) {
+       NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
+       napms(ms);
+    } else {
+       NCURSES_SP_OUTC my_outch = GetOutCh();
+       register int nullcount;
+
+       nullcount = (ms * _nc_baudrate(ospeed)) / (BAUDBYTE * 1000);
+       for (_nc_nulls_sent += nullcount; nullcount > 0; nullcount--)
+           my_outch(NCURSES_SP_ARGx PC);
+       if (my_outch == NCURSES_SP_NAME(_nc_outch))
+           NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
+    }
+
+    returnCode(OK);
+}
+
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(int)
+delay_output(int ms)
+{
+    return NCURSES_SP_NAME(delay_output) (CURRENT_SCREEN, ms);
+}
+#endif
+
+NCURSES_EXPORT(void)
+NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_DCL0)
+{
+    if (SP_PARM != 0 && SP_PARM->_ofd >= 0) {
+       if (SP_PARM->out_inuse) {
+           char *buf = SP_PARM->out_buffer;
+           size_t amount = SP->out_inuse;
+
+           SP->out_inuse = 0;
+           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 {
+       fflush(stdout);
+    }
+}
 
 
-       returnCode(OK);
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(void)
+_nc_flush(void)
+{
+    NCURSES_SP_NAME(_nc_flush) (CURRENT_SCREEN);
 }
 }
+#endif
 
 
-int _nc_outch(int ch)
+NCURSES_EXPORT(int)
+NCURSES_SP_NAME(_nc_outch) (NCURSES_SP_DCLx int ch)
 {
 {
-#ifdef TRACE
-       _nc_outchars++;
-#endif /* TRACE */
+    int rc = OK;
+
+    COUNT_OUTCHARS(1);
 
 
-       if (SP != 0
-        && SP->_cleanup) {
-               char tmp = ch;
-               /*
-                * POSIX says write() is safe in a signal handler, but the
-                * buffered I/O is not.
-                */
-               write(fileno(NC_OUTPUT), &tmp, 1);
+    if (HasTInfoTerminal(SP_PARM)
+       && 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 {
        } else {
-               putc(ch, NC_OUTPUT);
+           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;
        }
        }
-       return OK;
+    } else {
+       char tmp = (char) ch;
+       if (write(fileno(stdout), &tmp, (size_t) 1) == -1)
+           rc = ERR;
+    }
+    return rc;
+}
+
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(int)
+_nc_outch(int ch)
+{
+    return NCURSES_SP_NAME(_nc_outch) (CURRENT_SCREEN, 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_putchar));
 }
 
 }
 
-int putp(const char *string)
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(int)
+putp(const char *string)
 {
 {
-       return tputs(string, 1, _nc_outch);
+    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,
+                          const char *string)
+{
+    int rc = ERR;
+
+    if (string != 0) {
+       TPUTS_TRACE(name);
+       rc = NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
+                                    string, 1, NCURSES_SP_NAME(_nc_outch));
+    }
+    return rc;
+}
+
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(int)
+_nc_putp(const char *name, const char *string)
+{
+    return NCURSES_SP_NAME(_nc_putp) (CURRENT_SCREEN, name, string);
+}
+#endif
 
 
-int tputs(const char *string, int affcnt, int (*outc)(int))
+NCURSES_EXPORT(int)
+NCURSES_SP_NAME(tputs) (NCURSES_SP_DCLx
+                       const char *string,
+                       int affcnt,
+                       NCURSES_SP_OUTC outc)
 {
 {
-bool   always_delay;
-bool   normal_delay;
-int    number;
-#ifdef BSD_TPUTS
-int    trailpad;
+    NCURSES_SP_OUTC my_outch = GetOutCh();
+    bool always_delay;
+    bool normal_delay;
+    int number;
+#if BSD_TPUTS
+    int trailpad;
 #endif /* BSD_TPUTS */
 
 #ifdef TRACE
 #endif /* BSD_TPUTS */
 
 #ifdef TRACE
-char   addrbuf[32];
-
-       if (_nc_tracing & TRACE_TPUTS)
-       {
-               if (outc == _nc_outch)
-                       (void) strcpy(addrbuf, "_nc_outch");
-               else
-                       (void) sprintf(addrbuf, "%p", outc);
-               if (_nc_tputs_trace) {
-                       TR(TRACE_MAXIMUM, ("tputs(%s = %s, %d, %s) called", _nc_tputs_trace, _nc_visbuf(string), affcnt, addrbuf));
-               }
-               else {
-                       TR(TRACE_MAXIMUM, ("tputs(%s, %d, %s) called", _nc_visbuf(string), affcnt, addrbuf));
-               }
-               _nc_tputs_trace = (char *)NULL;
+    if (USE_TRACEF(TRACE_TPUTS)) {
+       char addrbuf[32];
+
+       if (outc == NCURSES_SP_NAME(_nc_outch))
+           _nc_STRCPY(addrbuf, "_nc_outch", sizeof(addrbuf));
+       else
+           _nc_SPRINTF(addrbuf, _nc_SLIMIT(sizeof(addrbuf)) "%p", TR_FUNC(outc));
+       if (_nc_tputs_trace) {
+           _tracef("tputs(%s = %s, %d, %s) called", _nc_tputs_trace,
+                   _nc_visbuf(string), affcnt, addrbuf);
+       } else {
+           _tracef("tputs(%s, %d, %s) called", _nc_visbuf(string), affcnt, addrbuf);
        }
        }
+       TPUTS_TRACE(NULL);
+       _nc_unlock_global(tracef);
+    }
 #endif /* TRACE */
 #endif /* TRACE */
-       
-       if (!VALID_STRING(string))
-               return ERR;
 
 
-       if (cur_term == 0) {
-               always_delay = FALSE;
-               normal_delay = TRUE;
-       } else {
-               always_delay = (string == bell) || (string == flash_screen);
-               normal_delay =
-                !xon_xoff
-                && padding_baud_rate
-#ifdef NCURSES_NO_PADDING
-                && (SP == 0 || !(SP->_no_padding))
+    if (SP_PARM != 0 && !HasTInfoTerminal(SP_PARM))
+       return ERR;
+
+    if (!VALID_STRING(string))
+       return ERR;
+
+    if (
+#if NCURSES_SP_FUNCS
+          (SP_PARM != 0 && SP_PARM->_term == 0)
+#else
+          cur_term == 0
 #endif
 #endif
-                && (_nc_baudrate(ospeed) >= 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)
+#endif
+           && (_nc_baudrate(ospeed) >= padding_baud_rate);
+    }
+
+#if BSD_TPUTS
+    /*
+     * This ugly kluge deals with the fact that some ancient BSD programs
+     * (like nethack) actually do the likes of tputs("50") to get delays.
+     */
+    trailpad = 0;
+    if (isdigit(UChar(*string))) {
+       while (isdigit(UChar(*string))) {
+           trailpad = trailpad * 10 + (*string - '0');
+           string++;
+       }
+       trailpad *= 10;
+       if (*string == '.') {
+           string++;
+           if (isdigit(UChar(*string))) {
+               trailpad += (*string - '0');
+               string++;
+           }
+           while (isdigit(UChar(*string)))
+               string++;
        }
 
        }
 
-#ifdef BSD_TPUTS
-       /*
-        * This ugly kluge deals with the fact that some ancient BSD programs
-        * (like nethack) actually do the likes of tputs("50") to get delays.
-        */
-       trailpad = 0;
-       if (isdigit(*string)) {
-               while (isdigit(*string)) {
-                       trailpad = trailpad * 10 + (*string - '0');
-                       string++;
+       if (*string == '*') {
+           trailpad *= affcnt;
+           string++;
+       }
+    }
+#endif /* BSD_TPUTS */
+
+    SetOutCh(outc);            /* redirect delay_output() */
+    while (*string) {
+       if (*string != '$')
+           (*outc) (NCURSES_SP_ARGx *string);
+       else {
+           string++;
+           if (*string != '<') {
+               (*outc) (NCURSES_SP_ARGx '$');
+               if (*string)
+                   (*outc) (NCURSES_SP_ARGx *string);
+           } else {
+               bool mandatory;
+
+               string++;
+               if ((!isdigit(UChar(*string)) && *string != '.')
+                   || !strchr(string, '>')) {
+                   (*outc) (NCURSES_SP_ARGx '$');
+                   (*outc) (NCURSES_SP_ARGx '<');
+                   continue;
                }
                }
-               trailpad *= 10;
+
+               number = 0;
+               while (isdigit(UChar(*string))) {
+                   number = number * 10 + (*string - '0');
+                   string++;
+               }
+               number *= 10;
                if (*string == '.') {
                if (*string == '.') {
+                   string++;
+                   if (isdigit(UChar(*string))) {
+                       number += (*string - '0');
+                       string++;
+                   }
+                   while (isdigit(UChar(*string)))
                        string++;
                        string++;
-                       if (isdigit(*string)) {
-                               trailpad += (*string - '0');
-                               string++;
-                       }
-                       while (isdigit(*string))
-                               string++;
                }
 
                }
 
-               if (*string == '*') {
-                       trailpad *= affcnt;
+               mandatory = FALSE;
+               while (*string == '*' || *string == '/') {
+                   if (*string == '*') {
+                       number *= affcnt;
                        string++;
                        string++;
+                   } else {    /* if (*string == '/') */
+                       mandatory = TRUE;
+                       string++;
+                   }
                }
                }
-       }
-#endif /* BSD_TPUTS */
 
 
-       my_outch = outc;        /* redirect delay_output() */
-       while (*string) {
-               if (*string != '$')
-                       (*outc)(*string);
-               else {
-                       string++;
-                       if (*string != '<') {
-                               (*outc)('$');
-                               if (*string)
-                                   (*outc)(*string);
-                       } else {
-                               bool mandatory;
-
-                               string++;
-                               if ((!isdigit(*string) && *string != '.') || !strchr(string, '>')) {
-                                       (*outc)('$');
-                                       (*outc)('<');
-                                       continue;
-                               }
-
-                               number = 0;
-                               while (isdigit(*string)) {
-                                       number = number * 10 + (*string - '0');
-                                       string++;
-                               }
-                               number *= 10;
-                               if (*string == '.') {
-                                       string++;
-                                       if (isdigit(*string)) {
-                                               number += (*string - '0');
-                                               string++;
-                                       }
-                                       while (isdigit(*string))
-                                               string++;
-                               }
-
-                               mandatory = FALSE;
-                               while (*string == '*' || *string == '/')
-                               {
-                                       if (*string == '*') {
-                                               number *= affcnt;
-                                               string++;
-                                       }
-                                       else /* if (*string == '/') */ {
-                                               mandatory = TRUE;
-                                               string++;
-                                       }
-                               }
-
-                               if (number > 0
-                                && (always_delay
-                                 || normal_delay
-                                 || mandatory))
-                                       delay_output(number/10);
-
-                       } /* endelse (*string == '<') */
-               } /* endelse (*string == '$') */
-
-               if (*string == '\0')
-                       break;
+               if (number > 0
+                   && (always_delay
+                       || normal_delay
+                       || mandatory))
+                   NCURSES_SP_NAME(delay_output) (NCURSES_SP_ARGx number / 10);
 
 
-               string++;
-       }
+           }                   /* endelse (*string == '<') */
+       }                       /* endelse (*string == '$') */
 
 
-#ifdef BSD_TPUTS
-       /*
-        * Emit any BSD-style prefix padding that we've accumulated now.
-        */
-       if (trailpad > 0
-        && (always_delay || normal_delay))
-               delay_output(trailpad/10);
+       if (*string == '\0')
+           break;
+
+       string++;
+    }
+
+#if BSD_TPUTS
+    /*
+     * Emit any BSD-style prefix padding that we've accumulated now.
+     */
+    if (trailpad > 0
+       && (always_delay || normal_delay))
+       delay_output(trailpad / 10);
 #endif /* BSD_TPUTS */
 
 #endif /* BSD_TPUTS */
 
-       my_outch = _nc_outch;
-       return OK;
+    SetOutCh(my_outch);
+    return OK;
+}
+
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(int)
+_nc_outc_wrapper(SCREEN *sp, int c)
+{
+    if (0 == sp) {
+       return (ERR);
+    } else {
+       return sp->jump(c);
+    }
+}
+
+NCURSES_EXPORT(int)
+tputs(const char *string, int affcnt, int (*outc) (int))
+{
+    SetSafeOutcWrapper(outc);
+    return NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx string, affcnt, _nc_outc_wrapper);
 }
 }
+#endif