]> diplodocus.org Git - nmh/blobdiff - sbr/utils.c
NEWS: Move "new features" that might bite a user to the top.
[nmh] / sbr / utils.c
index ca809439ea7262c4d58cfec365c67cdeb494be6a..90f36bd340ef8cfd9eab9aed71f71a0b68e2f6d1 100644 (file)
@@ -1,6 +1,4 @@
-
-/*
- * utils.c -- various utility routines
+/* utils.c -- various utility routines
  *
  * This code is Copyright (c) 2006, by the authors of nmh.  See the
  * COPYRIGHT file in the root directory of the nmh distribution for
@@ -9,16 +7,19 @@
 
 #include <h/mh.h>
 #include <h/utils.h>
+#include <h/signals.h>
+#include "m_mktemp.h"
+#include "makedir.h"
 #include <fcntl.h>
-
-/* sbr/signals.c */
-extern int setup_signal_handlers();
-
-/* sbr/m_mktemp.c */
-extern void remove_registered_files_atexit();
+#include <limits.h>
 
 extern char *mhdocdir;
 
+/* plurals gives the letter ess to indicate a plural noun, or an empty
+ * string as plurals+1 for the singular noun.  Used by the PLURALS
+ * macro. */
+const char plurals[] = "s";
+
 /*
  * We allocate space for messages (msgs array)
  * this number of elements at a time.
@@ -105,7 +106,7 @@ pwd(void)
     static char curwd[PATH_MAX];
 
     if (!getcwd (curwd, PATH_MAX)) {
-        admonish (NULL, "unable to determine working directory");
+        inform("unable to determine working directory, continuing...");
         if (!mypath || !*mypath
                 || (strcpy (curwd, mypath), chdir (curwd)) == -1) {
             strcpy (curwd, "/");
@@ -267,22 +268,6 @@ app_msgnum(struct msgnum_array *msgs, int msgnum)
        msgs->msgnums[msgs->size++] = msgnum;
 }
 
-/* Open a form or components file */
-int
-open_form(char **form, char *def)
-{
-       int in;
-       if (*form) {
-               if ((in = open (etcpath (*form), O_RDONLY)) == NOTOK)
-                       adios (*form, "unable to open form file");
-       } else {
-               if ((in = open (etcpath (def), O_RDONLY)) == NOTOK)
-                       adios (def, "unable to open default components file");
-               *form = def;
-       }
-       return in;
-}
-
 
 /*
  * Finds first occurrence of str in buf.  buf is not a C string but a
@@ -346,9 +331,9 @@ nmh_strcasestr (const char *s1, const char *s2) {
 }
 
 
-/* truncpy copies at most size - 1 chars from non-NULL src to non-NULL
- * dst, and ensures dst is NUL terminated.  If size is zero then it
- * aborts as dst cannot be NUL terminated.
+/* truncpy copies at most size - 1 chars from non-NULL src to non-NULL,
+ * non-overlapping, dst, and ensures dst is NUL terminated.  If size is
+ * zero then it aborts as dst cannot be NUL terminated.
  *
  * It's to be used when truncation is intended and correct, e.g.
  * reporting a possibly very long external string back to the user.  One
@@ -357,7 +342,7 @@ nmh_strcasestr (const char *s1, const char *s2) {
 void trunccpy(char *dst, const char *src, size_t size)
 {
     if (!size) {
-        advise(NULL, "trunccpy: zero-length destination: \"%.20s\"",
+        inform("trunccpy: zero-length destination: \"%.20s\"",
             src ? src : "null");
         abort();
     }
@@ -371,8 +356,8 @@ void trunccpy(char *dst, const char *src, size_t size)
 }
 
 
-/* HasPrefix returns true if non-NULL s starts with non-NULL prefix. */
-bool HasPrefix(const char *s, const char *prefix)
+/* has_prefix returns true if non-NULL s starts with non-NULL prefix. */
+bool has_prefix(const char *s, const char *prefix)
 {
     while (*s && *s == *prefix) {
         s++;
@@ -383,8 +368,8 @@ bool HasPrefix(const char *s, const char *prefix)
 }
 
 
-/* HasSuffix returns true if non-NULL s ends with non-NULL suffix. */
-bool HasSuffix(const char *s, const char *suffix)
+/* has_suffix returns true if non-NULL s ends with non-NULL suffix. */
+bool has_suffix(const char *s, const char *suffix)
 {
     size_t ls, lsuf;
 
@@ -395,17 +380,17 @@ bool HasSuffix(const char *s, const char *suffix)
 }
 
 
-/* HasSuffixC returns true if non-NULL string s ends with a c before the
+/* has_suffix_c returns true if non-NULL string s ends with a c before the
  * terminating NUL. */
-bool HasSuffixC(const char *s, int c)
+bool has_suffix_c(const char *s, int c)
 {
     return *s && s[strlen(s) - 1] == c;
 }
 
 
-/* TrimSuffixC deletes c from the end of non-NULL string s if it's
+/* trim_suffix_c deletes c from the end of non-NULL string s if it's
  * present, shortening s by 1.  Only one instance of c is removed. */
-void TrimSuffixC(char *s, int c)
+void trim_suffix_c(char *s, int c)
 {
     if (!*s)
         return;
@@ -416,8 +401,8 @@ void TrimSuffixC(char *s, int c)
 }
 
 
-/* ToLower runs all of s through tolower(3). */
-void ToLower(char *s)
+/* to_lower runs all of s through tolower(3). */
+void to_lower(char *s)
 {
     unsigned char *b;
 
@@ -426,8 +411,8 @@ void ToLower(char *s)
 }
 
 
-/* ToUpper runs all of s through toupper(3). */
-void ToUpper(char *s)
+/* to_upper runs all of s through toupper(3). */
+void to_upper(char *s)
 {
     unsigned char *b;
 
@@ -471,7 +456,7 @@ nmh_init(const char *argv0, int read_context) {
         }
 
         /* Check to see if the user is running a different (or older, if
-           specified) version of nmh than they had run bfore, and notify them
+           specified) version of nmh than they had run before, and notify them
            if so.  But only if read_context was set to a value to enable. */
         if (allow_version_check  &&  isatty (fileno (stdin))  &&
             isatty (fileno (stdout))  &&  isatty (fileno (stderr))) {
@@ -505,8 +490,8 @@ nmh_init(const char *argv0, int read_context) {
     }
 
     if (! setlocale (LC_ALL, locale)) {
-        admonish (NULL, "setlocale failed, check your LC_ALL, LC_CTYPE, and "
-                 "LANG environment variables");
+        inform("setlocale failed, check your LC_ALL, LC_CTYPE, and LANG "
+           "environment variables, continuing...");
     }
 
     return status;
@@ -527,7 +512,7 @@ nmh_version_changed (int older) {
            break for versions with multiple decimal points, etc. */
         const float current_version = strtof (VERSION, NULL);
         const float old_version =
-            context_version  &&  HasPrefix(context_version, "nmh-")
+            context_version  &&  has_prefix(context_version, "nmh-")
             ?  strtof (context_version + 4, NULL)
             :  99999999;
 
@@ -535,7 +520,7 @@ nmh_version_changed (int older) {
             context_replace ("Version", "nmh-" VERSION);
         }
 
-        return old_version < current_version  ?  1  :  0;
+        return old_version < current_version;
     }
 
     if (context_version == NULL  ||  strcmp(context_version, "nmh-" VERSION) != 0) {
@@ -547,18 +532,6 @@ nmh_version_changed (int older) {
 }
 
 
-/* Returns copy of argument str with all characters converted to upper
-   case, and trimmed whitespace (see cpytrim()) . */
-char *
-upcase (const char *str) {
-    char *up = cpytrim (str);
-
-    ToUpper(up);
-
-    return up;
-}
-
-
 /*
  * Scan for any 8-bit characters.  Return 1 if they exist.
  *
@@ -589,7 +562,7 @@ scan_input (int fd, int *eightbit) {
     char buf[BUFSIZ];
 
     *eightbit = 0;
-    lseek (fd, (off_t) 0, SEEK_SET);
+    lseek(fd, 0, SEEK_SET);
 
     while ((state = read (fd, buf, sizeof buf)) > 0) {
         if (contains8bit (buf, buf + state)) {
@@ -600,3 +573,32 @@ scan_input (int fd, int *eightbit) {
 
     return state == NOTOK  ?  NOTOK  :  OK;
 }
+
+
+/*
+ * Convert an int to a char string.
+ */
+char *
+m_str(int value) {
+    return m_strn(value, 0);
+}
+
+
+/*
+ * Convert an int to a char string, of limited width if > 0.
+ */
+#define STR(s) #s
+/* SIZE(n) includes NUL.  n must just be digits, not an equation. */
+#define SIZE(n) (sizeof STR(n))
+
+char *
+m_strn(int value, unsigned int width) {
+    /* Need to include space for negative sign.  But don't use INT_MIN
+       because it could be a macro that would fool SIZE(n). */
+    static char buffer[SIZE(-INT_MAX)];
+    const int num_chars = snprintf(buffer, sizeof buffer, "%d", value);
+
+    return num_chars > 0  &&  (width == 0 || (unsigned int) num_chars <= width)
+        ? buffer
+        : "?";
+}