xref: /freebsd/contrib/ncurses/ncurses/tinfo/lib_tputs.c (revision f0a75d274af375d15b97b830966b99a02b7db911)
1 /****************************************************************************
2  * Copyright (c) 1998-2002,2003 Free Software Foundation, Inc.              *
3  *                                                                          *
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:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
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.                               *
22  *                                                                          *
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       *
26  * authorization.                                                           *
27  ****************************************************************************/
28 
29 /****************************************************************************
30  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
31  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
32  ****************************************************************************/
33 
34 /*
35  *	tputs.c
36  *		delay_output()
37  *		_nc_outch()
38  *		tputs()
39  *
40  */
41 
42 #include <curses.priv.h>
43 #include <ctype.h>
44 #include <term.h>		/* padding_baud_rate, xon_xoff */
45 #include <termcap.h>		/* ospeed */
46 #include <tic.h>
47 
48 MODULE_ID("$Id: lib_tputs.c,v 1.62 2003/08/23 21:39:20 tom Exp $")
49 
50 NCURSES_EXPORT_VAR(char) PC = 0;		/* used by termcap library */
51 NCURSES_EXPORT_VAR(NCURSES_OSPEED) ospeed = 0;	/* used by termcap library */
52 
53 NCURSES_EXPORT_VAR(int) _nc_nulls_sent = 0;	/* used by 'tack' program */
54 
55 static int (*my_outch) (int c) = _nc_outch;
56 
57 NCURSES_EXPORT(int)
58 delay_output(int ms)
59 {
60     T((T_CALLED("delay_output(%d)"), ms));
61 
62     if (no_pad_char) {
63 	_nc_flush();
64 	napms(ms);
65     } else {
66 	register int nullcount;
67 
68 	nullcount = (ms * _nc_baudrate(ospeed)) / (BAUDBYTE * 1000);
69 	for (_nc_nulls_sent += nullcount; nullcount > 0; nullcount--)
70 	    my_outch(PC);
71 	if (my_outch == _nc_outch)
72 	    _nc_flush();
73     }
74 
75     returnCode(OK);
76 }
77 
78 NCURSES_EXPORT(void)
79 _nc_flush(void)
80 {
81     (void) fflush(NC_OUTPUT);
82 }
83 
84 NCURSES_EXPORT(int)
85 _nc_outch(int ch)
86 {
87     TRACE_OUTCHARS(1);
88 
89     if (SP != 0
90 	&& SP->_cleanup) {
91 	char tmp = ch;
92 	/*
93 	 * POSIX says write() is safe in a signal handler, but the
94 	 * buffered I/O is not.
95 	 */
96 	write(fileno(NC_OUTPUT), &tmp, 1);
97     } else {
98 	putc(ch, NC_OUTPUT);
99     }
100     return OK;
101 }
102 
103 NCURSES_EXPORT(int)
104 putp(const char *string)
105 {
106     return tputs(string, 1, _nc_outch);
107 }
108 
109 NCURSES_EXPORT(int)
110 tputs(const char *string, int affcnt, int (*outc) (int))
111 {
112     bool always_delay;
113     bool normal_delay;
114     int number;
115 #if BSD_TPUTS
116     int trailpad;
117 #endif /* BSD_TPUTS */
118 
119 #ifdef TRACE
120     char addrbuf[32];
121 
122     if (_nc_tracing & TRACE_TPUTS) {
123 	if (outc == _nc_outch)
124 	    (void) strcpy(addrbuf, "_nc_outch");
125 	else
126 	    (void) sprintf(addrbuf, "%p", outc);
127 	if (_nc_tputs_trace) {
128 	    _tracef("tputs(%s = %s, %d, %s) called", _nc_tputs_trace,
129 		    _nc_visbuf(string), affcnt, addrbuf);
130 	} else {
131 	    _tracef("tputs(%s, %d, %s) called", _nc_visbuf(string), affcnt, addrbuf);
132 	}
133 	_nc_tputs_trace = (char *) NULL;
134     }
135 #endif /* TRACE */
136 
137     if (!VALID_STRING(string))
138 	return ERR;
139 
140     if (cur_term == 0) {
141 	always_delay = FALSE;
142 	normal_delay = TRUE;
143     } else {
144 	always_delay = (string == bell) || (string == flash_screen);
145 	normal_delay =
146 	    !xon_xoff
147 	    && padding_baud_rate
148 #if NCURSES_NO_PADDING
149 	    && (SP == 0 || !(SP->_no_padding))
150 #endif
151 	    && (_nc_baudrate(ospeed) >= padding_baud_rate);
152     }
153 
154 #if BSD_TPUTS
155     /*
156      * This ugly kluge deals with the fact that some ancient BSD programs
157      * (like nethack) actually do the likes of tputs("50") to get delays.
158      */
159     trailpad = 0;
160     if (isdigit(UChar(*string))) {
161 	while (isdigit(UChar(*string))) {
162 	    trailpad = trailpad * 10 + (*string - '0');
163 	    string++;
164 	}
165 	trailpad *= 10;
166 	if (*string == '.') {
167 	    string++;
168 	    if (isdigit(UChar(*string))) {
169 		trailpad += (*string - '0');
170 		string++;
171 	    }
172 	    while (isdigit(UChar(*string)))
173 		string++;
174 	}
175 
176 	if (*string == '*') {
177 	    trailpad *= affcnt;
178 	    string++;
179 	}
180     }
181 #endif /* BSD_TPUTS */
182 
183     my_outch = outc;		/* redirect delay_output() */
184     while (*string) {
185 	if (*string != '$')
186 	    (*outc) (*string);
187 	else {
188 	    string++;
189 	    if (*string != '<') {
190 		(*outc) ('$');
191 		if (*string)
192 		    (*outc) (*string);
193 	    } else {
194 		bool mandatory;
195 
196 		string++;
197 		if ((!isdigit(UChar(*string)) && *string != '.')
198 		    || !strchr(string, '>')) {
199 		    (*outc) ('$');
200 		    (*outc) ('<');
201 		    continue;
202 		}
203 
204 		number = 0;
205 		while (isdigit(UChar(*string))) {
206 		    number = number * 10 + (*string - '0');
207 		    string++;
208 		}
209 		number *= 10;
210 		if (*string == '.') {
211 		    string++;
212 		    if (isdigit(UChar(*string))) {
213 			number += (*string - '0');
214 			string++;
215 		    }
216 		    while (isdigit(UChar(*string)))
217 			string++;
218 		}
219 
220 		mandatory = FALSE;
221 		while (*string == '*' || *string == '/') {
222 		    if (*string == '*') {
223 			number *= affcnt;
224 			string++;
225 		    } else {	/* if (*string == '/') */
226 			mandatory = TRUE;
227 			string++;
228 		    }
229 		}
230 
231 		if (number > 0
232 		    && (always_delay
233 			|| normal_delay
234 			|| mandatory))
235 		    delay_output(number / 10);
236 
237 	    }			/* endelse (*string == '<') */
238 	}			/* endelse (*string == '$') */
239 
240 	if (*string == '\0')
241 	    break;
242 
243 	string++;
244     }
245 
246 #if BSD_TPUTS
247     /*
248      * Emit any BSD-style prefix padding that we've accumulated now.
249      */
250     if (trailpad > 0
251 	&& (always_delay || normal_delay))
252 	delay_output(trailpad / 10);
253 #endif /* BSD_TPUTS */
254 
255     my_outch = _nc_outch;
256     return OK;
257 }
258