X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/5c34a38ad47b5bec1535a4c6c3272f8b4b2364bd..4a56a28ac:/h/utils.h?ds=sidebyside diff --git a/h/utils.h b/h/utils.h index 92c940de..944a3ccb 100644 --- a/h/utils.h +++ b/h/utils.h @@ -1,10 +1,36 @@ - -/* - * utils.h -- utility prototypes +/* utils.h -- utility prototypes */ -void *mh_xmalloc(size_t); -void *mh_xrealloc(void *, size_t); +/* PLURALS gives a pointer to the string "s" when n isn't 1, and to the + * empty string "" when it is. Suitable for obtaining the plural `s' + * used for English nouns. It treats -1 as plural, as does GNU gettext. + * Having output vary for plurals is annoying for those writing parsers; + * better to phrase the output such that no test is needed, e.g. + * "messages found: 42". */ +extern const char plurals[]; +#define PLURALS(n) (plurals + ((n) == 1)) + +/* Call malloc(3), exiting on NULL return. */ +void *mh_xmalloc(size_t size); + +/* Call realloc(3), exiting on NULL return. */ +void *mh_xrealloc(void *ptr, size_t size); + +/* Call calloc(3), exiting on NULL return. */ +void *mh_xcalloc(size_t nelem, size_t elsize); + +/* Duplicate a NUL-terminated string, exit on failure. */ +char *mh_xstrdup(const char *src); + +/* Call free(3), if ptr isn't NULL. */ +void mh_xfree(void *ptr); + +/* Set p to point to newly allocated, uninitialised, memory. */ +#define NEW(p) ((p) = mh_xmalloc(sizeof *(p))) + +/* Set p to point to newly allocated, zeroed, memory. */ +#define NEW0(p) ((p) = mh_xcalloc(1, sizeof *(p))) + char *pwd(void); char *add(const char *, char *); char *addlist(char *, const char *); @@ -39,11 +65,21 @@ struct msgnum_array { void app_msgarg(struct msgs_array *, char *); void app_msgnum(struct msgnum_array *, int); -int open_form(char **, char *); char *find_str (const char [], size_t, const char *); char *rfind_str (const char [], size_t, const char *); char *nmh_strcasestr (const char *, const char *); +void trunccpy(char *dst, const char *src, size_t size); +/* A convenience for the common case of dst being an array. */ +#define TRUNCCPY(dst, src) trunccpy(dst, src, sizeof (dst)) + +bool has_prefix(const char *s, const char *prefix); +bool has_suffix(const char *s, const char *suffix); +bool has_suffix_c(const char *s, int c); +void trim_suffix_c(char *s, int c); +void to_lower(char *s); +void to_upper(char *s); + /* * See if a string contains 8 bit characters (use isascii() for the test). * Arguments include: @@ -56,3 +92,48 @@ char *nmh_strcasestr (const char *, const char *); * Returns 1 if the string contains an 8-bit character, 0 if it does not. */ int contains8bit(const char *start, const char *end); + +/* + * See if file has any 8-bit bytes. + * Arguments include: + * + * fd - file descriptor + * eightbit - address of result, will be set to 1 if the file contains + * any 8-bit bytes, 0 otherwise. + * + * Returns OK on success, NOTOK on read failure. + * + */ +int scan_input (int fd, int *eightbit); + +/* + * Returns string representation of int, in static memory. + */ +char *m_str(int value); + +/* + * Returns string representation of an int, in static memory. If width + * == 0, does not limit the width. If width > 0 and value will not fit + * in field of that size, including any negative sign but excluding + * terminating null, then returns "?". If width < 0, returns "?". + */ +char *m_strn(int value, unsigned int width); + +/* + * program initialization + * + * argv0 - argv[0], presumably the program name + * read_context - 0: don't read context + * - 1: read context, check nmh version, and issue warning message + * if non-existent or old + * - 2: read context, don't check nmh version + */ +int nmh_init(const char *argv0, int read_context); + +/* + * Compares prior version of nmh with current version. Returns 1 + * if they compare the be the same, 0 if not. + * + * older - 0 for difference comparison, 1 for only if older + */ +int nmh_version_changed (int older);