Match `NORETURN' function prototypes by adding it to definition.

[nmh] / sbr / utils.c

diff --git a/sbr/utils.c b/sbr/utils.c
index d8a43c172b113b03939b46cb8314a3826e7aa3ef..ef7df4aaad6984fc8f300d6c2d92fa2e2f8c4475 100644 (file)
--- a/sbr/utils.c
+++ b/sbr/utils.c
@@ -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
@@ -19,6 +17,11 @@ extern void remove_registered_files_atexit();
 
 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 +108,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, "/");
@@ -179,22 +182,10 @@ addlist (char *list, const char *item)
 int folder_exists(const char *folder)
 {
     struct stat st;
-    int exists = 0;
-
-    if (stat (folder, &st) == -1) {
-        /* The folder either doesn't exist, or we hit an error.  Either way
-         * return a failure.
-         */
-        exists = 0;
-    } else {
-        /* We can see a folder with the right name */
-        exists = 1;
-    }
 
-    return exists;
+    return stat(folder, &st) != -1;
 }
 
-
 /*
  * create_folder
  *      Check to see if a folder exists, if not, prompt the user to create
@@ -358,17 +349,66 @@ nmh_strcasestr (const char *s1, const char *s2) {
 }
 
 
-/* HasSuffixC returns true if non-NULL string s ends with a c before the
+/* 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
+ * of its advantages over strncpy(3) is it doesn't pad in the common
+ * case of no truncation. */
+void trunccpy(char *dst, const char *src, size_t size)
+{
+    if (!size) {
+        inform("trunccpy: zero-length destination: \"%.20s\"",
+            src ? src : "null");
+        abort();
+    }
+
+    if (strnlen(src, size) < size) {
+        strcpy(dst, src);
+    } else {
+        memcpy(dst, src, size - 1);
+        dst[size - 1] = '\0';
+    }
+}
+
+
+/* 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++;
+        prefix++;
+    }
+
+    return *prefix == '\0';
+}
+
+
+/* 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;
+
+    ls = strlen(s);
+    lsuf = strlen(suffix);
+
+    return lsuf <= ls && !strcmp(s + ls - lsuf, suffix);
+}
+
+
+/* has_suffix_c returns true if non-NULL string s ends with a c before the
  * terminating NUL. */
-bool HasSuffixC(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;
@@ -379,8 +419,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;
 
@@ -389,8 +429,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;
 
@@ -434,7 +474,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))) {
@@ -468,8 +508,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;
@@ -490,7 +530,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  &&  strncmp (context_version, "nmh-", 4) == 0
+            context_version  &&  has_prefix(context_version, "nmh-")
             ?  strtof (context_version + 4, NULL)
             :  99999999;
 
@@ -498,7 +538,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) {
@@ -516,7 +556,7 @@ char *
 upcase (const char *str) {
     char *up = cpytrim (str);
 
-    ToUpper(up);
+    to_upper(up);
 
     return up;
 }