Start 1.33.0 development cycle
[oweals/busybox.git] / libbb / process_escape_sequence.c
index ad2be94ee23e56776e0bf0505e7dd798b9512dfd..13022b83eea5428a8c999f549b08486e4bf5a144 100644 (file)
 /*
  * Utility routines.
  *
- * Copyright (C) tons of folks.  Tracking down who wrote what
- * isn't something I'm going to worry about...  If you wrote something
- * here, please feel free to acknowledge your work.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- *
- * Based in part on code from sash, Copyright (c) 1999 by David I. Bell 
- * Permission has been granted to redistribute this code under the GPL.
+ * Copyright (C) Manuel Novoa III <mjn3@codepoet.org>
+ * and Vladimir Oleynik <dzo@simtreas.ru>
  *
+ * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
-
-#include <stdio.h>
-#include <limits.h>
 #include "libbb.h"
 
+#define WANT_HEX_ESCAPES 1
 
+/* Usual "this only works for ascii compatible encodings" disclaimer. */
+#undef _tolower
+#define _tolower(X) ((X)|((char) 0x20))
 
-char process_escape_sequence(char **ptr)
+char FAST_FUNC bb_process_escape_sequence(const char **ptr)
 {
-       static const char charmap[] = {
-                  'a',  'b',  'f',  'n',  'r',  't',  'v',  '\\', 0,
-              '\a', '\b', '\f', '\n', '\r', '\t', '\v', '\\', '\\' };
+       const char *q;
+       unsigned num_digits;
+       unsigned n;
+       unsigned base;
 
-       const char *p;
-          char *q;
-       int num_digits;
-       unsigned int n;
+       num_digits = n = 0;
+       base = 8;
+       q = *ptr;
 
-       n = 0;
-          q = *ptr;
+       if (WANT_HEX_ESCAPES && *q == 'x') {
+               ++q;
+               base = 16;
+               ++num_digits;
+       }
 
-       for ( num_digits = 0 ; num_digits < 3 ; ++num_digits) {
-              if ((*q < '0') || (*q > '7')) { /* not a digit? */
-                      break;
-              }
-              n = n * 8 + (*q++ - '0');
-       }
+       /* bash requires leading 0 in octal escapes:
+        * \02 works, \2 does not (prints \ and 2).
+        * We treat \2 as a valid octal escape sequence. */
+       do {
+               unsigned r;
+               unsigned d = (unsigned char)(*q) - '0';
+#if WANT_HEX_ESCAPES
+               if (d >= 10) {
+                       d = (unsigned char)_tolower(*q) - 'a';
+                       //d += 10;
+                       /* The above would map 'A'-'F' and 'a'-'f' to 10-15,
+                        * however, some chars like '@' would map to 9 < base.
+                        * Do not allow that, map invalid chars to N > base:
+                        */
+                       if ((int)d >= 0)
+                               d += 10;
+               }
+#endif
+               if (d >= base) {
+                       if (WANT_HEX_ESCAPES && base == 16) {
+                               --num_digits;
+                               if (num_digits == 0) {
+                                       /* \x<bad_char>: return '\',
+                                        * leave ptr pointing to x */
+                                       return '\\';
+                               }
+                       }
+                       break;
+               }
 
-       if (num_digits == 0) {  /* mnemonic escape sequence? */
-                  for (p=charmap ; *p ; p++) {
-                          if (*p == *q) {
-                                  q++;
-                                  break;
-                          }
-                  }
-                  n = *(p+(sizeof(charmap)/2));
-          }
+               r = n * base + d;
+               if (r > UCHAR_MAX) {
+                       break;
+               }
 
-          /* doesn't hurt to fall through to here from mnemonic case */
-          if (n > UCHAR_MAX) { /* is octal code too big for a char? */
-                  n /= 8;                      /* adjust value and */
-                  --q;                         /* back up one char */
-          }
+               n = r;
+               ++q;
+       } while (++num_digits < 3);
 
-          *ptr = q;
-          return (char) n;
-}
+       if (num_digits == 0) {
+               /* Not octal or hex escape sequence.
+                * Is it one-letter one? */
 
+               /* bash builtin "echo -e '\ec'" interprets \e as ESC,
+                * but coreutils "/bin/echo -e '\ec'" does not.
+                * Manpages tend to support coreutils way.
+                * Update: coreutils added support for \e on 28 Oct 2009. */
+               static const char charmap[] ALIGN1 = {
+                       'a',  'b', 'e', 'f',  'n',  'r',  't',  'v',  '\\', '\0',
+                       '\a', '\b', 27, '\f', '\n', '\r', '\t', '\v', '\\', '\\',
+               };
+               const char *p = charmap;
+               do {
+                       if (*p == *q) {
+                               q++;
+                               break;
+                       }
+               } while (*++p != '\0');
+               /* p points to found escape char or NUL,
+                * advance it and find what it translates to.
+                * Note that \NUL and unrecognized sequence \z return '\'
+                * and leave ptr pointing to NUL or z. */
+               n = p[sizeof(charmap) / 2];
+       }
 
-/* END CODE */
-/*
-Local Variables:
-c-file-style: "linux"
-c-basic-offset: 4
-tab-width: 4
-End:
-*/
+       *ptr = q;
+
+       return (char) n;
+}
+
+char* FAST_FUNC strcpy_and_process_escape_sequences(char *dst, const char *src)
+{
+       while (1) {
+               char c, c1;
+               c = c1 = *src++;
+               if (c1 == '\\')
+                       c1 = bb_process_escape_sequence(&src);
+               *dst = c1;
+               if (c == '\0')
+                       return dst;
+               dst++;
+       }
+}