X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/1d03fb9aeca8ed1d59e41b938629e9d9ff8f49bf..6db45651:/h/mh.h?ds=inline

diff --git a/h/mh.h b/h/mh.h
index 1ff275b5..dda0c3d2 100644
--- a/h/mh.h
+++ b/h/mh.h
@@ -30,14 +30,15 @@
 #endif
 typedef unsigned char  boolean;  /* not int so we can pack in a structure */
 
-/* If we're using gcc then give it some information about
- * functions that abort.
- */
+/* 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 NMH_UNUSED(i) (void) i
 #else
 #define NORETURN
+#define CHECK_PRINTF(fmt, arg)
 #define NMH_UNUSED(i) i
 #endif
 
@@ -367,12 +368,28 @@ struct msgs {
 				   followed by a colon.	 Add one for
 				   terminating NULL. */
 
-#define LENERR  (-2)		/* Name too long error from getfld  */
-#define FMTERR  (-3)		/* Message Format error             */
-#define FLD      0		/* Field returned                   */
-#define FLDPLUS  1		/* Field returned with more to come */
-#define BODY     3		/* Body  returned with more to come */
-#define FILEEOF  5		/* Reached end of input file        */
+/* Token type or error returned from m_getfld(), and its internal state
+ * for the next call. */
+/* FLD detects the header's name is too long to fit in the fixed size
+ * array. */
+#define LENERR  (-2)
+/* FLD reaches EOF after the header's name, or the name is followed by
+ * a linefeed rather than a colon and the body buffer isn't large enough
+ * to pretend this header line starts the body. */
+#define FMTERR  (-3)
+/* The initial state, looking for headers.  Returned when the header's
+ * value finishes. */
+#define FLD      0
+/* Another chunk of the header's value has been returned, but there's
+ * more to come. */
+#define FLDPLUS  1
+/* A chunk of the email's body has been returned. */
+#define BODY     3
+/* Either the end of the input file has been reached, or the delimiter
+ * between emails has been found and the caller should
+ * m_getfld_state_reset() to reset the state to FLD for continuing
+ * through the file. */
+#define FILEEOF  5
 
 typedef struct m_getfld_state *m_getfld_state_t;