1 /****************************************************************************
2 * Copyright (c) 1998-2012,2013 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 ****************************************************************************/
40 #include <curses.priv.h>
45 MODULE_ID("$Id: lib_tparm.c,v 1.88 2013/01/26 17:07:05 tom Exp $")
51 * Substitute the given parameters into the given string by the following
52 * rules (taken from terminfo(5)):
54 * Cursor addressing and other strings requiring parame-
55 * ters in the terminal are described by a parameterized string
56 * capability, with like escapes %x in it. For example, to
57 * address the cursor, the cup capability is given, using two
58 * parameters: the row and column to address to. (Rows and
59 * columns are numbered from zero and refer to the physical
60 * screen visible to the user, not to any unseen memory.) If
61 * the terminal has memory relative cursor addressing, that can
64 * The parameter mechanism uses a stack and special %
65 * codes to manipulate it. Typically a sequence will push one
66 * of the parameters onto the stack and then print it in some
67 * format. Often more complex operations are necessary.
69 * The % encodings have the following meanings:
72 * %c print pop() like %c in printf()
73 * %s print pop() like %s in printf()
74 * %[[:]flags][width[.precision]][doxXs]
75 * as in printf, flags are [-+#] and space
76 * The ':' is used to avoid making %+ or %-
77 * patterns (see below).
79 * %p[1-9] push ith parm
80 * %P[a-z] set dynamic variable [a-z] to pop()
81 * %g[a-z] get dynamic variable [a-z] and push it
82 * %P[A-Z] set static variable [A-Z] to pop()
83 * %g[A-Z] get static variable [A-Z] and push it
85 * %'c' push char constant c
86 * %{nn} push integer constant nn
89 * arithmetic (%m is mod): push(pop() op pop())
90 * %& %| %^ bit operations: push(pop() op pop())
91 * %= %> %< logical operations: push(pop() op pop())
92 * %A %O logical and & or operations for conditionals
93 * %! %~ unary operations push(op pop())
94 * %i add 1 to first two parms (for ANSI terminals)
96 * %? expr %t thenpart %e elsepart %;
97 * if-then-else, %e elsepart is optional.
98 * else-if's are possible ala Algol 68:
99 * %? c1 %t b1 %e c2 %t b2 %e c3 %t b3 %e c4 %t b4 %e b5 %;
101 * For those of the above operators which are binary and not commutative,
102 * the stack works in the usual way, with
104 * resulting in x mod y, not the reverse.
107 NCURSES_EXPORT_VAR(int) _nc_tparm_err = 0;
109 #define TPS(var) _nc_prescreen.tparm_state.var
115 if (TPS(out_buff) != 0) {
116 FreeAndNull(TPS(out_buff));
119 FreeAndNull(TPS(fmt_buff));
125 static NCURSES_INLINE void
126 get_space(size_t need)
128 need += TPS(out_used);
129 if (need > TPS(out_size)) {
130 TPS(out_size) = need * 2;
131 TYPE_REALLOC(char, TPS(out_size), TPS(out_buff));
135 static NCURSES_INLINE void
136 save_text(const char *fmt, const char *s, int len)
138 size_t s_len = strlen(s);
139 if (len > (int) s_len)
140 s_len = (size_t) len;
142 get_space(s_len + 1);
144 _nc_SPRINTF(TPS(out_buff) + TPS(out_used),
145 _nc_SLIMIT(TPS(out_size) - TPS(out_used))
147 TPS(out_used) += strlen(TPS(out_buff) + TPS(out_used));
150 static NCURSES_INLINE void
151 save_number(const char *fmt, int number, int len)
154 len = 30; /* actually log10(MAX_INT)+1 */
156 get_space((size_t) len + 1);
158 _nc_SPRINTF(TPS(out_buff) + TPS(out_used),
159 _nc_SLIMIT(TPS(out_size) - TPS(out_used))
161 TPS(out_used) += strlen(TPS(out_buff) + TPS(out_used));
164 static NCURSES_INLINE void
169 get_space((size_t) 1);
170 TPS(out_buff)[TPS(out_used)++] = (char) c;
173 static NCURSES_INLINE void
176 if (TPS(stack_ptr) < STACKSIZE) {
177 TPS(stack)[TPS(stack_ptr)].num_type = TRUE;
178 TPS(stack)[TPS(stack_ptr)].data.num = x;
181 DEBUG(2, ("npush: stack overflow: %s", _nc_visbuf(TPS(tparam_base))));
186 static NCURSES_INLINE int
190 if (TPS(stack_ptr) > 0) {
192 if (TPS(stack)[TPS(stack_ptr)].num_type)
193 result = TPS(stack)[TPS(stack_ptr)].data.num;
195 DEBUG(2, ("npop: stack underflow: %s", _nc_visbuf(TPS(tparam_base))));
201 static NCURSES_INLINE void
204 if (TPS(stack_ptr) < STACKSIZE) {
205 TPS(stack)[TPS(stack_ptr)].num_type = FALSE;
206 TPS(stack)[TPS(stack_ptr)].data.str = x;
209 DEBUG(2, ("spush: stack overflow: %s", _nc_visbuf(TPS(tparam_base))));
214 static NCURSES_INLINE char *
217 static char dummy[] = ""; /* avoid const-cast */
218 char *result = dummy;
219 if (TPS(stack_ptr) > 0) {
221 if (!TPS(stack)[TPS(stack_ptr)].num_type
222 && TPS(stack)[TPS(stack_ptr)].data.str != 0)
223 result = TPS(stack)[TPS(stack_ptr)].data.str;
225 DEBUG(2, ("spop: stack underflow: %s", _nc_visbuf(TPS(tparam_base))));
231 static NCURSES_INLINE const char *
232 parse_format(const char *s, char *format, int *len)
237 bool allowminus = FALSE;
247 while (*s != '\0' && !done) {
249 case 'c': /* FALLTHRU */
250 case 'd': /* FALLTHRU */
251 case 'o': /* FALLTHRU */
252 case 'x': /* FALLTHRU */
253 case 'X': /* FALLTHRU */
262 } else { /* value before '.' is the width */
286 if (isdigit(UChar(*s))) {
287 value = (value * 10) + (*s - '0');
298 * If we found an error, ignore (and remove) the flags.
301 my_width = my_prec = value = 0;
308 * Any value after '.' is the precision. If we did not see '.', then
309 * the value is the width.
317 /* return maximum string length in print */
318 *len = (my_width > my_prec) ? my_width : my_prec;
323 #define isUPPER(c) ((c) >= 'A' && (c) <= 'Z')
324 #define isLOWER(c) ((c) >= 'a' && (c) <= 'z')
327 * Analyze the string to see how many parameters we need from the varargs list,
328 * and what their types are. We will only accept string parameters if they
329 * appear as a %l or %s format following an explicit parameter reference (e.g.,
330 * %p2%s). All other parameters are numbers.
332 * 'number' counts coarsely the number of pop's we see in the string, and
333 * 'popcount' shows the highest parameter number in the string. We would like
334 * to simply use the latter count, but if we are reading termcap strings, there
335 * may be cases that we cannot see the explicit parameter numbers.
338 _nc_tparm_analyze(const char *string, char *p_is_s[NUM_PARM], int *popcount)
345 const char *cp = string;
346 static char dummy[] = "";
351 if ((len2 = strlen(cp)) > TPS(fmt_size)) {
352 TPS(fmt_size) = len2 + TPS(fmt_size) + 2;
353 TPS(fmt_buff) = typeRealloc(char, TPS(fmt_size), TPS(fmt_buff));
354 if (TPS(fmt_buff) == 0)
358 memset(p_is_s, 0, sizeof(p_is_s[0]) * NUM_PARM);
361 while ((cp - string) < (int) len2) {
364 cp = parse_format(cp, TPS(fmt_buff), &len);
369 case 'd': /* FALLTHRU */
370 case 'o': /* FALLTHRU */
371 case 'x': /* FALLTHRU */
372 case 'X': /* FALLTHRU */
373 case 'c': /* FALLTHRU */
382 p_is_s[lastpop - 1] = dummy;
388 i = (UChar(*cp) - '0');
389 if (i >= 0 && i <= NUM_PARM) {
391 if (lastpop > *popcount)
412 while (isdigit(UChar(*cp))) {
441 /* will add 1 to first (usually two) parameters */
449 if (number > NUM_PARM)
454 static NCURSES_INLINE char *
455 tparam_internal(int use_TPARM_ARG, const char *string, va_list ap)
457 char *p_is_s[NUM_PARM];
458 TPARM_ARG param[NUM_PARM];
466 const char *cp = string;
476 * Find the highest parameter-number referred to in the format string.
477 * Use this value to limit the number of arguments copied from the
478 * variable-length argument list.
480 number = _nc_tparm_analyze(cp, p_is_s, &popcount);
481 if (TPS(fmt_buff) == 0)
484 if (number > NUM_PARM)
486 if (popcount > NUM_PARM)
488 num_args = max(popcount, number);
490 for (i = 0; i < num_args; i++) {
492 * A few caps (such as plab_norm) have string-valued parms.
493 * We'll have to assume that the caller knows the difference, since
494 * a char* and an int may not be the same size on the stack. The
495 * normal prototype for this uses 9 long's, which is consistent with
496 * our va_arg() usage.
498 if (p_is_s[i] != 0) {
499 p_is_s[i] = va_arg(ap, char *);
501 } else if (use_TPARM_ARG) {
502 param[i] = va_arg(ap, TPARM_ARG);
504 param[i] = (TPARM_ARG) va_arg(ap, int);
509 * This is a termcap compatibility hack. If there are no explicit pop
510 * operations in the string, load the stack in such a way that
511 * successive pops will grab successive parameters. That will make
512 * the expansion of (for example) \E[%d;%dH work correctly in termcap
513 * style, which means tparam() will expand termcap strings OK.
518 for (i = number - 1; i >= 0; i--) {
522 npush((int) param[i]);
526 if (USE_TRACEF(TRACE_CALLS)) {
527 for (i = 0; i < num_args; i++) {
529 save_text(", %s", _nc_visbuf(p_is_s[i]), 0);
531 save_number(", %d", (int) param[i], 0);
533 _tracef(T_CALLED("%s(%s%s)"), TPS(tname), _nc_visbuf(cp), TPS(out_buff));
535 _nc_unlock_global(tracef);
539 while ((cp - string) < (int) len2) {
541 save_char(UChar(*cp));
543 TPS(tparam_base) = cp++;
544 cp = parse_format(cp, TPS(fmt_buff), &len);
552 case 'd': /* FALLTHRU */
553 case 'o': /* FALLTHRU */
554 case 'x': /* FALLTHRU */
555 case 'X': /* FALLTHRU */
556 save_number(TPS(fmt_buff), npop(), len);
559 case 'c': /* FALLTHRU */
564 npush((int) strlen(spop()));
568 save_text(TPS(fmt_buff), spop(), len);
573 i = (UChar(*cp) - '1');
574 if (i >= 0 && i < NUM_PARM) {
578 npush((int) param[i]);
585 i = (UChar(*cp) - 'A');
586 TPS(static_vars)[i] = npop();
587 } else if (isLOWER(*cp)) {
588 i = (UChar(*cp) - 'a');
589 TPS(dynamic_var)[i] = npop();
596 i = (UChar(*cp) - 'A');
597 npush(TPS(static_vars)[i]);
598 } else if (isLOWER(*cp)) {
599 i = (UChar(*cp) - 'a');
600 npush(TPS(dynamic_var)[i]);
613 while (isdigit(UChar(*cp))) {
614 number = (number * 10) + (UChar(*cp) - '0');
621 npush(npop() + npop());
631 npush(npop() * npop());
637 npush(y ? (x / y) : 0);
643 npush(y ? (x % y) : 0);
647 npush(npop() && npop());
651 npush(npop() || npop());
655 npush(npop() & npop());
659 npush(npop() | npop());
663 npush(npop() ^ npop());
705 /* scan forward for %e or %; at level zero */
713 else if (*cp == ';') {
718 } else if (*cp == 'e' && level == 0)
729 /* scan forward for a %; at level zero */
737 else if (*cp == ';') {
753 } /* endswitch (*cp) */
754 } /* endelse (*cp == '%') */
760 } /* endwhile (*cp) */
762 get_space((size_t) 1);
763 TPS(out_buff)[TPS(out_used)] = '\0';
765 T((T_RETURN("%s"), _nc_visbuf(TPS(out_buff))));
766 return (TPS(out_buff));
769 #if NCURSES_TPARM_VARARGS
770 #define tparm_varargs tparm
772 #define tparm_proto tparm
775 NCURSES_EXPORT(char *)
776 tparm_varargs(NCURSES_CONST char *string,...)
782 va_start(ap, string);
784 TPS(tname) = "tparm";
786 result = tparam_internal(TRUE, string, ap);
791 #if !NCURSES_TPARM_VARARGS
792 NCURSES_EXPORT(char *)
793 tparm_proto(NCURSES_CONST char *string,
804 return tparm_varargs(string, a1, a2, a3, a4, a5, a6, a7, a8, a9);
806 #endif /* NCURSES_TPARM_VARARGS */
808 NCURSES_EXPORT(char *)
809 tiparm(const char *string,...)
815 va_start(ap, string);
817 TPS(tname) = "tiparm";
819 result = tparam_internal(FALSE, string, ap);