ncurses 5.7 - patch 20090606
[ncurses.git] / ncurses / tinfo / lib_tputs.c
1 /****************************************************************************
2  * Copyright (c) 1998-2008,2009 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  *     and: Thomas E. Dickey                        1996-on                 *
33  *     and: Juergen Pfeifer                         2009                    *
34  ****************************************************************************/
35
36 /*
37  *      tputs.c
38  *              delay_output()
39  *              _nc_outch()
40  *              tputs()
41  *
42  */
43
44 #include <curses.priv.h>
45
46 #ifndef CUR
47 #define CUR SP_TERMTYPE
48 #endif
49
50 #include <ctype.h>
51 #include <termcap.h>            /* ospeed */
52 #include <tic.h>
53
54 MODULE_ID("$Id: lib_tputs.c,v 1.75 2009/05/30 19:44:43 tom Exp $")
55
56 NCURSES_EXPORT_VAR(char) PC = 0;              /* used by termcap library */
57 NCURSES_EXPORT_VAR(NCURSES_OSPEED) ospeed = 0;        /* used by termcap library */
58
59 NCURSES_EXPORT_VAR(int) _nc_nulls_sent = 0;   /* used by 'tack' program */
60
61 #if NCURSES_NO_PADDING
62 NCURSES_EXPORT(void)
63 _nc_set_no_padding(SCREEN *sp)
64 {
65     bool no_padding = (getenv("NCURSES_NO_PADDING") != 0);
66
67     if (sp)
68         sp->_no_padding = no_padding;
69     else
70         _nc_prescreen._no_padding = no_padding;
71
72     TR(TRACE_CHARPUT | TRACE_MOVE, ("padding will%s be used",
73                                     GetNoPadding(sp) ? " not" : ""));
74 }
75 #endif
76
77 #if NCURSES_SP_FUNCS
78 #define my_outch SP_PARM->_outch
79 #else
80 static NCURSES_SP_OUTC my_outch = NCURSES_SP_NAME(_nc_outch);
81 #endif
82
83 NCURSES_EXPORT(int)
84 NCURSES_SP_NAME(delay_output) (NCURSES_SP_DCLx int ms)
85 {
86     T((T_CALLED("delay_output(%p,%d)"), SP_PARM, ms));
87
88     if (!HasTInfoTerminal(SP_PARM))
89         returnCode(ERR);
90
91     if (no_pad_char) {
92         NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
93         napms(ms);
94     } else {
95         register int nullcount;
96
97         nullcount = (ms * _nc_baudrate(ospeed)) / (BAUDBYTE * 1000);
98         for (_nc_nulls_sent += nullcount; nullcount > 0; nullcount--)
99             my_outch(NCURSES_SP_ARGx PC);
100         if (my_outch == NCURSES_SP_NAME(_nc_outch))
101             NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_ARG);
102     }
103
104     returnCode(OK);
105 }
106
107 #if NCURSES_SP_FUNCS
108 NCURSES_EXPORT(int)
109 delay_output(int ms)
110 {
111     return NCURSES_SP_NAME(delay_output) (CURRENT_SCREEN, ms);
112 }
113 #endif
114
115 NCURSES_EXPORT(void)
116 NCURSES_SP_NAME(_nc_flush) (NCURSES_SP_DCL0)
117 {
118     (void) fflush(NC_OUTPUT(SP_PARM));
119 }
120
121 #if NCURSES_SP_FUNCS
122 NCURSES_EXPORT(void)
123 _nc_flush(void)
124 {
125     NCURSES_SP_NAME(_nc_flush) (CURRENT_SCREEN);
126 }
127 #endif
128
129 NCURSES_EXPORT(int)
130 NCURSES_SP_NAME(_nc_outch) (NCURSES_SP_DCLx int ch)
131 {
132     COUNT_OUTCHARS(1);
133
134     if (HasTInfoTerminal(SP_PARM)
135         && SP_PARM->_cleanup) {
136         char tmp = ch;
137         /*
138          * POSIX says write() is safe in a signal handler, but the
139          * buffered I/O is not.
140          */
141         write(fileno(NC_OUTPUT(SP_PARM)), &tmp, 1);
142     } else {
143         putc(ch, NC_OUTPUT(SP_PARM));
144     }
145     return OK;
146 }
147
148 #if NCURSES_SP_FUNCS
149 NCURSES_EXPORT(int)
150 _nc_outch(int ch)
151 {
152     return NCURSES_SP_NAME(_nc_outch) (CURRENT_SCREEN, ch);
153 }
154 #endif
155
156 NCURSES_EXPORT(int)
157 NCURSES_SP_NAME(putp) (NCURSES_SP_DCLx const char *string)
158 {
159     return NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx
160                                    string, 1, NCURSES_SP_NAME(_nc_outch));
161 }
162
163 NCURSES_EXPORT(int)
164 NCURSES_SP_NAME(_nc_putp) (NCURSES_SP_DCLx
165                            const char *name GCC_UNUSED,
166                            const char *string)
167 {
168     int rc = ERR;
169
170     if (string != 0) {
171         TPUTS_TRACE(name);
172         rc = NCURSES_SP_NAME(putp) (NCURSES_SP_ARGx string);
173     }
174     return rc;
175 }
176
177 #if NCURSES_SP_FUNCS
178 NCURSES_EXPORT(int)
179 putp(const char *string)
180 {
181     return NCURSES_SP_NAME(putp) (CURRENT_SCREEN, string);
182 }
183
184 NCURSES_EXPORT(int)
185 _nc_putp(const char *name, const char *string)
186 {
187     return NCURSES_SP_NAME(_nc_putp) (CURRENT_SCREEN, name, string);
188 }
189 #endif
190
191 NCURSES_EXPORT(int)
192 NCURSES_SP_NAME(tputs) (NCURSES_SP_DCLx
193                         const char *string,
194                         int affcnt,
195                         NCURSES_SP_OUTC outc)
196 {
197     bool always_delay;
198     bool normal_delay;
199     int number;
200 #if BSD_TPUTS
201     int trailpad;
202 #endif /* BSD_TPUTS */
203
204 #ifdef TRACE
205     char addrbuf[32];
206
207     if (USE_TRACEF(TRACE_TPUTS)) {
208         if (outc == NCURSES_SP_NAME(_nc_outch))
209             (void) strcpy(addrbuf, "_nc_outch");
210         else
211             (void) sprintf(addrbuf, "%p", outc);
212         if (_nc_tputs_trace) {
213             _tracef("tputs(%s = %s, %d, %s) called", _nc_tputs_trace,
214                     _nc_visbuf(string), affcnt, addrbuf);
215         } else {
216             _tracef("tputs(%s, %d, %s) called", _nc_visbuf(string), affcnt, addrbuf);
217         }
218         TPUTS_TRACE(NULL);
219         _nc_unlock_global(tracef);
220     }
221 #endif /* TRACE */
222
223     if (SP_PARM != 0 && !HasTInfoTerminal(SP_PARM))
224         return ERR;
225
226     if (!VALID_STRING(string))
227         return ERR;
228
229     if (SP_PARM != 0 && SP_PARM->_term == 0) {
230         always_delay = FALSE;
231         normal_delay = TRUE;
232     } else {
233         always_delay = (string == bell) || (string == flash_screen);
234         normal_delay =
235             !xon_xoff
236             && padding_baud_rate
237 #if NCURSES_NO_PADDING
238             && !GetNoPadding(SP_PARM)
239 #endif
240             && (_nc_baudrate(ospeed) >= padding_baud_rate);
241     }
242
243 #if BSD_TPUTS
244     /*
245      * This ugly kluge deals with the fact that some ancient BSD programs
246      * (like nethack) actually do the likes of tputs("50") to get delays.
247      */
248     trailpad = 0;
249     if (isdigit(UChar(*string))) {
250         while (isdigit(UChar(*string))) {
251             trailpad = trailpad * 10 + (*string - '0');
252             string++;
253         }
254         trailpad *= 10;
255         if (*string == '.') {
256             string++;
257             if (isdigit(UChar(*string))) {
258                 trailpad += (*string - '0');
259                 string++;
260             }
261             while (isdigit(UChar(*string)))
262                 string++;
263         }
264
265         if (*string == '*') {
266             trailpad *= affcnt;
267             string++;
268         }
269     }
270 #endif /* BSD_TPUTS */
271
272     my_outch = outc;            /* redirect delay_output() */
273     while (*string) {
274         if (*string != '$')
275             (*outc) (NCURSES_SP_ARGx *string);
276         else {
277             string++;
278             if (*string != '<') {
279                 (*outc) (NCURSES_SP_ARGx '$');
280                 if (*string)
281                     (*outc) (NCURSES_SP_ARGx *string);
282             } else {
283                 bool mandatory;
284
285                 string++;
286                 if ((!isdigit(UChar(*string)) && *string != '.')
287                     || !strchr(string, '>')) {
288                     (*outc) (NCURSES_SP_ARGx '$');
289                     (*outc) (NCURSES_SP_ARGx '<');
290                     continue;
291                 }
292
293                 number = 0;
294                 while (isdigit(UChar(*string))) {
295                     number = number * 10 + (*string - '0');
296                     string++;
297                 }
298                 number *= 10;
299                 if (*string == '.') {
300                     string++;
301                     if (isdigit(UChar(*string))) {
302                         number += (*string - '0');
303                         string++;
304                     }
305                     while (isdigit(UChar(*string)))
306                         string++;
307                 }
308
309                 mandatory = FALSE;
310                 while (*string == '*' || *string == '/') {
311                     if (*string == '*') {
312                         number *= affcnt;
313                         string++;
314                     } else {    /* if (*string == '/') */
315                         mandatory = TRUE;
316                         string++;
317                     }
318                 }
319
320                 if (number > 0
321                     && (always_delay
322                         || normal_delay
323                         || mandatory))
324                     NCURSES_SP_NAME(delay_output) (NCURSES_SP_ARGx number / 10);
325
326             }                   /* endelse (*string == '<') */
327         }                       /* endelse (*string == '$') */
328
329         if (*string == '\0')
330             break;
331
332         string++;
333     }
334
335 #if BSD_TPUTS
336     /*
337      * Emit any BSD-style prefix padding that we've accumulated now.
338      */
339     if (trailpad > 0
340         && (always_delay || normal_delay))
341         delay_output(trailpad / 10);
342 #endif /* BSD_TPUTS */
343
344     my_outch = NCURSES_SP_NAME(_nc_outch);
345     return OK;
346 }
347
348 #if NCURSES_SP_FUNCS
349 NCURSES_EXPORT(int)
350 _nc_outc_wrapper(SCREEN *sp, int c)
351 {
352     if (0 == sp) {
353         return (ERR);
354     } else {
355         return sp->jump(c);
356     }
357 }
358
359 NCURSES_EXPORT(int)
360 tputs(const char *string, int affcnt, int (*outc) (int))
361 {
362     SetSafeOutcWrapper(outc);
363     return NCURSES_SP_NAME(tputs) (NCURSES_SP_ARGx string, affcnt, _nc_outc_wrapper);
364 }
365 #endif