Reformated comments and long lines
[mmh] / sbr / m_getfld.c
index f2c2ffa..1ce52b6 100644 (file)
 /*
- * m_getfld.c -- read/parse a message
- *
- * This code is Copyright (c) 2002, by the authors of nmh.  See the
- * COPYRIGHT file in the root directory of the nmh distribution for
- * complete copyright information.
- */
+** m_getfld.c -- read/parse a message
+**
+** This code is Copyright (c) 2002, by the authors of nmh.  See the
+** COPYRIGHT file in the root directory of the nmh distribution for
+** complete copyright information.
+*/
 
 #include <h/mh.h>
 #include <h/mts.h>
 #include <h/utils.h>
 
-/* This module has a long and checkered history.  First, it didn't burst
-   maildrops correctly because it considered two CTRL-A:s in a row to be
-   an inter-message delimiter.  It really is four CTRL-A:s followed by a
-   newline.  Unfortunately, MMDF will convert this delimiter *inside* a
-   message to a CTRL-B followed by three CTRL-A:s and a newline.  This
-   caused the old version of m_getfld() to declare eom prematurely.  The
-   fix was a lot slower than
-
-                c == '\001' && peekc (iob) == '\001'
-
-   but it worked, and to increase generality, MBOX style maildrops could
-   be parsed as well.  Unfortunately the speed issue finally caught up with
-   us since this routine is at the very heart of MH.
-
-   To speed things up considerably, the routine Eom() was made an auxilary
-   function called by the macro eom().  Unless we are bursting a maildrop,
-   the eom() macro returns FALSE saying we aren't at the end of the
-   message.
-
-   The next thing to do is to read the mts.conf file and initialize
-   delimiter[] and delimlen accordingly...
-
-   After mhl was made a built-in in msh, m_getfld() worked just fine
-   (using m_unknown() at startup).  Until one day: a message which was
-   the result of a bursting was shown. Then, since the burst boundaries
-   aren't CTRL-A:s, m_getfld() would blinding plunge on past the boundary.
-   Very sad.  The solution: introduce m_eomsbr().  This hook gets called
-   after the end of each line (since testing for eom involves an fseek()).
-   This worked fine, until one day: a message with no body portion arrived.
-   Then the
-
-                   while (eom (c = Getc (iob), iob))
-                        continue;
-
-   loop caused m_getfld() to return FMTERR.  So, that logic was changed to
-   check for (*eom_action) and act accordingly.
-
-   [ Note by meillo 2011-10:
-     as msh was removed from mmh, m_eomsbr() became irrelevant. ]
-
-   This worked fine, until one day: someone didn't use four CTRL:A's as
-   their delimiters.  So, the bullet got bit and we read mts.h and
-   continue to struggle on.  It's not that bad though, since the only time
-   the code gets executed is when inc (or msh) calls it, and both of these
-   have already called mts_init().
-
-   ------------------------
-   (Written by Van Jacobson for the mh6 m_getfld, January, 1986):
-
-   This routine was accounting for 60% of the cpu time used by most mh
-   programs.  I spent a bit of time tuning and it now accounts for <10%
-   of the time used.  Like any heavily tuned routine, it's a bit
-   complex and you want to be sure you understand everything that it's
-   doing before you start hacking on it.  Let me try to emphasize
-   that:  every line in this atrocity depends on every other line,
-   sometimes in subtle ways.  You should understand it all, in detail,
-   before trying to change any part.  If you do change it, test the
-   result thoroughly (I use a hand-constructed test file that exercises
-   all the ways a header name, header body, header continuation,
-   header-body separator, body line and body eom can align themselves
-   with respect to a buffer boundary).  "Minor" bugs in this routine
-   result in garbaged or lost mail.
-
-   If you hack on this and slow it down, I, my children and my
-   children's children will curse you.
-
-   This routine gets used on three different types of files: normal,
-   single msg files, "packed" unix or mmdf mailboxs (when used by inc)
-   and packed, directoried bulletin board files (when used by msh).
-   The biggest impact of different file types is in "eom" testing.  The
-   code has been carefully organized to test for eom at appropriate
-   times and at no other times (since the check is quite expensive).
-   I have tried to arrange things so that the eom check need only be
-   done on entry to this routine.  Since an eom can only occur after a
-   newline, this is easy to manage for header fields.  For the msg
-   body, we try to efficiently search the input buffer to see if
-   contains the eom delimiter.  If it does, we take up to the
-   delimiter, otherwise we take everything in the buffer.  (The change
-   to the body eom/copy processing produced the most noticeable
-   performance difference, particularly for "inc" and "show".)
-
-   There are three qualitatively different things this routine busts
-   out of a message: field names, field text and msg bodies.  Field
-   names are typically short (~8 char) and the loop that extracts them
-   might terminate on a colon, newline or max width.  I considered
-   using a Vax "scanc" to locate the end of the field followed by a
-   "bcopy" but the routine call overhead on a Vax is too large for this
-   to work on short names.  If Berkeley ever makes "inline" part of the
-   C optimiser (so things like "scanc" turn into inline instructions) a
-   change here would be worthwhile.
-
-   Field text is typically 60 - 100 characters so there's (barely)
-   a win in doing a routine call to something that does a "locc"
-   followed by a "bmove".  About 30% of the fields have continuations
-   (usually the 822 "received:" lines) and each continuation generates
-   another routine call.  "Inline" would be a big win here, as well.
-
-   Messages, as of this writing, seem to come in two flavors: small
-   (~1K) and long (>2K).  Most messages have 400 - 600 bytes of headers
-   so message bodies average at least a few hundred characters.
-   Assuming your system uses reasonably sized stdio buffers (1K or
-   more), this routine should be able to remove the body in large
-   (>500 byte) chunks.  The makes the cost of a call to "bcopy"
-   small but there is a premium on checking for the eom in packed
-   maildrops.  The eom pattern is always a simple string so we can
-   construct an efficient pattern matcher for it (e.g., a Vax "matchc"
-   instruction).  Some thought went into recognizing the start of
-   an eom that has been split across two buffers.
-
-   This routine wants to deal with large chunks of data so, rather
-   than "getc" into a local buffer, it uses stdio's buffer.  If
-   you try to use it on a non-buffered file, you'll get what you
-   deserve.  This routine "knows" that struct FILEs have a _ptr
-   and a _cnt to describe the current state of the buffer and
-   it knows that _filbuf ignores the _ptr & _cnt and simply fills
-   the buffer.  If stdio on your system doesn't work this way, you
-   may have to make small changes in this routine.
-
-   This routine also "knows" that an EOF indication on a stream is
-   "sticky" (i.e., you will keep getting EOF until you reposition the
-   stream).  If your system doesn't work this way it is broken and you
-   should complain to the vendor.  As a consequence of the sticky
-   EOF, this routine will never return any kind of EOF status when
-   there is data in "name" or "buf").
-  */
+/*
+** This module has a long and checkered history.  First, it didn't burst
+** maildrops correctly because it considered two CTRL-A:s in a row to be
+** an inter-message delimiter.  It really is four CTRL-A:s followed by a
+** newline.  Unfortunately, MMDF will convert this delimiter *inside* a
+** message to a CTRL-B followed by three CTRL-A:s and a newline.  This
+** caused the old version of m_getfld() to declare eom prematurely.  The
+** fix was a lot slower than
+**
+**              c == '\001' && peekc (iob) == '\001'
+**
+** but it worked, and to increase generality, MBOX style maildrops could
+** be parsed as well.  Unfortunately the speed issue finally caught up with
+** us since this routine is at the very heart of MH.
+**
+** To speed things up considerably, the routine Eom() was made an auxilary
+** function called by the macro eom().  Unless we are bursting a maildrop,
+** the eom() macro returns FALSE saying we aren't at the end of the
+** message.
+**
+** The next thing to do is to read the mts.conf file and initialize
+** delimiter[] and delimlen accordingly...
+**
+** After mhl was made a built-in in msh, m_getfld() worked just fine
+** (using m_unknown() at startup).  Until one day: a message which was
+** the result of a bursting was shown. Then, since the burst boundaries
+** aren't CTRL-A:s, m_getfld() would blinding plunge on past the boundary.
+** Very sad.  The solution: introduce m_eomsbr().  This hook gets called
+** after the end of each line (since testing for eom involves an fseek()).
+** This worked fine, until one day: a message with no body portion arrived.
+** Then the
+**
+**                 while (eom (c = Getc (iob), iob))
+**                      continue;
+**
+** loop caused m_getfld() to return FMTERR.  So, that logic was changed to
+** check for (*eom_action) and act accordingly.
+**
+** [ Note by meillo 2011-10:
+**   as msh was removed from mmh, m_eomsbr() became irrelevant. ]
+**
+** This worked fine, until one day: someone didn't use four CTRL:A's as
+** their delimiters.  So, the bullet got bit and we read mts.h and
+** continue to struggle on.  It's not that bad though, since the only time
+** the code gets executed is when inc (or msh) calls it, and both of these
+** have already called mts_init().
+**
+** ------------------------
+** (Written by Van Jacobson for the mh6 m_getfld, January, 1986):
+**
+** This routine was accounting for 60% of the cpu time used by most mh
+** programs.  I spent a bit of time tuning and it now accounts for <10%
+** of the time used.  Like any heavily tuned routine, it's a bit
+** complex and you want to be sure you understand everything that it's
+** doing before you start hacking on it.  Let me try to emphasize
+** that:  every line in this atrocity depends on every other line,
+** sometimes in subtle ways.  You should understand it all, in detail,
+** before trying to change any part.  If you do change it, test the
+** result thoroughly (I use a hand-constructed test file that exercises
+** all the ways a header name, header body, header continuation,
+** header-body separator, body line and body eom can align themselves
+** with respect to a buffer boundary).  "Minor" bugs in this routine
+** result in garbaged or lost mail.
+**
+** If you hack on this and slow it down, I, my children and my
+** children's children will curse you.
+**
+** This routine gets used on three different types of files: normal,
+** single msg files, "packed" unix or mmdf mailboxs (when used by inc)
+** and packed, directoried bulletin board files (when used by msh).
+** The biggest impact of different file types is in "eom" testing.  The
+** code has been carefully organized to test for eom at appropriate
+** times and at no other times (since the check is quite expensive).
+** I have tried to arrange things so that the eom check need only be
+** done on entry to this routine.  Since an eom can only occur after a
+** newline, this is easy to manage for header fields.  For the msg
+** body, we try to efficiently search the input buffer to see if
+** contains the eom delimiter.  If it does, we take up to the
+** delimiter, otherwise we take everything in the buffer.  (The change
+** to the body eom/copy processing produced the most noticeable
+** performance difference, particularly for "inc" and "show".)
+**
+** There are three qualitatively different things this routine busts
+** out of a message: field names, field text and msg bodies.  Field
+** names are typically short (~8 char) and the loop that extracts them
+** might terminate on a colon, newline or max width.  I considered
+** using a Vax "scanc" to locate the end of the field followed by a
+** "bcopy" but the routine call overhead on a Vax is too large for this
+** to work on short names.  If Berkeley ever makes "inline" part of the
+** C optimiser (so things like "scanc" turn into inline instructions) a
+** change here would be worthwhile.
+**
+** Field text is typically 60 - 100 characters so there's (barely)
+** a win in doing a routine call to something that does a "locc"
+** followed by a "bmove".  About 30% of the fields have continuations
+** (usually the 822 "received:" lines) and each continuation generates
+** another routine call.  "Inline" would be a big win here, as well.
+**
+** Messages, as of this writing, seem to come in two flavors: small
+** (~1K) and long (>2K).  Most messages have 400 - 600 bytes of headers
+** so message bodies average at least a few hundred characters.
+** Assuming your system uses reasonably sized stdio buffers (1K or
+** more), this routine should be able to remove the body in large
+** (>500 byte) chunks.  The makes the cost of a call to "bcopy"
+** small but there is a premium on checking for the eom in packed
+** maildrops.  The eom pattern is always a simple string so we can
+** construct an efficient pattern matcher for it (e.g., a Vax "matchc"
+** instruction).  Some thought went into recognizing the start of
+** an eom that has been split across two buffers.
+**
+** This routine wants to deal with large chunks of data so, rather
+** than "getc" into a local buffer, it uses stdio's buffer.  If
+** you try to use it on a non-buffered file, you'll get what you
+** deserve.  This routine "knows" that struct FILEs have a _ptr
+** and a _cnt to describe the current state of the buffer and
+** it knows that _filbuf ignores the _ptr & _cnt and simply fills
+** the buffer.  If stdio on your system doesn't work this way, you
+** may have to make small changes in this routine.
+**
+** This routine also "knows" that an EOF indication on a stream is
+** "sticky" (i.e., you will keep getting EOF until you reposition the
+** stream).  If your system doesn't work this way it is broken and you
+** should complain to the vendor.  As a consequence of the sticky
+** EOF, this routine will never return any kind of EOF status when
+** there is data in "name" or "buf").
+*/
 
 
 /*
- * static prototypes
- */
+** static prototypes
+*/
 static int m_Eom (int, FILE *);
 static unsigned char *matchc(int, char *, int, char *);
 static unsigned char *locc(int, unsigned char *, unsigned char);
@@ -152,30 +153,30 @@ static unsigned char *locc(int, unsigned char *, unsigned char);
 static unsigned char **pat_map;
 
 /*
- * defined in sbr/m_msgdef.c = 0
- * This is a disgusting hack for "inc" so it can know how many
- * characters were stuffed in the buffer on the last call
- * (see comments in uip/scansbr.c).
- */
+** defined in sbr/m_msgdef.c = 0
+** This is a disgusting hack for "inc" so it can know how many
+** characters were stuffed in the buffer on the last call
+** (see comments in uip/scansbr.c).
+*/
 extern int msg_count;
 
 /*
- * defined in sbr/m_msgdef.c = MS_DEFAULT
- */
+** defined in sbr/m_msgdef.c = MS_DEFAULT
+*/
 extern int msg_style;
 
 /*
- * The "full" delimiter string for a packed maildrop consists
- * of a newline followed by the actual delimiter.  E.g., the
- * full string for a Unix maildrop would be: "\n\nFrom ".
- * "Fdelim" points to the start of the full string and is used
- * in the BODY case of the main routine to search the buffer for
- * a possible eom.  Msg_delim points to the first character of
- * the actual delim. string (i.e., fdelim+1).  Edelim
- * points to the 2nd character of actual delimiter string.  It
- * is used in m_Eom because the first character of the string
- * has been read and matched before m_Eom is called.
- */
+** The "full" delimiter string for a packed maildrop consists
+** of a newline followed by the actual delimiter.  E.g., the
+** full string for a Unix maildrop would be: "\n\nFrom ".
+** "Fdelim" points to the start of the full string and is used
+** in the BODY case of the main routine to search the buffer for
+** a possible eom.  Msg_delim points to the first character of
+** the actual delim. string (i.e., fdelim+1).  Edelim
+** points to the 2nd character of actual delimiter string.  It
+** is used in m_Eom because the first character of the string
+** has been read and matched before m_Eom is called.
+*/
 extern char *msg_delim;  /* defined in sbr/m_msgdef.c = "" */
 static unsigned char *fdelim;
 static unsigned char *delimend;
@@ -255,10 +256,10 @@ m_getfld (int state, unsigned char *name, unsigned char *buf,
                                goto body;
                        }
                        /*
-                        * get the name of this component.  take characters up
-                        * to a ':', a newline or NAMESZ-1 characters,
-                        * whichever comes first.
-                        */
+                       ** get the name of this component.  take characters up
+                       ** to a ':', a newline or NAMESZ-1 characters,
+                       ** whichever comes first.
+                       */
                        cp = name;
                        i = NAMESZ - 1;
                        for (;;) {
@@ -308,24 +309,35 @@ m_getfld (int state, unsigned char *name, unsigned char *buf,
                                        break;
 
                                /*
-                                * something went wrong.  possibilities are:
-                                *  . hit a newline (error)
-                                *  . got more than namesz chars. (error)
-                                *  . hit the end of the buffer. (loop)
-                                */
+                               ** something went wrong.  possibilities are:
+                               **  . hit a newline (error)
+                               **  . got more than namesz chars. (error)
+                               **  . hit the end of the buffer. (loop)
+                               */
                                if (c == '\n') {
-                                       /* We hit the end of the line without seeing ':' to
-                                        * terminate the field name.  This is usually (always?)
-                                        * spam.  But, blowing up is lame, especially when
-                                        * scan(1)ing a folder with such messages.  Pretend such
-                                        * lines are the first of the body (at least mutt also
-                                        * handles it this way). */
-
-                                       /* See if buf can hold this line, since we were assuming
-                                        * we had a buffer of NAMESZ, not bufsz. */
+                                       /*
+                                       ** We hit the end of the line
+                                       ** without seeing ':' to terminate
+                                       ** the field name.  This is usually
+                                       ** (always?)  spam.  But, blowing
+                                       ** up is lame, especially when
+                                       ** scan(1)ing a folder with such
+                                       ** messages.  Pretend such lines are
+                                       ** the first of the body (at least
+                                       ** mutt also handles it this way).
+                                       */
+
+                                       /*
+                                       ** See if buf can hold this line,
+                                       ** since we were assuming we had
+                                       ** a buffer of NAMESZ, not bufsz.
+                                       */
                                        /* + 1 for the newline */
                                        if (bufsz < j + 1) {
-                                               /* No, it can't.  Oh well, guess we'll blow up. */
+                                               /*
+                                               ** No, it can't.  Oh well,
+                                               ** guess we'll blow up.
+                                               */
                                                *cp = *buf = 0;
                                                advise (NULL, "eol encountered in field \"%s\"", name);
                                                state = FMTERR;
@@ -334,13 +346,20 @@ m_getfld (int state, unsigned char *name, unsigned char *buf,
                                        memcpy (buf, name, j - 1);
                                        buf[j - 1] = '\n';
                                        buf[j] = '\0';
-                                       /* mhparse.c:get_content wants to find the position of the
-                                        * body start, but it thinks there's a blank line between
-                                        * the header and the body (naturally!), so seek back so
-                                        * that things line up even though we don't have that
-                                        * blank line in this case.  Simpler parsers (e.g. mhl)
-                                        * get extra newlines, but that should be harmless enough,
-                                        * right?  This is a corrupt message anyway. */
+                                       /*
+                                       ** mhparse.c:get_content wants to
+                                       ** find the position of the body
+                                       ** start, but it thinks there's a
+                                       ** blank line between the header
+                                       ** and the body (naturally!), so
+                                       ** seek back so that things line
+                                       ** up even though we don't have
+                                       ** that blank line in this case.
+                                       ** Simpler parsers (e.g. mhl)
+                                       ** get extra newlines, but that
+                                       ** should be harmless enough, right?
+                                       ** This is a corrupt message anyway.
+                                       */
                                        fseek (iob, ftell (iob) - 2, SEEK_SET);
                                        return BODY;
                                }
@@ -359,10 +378,10 @@ m_getfld (int state, unsigned char *name, unsigned char *buf,
 
                case FLDPLUS:
                        /*
-                        * get (more of) the text of a field.  take
-                        * characters up to the end of this field (newline
-                        * followed by non-blank) or bufsz-1 characters.
-                        */
+                       ** get (more of) the text of a field.  take
+                       ** characters up to the end of this field (newline
+                       ** followed by non-blank) or bufsz-1 characters.
+                       */
                        cp = buf; i = bufsz-1;
                        for (;;) {
 #ifdef LINUX_STDIO
@@ -378,8 +397,9 @@ m_getfld (int state, unsigned char *name, unsigned char *buf,
                                c = cnt < i ? cnt : i;
                                while ((ep = locc( c, bp, '\n' ))) {
                                        /*
-                                        * if we hit the end of this field, return.
-                                        */
+                                       ** if we hit the end of this field,
+                                       ** return.
+                                       */
                                        if ((j = *++ep) != ' ' && j != '\t') {
 #ifdef LINUX_STDIO
                                                j = ep - (unsigned char *) iob->_IO_read_ptr;
@@ -404,8 +424,9 @@ m_getfld (int state, unsigned char *name, unsigned char *buf,
                                        bp = ep;
                                }
                                /*
-                                * end of input or dest buffer - copy what we've found.
-                                */
+                               ** end of input or dest buffer - copy what
+                               ** we've found.
+                               */
 #ifdef LINUX_STDIO
                                c += bp - (unsigned char *) iob->_IO_read_ptr;
                                memcpy( cp, iob->_IO_read_ptr, c);
@@ -433,11 +454,12 @@ m_getfld (int state, unsigned char *name, unsigned char *buf,
                                        break;
                                }
                                /*
-                                * There's one character left in the input buffer.
-                                * Copy it & fill the buffer.  If the last char
-                                * was a newline and the next char is not whitespace,
-                                * this is the end of the field.  Otherwise loop.
-                                */
+                               ** There's one character left in the input
+                               ** buffer.  Copy it & fill the buffer.
+                               ** If the last char was a newline and the
+                               ** next char is not whitespace, this is
+                               ** the end of the field.  Otherwise loop.
+                               */
                                --i;
 #ifdef LINUX_STDIO
                                *cp++ = j = *(iob->_IO_read_ptr + c);
@@ -473,11 +495,12 @@ m_getfld (int state, unsigned char *name, unsigned char *buf,
                case BODY:
                body:
                        /*
-                        * get the message body up to bufsz characters or the
-                        * end of the message.  Sleazy hack: if bufsz is negative
-                        * we assume that we were called to copy directly into
-                        * the output buffer and we don't add an eos.
-                        */
+                       ** get the message body up to bufsz characters or
+                       ** the end of the message.  Sleazy hack: if bufsz
+                       ** is negative we assume that we were called to
+                       ** copy directly into the output buffer and we
+                       ** don't add an eos.
+                       */
                        i = (bufsz < 0) ? -bufsz : bufsz-1;
 #ifdef LINUX_STDIO
                        bp = (unsigned char *) --iob->_IO_read_ptr;
@@ -492,61 +515,91 @@ m_getfld (int state, unsigned char *name, unsigned char *buf,
                        c = (cnt < i ? cnt : i);
                        if (msg_style != MS_DEFAULT && c > 1) {
                                /*
-                                * packed maildrop - only take up to the (possible)
-                                * start of the next message.  This "matchc" should
-                                * probably be a Boyer-Moore matcher for non-vaxen,
-                                * particularly since we have the alignment table
-                                * all built for the end-of-buffer test (next).
-                                * But our vax timings indicate that the "matchc"
-                                * instruction is 50% faster than a carefully coded
-                                * B.M. matcher for most strings.  (So much for elegant
-                                * algorithms vs. brute force.)  Since I (currently)
-                                * run MH on a vax, we use the matchc instruction. --vj
-                                */
+                               ** packed maildrop - only take up to the
+                               ** (possible) start of the next message.
+                               ** This "matchc" should probably be a
+                               ** Boyer-Moore matcher for non-vaxen,
+                               ** particularly since we have the alignment
+                               ** table all built for the end-of-buffer
+                               ** test (next).  But our vax timings
+                               ** indicate that the "matchc" instruction
+                               ** is 50% faster than a carefully coded
+                               ** B.M. matcher for most strings.  (So much
+                               ** for elegant algorithms vs. brute force.)
+                               ** Since I (currently) run MH on a vax,
+                               ** we use the matchc instruction. --vj
+                               */
                                if ((ep = matchc( fdelimlen, fdelim, c, bp )))
                                        c = ep - bp + 1;
                                else {
                                        /*
-                                        * There's no delim in the buffer but there may be
-                                        * a partial one at the end.  If so, we want to leave
-                                        * it so the "eom" check on the next call picks it up.
-                                        * Use a modified Boyer-Moore matcher to make this
-                                        * check relatively cheap.  The first "if" figures
-                                        * out what position in the pattern matches the last
-                                        * character in the buffer.  The inner "while" matches
-                                        * the pattern against the buffer, backwards starting
-                                        * at that position.  Note that unless the buffer
-                                        * ends with one of the characters in the pattern
-                                        * (excluding the first and last), we do only one test.
-                                        */
+                                       ** There's no delim in the buffer
+                                       ** but there may be a partial one
+                                       ** at the end.  If so, we want
+                                       ** to leave it so the "eom" check
+                                       ** on the next call picks it up.
+                                       ** Use a modified Boyer-Moore
+                                       ** matcher to make this check
+                                       ** relatively cheap.  The first
+                                       ** "if" figures out what position
+                                       ** in the pattern matches the
+                                       ** last character in the buffer.
+                                       ** The inner "while" matches the
+                                       ** pattern against the buffer,
+                                       ** backwards starting at that
+                                       ** position.  Note that unless
+                                       ** the buffer ends with one of
+                                       ** the characters in the pattern
+                                       ** (excluding the first and last),
+                                       ** we do only one test.
+                                       */
                                        ep = bp + c - 1;
                                        if ((sp = pat_map[*ep])) {
                                                do {
-                                                       /* This if() is true unless (a) the buffer is too
-                                                        * small to contain this delimiter prefix, or
-                                                        * (b) it contains exactly enough chars for the
-                                                        * delimiter prefix.
-                                                        * For case (a) obviously we aren't going to match.
-                                                        * For case (b), if the buffer really contained exactly
-                                                        * a delim prefix, then the m_eom call at entry
-                                                        * should have found it.  Thus it's not a delim
-                                                        * and we know we won't get a match.
-                                                        */
+                                                       /*
+                                                       ** This if() is
+                                                       ** true unless (a)
+                                                       ** the buffer is too
+                                                       ** small to contain
+                                                       ** this delimiter
+                                                       ** prefix, or (b)
+                                                       ** it contains
+                                                       ** exactly enough
+                                                       ** chars for the
+                                                       ** delimiter prefix.
+                                                       ** For case (a)
+                                                       ** obviously we
+                                                       ** aren't going
+                                                       ** to match.
+                                                       ** For case (b),
+                                                       ** if the buffer
+                                                       ** really contained
+                                                       ** exactly a delim
+                                                       ** prefix, then
+                                                       ** the m_eom call
+                                                       ** at entry should
+                                                       ** have found it.
+                                                       ** Thus it's not
+                                                       ** a delim and we
+                                                       ** know we won't
+                                                       ** get a match.
+                                                       */
                                                        if (((sp - fdelim) + 2) <= c) {
                                                                cp = sp;
-                                                               /* Unfortunately although fdelim has a preceding NUL
-                                                                * we can't use this as a sentinel in case the buffer
-                                                                * contains a NUL in exactly the wrong place (this
-                                                                * would cause us to run off the front of fdelim).
-                                                                */
+                                                               /*
+                                                               ** Unfortunately although fdelim has a preceding NUL
+                                                               ** we can't use this as a sentinel in case the buffer
+                                                               ** contains a NUL in exactly the wrong place (this
+                                                               ** would cause us to run off the front of fdelim).
+                                                               */
                                                                while (*--ep == *--cp)
                                                                        if (cp < fdelim)
                                                                                break;
                                                                if (cp < fdelim) {
                                                                        /* we matched the entire delim prefix,
-                                                                        * so only take the buffer up to there.
-                                                                        * we know ep >= bp -- check above prevents underrun
-                                                                        */
+                                                                       ** so only take the buffer up to there.
+                                                                       ** we know ep >= bp -- check above prevents underrun
+                                                                       */
                                                                        c = (ep - bp) + 2;
                                                                        break;
                                                                }
@@ -598,17 +651,17 @@ m_unknown(FILE *iob)
        register char *delimstr;
 
 /*
- * Figure out what the message delimitter string is for this
- * maildrop.  (This used to be part of m_Eom but I didn't like
- * the idea of an "if" statement that could only succeed on the
- * first call to m_Eom getting executed on each call, i.e., at
- * every newline in the message).
- *
- * If the first line of the maildrop is a Unix "From " line, we
- * say the style is MBOX and eat the rest of the line.  Otherwise
- * we say the style is MMDF and look for the delimiter string
- * specified when nmh was built (or from the mts.conf file).
- */
+** Figure out what the message delimitter string is for this
+** maildrop.  (This used to be part of m_Eom but I didn't like
+** the idea of an "if" statement that could only succeed on the
+** first call to m_Eom getting executed on each call, i.e., at
+** every newline in the message).
+**
+** If the first line of the maildrop is a Unix "From " line, we
+** say the style is MBOX and eat the rest of the line.  Otherwise
+** we say the style is MMDF and look for the delimiter string
+** specified when nmh was built (or from the mts.conf file).
+*/
 
        msg_style = MS_UNKNOWN;
 
@@ -647,11 +700,11 @@ m_unknown(FILE *iob)
        if (edelimlen <= 1)
                adios (NULL, "maildrop delimiter must be at least 2 bytes");
        /*
-        * build a Boyer-Moore end-position map for the matcher in m_getfld.
-        * N.B. - we don't match just the first char (since it's the newline
-        * separator) or the last char (since the matchc would have found it
-        * if it was a real delim).
-        */
+       ** build a Boyer-Moore end-position map for the matcher in m_getfld.
+       ** N.B. - we don't match just the first char (since it's the newline
+       ** separator) or the last char (since the matchc would have found it
+       ** if it was a real delim).
+       */
        pat_map = (unsigned char **) calloc (256, sizeof(unsigned char *));
 
        for (cp = (char *) fdelim + 1; cp < (char *) delimend; cp++ )
@@ -668,8 +721,8 @@ m_unknown(FILE *iob)
 
 
 /*
- * test for msg delimiter string
- */
+** test for msg delimiter string
+*/
 
 static int
 m_Eom (int c, FILE *iob)
@@ -685,9 +738,10 @@ m_Eom (int c, FILE *iob)
        if ((i = fread (text, sizeof *text, edelimlen, iob)) != edelimlen
                || strncmp (text, (char *)edelim, edelimlen)) {
                if (i == 0 && msg_style == MS_MBOX)
-                       /* the final newline in the (brain damaged) unix-format
-                        * maildrop is part of the delimitter - delete it.
-                        */
+                       /*
+                       ** the final newline in the (brain damaged) unix-format
+                       ** maildrop is part of the delimitter - delete it.
+                       */
                        return 1;
 
 #if 0
@@ -718,15 +772,15 @@ m_Eom (int c, FILE *iob)
 
 #ifdef RPATHS
 /*
- * Return the Return-Path and Delivery-Date
- * header information.
- *
- * Currently, I'm assuming that the "From " line
- * takes one of the following forms.
- *
- * From sender date remote from host   (for UUCP delivery)
- * From sender@host  date              (for sendmail delivery)
- */
+** Return the Return-Path and Delivery-Date
+** header information.
+**
+** Currently, I'm assuming that the "From " line
+** takes one of the following forms.
+**
+** From sender date remote from host   (for UUCP delivery)
+** From sender@host  date              (for sendmail delivery)
+*/
 
 int
 get_returnpath (char *rp, int rplen, char *dd, int ddlen)
@@ -738,9 +792,9 @@ get_returnpath (char *rp, int rplen, char *dd, int ddlen)
                return 0;
 
        /*
-        * Check for "remote from" in envelope to see
-        * if this message uses UUCP style addressing
-        */
+       ** Check for "remote from" in envelope to see
+       ** if this message uses UUCP style addressing
+       */
        while ((cp = strchr(++cp, 'r'))) {
                if (strncmp (cp, "remote from", 11) == 0) {
                        cp = strrchr (cp, ' ');
@@ -749,9 +803,9 @@ get_returnpath (char *rp, int rplen, char *dd, int ddlen)
        }
 
        /*
-        * Get the Return-Path information from
-        * the "From " envelope.
-        */
+       ** Get the Return-Path information from
+       ** the "From " envelope.
+       */
        if (cp) {
                /* return path for UUCP style addressing */
                dp = strchr (++cp, '\n');
@@ -762,9 +816,9 @@ get_returnpath (char *rp, int rplen, char *dd, int ddlen)
        }
 
        /*
-        * advance over the spaces to get to
-        * delivery date on envelope
-        */
+       ** advance over the spaces to get to
+       ** delivery date on envelope
+       */
        while (*bp == ' ')
                bp++;
 
@@ -802,9 +856,9 @@ matchc(int patln, char *pat, int strln, char *str)
 
 
 /*
- * Locate character "term" in the next "cnt" characters of "src".
- * If found, return its address, otherwise return 0.
- */
+** Locate character "term" in the next "cnt" characters of "src".
+** If found, return its address, otherwise return 0.
+*/
 
 static unsigned char *
 locc(int cnt, unsigned char *src, unsigned char term)