coreutils/expr.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Mini expr implementation for busybox
   4  *
   5  * based on GNU expr Mike Parker.
   6  * Copyright (C) 86, 1991-1997, 1999 Free Software Foundation, Inc.
   7  *
   8  * Busybox modifications
   9  * Copyright (c) 2000  Edward Betts <edward@debian.org>.
  10  * Copyright (C) 2003-2005  Vladimir Oleynik <dzo@simtreas.ru>
  11  *  - reduced 464 bytes.
  12  *  - 64 math support
  13  *
  14  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  15  */
  16
  17 /* This program evaluates expressions.  Each token (operator, operand,
  18  * parenthesis) of the expression must be a separate argument.  The
  19  * parser used is a reasonably general one, though any incarnation of
  20  * it is language-specific.  It is especially nice for expressions.
  21  *
  22  * No parse tree is needed; a new node is evaluated immediately.
  23  * One function can handle multiple operators all of equal precedence,
  24  * provided they all associate ((x op x) op x). */
  25
  26 /* no getopt needed */
  27
  28 //usage:#define expr_trivial_usage
  29 //usage:       "EXPRESSION"
  30 //usage:#define expr_full_usage "\n\n"
  31 //usage:       "Print the value of EXPRESSION to stdout\n"
  32 //usage:    "\n"
  33 //usage:       "EXPRESSION may be:\n"
  34 //usage:       "        ARG1 | ARG2     ARG1 if it is neither null nor 0, otherwise ARG2\n"
  35 //usage:       "        ARG1 & ARG2     ARG1 if neither argument is null or 0, otherwise 0\n"
  36 //usage:       "        ARG1 < ARG2     1 if ARG1 is less than ARG2, else 0. Similarly:\n"
  37 //usage:       "        ARG1 <= ARG2\n"
  38 //usage:       "        ARG1 = ARG2\n"
  39 //usage:       "        ARG1 != ARG2\n"
  40 //usage:       "        ARG1 >= ARG2\n"
  41 //usage:       "        ARG1 > ARG2\n"
  42 //usage:       "        ARG1 + ARG2     Sum of ARG1 and ARG2. Similarly:\n"
  43 //usage:       "        ARG1 - ARG2\n"
  44 //usage:       "        ARG1 * ARG2\n"
  45 //usage:       "        ARG1 / ARG2\n"
  46 //usage:       "        ARG1 % ARG2\n"
  47 //usage:       "        STRING : REGEXP         Anchored pattern match of REGEXP in STRING\n"
  48 //usage:       "        match STRING REGEXP     Same as STRING : REGEXP\n"
  49 //usage:       "        substr STRING POS LENGTH Substring of STRING, POS counted from 1\n"
  50 //usage:       "        index STRING CHARS      Index in STRING where any CHARS is found, or 0\n"
  51 //usage:       "        length STRING           Length of STRING\n"
  52 //usage:       "        quote TOKEN             Interpret TOKEN as a string, even if\n"
  53 //usage:       "                                it is a keyword like 'match' or an\n"
  54 //usage:       "                                operator like '/'\n"
  55 //usage:       "        (EXPRESSION)            Value of EXPRESSION\n"
  56 //usage:       "\n"
  57 //usage:       "Beware that many operators need to be escaped or quoted for shells.\n"
  58 //usage:       "Comparisons are arithmetic if both ARGs are numbers, else\n"
  59 //usage:       "lexicographical. Pattern matches return the string matched between\n"
  60 //usage:       "\\( and \\) or null; if \\( and \\) are not used, they return the number\n"
  61 //usage:       "of characters matched or 0."
  62
  63 #include "libbb.h"
  64 #include "xregex.h"
  65
  66 #if ENABLE_EXPR_MATH_SUPPORT_64
  67 typedef int64_t arith_t;
  68
  69 #define PF_REZ      "ll"
  70 #define PF_REZ_TYPE (long long)
  71 #define STRTOL(s, e, b) strtoll(s, e, b)
  72 #else
  73 typedef long arith_t;
  74
  75 #define PF_REZ      "l"
  76 #define PF_REZ_TYPE (long)
  77 #define STRTOL(s, e, b) strtol(s, e, b)
  78 #endif
  79
  80 /* TODO: use bb_strtol[l]? It's easier to check for errors... */
  81
  82 /* The kinds of value we can have.  */
  83 enum {
  84         INTEGER,
  85         STRING
  86 };
  87
  88 /* A value is.... */
  89 struct valinfo {
  90         smallint type;                  /* Which kind. */
  91         union {                         /* The value itself. */
  92                 arith_t i;
  93                 char *s;
  94         } u;
  95 };
  96 typedef struct valinfo VALUE;
  97
  98 /* The arguments given to the program, minus the program name.  */
  99 struct globals {
 100         char **args;
 101 } FIX_ALIASING;
 102 #define G (*(struct globals*)&bb_common_bufsiz1)
 103
 104 /* forward declarations */
 105 static VALUE *eval(void);
 106
 107
 108 /* Return a VALUE for I.  */
 109
 110 static VALUE *int_value(arith_t i)
 111 {
 112         VALUE *v;
 113
 114         v = xzalloc(sizeof(VALUE));
 115         if (INTEGER) /* otherwise xzaaloc did it already */
 116                 v->type = INTEGER;
 117         v->u.i = i;
 118         return v;
 119 }
 120
 121 /* Return a VALUE for S.  */
 122
 123 static VALUE *str_value(const char *s)
 124 {
 125         VALUE *v;
 126
 127         v = xzalloc(sizeof(VALUE));
 128         if (STRING) /* otherwise xzaaloc did it already */
 129                 v->type = STRING;
 130         v->u.s = xstrdup(s);
 131         return v;
 132 }
 133
 134 /* Free VALUE V, including structure components.  */
 135
 136 static void freev(VALUE *v)
 137 {
 138         if (v->type == STRING)
 139                 free(v->u.s);
 140         free(v);
 141 }
 142
 143 /* Return nonzero if V is a null-string or zero-number.  */
 144
 145 static int null(VALUE *v)
 146 {
 147         if (v->type == INTEGER)
 148                 return v->u.i == 0;
 149         /* STRING: */
 150         return v->u.s[0] == '\0' || LONE_CHAR(v->u.s, '0');
 151 }
 152
 153 /* Coerce V to a STRING value (can't fail).  */
 154
 155 static void tostring(VALUE *v)
 156 {
 157         if (v->type == INTEGER) {
 158                 v->u.s = xasprintf("%" PF_REZ "d", PF_REZ_TYPE v->u.i);
 159                 v->type = STRING;
 160         }
 161 }
 162
 163 /* Coerce V to an INTEGER value.  Return 1 on success, 0 on failure.  */
 164
 165 static bool toarith(VALUE *v)
 166 {
 167         if (v->type == STRING) {
 168                 arith_t i;
 169                 char *e;
 170
 171                 /* Don't interpret the empty string as an integer.  */
 172                 /* Currently does not worry about overflow or int/long differences. */
 173                 i = STRTOL(v->u.s, &e, 10);
 174                 if ((v->u.s == e) || *e)
 175                         return 0;
 176                 free(v->u.s);
 177                 v->u.i = i;
 178                 v->type = INTEGER;
 179         }
 180         return 1;
 181 }
 182
 183 /* Return str[0]+str[1] if the next token matches STR exactly.
 184    STR must not be NULL.  */
 185
 186 static int nextarg(const char *str)
 187 {
 188         if (*G.args == NULL || strcmp(*G.args, str) != 0)
 189                 return 0;
 190         return (unsigned char)str[0] + (unsigned char)str[1];
 191 }
 192
 193 /* The comparison operator handling functions.  */
 194
 195 static int cmp_common(VALUE *l, VALUE *r, int op)
 196 {
 197         arith_t ll, rr;
 198
 199         ll = l->u.i;
 200         rr = r->u.i;
 201         if (l->type == STRING || r->type == STRING) {
 202                 tostring(l);
 203                 tostring(r);
 204                 ll = strcmp(l->u.s, r->u.s);
 205                 rr = 0;
 206         }
 207         /* calculating ll - rr and checking the result is prone to overflows.
 208          * We'll do it differently: */
 209         if (op == '<')
 210                 return ll < rr;
 211         if (op == ('<' + '='))
 212                 return ll <= rr;
 213         if (op == '=' || (op == '=' + '='))
 214                 return ll == rr;
 215         if (op == '!' + '=')
 216                 return ll != rr;
 217         if (op == '>')
 218                 return ll > rr;
 219         /* >= */
 220         return ll >= rr;
 221 }
 222
 223 /* The arithmetic operator handling functions.  */
 224
 225 static arith_t arithmetic_common(VALUE *l, VALUE *r, int op)
 226 {
 227         arith_t li, ri;
 228
 229         if (!toarith(l) || !toarith(r))
 230                 bb_error_msg_and_die("non-numeric argument");
 231         li = l->u.i;
 232         ri = r->u.i;
 233         if (op == '+')
 234                 return li + ri;
 235         if (op == '-')
 236                 return li - ri;
 237         if (op == '*')
 238                 return li * ri;
 239         if (ri == 0)
 240                 bb_error_msg_and_die("division by zero");
 241         if (op == '/')
 242                 return li / ri;
 243         return li % ri;
 244 }
 245
 246 /* Do the : operator.
 247    SV is the VALUE for the lhs (the string),
 248    PV is the VALUE for the rhs (the pattern).  */
 249
 250 static VALUE *docolon(VALUE *sv, VALUE *pv)
 251 {
 252         enum { NMATCH = 2 };
 253         VALUE *v;
 254         regex_t re_buffer;
 255         regmatch_t re_regs[NMATCH];
 256
 257         tostring(sv);
 258         tostring(pv);
 259
 260         if (pv->u.s[0] == '^') {
 261                 bb_error_msg(
 262 "warning: '%s': using '^' as the first character\n"
 263 "of a basic regular expression is not portable; it is ignored", pv->u.s);
 264         }
 265
 266         memset(&re_buffer, 0, sizeof(re_buffer));
 267         memset(re_regs, 0, sizeof(re_regs));
 268         xregcomp(&re_buffer, pv->u.s, 0);
 269
 270         /* expr uses an anchored pattern match, so check that there was a
 271          * match and that the match starts at offset 0. */
 272         if (regexec(&re_buffer, sv->u.s, NMATCH, re_regs, 0) != REG_NOMATCH
 273          && re_regs[0].rm_so == 0
 274         ) {
 275                 /* Were \(...\) used? */
 276                 if (re_buffer.re_nsub > 0 && re_regs[1].rm_so >= 0) {
 277                         sv->u.s[re_regs[1].rm_eo] = '\0';
 278                         v = str_value(sv->u.s + re_regs[1].rm_so);
 279                 } else {
 280                         v = int_value(re_regs[0].rm_eo);
 281                 }
 282         } else {
 283                 /* Match failed -- return the right kind of null.  */
 284                 if (re_buffer.re_nsub > 0)
 285                         v = str_value("");
 286                 else
 287                         v = int_value(0);
 288         }
 289         regfree(&re_buffer);
 290         return v;
 291 }
 292
 293 /* Handle bare operands and ( expr ) syntax.  */
 294
 295 static VALUE *eval7(void)
 296 {
 297         VALUE *v;
 298
 299         if (!*G.args)
 300                 bb_error_msg_and_die("syntax error");
 301
 302         if (nextarg("(")) {
 303                 G.args++;
 304                 v = eval();
 305                 if (!nextarg(")"))
 306                         bb_error_msg_and_die("syntax error");
 307                 G.args++;
 308                 return v;
 309         }
 310
 311         if (nextarg(")"))
 312                 bb_error_msg_and_die("syntax error");
 313
 314         return str_value(*G.args++);
 315 }
 316
 317 /* Handle match, substr, index, length, and quote keywords.  */
 318
 319 static VALUE *eval6(void)
 320 {
 321         static const char keywords[] ALIGN1 =
 322                 "quote\0""length\0""match\0""index\0""substr\0";
 323
 324         VALUE *r, *i1, *i2;
 325         VALUE *l = l; /* silence gcc */
 326         VALUE *v = v; /* silence gcc */
 327         int key = *G.args ? index_in_strings(keywords, *G.args) + 1 : 0;
 328
 329         if (key == 0) /* not a keyword */
 330                 return eval7();
 331         G.args++; /* We have a valid token, so get the next argument.  */
 332         if (key == 1) { /* quote */
 333                 if (!*G.args)
 334                         bb_error_msg_and_die("syntax error");
 335                 return str_value(*G.args++);
 336         }
 337         if (key == 2) { /* length */
 338                 r = eval6();
 339                 tostring(r);
 340                 v = int_value(strlen(r->u.s));
 341                 freev(r);
 342         } else
 343                 l = eval6();
 344
 345         if (key == 3) { /* match */
 346                 r = eval6();
 347                 v = docolon(l, r);
 348                 freev(l);
 349                 freev(r);
 350         }
 351         if (key == 4) { /* index */
 352                 r = eval6();
 353                 tostring(l);
 354                 tostring(r);
 355                 v = int_value(strcspn(l->u.s, r->u.s) + 1);
 356                 if (v->u.i == (arith_t) strlen(l->u.s) + 1)
 357                         v->u.i = 0;
 358                 freev(l);
 359                 freev(r);
 360         }
 361         if (key == 5) { /* substr */
 362                 i1 = eval6();
 363                 i2 = eval6();
 364                 tostring(l);
 365                 if (!toarith(i1) || !toarith(i2)
 366                  || i1->u.i > (arith_t) strlen(l->u.s)
 367                  || i1->u.i <= 0 || i2->u.i <= 0)
 368                         v = str_value("");
 369                 else {
 370                         v = xmalloc(sizeof(VALUE));
 371                         v->type = STRING;
 372                         v->u.s = xstrndup(l->u.s + i1->u.i - 1, i2->u.i);
 373                 }
 374                 freev(l);
 375                 freev(i1);
 376                 freev(i2);
 377         }
 378         return v;
 379 }
 380
 381 /* Handle : operator (pattern matching).
 382    Calls docolon to do the real work.  */
 383
 384 static VALUE *eval5(void)
 385 {
 386         VALUE *l, *r, *v;
 387
 388         l = eval6();
 389         while (nextarg(":")) {
 390                 G.args++;
 391                 r = eval6();
 392                 v = docolon(l, r);
 393                 freev(l);
 394                 freev(r);
 395                 l = v;
 396         }
 397         return l;
 398 }
 399
 400 /* Handle *, /, % operators.  */
 401
 402 static VALUE *eval4(void)
 403 {
 404         VALUE *l, *r;
 405         int op;
 406         arith_t val;
 407
 408         l = eval5();
 409         while (1) {
 410                 op = nextarg("*");
 411                 if (!op) { op = nextarg("/");
 412                  if (!op) { op = nextarg("%");
 413                   if (!op) return l;
 414                 }}
 415                 G.args++;
 416                 r = eval5();
 417                 val = arithmetic_common(l, r, op);
 418                 freev(l);
 419                 freev(r);
 420                 l = int_value(val);
 421         }
 422 }
 423
 424 /* Handle +, - operators.  */
 425
 426 static VALUE *eval3(void)
 427 {
 428         VALUE *l, *r;
 429         int op;
 430         arith_t val;
 431
 432         l = eval4();
 433         while (1) {
 434                 op = nextarg("+");
 435                 if (!op) {
 436                         op = nextarg("-");
 437                         if (!op) return l;
 438                 }
 439                 G.args++;
 440                 r = eval4();
 441                 val = arithmetic_common(l, r, op);
 442                 freev(l);
 443                 freev(r);
 444                 l = int_value(val);
 445         }
 446 }
 447
 448 /* Handle comparisons.  */
 449
 450 static VALUE *eval2(void)
 451 {
 452         VALUE *l, *r;
 453         int op;
 454         arith_t val;
 455
 456         l = eval3();
 457         while (1) {
 458                 op = nextarg("<");
 459                 if (!op) { op = nextarg("<=");
 460                  if (!op) { op = nextarg("=");
 461                   if (!op) { op = nextarg("==");
 462                    if (!op) { op = nextarg("!=");
 463                     if (!op) { op = nextarg(">=");
 464                      if (!op) { op = nextarg(">");
 465                       if (!op) return l;
 466                 }}}}}}
 467                 G.args++;
 468                 r = eval3();
 469                 toarith(l);
 470                 toarith(r);
 471                 val = cmp_common(l, r, op);
 472                 freev(l);
 473                 freev(r);
 474                 l = int_value(val);
 475         }
 476 }
 477
 478 /* Handle &.  */
 479
 480 static VALUE *eval1(void)
 481 {
 482         VALUE *l, *r;
 483
 484         l = eval2();
 485         while (nextarg("&")) {
 486                 G.args++;
 487                 r = eval2();
 488                 if (null(l) || null(r)) {
 489                         freev(l);
 490                         freev(r);
 491                         l = int_value(0);
 492                 } else
 493                         freev(r);
 494         }
 495         return l;
 496 }
 497
 498 /* Handle |.  */
 499
 500 static VALUE *eval(void)
 501 {
 502         VALUE *l, *r;
 503
 504         l = eval1();
 505         while (nextarg("|")) {
 506                 G.args++;
 507                 r = eval1();
 508                 if (null(l)) {
 509                         freev(l);
 510                         l = r;
 511                 } else
 512                         freev(r);
 513         }
 514         return l;
 515 }
 516
 517 int expr_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 518 int expr_main(int argc UNUSED_PARAM, char **argv)
 519 {
 520         VALUE *v;
 521
 522         xfunc_error_retval = 2; /* coreutils compat */
 523         G.args = argv + 1;
 524         if (*G.args == NULL) {
 525                 bb_error_msg_and_die("too few arguments");
 526         }
 527         v = eval();
 528         if (*G.args)
 529                 bb_error_msg_and_die("syntax error");
 530         if (v->type == INTEGER)
 531                 printf("%" PF_REZ "d\n", PF_REZ_TYPE v->u.i);
 532         else
 533                 puts(v->u.s);
 534         fflush_stdout_and_exit(null(v));
 535 }