X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/9ffabd06f0dc8e7478b7484fceee4906990d44e2..refs/heads/master:/h/mh.h?ds=inline diff --git a/h/mh.h b/h/mh.h index 2a4ce617..e11876a3 100644 --- a/h/mh.h +++ b/h/mh.h @@ -1,7 +1,20 @@ /* mh.h -- main header file for all of nmh */ -#include +#include "nmh.h" + +/* It's undefined behaviour in C99 to convert from a function pointer to + * a data-object pointer, e.g. void pointer. gcc's -pedantic warns of + * this and can stop compilation. POSIX requires the operation however, + * e.g. for dlsym(3), and so we know it's safe on POSIX platforms, e.g. + * the pointers are of the same size. Thus use a union to subvert gcc's + * check. The function-pointer equivalent of a void pointer is any + * function-pointer type as all function pointers are defined to be + * convertible from one another; use the simplest available. */ +typedef union { + void *v; + void (*f)(void); +} generic_pointer; /* * Well-used constants @@ -22,32 +35,37 @@ */ #define NMH_BUFSIZ max(BUFSIZ, 8192) -#ifndef FALSE -#define FALSE false -#endif -#ifndef TRUE -#define TRUE true -#endif -typedef unsigned char boolean; /* not int so we can pack in a structure */ - /* If we're using gcc then tell it extra information so it can do more * compile-time checks. */ #if __GNUC__ > 2 #define NORETURN __attribute__((__noreturn__)) -#define CHECK_PRINTF(fmt, arg) __attribute__((format(printf, fmt, arg))) -#define ALLOC_SIZE(n) __attribute__((alloc_size(n))) -#define ALLOC_SIZE2(m, n) __attribute__((alloc_size(m, n))) #define CONST __attribute__((const)) -#define NMH_UNUSED(i) (void) i +#define MALLOC __attribute__((malloc)) +#define NONNULL(...) __attribute__((nonnull(__VA_ARGS__))) +#define PURE __attribute__((pure)) +#define ENDNULL __attribute__((sentinel)) #else #define NORETURN #define CHECK_PRINTF(fmt, arg) -#define ALLOC_SIZE(n) -#define ALLOC_SIZE2(m, n) +#define ALLOC_SIZE(...) #define CONST -#define NMH_UNUSED(i) i +#define MALLOC +#define NONNULL(...) +#define PURE +#define ENDNULL #endif +#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3) +#define ALLOC_SIZE(...) __attribute__((alloc_size(__VA_ARGS__))) +#define CHECK_PRINTF(fmt, arg) __attribute__((format(printf, fmt, arg))) +#else +#define ALLOC_SIZE(...) +#define CHECK_PRINTF(fmt, arg) +#endif + +/* Silence the compiler's "unused variable" warning. */ +#define NMH_UNUSED(i) (void)i + /* DIM gives the number of elements in the one-dimensional array a. */ #define DIM(a) (sizeof (a) / sizeof (*(a))) @@ -58,6 +76,9 @@ typedef unsigned char boolean; /* not int so we can pack in a structure */ /* FENDNULL fends off NULL by giving an empty string instead. */ #define FENDNULL(s) ((s) ? (s) : "") +/* If not specified in a file and PAGER is NULL or empty. */ +#define DEFAULT_PAGER "more" + /* * char array that keeps track of size in both bytes and characters * Usage note: @@ -68,24 +89,24 @@ typedef unsigned char boolean; /* not int so we can pack in a structure */ typedef struct charstring *charstring_t; charstring_t charstring_create (size_t); -charstring_t charstring_copy (const charstring_t); +charstring_t charstring_copy (const charstring_t) NONNULL(1); void charstring_free (charstring_t); /* Append a single-byte character: */ -void charstring_push_back (charstring_t, const char); +void charstring_push_back (charstring_t, const char) NONNULL(1); /* Append possibly multi-byte character(s): */ -void charstring_push_back_chars (charstring_t, const char [], size_t, size_t); -void charstring_append (charstring_t, const charstring_t); -void charstring_append_cstring (charstring_t, const char []); -void charstring_clear (charstring_t); +void charstring_push_back_chars (charstring_t, const char [], size_t, size_t) NONNULL(1); +void charstring_append (charstring_t, const charstring_t) NONNULL(2); +void charstring_append_cstring (charstring_t, const char []) NONNULL(2); +void charstring_clear (charstring_t) NONNULL(1); /* Don't store return value of charstring_buffer() and use later after intervening push_back's; use charstring_buffer_copy() instead. */ -const char *charstring_buffer (const charstring_t); +const char *charstring_buffer (const charstring_t) NONNULL(1); /* User is responsible for free'ing result of buffer copy. */ -char *charstring_buffer_copy (const charstring_t); -size_t charstring_bytes (const charstring_t); -size_t charstring_chars (const charstring_t); +char *charstring_buffer_copy (const charstring_t) NONNULL(1); +size_t charstring_bytes (const charstring_t) NONNULL(1) PURE; +size_t charstring_chars (const charstring_t) NONNULL(1) PURE; /* Length of the last character in the charstring. */ -int charstring_last_char_len (const charstring_t); +int charstring_last_char_len (const charstring_t) NONNULL(1); /* * user context/profile structure @@ -111,11 +132,60 @@ struct swit { char *sw; - /* The minchars field is apparently used like this: + /* + * The previous comments here about minchars was incorrect; this is + * (AFAIK) the correct information. + * + * A minchars of "0" means this switch can be abbreviated to any number + * of characters (assuming the abbreviation does not match any other + * switches). + * + * A positive value for minchars means that when the user specifies + * the switch on the command line, it MUST be at least that many + * characters. + * + * A negative value for minchars means that the user-given switch must + * be that many characters, but will NOT be shown in -help output. + * + * So what should I use? Well, for nearly all switches you want to specify + * a minchars of 0. smatch will report an error if the switch given + * matches more than one entry. Let's say you have the following + * two switches: -append and -apply. -app will return AMBIGSW from + * smatch. -appe and -appl will work fine. So 0 is the correct choice + * here. + * + * The only time you want to specify a minimum length is if you have + * a switch who's name is a substring of a longer switch. The example + * you see sometimes in the code is -form and -format. If you gave a + * minchars of 0 for both, -form would match both -form AND -format, + * and you'd always get AMBIGSW. The solution is to specify a minchars + * of 5 for -format; that way just -form will just match -form. When + * a minchars is given, the -help output will specify the minimum + * switch length, like this: + * + * -(forma)t string + * + * A negative value works the same way, except the switch isn't printed + * in -help. Why would you do that? Well, there are a few instances + * of internal switches and some switches which only appear if a particular + * feature is enabled (such as SASL or TLS). Lately I've been of the + * opinion that all switches should be specified, even if they are + * internal or use non-available features, but currently the smatch + * code still supports this. + * + * This isn't the appropriate place to make this note, but since I was + * here ... when creating switches, you should make a negation switch + * right after the enabling switch. E.g. you should have: + * + * X("sasl", 0, SASLSW) \ + * X("nosasl", 0, NOSASLSW) \ + * + * in the switch array, because when you run -help, print_sw will detect + * this and output: + * + * -[no]sasl + */ - -# : Switch can be abbreviated to # characters; switch hidden in -help. - 0 : Switch can't be abbreviated; switch shown in -help. - # : Switch can be abbreviated to # characters; switch shown in -help. */ int minchars; /* @@ -159,13 +229,13 @@ struct swit { #define DEFINE_SWITCH_ENUM(name) \ enum { \ - name ## _SWITCHES \ + name ## _SWITCHES \ LEN_ ## name \ } #define DEFINE_SWITCH_ARRAY(name, array) \ static struct swit array[] = { \ - name ## _SWITCHES \ + name ## _SWITCHES \ { NULL, 0, 0 } \ } @@ -197,45 +267,7 @@ extern struct swit anoyes[]; /* standard yes/no switches */ #define MBITS "\020\01EXISTS\02SELECTED\03NEW\04UNSEEN" -/* A vector of bits for tracking the sequence membership of a single - * message. Do not access the struct members; use vector.c. - * Do not move or copy this struct as it may contain a pointer to - * itself; use bvector_copy(). */ -struct bvector { - unsigned long *bits; - size_t maxsize; - unsigned long tiny[2]; /* Default fixed-size storage for bits. */ -}; -typedef struct bvector *bvector_t; - -bvector_t bvector_create (void); -void bvector_init(struct bvector *bv); -void bvector_copy (bvector_t, bvector_t); -void bvector_free (bvector_t); -void bvector_fini(struct bvector *bv); -void bvector_clear (bvector_t, size_t); -void bvector_clear_all (bvector_t); -void bvector_set (bvector_t, size_t); -unsigned int bvector_at (bvector_t, size_t); -unsigned long bvector_first_bits (bvector_t); - -typedef struct svector *svector_t; - -svector_t svector_create (size_t); -void svector_free (svector_t); -char *svector_push_back (svector_t, char *); -char *svector_at (svector_t, size_t); -char **svector_find(svector_t, const char *); -char **svector_strs (svector_t); -size_t svector_size (svector_t); - -typedef struct ivector *ivector_t; - -ivector_t ivector_create (size_t); -void ivector_free (ivector_t); -int ivector_push_back (ivector_t, int); -int ivector_at (ivector_t, size_t); -int *ivector_atp (ivector_t, size_t); +#include "sbr/vector.h" /* * Primary structure of folder/message information @@ -504,6 +536,4 @@ extern char *version_str; extern char *whatnowproc; extern char *whomproc; -extern void (*done) (int) NORETURN; - -#include +#include "prototypes.h"