diff options
| -rw-r--r-- | Makefile | 2 | ||||
| -rw-r--r-- | man.7 | 437 | ||||
| -rw-r--r-- | man.c | 31 | ||||
| -rw-r--r-- | man_action.c | 20 | ||||
| -rw-r--r-- | man_hash.c | 2 | ||||
| -rw-r--r-- | man_validate.c | 6 |
6 files changed, 53 insertions, 445 deletions
@@ -39,7 +39,7 @@ MAINOBJS = main.o term.o ascii.o terminal.o tree.o compat.o MAINSRCS = main.c term.c ascii.c terminal.c tree.c compat.c LLNS = llib-llibmdoc.ln llib-llibman.ln llib-lmandoc.ln -LNS = $(MAINLNS) $(MDOCLNS) +LNS = $(MAINLNS) $(MDOCLNS) $(MANLNS) LIBS = libmdoc.a libman.a OBJS = $(MDOCOBJS) $(MAINOBJS) SRCS = $(MDOCSRCS) $(MAINSRCS) $(MANSRCS) @@ -46,7 +46,7 @@ An .Nm document follows simple rules: lines beginning with the control character -.Sq \. +.Sq \&. are parsed for macros. Other lines are interpreted within the scope of prior macros: .Bd -literal -offset XXX @@ -72,7 +72,7 @@ vertical space. .\" SUB-SECTION .Ss Special Characters Special character sequences begin with the escape character -.Sq \\ +.Sq \e followed by either an open-parenthesis .Sq \&( for two-character sequences; an open-bracket @@ -82,427 +82,26 @@ for n-character sequences (terminated at a close-bracket or a single one-character sequence. .Pp Characters may alternatively be escaped by a slash-asterisk, -.Sq \\* , +.Sq \e* , with the same combinations as described above. This form is deprecated. .Pp -The following is a table of all available escapes. -.Pp -Grammatic: -.Bl -tag -width 12n -offset "XXXX" -compact -.It \\(em -.Pq em-dash -.It \\(en -.Pq en-dash -.It \e- -.Pq hyphen -.It \\\\ -.Pq back-slash -.It \e' -.Pq apostrophe -.It \e` -.Pq back-tick -.It \\ -.Pq space -.It \\. -.Pq period -.It \\(r! -.Pq upside-down exclamation -.It \\(r? -.Pq upside-down question -.El -.\" PARAGRAPH -.Pp -Enclosures: -.Bl -tag -width 12n -offset "XXXX" -compact -.It \\(lh -.Pq left hand -.It \\(rh -.Pq right hand -.It \\(Fo -.Pq left guillemet -.It \\(Fc -.Pq right guillemet -.It \\(fo -.Pq left guilsing -.It \\(fc -.Pq right guilsing -.It \\(rC -.Pq right brace -.It \\(lC -.Pq left brace -.It \\(ra -.Pq right angle -.It \\(la -.Pq left angle -.It \\(rB -.Pq right bracket -.It \\(lB -.Pq left bracket -.It \\q -.Pq double-quote -.It \\(lq -.Pq left double-quote -.It \\(Lq -.Pq left double-quote, deprecated -.It \\(rq -.Pq right double-quote -.It \\(Rq -.Pq right double-quote, deprecated -.It \\(oq -.Pq left single-quote -.It \\(aq -.Pq right single-quote -.It \\(Bq -.Pq right low double-quote -.It \\(bq -.Pq right low single-quote -.El -.\" PARAGRAPH -.Pp -Indicatives: -.Bl -tag -width 12n -offset "XXXX" -compact -.It \\(<- -.Pq left arrow -.It \\(-> -.Pq right arrow -.It \\(ua -.Pq up arrow -.It \\(da -.Pq down arrow -.It \\(<> -.Pq left-right arrow -.It \\(lA -.Pq left double-arrow -.It \\(rA -.Pq right double-arrow -.It \\(uA -.Pq up double-arrow -.It \\(dA -.Pq down double-arrow -.It \\(hA -.Pq left-right double-arrow -.El -.\" PARAGRAPH -.Pp -Mathematical: -.Bl -tag -width 12n -offset "XXXX" -compact -.It \\(es -.Pq empty set -.It \\(ca -.Pq intersection -.It \\(cu -.Pq union -.It \\(gr -.Pq gradient -.It \\(pd -.Pq partial differential -.It \\(ap -.Pq similarity -.It \\(=) -.Pq proper superset -.It \\((= -.Pq proper subset -.It \\(eq -.Pq equals -.It \\(di -.Pq division -.It \\(mu -.Pq multiplication -.It \\(pl -.Pq addition -.It \\(nm -.Pq not element -.It \\(mo -.Pq element -.It \\(Im -.Pq imaginary -.It \\(Re -.Pq real -.It \\(Ah -.Pq aleph -.It \\(te -.Pq existential quantifier -.It \\(fa -.Pq universal quantifier -.It \\(AN -.Pq logical AND -.It \\(OR -.Pq logical OR -.It \\(no -.Pq logical NOT -.It \\(st -.Pq such that -.It \\(tf -.Pq therefore -.It \\(~~ -.Pq approximate -.It \\(~= -.Pq approximately equals -.It \\(=~ -.Pq congruent -.It \\(Gt -.Pq greater-than, deprecated -.It \\(Lt -.Pq less-than, deprecated -.It \\(<= -.Pq less-than-equal -.It \\(Le -.Pq less-than-equal, deprecated -.It \\(>= -.Pq greater-than-equal -.It \\(Ge -.Pq greater-than-equal -.It \\(== -.Pq equal -.It \\(!= -.Pq not equal -.It \\(Ne -.Pq not equal, deprecated -.It \\(if -.Pq infinity -.It \\(If -.Pq infinity, deprecated -.It \\(na -.Pq NaN , an extension -.It \\(Na -.Pq NaN, deprecated -.It \\(+- -.Pq plus-minus -.It \\(Pm -.Pq plus-minus, deprecated -.It \\(** -.Pq asterisk -.El -.\" PARAGRAPH -.Pp -Ligatures: -.Bl -tag -width 12n -offset "XXXX" -compact -.It \\(ss -.Pq German eszett -.It \\(AE -.Pq upper-case AE -.It \\(ae -.Pq lower-case AE -.It \\(OE -.Pq upper-case OE -.It \\(oe -.Pq lower-case OE -.It \\(ff -.Pq ff ligature -.It \\(fi -.Pq fi ligature -.It \\(fl -.Pq fl ligature -.It \\(Fi -.Pq ffi ligature -.It \\(Fl -.Pq ffl ligature -.El -.\" PARAGRAPH -.Pp -Diacritics and letters: -.Bl -tag -width 12n -offset "XXXX" -compact -.It \\(ga -.Pq grave accent -.It \\(aa -.Pq accute accent -.It \\(a" -.Pq umlaut accent -.It \\(ad -.Pq dieresis accent -.It \\(a~ -.Pq tilde accent -.It \\(a^ -.Pq circumflex accent -.It \\(ac -.Pq cedilla accent -.It \\(ad -.Pq dieresis accent -.It \\(ah -.Pq caron accent -.It \\(ao -.Pq ring accent -.It \\(ho -.Pq hook accent -.It \\(ab -.Pq breve accent -.It \\(a- -.Pq macron accent -.It \\(-D -.Pq upper-case eth -.It \\(Sd -.Pq lower-case eth -.It \\(TP -.Pq upper-case thorn -.It \\(Tp -.Pq lower-case thorn -.It \\('A -.Pq upper-case acute A -.It \\('E -.Pq upper-case acute E -.It \\('I -.Pq upper-case acute I -.It \\('O -.Pq upper-case acute O -.It \\('U -.Pq upper-case acute U -.It \\('a -.Pq lower-case acute a -.It \\('e -.Pq lower-case acute e -.It \\('i -.Pq lower-case acute i -.It \\('o -.Pq lower-case acute o -.It \\('u -.Pq lower-case acute u -.It \\(`A -.Pq upper-case grave A -.It \\(`E -.Pq upper-case grave E -.It \\(`I -.Pq upper-case grave I -.It \\(`O -.Pq upper-case grave O -.It \\(`U -.Pq upper-case grave U -.It \\(`a -.Pq lower-case grave a -.It \\(`e -.Pq lower-case grave e -.It \\(`i -.Pq lower-case grave i -.It \\(`o -.Pq lower-case grave o -.It \\(`u -.Pq lower-case grave u -.It \\(~A -.Pq upper-case tilde A -.It \\(~N -.Pq upper-case tilde N -.It \\(~O -.Pq upper-case tilde O -.It \\(~a -.Pq lower-case tilde a -.It \\(~n -.Pq lower-case tilde n -.It \\(~o -.Pq lower-case tilde o -.It \\(:A -.Pq upper-case dieresis A -.It \\(:E -.Pq upper-case dieresis E -.It \\(:I -.Pq upper-case dieresis I -.It \\(:O -.Pq upper-case dieresis O -.It \\(:U -.Pq upper-case dieresis U -.It \\(:a -.Pq lower-case dieresis a -.It \\(:e -.Pq lower-case dieresis e -.It \\(:i -.Pq lower-case dieresis i -.It \\(:o -.Pq lower-case dieresis o -.It \\(:u -.Pq lower-case dieresis u -.It \\(:y -.Pq lower-case dieresis y -.It \\(^A -.Pq upper-case circumflex A -.It \\(^E -.Pq upper-case circumflex E -.It \\(^I -.Pq upper-case circumflex I -.It \\(^O -.Pq upper-case circumflex O -.It \\(^U -.Pq upper-case circumflex U -.It \\(^a -.Pq lower-case circumflex a -.It \\(^e -.Pq lower-case circumflex e -.It \\(^i -.Pq lower-case circumflex i -.It \\(^o -.Pq lower-case circumflex o -.It \\(^u -.Pq lower-case circumflex u -.It \\(,C -.Pq upper-case cedilla C -.It \\(,c -.Pq lower-case cedilla c -.It \\(/L -.Pq upper-case stroke L -.It \\(/l -.Pq lower-case stroke l -.It \\(/O -.Pq upper-case stroke O -.It \\(/o -.Pq lower-case stroke o -.It \\(oA -.Pq upper-case ring A -.It \\(oa -.Pq lower-case ring a -.El -.\" PARAGRAPH -.Pp -Monetary: -.Bl -tag -width 12n -offset "XXXX" -compact -.It \\(Cs -.Pq Scandinavian -.It \\(Do -.Pq dollar -.It \\(Po -.Pq pound -.It \\(Ye -.Pq yen -.It \\(Fn -.Pq florin -.It \\(ct -.Pq cent -.El -.\" PARAGRAPH -.Pp -Special symbols: -.Bl -tag -width 12n -offset "XXXX" -compact -.It \\(de -.Pq degree -.It \\(ps -.Pq paragraph -.It \\(sc -.Pq section -.It \\(dg -.Pq dagger -.It \\(dd -.Pq double dagger -.It \\(ci -.Pq circle -.It \\(ba -.Pq bar -.It \\(bb -.Pq broken bar -.It \\(Ba -.Pq bar, deprecated -.It \\(co -.Pq copyright -.It \\(rg -.Pq registered -.It \\(tm -.Pq trademarked -.It \\& -.Pq non-breaking space -.It \\e -.Pq escape -.It \\(Am -.Pq ampersand, deprecated -.El +The +.Xr mdoc 7 +contains a table of all available escapes. .\" SECTION .Sh STRUCTURE -Macros are case in-sensitive and one to three three characters in -length. All follow the same structural rules: +Macros are one to three three characters in length and begin with a +control character +.Sq \&. +at the beginning of the line. An arbitrary amount of whitespace may +sit between the control character and the macro name. Thus, +.Sq \&PP +and +.Sq \&.\ \ \ \&PP +are equivalent. +.Pp +All follow the same +structural rules: .Bd -literal -offset XXXX \&.Yo \(lBbody...\(rB .Ed @@ -275,7 +275,7 @@ man_ptext(struct man *m, int line, char *buf) int man_pmacro(struct man *m, int ln, char *buf) { - int i, c; + int i, j, c; char mac[5]; /* Comments and empties are quickly ignored. */ @@ -283,48 +283,49 @@ man_pmacro(struct man *m, int ln, char *buf) if (0 == buf[1]) return(1); - if (' ' == buf[1]) { - i = 2; + i = 1; + + if (' ' == buf[i]) { + i++; while (buf[i] && ' ' == buf[i]) i++; if (0 == buf[i]) return(1); - return(man_vwarn(m, ln, 0, "invalid syntax")); } - if (buf[1] && '\\' == buf[1]) - if (buf[2] && '\"' == buf[2]) + if (buf[i] && '\\' == buf[i]) + if (buf[i + 1] && '\"' == buf[i + 1]) return(1); /* Copy the first word into a nil-terminated buffer. */ - for (i = 1; i < 5; i++) { - if (0 == (mac[i - 1] = buf[i])) + for (j = 0; j < 4; j++) { + if (0 == (mac[j] = buf[j + i])) break; - else if (' ' == buf[i]) + else if (' ' == buf[j + i]) break; } - mac[i - 1] = 0; + mac[j] = 0; - if (i == 5 || i <= 1) { + if (j == 4 || j < 1) { if ( ! (MAN_IGN_MACRO & m->pflags)) { - (void)man_verr(m, ln, 1, + (void)man_verr(m, ln, i, "ill-formed macro: %s", mac); goto err; } - if ( ! man_vwarn(m, ln, 1, "ill-formed macro: %s", mac)) + if ( ! man_vwarn(m, ln, 0, "ill-formed macro: %s", mac)) goto err; return(1); } if (MAN_MAX == (c = man_hash_find(m->htab, mac))) { if ( ! (MAN_IGN_MACRO & m->pflags)) { - (void)man_verr(m, ln, 1, + (void)man_verr(m, ln, i, "unknown macro: %s", mac); goto err; } - if ( ! man_vwarn(m, ln, 1, "unknown macro: %s", mac)) + if ( ! man_vwarn(m, ln, i, "unknown macro: %s", mac)) goto err; return(1); } diff --git a/man_action.c b/man_action.c index 00a284d8..e159baa5 100644 --- a/man_action.c +++ b/man_action.c @@ -153,12 +153,20 @@ post_TH(struct man *m) * of the syntax tree (they encompass only meta-data). */ - assert(MAN_ROOT == m->last->parent->type); - m->last->parent->child = NULL; - n = m->last; - m->last = m->last->parent; - m->next = MAN_NEXT_CHILD; - assert(m->last == m->first); + if (m->last->parent->child == m->last) { + assert(MAN_ROOT == m->last->parent->type); + m->last->parent->child = NULL; + n = m->last; + m->last = m->last->parent; + m->next = MAN_NEXT_CHILD; + assert(m->last == m->first); + } else { + assert(m->last->prev); + m->last->prev->next = NULL; + n = m->last; + m->last = m->last->prev; + m->next = MAN_NEXT_SIBLING; + } man_node_freelist(n); return(1); @@ -52,7 +52,7 @@ man_hash_find(const void *arg, const char *tmp) /* TODO */ for (i = 0; i < MAN_MAX; i++) - if (0 == strcasecmp(tmp, man_macronames[i])) + if (0 == strcmp(tmp, man_macronames[i])) return(i); return(MAN_MAX); diff --git a/man_validate.c b/man_validate.c index e67444f7..495e4329 100644 --- a/man_validate.c +++ b/man_validate.c @@ -35,7 +35,7 @@ struct man_valid { v_post *posts; }; -static int count(POSTARGS); +static int count(const struct man_node *); static int check_eq0(POSTARGS); static int check_ge1(POSTARGS); static int check_ge2(POSTARGS); @@ -102,7 +102,7 @@ man_valid_post(struct man *m) static inline int -count(POSTARGS) +count(const struct man_node *n) { int i; @@ -117,7 +117,7 @@ static int \ check_##name(POSTARGS) \ { \ int c; \ - if ((c = count(m, n->child)) ineq (x)) \ + if ((c = count(n->child)) ineq (x)) \ return(1); \ return(man_vwarn(m, n->line, n->pos, \ "expected line arguments %s %d, have %d", \ |