Escape literal leading full stop in man/new.man.

[nmh] / h / utils.h

diff --git a/h/utils.h b/h/utils.h
index aba8fc44cc5123814daef962cd730b3bb171858c..e1cfaedf1a685a8a43ecbb9ccb06f6ba2ceaafcc 100644 (file)
--- a/h/utils.h
+++ b/h/utils.h
@@ -1,9 +1,110 @@
 
 /*
  * utils.h -- utility prototypes
+ */
+
+/* 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 *);
+int folder_exists(const char *);
+void create_folder(char *, int, void (*)(int));
+int num_digits(int);
+
+/*
+ * A vector of char array, used to hold a list of string message numbers
+ * or command arguments.
+ */
+
+struct msgs_array {
+       int max, size;
+       char **msgs;
+};
+
+/*
+ * Same as msgs_array, but for a vector of ints
+ */
+
+struct msgnum_array {
+       int max, size;
+       int *msgnums;
+};
+
+/*
+ * Add a argument to the given msgs_array or msgnum_array structure; extend
+ * the array size if necessary
+ */
+
+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:
+ *
+ * start       - Pointer to start of string to test.
+ * end         - End of string to test (test will stop before reaching
+ *               this point).  If NULL, continue until reaching '\0'.
  *
- * $Id$
+ * This function always stops at '\0' regardless of the value of 'end'.
+ * Returns 1 if the string contains an 8-bit character, 0 if it does not.
  */
+int contains8bit(const char *start, const char *end);
 
-void *mh_xmalloc(size_t);
+/*
+ * 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);
 
+
+/*
+ * 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);