claenups for previous commit
[oweals/busybox.git] / coreutils / echo.c
index 5fa3d10c55e64aafa7c3caf456343b04512a1eb8..e45b909402a6cd2563cfc16216ab9878732ecf72 100644 (file)
@@ -9,10 +9,6 @@
  *
  * Original copyright notice is retained at the end of this file.
  */
-
-/* BB_AUDIT SUSv3 compliant -- unless configured as fancy echo. */
-/* http://www.opengroup.org/onlinepubs/007904975/utilities/echo.html */
-
 /* Mar 16, 2003      Manuel Novoa III   (mjn3@codepoet.org)
  *
  * Because of behavioral differences, implemented configurable SUSv3
  * 2) SUSv3 specifies that octal escapes are of the form \0{#{#{#}}}.
  *    The previous version did not allow 4-digit octals.
  */
+//config:config ECHO
+//config:      bool "echo (basic SuSv3 version taking no options)"
+//config:      default y
+//config:      help
+//config:      echo is used to print a specified string to stdout.
+//config:
+//config:# this entry also appears in shell/Config.in, next to the echo builtin
+//config:config FEATURE_FANCY_ECHO
+//config:      bool "Enable -n and -e options"
+//config:      default y
+//config:      depends on ECHO || ASH_ECHO || HUSH_ECHO
+
+//applet:IF_ECHO(APPLET_NOFORK(echo, echo, BB_DIR_BIN, BB_SUID_DROP, echo))
+
+//kbuild:lib-$(CONFIG_ECHO) += echo.o
+
+//kbuild:lib-$(CONFIG_ASH_ECHO)  += echo.o
+//kbuild:lib-$(CONFIG_HUSH_ECHO) += echo.o
+
+/* BB_AUDIT SUSv3 compliant -- unless configured as fancy echo. */
+/* http://www.opengroup.org/onlinepubs/007904975/utilities/echo.html */
+
+//usage:#define echo_trivial_usage
+//usage:       IF_FEATURE_FANCY_ECHO("[-neE] ") "[ARG]..."
+//usage:#define echo_full_usage "\n\n"
+//usage:       "Print the specified ARGs to stdout"
+//usage:       IF_FEATURE_FANCY_ECHO( "\n"
+//usage:     "\n       -n      Suppress trailing newline"
+//usage:     "\n       -e      Interpret backslash escapes (i.e., \\t=tab)"
+//usage:     "\n       -E      Don't interpret backslash escapes (default)"
+//usage:       )
+//usage:
+//usage:#define echo_example_usage
+//usage:       "$ echo \"Erik is cool\"\n"
+//usage:       "Erik is cool\n"
+//usage:       IF_FEATURE_FANCY_ECHO("$ echo -e \"Erik\\nis\\ncool\"\n"
+//usage:       "Erik\n"
+//usage:       "is\n"
+//usage:       "cool\n"
+//usage:       "$ echo \"Erik\\nis\\ncool\"\n"
+//usage:       "Erik\\nis\\ncool\n")
 
 #include "libbb.h"
 
@@ -50,55 +87,54 @@ int echo_main(int argc UNUSED_PARAM, char **argv)
        char *out;
        char *buffer;
        unsigned buflen;
-       int r;
 #if !ENABLE_FEATURE_FANCY_ECHO
        enum {
-               eflag = '\\',
+               eflag = 0,  /* 0 -- disable escape sequences */
                nflag = 1,  /* 1 -- print '\n' */
        };
 
        argv++;
 #else
-       const char *p;
        char nflag = 1;
        char eflag = 0;
 
        while ((arg = *++argv) != NULL) {
-               if (!arg || arg[0] != '-')
-                       break;
+               char n, e;
+
+               if (arg[0] != '-')
+                       break; /* not an option arg, echo it */
 
                /* If it appears that we are handling options, then make sure
                 * that all of the options specified are actually valid.
                 * Otherwise, the string should just be echoed.
                 */
-               p = arg + 1;
-               if (!*p)        /* A single '-', so echo it. */
-                       break;
-
+               arg++;
+               n = nflag;
+               e = eflag;
                do {
-                       if (!strrchr("neE", *p))
+                       if (*arg == 'n')
+                               n = 0;
+                       else if (*arg == 'e')
+                               e = '\\';
+                       else if (*arg != 'E') {
+                               /* "-ccc" arg with one of c's invalid, echo it */
+                               /* arg consisting from just "-" also handled here */
                                goto just_echo;
-               } while (*++p);
-
-               /* All of the options in this arg are valid, so handle them. */
-               p = arg + 1;
-               do {
-                       if (*p == 'n')
-                               nflag = 0;
-                       if (*p == 'e')
-                               eflag = '\\';
-               } while (*++p);
+                       }
+               } while (*++arg);
+               nflag = n;
+               eflag = e;
        }
  just_echo:
 #endif
 
-       buflen = 1;
+       buflen = 0;
        pp = argv;
        while ((arg = *pp) != NULL) {
                buflen += strlen(arg) + 1;
                pp++;
        }
-       out = buffer = xmalloc(buflen);
+       out = buffer = xmalloc(buflen + 1); /* +1 is needed for "no args" case */
 
        while ((arg = *argv) != NULL) {
                int c;
@@ -106,29 +142,32 @@ int echo_main(int argc UNUSED_PARAM, char **argv)
                if (!eflag) {
                        /* optimization for very common case */
                        out = stpcpy(out, arg);
-               } else while ((c = *arg++)) {
-                       if (c == eflag) {       /* Check for escape seq. */
+               } else
+               while ((c = *arg++) != '\0') {
+                       if (c == eflag) {
+                               /* This is an "\x" sequence */
+
                                if (*arg == 'c') {
-                                       /* '\c' means cancel newline and
+                                       /* "\c" means cancel newline and
                                         * ignore all subsequent chars. */
                                        goto do_write;
                                }
-#if !ENABLE_FEATURE_FANCY_ECHO
-                               /* SUSv3 specifies that octal escapes must begin with '0'. */
-                               if ( ((int)(unsigned char)(*arg) - '0') >= 8) /* '8' or bigger */
-#endif
-                               {
-                                       /* Since SUSv3 mandates a first digit of 0, 4-digit octals
-                                       * of the form \0### are accepted. */
-                                       if (*arg == '0') {
-                                               /* NB: don't turn "...\0" into "...\" */
-                                               if (arg[1] && ((unsigned char)(arg[1]) - '0') < 8) {
-                                                       arg++;
-                                               }
+                               /* Since SUSv3 mandates a first digit of 0, 4-digit octals
+                               * of the form \0### are accepted. */
+                               if (*arg == '0') {
+                                       if ((unsigned char)(arg[1] - '0') < 8) {
+                                               /* 2nd char is 0..7: skip leading '0' */
+                                               arg++;
                                        }
-                                       /* bb_process_escape_sequence handles NUL correctly
-                                        * ("...\" case). */
-                                       c = bb_process_escape_sequence(&arg);
+                               }
+                               /* bb_process_escape_sequence handles NUL correctly
+                                * ("...\" case). */
+                               {
+                                       /* optimization: don't force arg to be on-stack,
+                                        * use another variable for that. ~30 bytes win */
+                                       const char *z = arg;
+                                       c = bb_process_escape_sequence(&z);
+                                       arg = z;
                                }
                        }
                        *out++ = c;
@@ -144,16 +183,18 @@ int echo_main(int argc UNUSED_PARAM, char **argv)
        }
 
  do_write:
-       r = full_write(STDOUT_FILENO, buffer, out - buffer);
+       /* Careful to error out on partial writes too (think ENOSPC!) */
+       errno = 0;
+       /*r =*/ full_write(STDOUT_FILENO, buffer, out - buffer);
        free(buffer);
-       if (r < 0) {
+       if (/*WRONG:r < 0*/ errno) {
                bb_perror_msg(bb_msg_write_error);
                return 1;
        }
        return 0;
 }
 
-/*-
+/*
  * Copyright (c) 1991, 1993
  *     The Regents of the University of California.  All rights reserved.
  *
@@ -177,7 +218,7 @@ int echo_main(int argc UNUSED_PARAM, char **argv)
  *    may be used to endorse or promote products derived from this software
  *    without specific prior written permission.
  *
- * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ''AS IS'' AND
  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
@@ -239,7 +280,7 @@ int echo_main(int argc, char **argv)
                        goto just_echo;
 
                do {
-                       if (!strrchr("neE", *p))
+                       if (!strchr("neE", *p))
                                goto just_echo;
                } while (*++p);
 
@@ -265,27 +306,23 @@ int echo_main(int argc, char **argv)
                        /* optimization for very common case */
                        p += strlen(arg);
                } else while ((c = *arg++)) {
-                       if (c == eflag) {       /* Check for escape seq. */
+                       if (c == eflag) {
+                               /* This is an "\x" sequence */
+
                                if (*arg == 'c') {
-                                       /* '\c' means cancel newline and
+                                       /* "\c" means cancel newline and
                                         * ignore all subsequent chars. */
                                        cur_io->iov_len = p - (char*)cur_io->iov_base;
                                        cur_io++;
                                        goto ret;
                                }
-#if !ENABLE_FEATURE_FANCY_ECHO
-                               /* SUSv3 specifies that octal escapes must begin with '0'. */
-                               if ( (((unsigned char)*arg) - '1') >= 7)
-#endif
-                               {
-                                       /* Since SUSv3 mandates a first digit of 0, 4-digit octals
-                                       * of the form \0### are accepted. */
-                                       if (*arg == '0' && ((unsigned char)(arg[1]) - '0') < 8) {
-                                               arg++;
-                                       }
-                                       /* bb_process_escape_sequence can handle nul correctly */
-                                       c = bb_process_escape_sequence( (void*) &arg);
+                               /* Since SUSv3 mandates a first digit of 0, 4-digit octals
+                               * of the form \0### are accepted. */
+                               if (*arg == '0' && (unsigned char)(arg[1] - '0') < 8) {
+                                       arg++;
                                }
+                               /* bb_process_escape_sequence can handle nul correctly */
+                               c = bb_process_escape_sequence( (void*) &arg);
                        }
                        *p++ = c;
                }