Added mhshow-suffix-text entry.

[nmh] / sbr / error.c

diff --git a/sbr/error.c b/sbr/error.c
index beb4ba6d2213e77937e9ac61c116a8ccdea47987..e4bc9e3f96c093f372263574baac2cdd3b715bb4 100644 (file)
--- a/sbr/error.c
+++ b/sbr/error.c
@@ -13,9 +13,8 @@
 #include <sys/uio.h>
 
 
-/*
- * print out error message
- */
+/* advise calls advertise() with no tail to print fmt, and perhaps what,
+ * to stderr. */
 void
 advise (const char *what, const char *fmt, ...)
 {
@@ -27,9 +26,12 @@ advise (const char *what, const char *fmt, ...)
 }
 
 
-/*
- * print out error message and exit
- */
+/* adios calls advertise() with no tail to print fmt, and perhaps what,
+ * to stderr, and "ends" the program with an error exit status.  The
+ * route to exit is via the done function pointer and may not be
+ * straightforward.
+ * FIXME: Document if this function can ever return.  If not, perhaps an
+ * abort(3) at the end of the routine would make that more clear. */
 void
 adios (const char *what, const char *fmt, ...)
 {
@@ -42,9 +44,8 @@ adios (const char *what, const char *fmt, ...)
 }
 
 
-/*
- * admonish the user
- */
+/* admonish calls advertise() with a tail indicating the program
+ * continues. */
 void
 admonish (char *what, char *fmt, ...)
 {
@@ -56,57 +57,68 @@ admonish (char *what, char *fmt, ...)
 }
 
 
-/*
- * main routine for printing error messages.
- */
+/* advertise prints fmt and ap to stderr after flushing stdout.
+ * If invo_name isn't NULL or empty, it precedes the output seperated by ": ".
+ * If what isn't NULL, errno as a string is appended.
+ * A non-empty what separates fmt from errno, surrounded by " " and ": ".
+ * BUG: No space separator before errno if what is "".
+ * If tail isn't NULL or empty then ", " and tail are appended
+ * before the finishing "\n".
+ * In summary: "invo_name: fmt what: errno, tail\n". */
 void
 advertise (const char *what, char *tail, const char *fmt, va_list ap)
 {
     int        eindex = errno;
-    char buffer[BUFSIZ], err[BUFSIZ];
-    struct iovec iob[20], *iov;
-
-    fflush (stdout);
+    char buffer[NMH_BUFSIZ], errbuf[NMH_BUFSIZ], *err;
+    struct iovec iob[10], *iov;
+    size_t niov;
 
-    fflush (stderr);
     iov = iob;
 
+#define APPEND_IOV(p, len) \
+    iov->iov_base = (p); \
+    iov->iov_len = (len); \
+    iov++
+
+#define ADD_LITERAL(s) APPEND_IOV((s), LEN(s))
+#define ADD_VAR(s) APPEND_IOV((s), strlen(s))
+
     if (invo_name && *invo_name) {
-       iov->iov_len = strlen (iov->iov_base = invo_name);
-       iov++;
-       iov->iov_len = strlen (iov->iov_base = ": ");
-       iov++;
+        ADD_VAR(invo_name);
+       ADD_LITERAL(": ");
     }
     
     vsnprintf (buffer, sizeof(buffer), fmt, ap);
-    iov->iov_len = strlen (iov->iov_base = buffer);
-    iov++;
+    ADD_VAR(buffer);
     if (what) {
        if (*what) {
-           iov->iov_len = strlen (iov->iov_base = " ");
-           iov++;
-           iov->iov_len = strlen (iov->iov_base = (void*)what);
-           iov++;
-           iov->iov_len = strlen (iov->iov_base = ": ");
-           iov++;
+            ADD_LITERAL(" ");
+            ADD_VAR((void *)what);
+            ADD_LITERAL(": ");
        }
-        if (!(iov->iov_base = strerror (eindex))) {
+        err = strerror(eindex);
+        if (!err) {
            /* this shouldn't happen, but we'll test for it just in case */
-           snprintf (err, sizeof(err), "Error %d", eindex);
-           iov->iov_base = err;
+           snprintf(errbuf, sizeof(errbuf), "Error %d", eindex);
+            err = errbuf;
        }
-       iov->iov_len = strlen (iov->iov_base);
-       iov++;
+        ADD_VAR(err);
     }
     if (tail && *tail) {
-       iov->iov_len = strlen (iov->iov_base = ", ");
-       iov++;
-       iov->iov_len = strlen (iov->iov_base = tail);
-       iov++;
+        ADD_LITERAL(", ");
+        ADD_VAR(tail);
     }
-    iov->iov_len = strlen (iov->iov_base = "\n");
-    iov++;
-    if (writev (fileno (stderr), iob, iov - iob) < 0) {
+    ADD_LITERAL("\n");
+
+#undef ADD_LITERAL
+#undef ADD_VAR
+
+    niov = iov - iob;
+    assert(niov <= DIM(iob));
+
+    fflush (stdout);
+    fflush (stderr);
+    if (writev(fileno(stderr), iob, niov) == -1) {
         snprintf(buffer, sizeof buffer, "%s: write stderr failed: %d\n",
             invo_name && *invo_name ? invo_name : "nmh", errno);
         if (write(2, buffer, strlen(buffer)) == -1) {