summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2009-06-16 19:13:28 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2009-06-16 19:13:28 +0000
commitbf5cc7adff53d67064937f93d51005e425746df8 (patch)
tree2a31290923a4aca3c8628070f8a9f0598b851be2
parent4c30e6f109f12c3f061caa13660a9a30fc807db2 (diff)
downloadmandoc-bf5cc7adff53d67064937f93d51005e425746df8.tar.gz
Modernised comment handling: text following \" is thrown away before
either parser is invoked. Single-dot lines correctly handled. This confirms with both new- and old-groff. "Comment" subsection added to mdoc.7 and man.7.
-rw-r--r--main.c63
-rw-r--r--man.710
-rw-r--r--man.c4
-rw-r--r--mdoc.712
-rw-r--r--mdoc.c6
5 files changed, 60 insertions, 35 deletions
diff --git a/main.c b/main.c
index 4bece6ac..357af713 100644
--- a/main.c
+++ b/main.c
@@ -74,12 +74,12 @@ struct curparse {
#define NO_IGN_ESCAPE (1 << 1) /* Don't ignore bad escapes. */
#define NO_IGN_MACRO (1 << 2) /* Don't ignore bad macros. */
#define NO_IGN_CHARS (1 << 3) /* Don't ignore bad chars. */
- enum intt inttype; /* Input parsers. */
+ enum intt inttype; /* Input parsers... */
struct man *man;
struct man *lastman;
struct mdoc *mdoc;
struct mdoc *lastmdoc;
- enum outt outtype; /* Output devices. */
+ enum outt outtype; /* Output devices... */
out_mdoc outmdoc;
out_man outman;
out_free outfree;
@@ -325,7 +325,7 @@ fdesc(struct buf *blk, struct buf *ln, struct curparse *curp)
size_t sz;
ssize_t ssz;
struct stat st;
- int j, i, pos, lnn;
+ int j, i, pos, lnn, comment;
struct man *man;
struct mdoc *mdoc;
@@ -355,7 +355,7 @@ fdesc(struct buf *blk, struct buf *ln, struct curparse *curp)
/* Fill buf with file blocksize. */
- for (lnn = 0, pos = 0; ; ) {
+ for (lnn = pos = comment = 0; ; ) {
if (-1 == (ssz = read(curp->fd, blk->buf, sz))) {
warn("%s", curp->file);
return(0);
@@ -375,17 +375,34 @@ fdesc(struct buf *blk, struct buf *ln, struct curparse *curp)
}
if ('\n' != blk->buf[i]) {
+ if (comment)
+ continue;
ln->buf[pos++] = blk->buf[i];
+
+ /* Handle in-line `\"' comments. */
+
+ if (1 == pos || '\"' != ln->buf[pos - 1])
+ continue;
+
+ for (j = pos - 2; j >= 0; j--)
+ if ('\\' != ln->buf[j])
+ break;
+
+ if ( ! ((pos - 2 - j) % 2))
+ continue;
+
+ comment = 1;
+ pos -= 2;
continue;
- }
+ }
- /* Check for CPP-escaped newline. */
+ /* Handle escaped `\\n' newlines. */
- if (pos > 0 && '\\' == ln->buf[pos - 1]) {
+ if (pos > 0 && 0 == comment &&
+ '\\' == ln->buf[pos - 1]) {
for (j = pos - 1; j >= 0; j--)
if ('\\' != ln->buf[j])
break;
-
if ( ! ((pos - j) % 2)) {
pos--;
lnn++;
@@ -395,19 +412,14 @@ fdesc(struct buf *blk, struct buf *ln, struct curparse *curp)
ln->buf[pos] = 0;
lnn++;
-
- /*
- * If no manual parser has been assigned, then
- * try to assign one in pset(), which may do
- * nothing at all. After this, parse the manual
- * line accordingly.
- */
+
+ /* If unset, assign parser in pset(). */
if ( ! (man || mdoc) && ! pset(ln->buf,
pos, curp, &man, &mdoc))
return(0);
- pos = 0;
+ pos = comment = 0;
if (man && ! man_parseln(man, lnn, ln->buf))
return(0);
@@ -416,7 +428,7 @@ fdesc(struct buf *blk, struct buf *ln, struct curparse *curp)
}
}
- /* Note that a parser may not have been assigned, yet. */
+ /* NOTE a parser may not have been assigned, yet. */
if ( ! (man || mdoc)) {
warnx("%s: not a manual", curp->file);
@@ -428,12 +440,7 @@ fdesc(struct buf *blk, struct buf *ln, struct curparse *curp)
if (man && ! man_endparse(man))
return(0);
- /*
- * If an output device hasn't been allocated, see if we should
- * do so now. Note that not all outtypes have functions, so
- * this switch statement may be superfluous, but it's
- * low-overhead enough not to matter very much.
- */
+ /* If unset, allocate output dev now (if applicable). */
if ( ! (curp->outman && curp->outmdoc)) {
switch (curp->outtype) {
@@ -469,6 +476,7 @@ static int
pset(const char *buf, int pos, struct curparse *curp,
struct man **man, struct mdoc **mdoc)
{
+ int i;
/*
* Try to intuit which kind of manual parser should be used. If
@@ -478,8 +486,13 @@ pset(const char *buf, int pos, struct curparse *curp,
* default to -man, which is more lenient.
*/
- if (pos >= 3 && 0 == memcmp(buf, ".\\\"", 3))
- return(1);
+ if (buf[0] == '.') {
+ for (i = 1; buf[i]; i++)
+ if (' ' != buf[i] && '\t' != buf[i])
+ break;
+ if (0 == buf[i])
+ return(1);
+ }
switch (curp->inttype) {
case (INTT_MDOC):
diff --git a/man.7 b/man.7
index a1068f3c..480004f4 100644
--- a/man.7
+++ b/man.7
@@ -70,6 +70,16 @@ escape is common in historical
documents; if encountered at the end of a word, it ensures that the
subsequent word isn't off-set by whitespace.
.\" SUB-SECTION
+.Ss Comments
+Anything following a
+.Sq \e"
+delimiter is considered a comment (unless the
+.Sq \e
+itself has been escaped) and is ignored to the end of line.
+Furthermore, a macro line with only a control character
+.Sq \. ,
+optionally followed by whitespace, is ignored.
+.\" SUB-SECTION
.Ss Special Characters
Special character sequences begin with the escape character
.Sq \e
diff --git a/man.c b/man.c
index 9074d7f8..9744cc8e 100644
--- a/man.c
+++ b/man.c
@@ -324,10 +324,6 @@ man_pmacro(struct man *m, int ln, char *buf)
ppos = i;
- if (buf[i] && '\\' == buf[i])
- if (buf[i + 1] && '\"' == buf[i + 1])
- goto out;
-
/* Copy the first word into a nil-terminated buffer. */
for (j = 0; j < 4; j++, i++) {
diff --git a/mdoc.7 b/mdoc.7
index 69cb6071..621c6f28 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -78,9 +78,19 @@ or
.Sq \&.Bd \-unfilled
contexts.
.\" SUB-SECTION
+.Ss Comments
+Anything following a
+.Sq \e"
+delimiter is considered a comment (unless the
+.Sq \e
+itself has been escaped) and is ignored to the end of line.
+Furthermore, a macro line with only a control character
+.Sq \. ,
+optionally followed by whitespace, is ignored.
+.\" SUB-SECTION
.Ss Reserved Characters
Within a macro line, the following characters are reserved:
-.Bl -tag -width 12n -offset XXXX -compact
+.Bl -tag -width Ds -offset XXXX -compact
.It \&.
.Pq period
.It \&,
diff --git a/mdoc.c b/mdoc.c
index 895bc44f..cb3f7ff7 100644
--- a/mdoc.c
+++ b/mdoc.c
@@ -657,7 +657,7 @@ parsemacro(struct mdoc *m, int ln, char *buf)
int i, c;
char mac[5];
- /* Comments and empties are quickly ignored. */
+ /* Empty lines are ignored. */
if (0 == buf[1])
return(1);
@@ -671,10 +671,6 @@ parsemacro(struct mdoc *m, int ln, char *buf)
return(perr(m, ln, 1, ESPACE));
}
- if (buf[1] && '\\' == buf[1])
- if (buf[2] && '\"' == buf[2])
- return(1);
-
/* Copy the first word into a nil-terminated buffer. */
for (i = 1; i < 5; i++) {