Improve this documentation a bit.

[nmh] / h / utils.h

diff --git a/h/utils.h b/h/utils.h
index 597569b517090d498bb7730baf3769498a703354..7cb96efdecb8f8f1905a2bdf53804fd7e2538811 100644 (file)
--- a/h/utils.h
+++ b/h/utils.h
@@ -22,9 +22,6 @@ void *mh_xcalloc(size_t nelem, size_t elsize) MALLOC ALLOC_SIZE(1, 2);
 /* Duplicate a NUL-terminated string, exit on failure. */
 char *mh_xstrdup(const char *src) MALLOC;
 
 /* Duplicate a NUL-terminated string, exit on failure. */
 char *mh_xstrdup(const char *src) MALLOC;
 

-/* 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, uninitialised, memory. */
 #define NEW(p) ((p) = mh_xmalloc(sizeof *(p)))
 


@@ -39,7 +36,7 @@ char *add(const char *, char *) MALLOC;
 char *addlist(char *, const char *) MALLOC;
 int folder_exists(const char *);
 void create_folder(char *, int, void (*)(int));
 char *addlist(char *, const char *) MALLOC;
 int folder_exists(const char *);
 void create_folder(char *, int, void (*)(int));

-int num_digits(int);
+int num_digits(int) PURE;

 
 /*
  * A vector of char array, used to hold a list of string message numbers
 
 /*
  * A vector of char array, used to hold a list of string message numbers


@@ -68,17 +65,17 @@ struct msgnum_array {
 void app_msgarg(struct msgs_array *, char *);
 void app_msgnum(struct msgnum_array *, int);
 
 void app_msgarg(struct msgs_array *, char *);
 void app_msgnum(struct msgnum_array *, int);
 

-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 *);
+char *find_str (const char [], size_t, const char *) PURE;
+char *rfind_str (const char [], size_t, const char *) PURE;
+char *nmh_strcasestr (const char *, const char *) PURE;

 
 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))
 
 
 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);
+bool has_prefix(const char *s, const char *prefix) PURE;
+bool has_suffix(const char *s, const char *suffix) PURE;
+bool has_suffix_c(const char *s, int c) PURE;

 void trim_suffix_c(char *s, int c);
 void to_lower(char *s);
 void to_upper(char *s);
 void trim_suffix_c(char *s, int c);
 void to_lower(char *s);
 void to_upper(char *s);