1 /****************************************************************************
2 * Copyright 2018-2021,2022 Thomas E. Dickey *
3 * Copyright 1998-2016,2017 Free Software Foundation, Inc. *
5 * Permission is hereby granted, free of charge, to any person obtaining a *
6 * copy of this software and associated documentation files (the *
7 * "Software"), to deal in the Software without restriction, including *
8 * without limitation the rights to use, copy, modify, merge, publish, *
9 * distribute, distribute with modifications, sublicense, and/or sell *
10 * copies of the Software, and to permit persons to whom the Software is *
11 * furnished to do so, subject to the following conditions: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * Except as contained in this notice, the name(s) of the above copyright *
25 * holders shall not be used in advertising or otherwise to promote the *
26 * sale, use or other dealings in this Software without prior written *
28 ****************************************************************************/
30 /****************************************************************************
31 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
32 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
33 * and: Thomas E. Dickey 1996-on *
34 * and: Juergen Pfeifer 2009 *
35 ****************************************************************************/
45 #include <curses.priv.h>
48 #define CUR SP_TERMTYPE
52 #include <termcap.h> /* ospeed */
55 MODULE_ID("$Id: lib_tputs.c,v 1.109 2022/07/21 23:26:34 tom Exp $")
57 NCURSES_EXPORT_VAR(char) PC = 0; /* used by termcap library */
58 NCURSES_EXPORT_VAR(NCURSES_OSPEED) ospeed = 0; /* used by termcap library */
60 NCURSES_EXPORT_VAR(int) _nc_nulls_sent = 0; /* used by 'tack' program */
62 #if NCURSES_NO_PADDING
64 _nc_set_no_padding(SCREEN *sp)
66 bool no_padding = (getenv("NCURSES_NO_PADDING") != 0);
69 sp->_no_padding = no_padding;
71 _nc_prescreen._no_padding = no_padding;
73 TR(TRACE_CHARPUT | TRACE_MOVE, ("padding will%s be used",
74 GetNoPadding(sp) ? " not" : ""));
79 #define SetOutCh(func) if (SP_PARM) SP_PARM->_outch = func; else _nc_prescreen._outch = func
80 #define GetOutCh() (SP_PARM ? SP_PARM->_outch : _nc_prescreen._outch)
82 #define SetOutCh(func) static_outch = func
83 #define GetOutCh() static_outch
84 static NCURSES_SP_OUTC static_outch = NCURSES_SP_NAME(_nc_outch);
88 NCURSES_SP_NAME(delay_output) (NCURSES_SP_DCLx int ms)
90 T((T_CALLED("delay_output(%p,%d)"), (void *) SP_PARM, ms));
92 if (!HasTInfoTerminal(SP_PARM))
96 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
99 NCURSES_SP_OUTC my_outch = GetOutCh();
100 register int nullcount;
102 nullcount = (ms * _nc_baudrate(ospeed)) / (BAUDBYTE * 1000);
103 for (_nc_nulls_sent += nullcount; nullcount > 0; nullcount--)
104 my_outch(NCURSES_SP_ARGx PC);
105 if (my_outch == NCURSES_SP_NAME(_nc_outch))
106 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
116 return NCURSES_SP_NAME(delay_output) (CURRENT_SCREEN, ms);
121 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_DCL0)
123 T((T_CALLED("_nc_flush(%p)"), (void *) SP_PARM));
124 if (SP_PARM != 0 && SP_PARM->_ofd >= 0) {
125 TR(TRACE_CHARPUT, ("ofd:%d inuse:%lu buffer:%p",
127 (unsigned long) SP_PARM->out_inuse,
128 SP_PARM->out_buffer));
129 if (SP_PARM->out_inuse) {
130 char *buf = SP_PARM->out_buffer;
131 size_t amount = SP_PARM->out_inuse;
133 TR(TRACE_CHARPUT, ("flushing %ld/%ld bytes",
134 (unsigned long) amount, _nc_outchars));
136 ssize_t res = write(SP_PARM->_ofd, buf, amount);
138 /* if the write was incomplete, try again */
139 amount -= (size_t) res;
141 } else if (errno == EAGAIN) {
143 } else if (errno == EINTR) {
146 break; /* an error we can not recover from */
149 } else if (SP_PARM->out_buffer == 0) {
150 TR(TRACE_CHARPUT, ("flushing stdout"));
154 TR(TRACE_CHARPUT, ("flushing stdout"));
158 SP_PARM->out_inuse = 0;
166 NCURSES_SP_NAME(_nc_flush) (CURRENT_SCREEN);
171 NCURSES_SP_NAME(_nc_outch) (NCURSES_SP_DCLx int ch)
177 if (HasTInfoTerminal(SP_PARM)
179 if (SP_PARM->out_buffer != 0) {
180 if (SP_PARM->out_inuse + 1 >= SP_PARM->out_limit)
181 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
182 SP_PARM->out_buffer[SP_PARM->out_inuse++] = (char) ch;
184 char tmp = (char) ch;
186 * POSIX says write() is safe in a signal handler, but the
187 * buffered I/O is not.
189 if (write(fileno(NC_OUTPUT(SP_PARM)), &tmp, (size_t) 1) == -1)
193 char tmp = (char) ch;
194 if (write(fileno(stdout), &tmp, (size_t) 1) == -1)
204 return NCURSES_SP_NAME(_nc_outch) (CURRENT_SCREEN, ch);
209 * This is used for the putp special case.
212 NCURSES_SP_NAME(_nc_putchar) (NCURSES_SP_DCLx int ch)
227 * putp is special - per documentation it calls tputs with putchar as the
228 * parameter for outputting characters. This means that it uses stdio, which
229 * is not signal-safe. Applications call this entrypoint; we do not call it
230 * from within the library.
233 NCURSES_SP_NAME(putp) (NCURSES_SP_DCLx const char *string)
235 return NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
236 string, 1, NCURSES_SP_NAME(_nc_putchar));
241 putp(const char *string)
243 return NCURSES_SP_NAME(putp) (CURRENT_SCREEN, string);
248 * Use these entrypoints rather than "putp" within the library.
251 NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_DCLx
252 const char *name GCC_UNUSED,
259 rc = NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
260 string, 1, NCURSES_SP_NAME(_nc_outch));
267 _nc_putp(const char *name, const char *string)
269 return NCURSES_SP_NAME(_nc_putp) (CURRENT_SCREEN, name, string);
274 NCURSES_SP_NAME(tputs) (NCURSES_SP_DCLx
277 NCURSES_SP_OUTC outc)
279 NCURSES_SP_OUTC my_outch = GetOutCh();
280 bool always_delay = FALSE;
281 bool normal_delay = FALSE;
285 #endif /* BSD_TPUTS */
288 if (USE_TRACEF(TRACE_TPUTS)) {
292 if (outc == NCURSES_SP_NAME(_nc_outch)) {
293 _nc_STRCPY(addrbuf, "_nc_outch", sizeof(addrbuf));
295 _nc_SPRINTF(addrbuf, _nc_SLIMIT(sizeof(addrbuf)) "%s",
296 TR_FUNC_ARG(0, outc));
298 if (_nc_tputs_trace) {
299 _tracef("tputs(%s = %s, %d, %s) called", _nc_tputs_trace,
300 _nc_visbuf(string), affcnt, addrbuf);
302 _tracef("tputs(%s, %d, %s) called", _nc_visbuf(string), affcnt, addrbuf);
305 _nc_unlock_global(tracef);
309 if (!VALID_STRING(string))
312 if (SP_PARM != 0 && HasTInfoTerminal(SP_PARM)) {
315 (SP_PARM != 0 && SP_PARM->_term == 0)
320 always_delay = FALSE;
323 always_delay = (string == bell) || (string == flash_screen);
327 #if NCURSES_NO_PADDING
328 && !GetNoPadding(SP_PARM)
330 && (_nc_baudrate(ospeed) >= padding_baud_rate);
335 * This ugly kluge deals with the fact that some ancient BSD programs
336 * (like nethack) actually do the likes of tputs("50") to get delays.
339 if (isdigit(UChar(*string))) {
340 while (isdigit(UChar(*string))) {
341 trailpad = trailpad * 10 + (*string - '0');
345 if (*string == '.') {
347 if (isdigit(UChar(*string))) {
348 trailpad += (*string - '0');
351 while (isdigit(UChar(*string)))
355 if (*string == '*') {
360 #endif /* BSD_TPUTS */
362 SetOutCh(outc); /* redirect delay_output() */
365 (*outc) (NCURSES_SP_ARGx *string);
368 if (*string != '<') {
369 (*outc) (NCURSES_SP_ARGx '$');
371 (*outc) (NCURSES_SP_ARGx *string);
376 if ((!isdigit(UChar(*string)) && *string != '.')
377 || !strchr(string, '>')) {
378 (*outc) (NCURSES_SP_ARGx '$');
379 (*outc) (NCURSES_SP_ARGx '<');
384 while (isdigit(UChar(*string))) {
385 number = number * 10 + (*string - '0');
389 if (*string == '.') {
391 if (isdigit(UChar(*string))) {
392 number += (*string - '0');
395 while (isdigit(UChar(*string)))
400 while (*string == '*' || *string == '/') {
401 if (*string == '*') {
404 } else { /* if (*string == '/') */
414 NCURSES_SP_NAME(delay_output) (NCURSES_SP_ARGx number / 10);
416 } /* endelse (*string == '<') */
417 } /* endelse (*string == '$') */
427 * Emit any BSD-style prefix padding that we've accumulated now.
430 && (always_delay || normal_delay))
431 NCURSES_SP_NAME(delay_output) (NCURSES_SP_ARGx trailpad / 10);
432 #endif /* BSD_TPUTS */
440 _nc_outc_wrapper(SCREEN *sp, int c)
443 return fputc(c, stdout);
450 tputs(const char *string, int affcnt, int (*outc) (int))
452 SetSafeOutcWrapper(outc);
453 return NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx string, affcnt, _nc_outc_wrapper);