ncurses 5.9 - patch 20141011
[ncurses.git] / ncurses / tinfo / lib_tputs.c
index f17d8382e921e6f0fcc60a8714917d6b8917214f..523678210da69211ba893501dd41ac8e6eb68090 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998,1999,2000 Free Software Foundation, Inc.              *
+ * Copyright (c) 1998-2012,2013 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            *
@@ -29,6 +29,8 @@
 /****************************************************************************
  *  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                    *
  ****************************************************************************/
 
 /*
  */
 
 #include <curses.priv.h>
+
+#ifndef CUR
+#define CUR SP_TERMTYPE
+#endif
+
 #include <ctype.h>
-#include <term.h>              /* padding_baud_rate, xon_xoff */
 #include <termcap.h>           /* ospeed */
 #include <tic.h>
 
-MODULE_ID("$Id: lib_tputs.c,v 1.47 2000/05/27 23:08:41 tom Exp $")
+MODULE_ID("$Id: lib_tputs.c,v 1.93 2013/01/12 20:57:32 tom Exp $")
 
-char PC = 0;                   /* used by termcap library */
-speed_t ospeed = 0;            /* used by termcap library */
+NCURSES_EXPORT_VAR(char) PC = 0;              /* used by termcap library */
+NCURSES_EXPORT_VAR(NCURSES_OSPEED) ospeed = 0;        /* used by termcap library */
 
-int _nc_nulls_sent = 0;                /* used by 'tack' program */
+NCURSES_EXPORT_VAR(int) _nc_nulls_sent = 0;   /* used by 'tack' program */
 
-static int (*my_outch) (int c) = _nc_outch;
+#if NCURSES_NO_PADDING
+NCURSES_EXPORT(void)
+_nc_set_no_padding(SCREEN *sp)
+{
+    bool no_padding = (getenv("NCURSES_NO_PADDING") != 0);
 
-int
-delay_output(int ms)
+    if (sp)
+       sp->_no_padding = no_padding;
+    else
+       _nc_prescreen._no_padding = no_padding;
+
+    TR(TRACE_CHARPUT | TRACE_MOVE, ("padding will%s be used",
+                                   GetNoPadding(sp) ? " not" : ""));
+}
+#endif
+
+#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
+
+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 (!HasTInfoTerminal(SP_PARM))
+       returnCode(ERR);
 
     if (no_pad_char) {
-       _nc_flush();
+       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)) / 10000;
+       nullcount = (ms * _nc_baudrate(ospeed)) / (BAUDBYTE * 1000);
        for (_nc_nulls_sent += nullcount; nullcount > 0; nullcount--)
-           my_outch(PC);
-       if (my_outch == _nc_outch)
-           _nc_flush();
+           my_outch(NCURSES_SP_ARGx PC);
+       if (my_outch == NCURSES_SP_NAME(_nc_outch))
+           NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
     }
 
     returnCode(OK);
 }
 
-void
+#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) {
+           size_t amount = SP->out_inuse;
+           /*
+            * Help a little, if the write is interrupted, by first resetting
+            * our amount.
+            */
+           SP->out_inuse = 0;
+           IGNORE_RC(write(SP_PARM->_ofd, SP_PARM->out_buffer, amount));
+       }
+    }
+}
+
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(void)
 _nc_flush(void)
 {
-    (void)fflush(NC_OUTPUT);
+    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;
 
-    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);
+    COUNT_OUTCHARS(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 {
+           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 {
-       putc(ch, NC_OUTPUT);
+       char tmp = (char) ch;
+       if (write(fileno(stdout), &tmp, (size_t) 1) == -1)
+           rc = ERR;
     }
-    return OK;
+    return rc;
 }
 
-#ifdef USE_WIDEC_SUPPORT
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(int)
+_nc_outch(int ch)
+{
+    return NCURSES_SP_NAME(_nc_outch) (CURRENT_SCREEN, ch);
+}
+#endif
+
 /*
- * Reference: The Unicode Standard 2.0
- *
- * No surrogates supported (we're storing only one 16-bit Unicode value per
- * cell).
+ * This is used for the putp special case.
  */
-int
-_nc_utf8_outch(int ch)
+NCURSES_EXPORT(int)
+NCURSES_SP_NAME(_nc_putchar) (NCURSES_SP_DCLx int ch)
 {
-    static const unsigned byteMask = 0xBF;
-    static const unsigned otherMark = 0x80;
-    static const unsigned firstMark[] =
-    {0x00, 0x00, 0xC0, 0xE0, 0xF0, 0xF8, 0xFC};
-
-    int result[7], *ptr;
-    int count = 0;
-
-    if (ch < 0x80)
-       count = 1;
-    else if (ch < 0x800)
-       count = 2;
-    else if (ch < 0x10000)
-       count = 3;
-    else if (ch < 0x200000)
-       count = 4;
-    else if (ch < 0x4000000)
-       count = 5;
-    else if (ch <= 0x7FFFFFFF)
-       count = 6;
-    else {
-       count = 2;
-       ch = 0xFFFD;
-    }
-    ptr = result + count;
-    switch (count) {
-    case 6:
-       *--ptr = (ch | otherMark) & byteMask;
-       ch >>= 6;
-    case 5:
-       *--ptr = (ch | otherMark) & byteMask;
-       ch >>= 6;
-    case 4:
-       *--ptr = (ch | otherMark) & byteMask;
-       ch >>= 6;
-    case 3:
-       *--ptr = (ch | otherMark) & byteMask;
-       ch >>= 6;
-    case 2:
-       *--ptr = (ch | otherMark) & byteMask;
-       ch >>= 6;
-    case 1:
-       *--ptr = (ch | firstMark[count]);
-    }
-    while (count--)
-       _nc_outch(*ptr++);
-    return OK;
+    (void) SP_PARM;
+    return putchar(ch);
+}
+
+#if NCURSES_SP_FUNCS
+NCURSES_EXPORT(int)
+_nc_putchar(int ch)
+{
+    return putchar(ch);
 }
 #endif
 
-int
+/*
+ * 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));
+}
+
+#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
 
-int
-tputs(const char *string, int affcnt, int (*outc) (int))
+/*
+ * 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
+
+NCURSES_EXPORT(int)
+NCURSES_SP_NAME(tputs) (NCURSES_SP_DCLx
+                       const char *string,
+                       int affcnt,
+                       NCURSES_SP_OUTC outc)
 {
+    NCURSES_SP_OUTC my_outch = GetOutCh();
     bool always_delay;
     bool normal_delay;
     int number;
-#ifdef BSD_TPUTS
+#if BSD_TPUTS
     int trailpad;
 #endif /* BSD_TPUTS */
 
 #ifdef TRACE
     char addrbuf[32];
 
-    if (_nc_tracing & TRACE_TPUTS) {
-       if (outc == _nc_outch)
-           (void) strcpy(addrbuf, "_nc_outch");
+    if (USE_TRACEF(TRACE_TPUTS)) {
+       if (outc == NCURSES_SP_NAME(_nc_outch))
+           _nc_STRCPY(addrbuf, "_nc_outch", sizeof(addrbuf));
        else
-           (void) sprintf(addrbuf, "%p", outc);
+           _nc_SPRINTF(addrbuf, _nc_SLIMIT(sizeof(addrbuf)) "%p", outc);
        if (_nc_tputs_trace) {
            _tracef("tputs(%s = %s, %d, %s) called", _nc_tputs_trace,
-               _nc_visbuf(string), affcnt, addrbuf);
+                   _nc_visbuf(string), affcnt, addrbuf);
        } else {
            _tracef("tputs(%s, %d, %s) called", _nc_visbuf(string), affcnt, addrbuf);
        }
-       _nc_tputs_trace = (char *) NULL;
+       TPUTS_TRACE(NULL);
+       _nc_unlock_global(tracef);
     }
 #endif /* TRACE */
 
+    if (SP_PARM != 0 && !HasTInfoTerminal(SP_PARM))
+       return ERR;
+
     if (!VALID_STRING(string))
        return ERR;
 
-    if (cur_term == 0) {
+    if (
+#if NCURSES_SP_FUNCS
+          (SP_PARM != 0 && SP_PARM->_term == 0)
+#else
+          cur_term == 0
+#endif
+       ) {
        always_delay = FALSE;
        normal_delay = TRUE;
     } else {
@@ -207,31 +296,31 @@ tputs(const char *string, int affcnt, int (*outc) (int))
        normal_delay =
            !xon_xoff
            && padding_baud_rate
-#ifdef NCURSES_NO_PADDING
-           && (SP == 0 || !(SP->_no_padding))
+#if NCURSES_NO_PADDING
+           && !GetNoPadding(SP_PARM)
 #endif
            && (_nc_baudrate(ospeed) >= padding_baud_rate);
     }
 
-#ifdef BSD_TPUTS
+#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(*string)) {
-       while (isdigit(*string)) {
+    if (isdigit(UChar(*string))) {
+       while (isdigit(UChar(*string))) {
            trailpad = trailpad * 10 + (*string - '0');
            string++;
        }
        trailpad *= 10;
        if (*string == '.') {
            string++;
-           if (isdigit(*string)) {
+           if (isdigit(UChar(*string))) {
                trailpad += (*string - '0');
                string++;
            }
-           while (isdigit(*string))
+           while (isdigit(UChar(*string)))
                string++;
        }
 
@@ -242,39 +331,40 @@ tputs(const char *string, int affcnt, int (*outc) (int))
     }
 #endif /* BSD_TPUTS */
 
-    my_outch = outc;           /* redirect delay_output() */
+    SetOutCh(outc);            /* redirect delay_output() */
     while (*string) {
        if (*string != '$')
-           (*outc) (*string);
+           (*outc) (NCURSES_SP_ARGx *string);
        else {
            string++;
            if (*string != '<') {
-               (*outc) ('$');
+               (*outc) (NCURSES_SP_ARGx '$');
                if (*string)
-                   (*outc) (*string);
+                   (*outc) (NCURSES_SP_ARGx *string);
            } else {
                bool mandatory;
 
                string++;
-               if ((!isdigit(*string) && *string != '.') || !strchr(string, '>')) {
-                   (*outc) ('$');
-                   (*outc) ('<');
+               if ((!isdigit(UChar(*string)) && *string != '.')
+                   || !strchr(string, '>')) {
+                   (*outc) (NCURSES_SP_ARGx '$');
+                   (*outc) (NCURSES_SP_ARGx '<');
                    continue;
                }
 
                number = 0;
-               while (isdigit(*string)) {
+               while (isdigit(UChar(*string))) {
                    number = number * 10 + (*string - '0');
                    string++;
                }
                number *= 10;
                if (*string == '.') {
                    string++;
-                   if (isdigit(*string)) {
+                   if (isdigit(UChar(*string))) {
                        number += (*string - '0');
                        string++;
                    }
-                   while (isdigit(*string))
+                   while (isdigit(UChar(*string)))
                        string++;
                }
 
@@ -293,7 +383,7 @@ tputs(const char *string, int affcnt, int (*outc) (int))
                    && (always_delay
                        || normal_delay
                        || mandatory))
-                   delay_output(number / 10);
+                   NCURSES_SP_NAME(delay_output) (NCURSES_SP_ARGx number / 10);
 
            }                   /* endelse (*string == '<') */
        }                       /* endelse (*string == '$') */
@@ -304,7 +394,7 @@ tputs(const char *string, int affcnt, int (*outc) (int))
        string++;
     }
 
-#ifdef BSD_TPUTS
+#if BSD_TPUTS
     /*
      * Emit any BSD-style prefix padding that we've accumulated now.
      */
@@ -313,6 +403,25 @@ tputs(const char *string, int affcnt, int (*outc) (int))
        delay_output(trailpad / 10);
 #endif /* BSD_TPUTS */
 
-    my_outch = _nc_outch;
+    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