X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/bed6327e0962c95394b530b7b1ebc40e2af28320..2b60a54adb3b0bf5a9b927708085492b816a6015:/sbr/utils.c diff --git a/sbr/utils.c b/sbr/utils.c index fff1aacd..8194f134 100644 --- 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 @@ -9,16 +7,19 @@ #include #include +#include +#include "m_mktemp.h" +#include "makedir.h" #include - -/* sbr/signals.c */ -extern int setup_signal_handlers(); - -/* sbr/m_mktemp.c */ -extern void remove_registered_files_atexit(); +#include 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. @@ -34,7 +35,7 @@ void *mh_xmalloc(size_t size) size = 1; /* Some mallocs don't like 0. */ p = malloc(size); if (!p) - adios(NULL, "malloc failed, size wanted: %zu", size); + adios(NULL, "malloc failed, size wanted: %lu", (unsigned long)size); return p; } @@ -46,9 +47,7 @@ void *mh_xrealloc(void *ptr, size_t size) /* Copy POSIX behaviour, coping with non-POSIX systems. */ if (size == 0) { - if (ptr) { - free(ptr); - } + mh_xfree(ptr); return mh_xmalloc(1); /* Get a unique pointer. */ } if (!ptr) @@ -56,7 +55,7 @@ void *mh_xrealloc(void *ptr, size_t size) new = realloc(ptr, size); if (!new) - adios(NULL, "realloc failed, size wanted: %zu", size); + adios(NULL, "realloc failed, size wanted: %lu", (unsigned long)size); return new; } @@ -71,7 +70,8 @@ void *mh_xcalloc(size_t nelem, size_t elsize) p = calloc(nelem, elsize); if (!p) - adios(NULL, "calloc failed, size wanted: %zu * %zu", nelem, elsize); + adios(NULL, "calloc failed, size wanted: %lu * %lu", + (unsigned long)nelem, (unsigned long)elsize); return p; } @@ -107,7 +107,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, "/"); @@ -181,22 +181,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 @@ -281,22 +269,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 @@ -360,17 +332,66 @@ nmh_strcasestr (const char *s1, const char *s2) { } -/* EndsWithC 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 EndsWithC(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; @@ -381,6 +402,26 @@ void TrimSuffixC(char *s, int c) } +/* to_lower runs all of s through tolower(3). */ +void to_lower(char *s) +{ + unsigned char *b; + + for (b = (unsigned char *)s; (*b = tolower(*b)); b++) + ; +} + + +/* to_upper runs all of s through toupper(3). */ +void to_upper(char *s) +{ + unsigned char *b; + + for (b = (unsigned char *)s; (*b = toupper(*b)); b++) + ; +} + + int nmh_init(const char *argv0, int read_context) { int status = OK; @@ -416,7 +457,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))) { @@ -450,8 +491,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; @@ -472,7 +513,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; @@ -480,50 +521,42 @@ nmh_version_changed (int older) { context_replace ("Version", "nmh-" VERSION); } - return old_version < current_version ? 1 : 0; - } else { - if (context_version == NULL || strcmp(context_version, "nmh-" VERSION) != 0) { - context_replace ("Version", "nmh-" VERSION); - - return 1; - } else { - return 0; - } + return old_version < current_version; } -} - - -/* 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); - char *cp; - for (cp = up; *cp; ++cp) { *cp = toupper ((unsigned char) *cp); } + if (context_version == NULL || strcmp(context_version, "nmh-" VERSION) != 0) { + context_replace ("Version", "nmh-" VERSION); + return 1; + } - return up; + return 0; } -/* - * Scan for any 8-bit characters. Return 1 if they exist. - * - * Scan up until the given endpoint (but not the actual endpoint itself). - * If the endpoint is NULL, scan until a '\0' is reached. - */ - -int -contains8bit(const char *start, const char *end) +/* contains8bit returns true if any byte from start onwards fails + * isascii(3), i.e. is outside [0, 0x7f]. If start is NULL it returns + * false. Bytes are examined until a NUL byte, or, if end is not NULL, + * whilst start is before end. */ +bool contains8bit(const char *start, const char *end) { - if (! start) - return 0; + const char *p; + char c; - while (*start != '\0' && (!end || (start < end))) - if (! isascii((unsigned char) *start++)) - return 1; + if (!start) + return false; - return 0; + p = start; + if (end) { + while (p < end && (c = (*p++))) + if (!isascii((unsigned char)c)) + return true; + } else { + while ((c = (*p++))) + if (!isascii((unsigned char)c)) + return true; + } + + return false; } @@ -536,7 +569,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)) { @@ -547,3 +580,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 + : "?"; +}