1 /****************************************************************************
2 * Copyright (c) 1998-2016,2017 Free Software Foundation, Inc. *
4 * Permission is hereby granted, free of charge, to any person obtaining a *
5 * copy of this software and associated documentation files (the *
6 * "Software"), to deal in the Software without restriction, including *
7 * without limitation the rights to use, copy, modify, merge, publish, *
8 * distribute, distribute with modifications, sublicense, and/or sell *
9 * copies of the Software, and to permit persons to whom the Software is *
10 * furnished to do so, subject to the following conditions: *
12 * The above copyright notice and this permission notice shall be included *
13 * in all copies or substantial portions of the Software. *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
16 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
18 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
21 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 * Except as contained in this notice, the name(s) of the above copyright *
24 * holders shall not be used in advertising or otherwise to promote the *
25 * sale, use or other dealings in this Software without prior written *
27 ****************************************************************************/
29 /****************************************************************************
30 * Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
31 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
32 * and: Thomas E. Dickey 1996-on *
33 * and: Juergen Pfeifer 2009 *
34 ****************************************************************************/
44 #include <curses.priv.h>
47 #define CUR SP_TERMTYPE
51 #include <termcap.h> /* ospeed */
54 MODULE_ID("$Id: lib_tputs.c,v 1.100 2017/06/24 15:15:55 tom Exp $")
56 NCURSES_EXPORT_VAR(char) PC = 0; /* used by termcap library */
57 NCURSES_EXPORT_VAR(NCURSES_OSPEED) ospeed = 0; /* used by termcap library */
59 NCURSES_EXPORT_VAR(int) _nc_nulls_sent = 0; /* used by 'tack' program */
61 #if NCURSES_NO_PADDING
63 _nc_set_no_padding(SCREEN *sp)
65 bool no_padding = (getenv("NCURSES_NO_PADDING") != 0);
68 sp->_no_padding = no_padding;
70 _nc_prescreen._no_padding = no_padding;
72 TR(TRACE_CHARPUT | TRACE_MOVE, ("padding will%s be used",
73 GetNoPadding(sp) ? " not" : ""));
78 #define SetOutCh(func) if (SP_PARM) SP_PARM->_outch = func; else _nc_prescreen._outch = func
79 #define GetOutCh() (SP_PARM ? SP_PARM->_outch : _nc_prescreen._outch)
81 #define SetOutCh(func) static_outch = func
82 #define GetOutCh() static_outch
83 static NCURSES_SP_OUTC static_outch = NCURSES_SP_NAME(_nc_outch);
87 NCURSES_SP_NAME(delay_output) (NCURSES_SP_DCLx int ms)
89 T((T_CALLED("delay_output(%p,%d)"), (void *) SP_PARM, ms));
91 if (!HasTInfoTerminal(SP_PARM))
95 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
98 NCURSES_SP_OUTC my_outch = GetOutCh();
99 register int nullcount;
101 nullcount = (ms * _nc_baudrate(ospeed)) / (BAUDBYTE * 1000);
102 for (_nc_nulls_sent += nullcount; nullcount > 0; nullcount--)
103 my_outch(NCURSES_SP_ARGx PC);
104 if (my_outch == NCURSES_SP_NAME(_nc_outch))
105 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
115 return NCURSES_SP_NAME(delay_output) (CURRENT_SCREEN, ms);
120 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_DCL0)
122 if (SP_PARM != 0 && SP_PARM->_ofd >= 0) {
123 if (SP_PARM->out_inuse) {
124 char *buf = SP_PARM->out_buffer;
125 size_t amount = SP->out_inuse;
129 ssize_t res = write(SP_PARM->_ofd, buf, amount);
132 /* if the write was incomplete, try again */
133 amount -= (size_t) res;
135 } else if (errno == EAGAIN) {
137 } else if (errno == EINTR) {
140 break; /* an error we can not recover from */
153 NCURSES_SP_NAME(_nc_flush) (CURRENT_SCREEN);
158 NCURSES_SP_NAME(_nc_outch) (NCURSES_SP_DCLx int ch)
164 if (HasTInfoTerminal(SP_PARM)
166 if (SP_PARM->out_buffer != 0) {
167 if (SP_PARM->out_inuse + 1 >= SP_PARM->out_limit)
168 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
169 SP_PARM->out_buffer[SP_PARM->out_inuse++] = (char) ch;
171 char tmp = (char) ch;
173 * POSIX says write() is safe in a signal handler, but the
174 * buffered I/O is not.
176 if (write(fileno(NC_OUTPUT(SP_PARM)), &tmp, (size_t) 1) == -1)
180 char tmp = (char) ch;
181 if (write(fileno(stdout), &tmp, (size_t) 1) == -1)
191 return NCURSES_SP_NAME(_nc_outch) (CURRENT_SCREEN, ch);
196 * This is used for the putp special case.
199 NCURSES_SP_NAME(_nc_putchar) (NCURSES_SP_DCLx int ch)
214 * putp is special - per documentation it calls tputs with putchar as the
215 * parameter for outputting characters. This means that it uses stdio, which
216 * is not signal-safe. Applications call this entrypoint; we do not call it
217 * from within the library.
220 NCURSES_SP_NAME(putp) (NCURSES_SP_DCLx const char *string)
222 return NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
223 string, 1, NCURSES_SP_NAME(_nc_putchar));
228 putp(const char *string)
230 return NCURSES_SP_NAME(putp) (CURRENT_SCREEN, string);
235 * Use these entrypoints rather than "putp" within the library.
238 NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_DCLx
239 const char *name GCC_UNUSED,
246 rc = NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
247 string, 1, NCURSES_SP_NAME(_nc_outch));
254 _nc_putp(const char *name, const char *string)
256 return NCURSES_SP_NAME(_nc_putp) (CURRENT_SCREEN, name, string);
261 NCURSES_SP_NAME(tputs) (NCURSES_SP_DCLx
264 NCURSES_SP_OUTC outc)
266 NCURSES_SP_OUTC my_outch = GetOutCh();
272 #endif /* BSD_TPUTS */
275 if (USE_TRACEF(TRACE_TPUTS)) {
278 if (outc == NCURSES_SP_NAME(_nc_outch))
279 _nc_STRCPY(addrbuf, "_nc_outch", sizeof(addrbuf));
281 _nc_SPRINTF(addrbuf, _nc_SLIMIT(sizeof(addrbuf)) "%p", TR_FUNC(outc));
282 if (_nc_tputs_trace) {
283 _tracef("tputs(%s = %s, %d, %s) called", _nc_tputs_trace,
284 _nc_visbuf(string), affcnt, addrbuf);
286 _tracef("tputs(%s, %d, %s) called", _nc_visbuf(string), affcnt, addrbuf);
289 _nc_unlock_global(tracef);
293 if (SP_PARM != 0 && !HasTInfoTerminal(SP_PARM))
296 if (!VALID_STRING(string))
301 (SP_PARM != 0 && SP_PARM->_term == 0)
306 always_delay = FALSE;
309 always_delay = (string == bell) || (string == flash_screen);
313 #if NCURSES_NO_PADDING
314 && !GetNoPadding(SP_PARM)
316 && (_nc_baudrate(ospeed) >= padding_baud_rate);
321 * This ugly kluge deals with the fact that some ancient BSD programs
322 * (like nethack) actually do the likes of tputs("50") to get delays.
325 if (isdigit(UChar(*string))) {
326 while (isdigit(UChar(*string))) {
327 trailpad = trailpad * 10 + (*string - '0');
331 if (*string == '.') {
333 if (isdigit(UChar(*string))) {
334 trailpad += (*string - '0');
337 while (isdigit(UChar(*string)))
341 if (*string == '*') {
346 #endif /* BSD_TPUTS */
348 SetOutCh(outc); /* redirect delay_output() */
351 (*outc) (NCURSES_SP_ARGx *string);
354 if (*string != '<') {
355 (*outc) (NCURSES_SP_ARGx '$');
357 (*outc) (NCURSES_SP_ARGx *string);
362 if ((!isdigit(UChar(*string)) && *string != '.')
363 || !strchr(string, '>')) {
364 (*outc) (NCURSES_SP_ARGx '$');
365 (*outc) (NCURSES_SP_ARGx '<');
370 while (isdigit(UChar(*string))) {
371 number = number * 10 + (*string - '0');
375 if (*string == '.') {
377 if (isdigit(UChar(*string))) {
378 number += (*string - '0');
381 while (isdigit(UChar(*string)))
386 while (*string == '*' || *string == '/') {
387 if (*string == '*') {
390 } else { /* if (*string == '/') */
400 NCURSES_SP_NAME(delay_output) (NCURSES_SP_ARGx number / 10);
402 } /* endelse (*string == '<') */
403 } /* endelse (*string == '$') */
413 * Emit any BSD-style prefix padding that we've accumulated now.
416 && (always_delay || normal_delay))
417 delay_output(trailpad / 10);
418 #endif /* BSD_TPUTS */
426 _nc_outc_wrapper(SCREEN *sp, int c)
429 return fputc(c, stdout);
436 tputs(const char *string, int affcnt, int (*outc) (int))
438 SetSafeOutcWrapper(outc);
439 return NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx string, affcnt, _nc_outc_wrapper);