-/* $Id: man.c,v 1.8 2009/03/25 21:46:24 kristaps Exp $ */
+/* $Id: man.c,v 1.187 2019/01/05 00:36:50 schwarze Exp $ */
/*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2013-2015, 2017-2019 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2011 Joerg Sonnenberger <joerg@netbsd.org>
*
* Permission to use, copy, modify, and distribute this software for any
- * purpose with or without fee is hereby granted, provided that the
- * above copyright notice and this permission notice appear in all
- * copies.
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
*
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
- * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
- * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
- * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
- * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- * PERFORMANCE OF THIS SOFTWARE.
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
+#include "config.h"
+
+#include <sys/types.h>
+
#include <assert.h>
#include <ctype.h>
-#include <err.h>
#include <stdarg.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
+#include "mandoc_aux.h"
+#include "mandoc.h"
+#include "roff.h"
+#include "man.h"
+#include "libmandoc.h"
+#include "roff_int.h"
#include "libman.h"
-const char *const __man_macronames[MAN_MAX] = {
- "\\\"", "TH", "SH", "SS",
- "TP", "LP", "PP", "P",
- "IP", "HP", "SM", "SB",
- "BI", "IB", "BR", "RB",
- "R", "B", "I", "IR"
- };
-
-const char * const *man_macronames = __man_macronames;
-
-static struct man_node *man_node_alloc(int, int, enum man_type);
-static int man_node_append(struct man *,
- struct man_node *);
-static int man_ptext(struct man *, int, char *);
-static int man_pmacro(struct man *, int, char *);
-static void man_free1(struct man *);
-static void man_alloc1(struct man *);
+static char *man_hasc(char *);
+static int man_ptext(struct roff_man *, int, char *, int);
+static int man_pmacro(struct roff_man *, int, char *, int);
-const struct man_node *
-man_node(const struct man *m)
+int
+man_parseln(struct roff_man *man, int ln, char *buf, int offs)
{
- return(MAN_HALT & m->flags ? NULL : m->first);
-}
-
+ if (man->last->type != ROFFT_EQN || ln > man->last->line)
+ man->flags |= MAN_NEWLINE;
-const struct man_meta *
-man_meta(const struct man *m)
-{
-
- return(MAN_HALT & m->flags ? NULL : &m->meta);
+ return roff_getcontrol(man->roff, buf, &offs) ?
+ man_pmacro(man, ln, buf, offs) :
+ man_ptext(man, ln, buf, offs);
}
-
-void
-man_reset(struct man *man)
+/*
+ * If the string ends with \c, return a pointer to the backslash.
+ * Otherwise, return NULL.
+ */
+static char *
+man_hasc(char *start)
{
+ char *cp, *ep;
- man_free1(man);
- man_alloc1(man);
+ ep = strchr(start, '\0') - 2;
+ if (ep < start || ep[0] != '\\' || ep[1] != 'c')
+ return NULL;
+ for (cp = ep; cp > start; cp--)
+ if (cp[-1] != '\\')
+ break;
+ return (ep - cp) % 2 ? NULL : ep;
}
-
void
-man_free(struct man *man)
+man_descope(struct roff_man *man, int line, int offs, char *start)
{
-
- man_free1(man);
-
- if (man->htab)
- man_hash_free(man->htab);
- free(man);
+ /* Trailing \c keeps next-line scope open. */
+
+ if (start != NULL && man_hasc(start) != NULL)
+ return;
+
+ /*
+ * Co-ordinate what happens with having a next-line scope open:
+ * first close out the element scopes (if applicable),
+ * then close out the block scope (also if applicable).
+ */
+
+ if (man->flags & MAN_ELINE) {
+ while (man->last->parent->type != ROFFT_ROOT &&
+ man_macro(man->last->parent->tok)->flags & MAN_ESCOPED)
+ man_unscope(man, man->last->parent);
+ man->flags &= ~MAN_ELINE;
+ }
+ if ( ! (man->flags & MAN_BLINE))
+ return;
+ man_unscope(man, man->last->parent);
+ roff_body_alloc(man, line, offs, man->last->tok);
+ man->flags &= ~(MAN_BLINE | ROFF_NONOFILL);
}
-
-struct man *
-man_alloc(void *data, int pflags, const struct man_cb *cb)
+static int
+man_ptext(struct roff_man *man, int line, char *buf, int offs)
{
- struct man *p;
-
- p = calloc(1, sizeof(struct man));
- if (NULL == p)
- err(1, "calloc");
+ int i;
+ char *ep;
- man_alloc1(p);
+ /* In no-fill mode, whitespace is preserved on text lines. */
- if (cb)
- (void)memcpy(&p->cb, cb, sizeof(struct man_cb));
-
- p->htab = man_hash_alloc();
- p->data = data;
- p->pflags = pflags;
-
- return(p);
-}
-
-
-int
-man_endparse(struct man *m)
-{
+ if (man->flags & ROFF_NOFILL) {
+ roff_word_alloc(man, line, offs, buf + offs);
+ man_descope(man, line, offs, buf + offs);
+ return 1;
+ }
- if (MAN_HALT & m->flags)
- return(0);
- else if (man_macroend(m))
- return(1);
- m->flags |= MAN_HALT;
- return(0);
-}
+ for (i = offs; buf[i] == ' '; i++)
+ /* Skip leading whitespace. */ ;
+
+ /*
+ * Blank lines are ignored in next line scope
+ * and right after headings and cancel preceding \c,
+ * but add a single vertical space elsewhere.
+ */
+
+ if (buf[i] == '\0') {
+ if (man->flags & (MAN_ELINE | MAN_BLINE)) {
+ mandoc_msg(MANDOCERR_BLK_BLANK, line, 0, NULL);
+ return 1;
+ }
+ if (man->last->tok == MAN_SH || man->last->tok == MAN_SS)
+ return 1;
+ if (man->last->type == ROFFT_TEXT &&
+ ((ep = man_hasc(man->last->string)) != NULL)) {
+ *ep = '\0';
+ return 1;
+ }
+ roff_elem_alloc(man, line, offs, ROFF_sp);
+ man->next = ROFF_NEXT_SIBLING;
+ return 1;
+ }
+ /*
+ * Warn if the last un-escaped character is whitespace. Then
+ * strip away the remaining spaces (tabs stay!).
+ */
-int
-man_parseln(struct man *m, int ln, char *buf)
-{
+ i = (int)strlen(buf);
+ assert(i);
- return('.' == *buf ?
- man_pmacro(m, ln, buf) :
- man_ptext(m, ln, buf));
-}
+ if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
+ if (i > 1 && '\\' != buf[i - 2])
+ mandoc_msg(MANDOCERR_SPACE_EOL, line, i - 1, NULL);
+ for (--i; i && ' ' == buf[i]; i--)
+ /* Spin back to non-space. */ ;
-static void
-man_free1(struct man *man)
-{
+ /* Jump ahead of escaped whitespace. */
+ i += '\\' == buf[i] ? 2 : 1;
- if (man->first)
- man_node_freelist(man->first);
- if (man->meta.title)
- free(man->meta.title);
- if (man->meta.source)
- free(man->meta.source);
- if (man->meta.vol)
- free(man->meta.vol);
-}
+ buf[i] = '\0';
+ }
+ roff_word_alloc(man, line, offs, buf + offs);
+ /*
+ * End-of-sentence check. If the last character is an unescaped
+ * EOS character, then flag the node as being the end of a
+ * sentence. The front-end will know how to interpret this.
+ */
-static void
-man_alloc1(struct man *m)
-{
+ assert(i);
+ if (mandoc_eos(buf, (size_t)i))
+ man->last->flags |= NODE_EOS;
- bzero(&m->meta, sizeof(struct man_meta));
- m->flags = 0;
- m->last = calloc(1, sizeof(struct man_node));
- if (NULL == m->last)
- err(1, "calloc");
- m->first = m->last;
- m->last->type = MAN_ROOT;
- m->next = MAN_NEXT_CHILD;
+ man_descope(man, line, offs, buf + offs);
+ return 1;
}
-
static int
-man_node_append(struct man *man, struct man_node *p)
+man_pmacro(struct roff_man *man, int ln, char *buf, int offs)
{
-
- assert(man->last);
- assert(man->first);
- assert(MAN_ROOT != p->type);
-
- switch (man->next) {
- case (MAN_NEXT_SIBLING):
- man->last->next = p;
- p->prev = man->last;
- p->parent = man->last->parent;
- break;
- case (MAN_NEXT_CHILD):
- man->last->child = p;
- p->parent = man->last;
- break;
- default:
- abort();
- /* NOTREACHED */
+ struct roff_node *n;
+ const char *cp;
+ size_t sz;
+ enum roff_tok tok;
+ int ppos;
+ int bline;
+
+ /* Determine the line macro. */
+
+ ppos = offs;
+ tok = TOKEN_NONE;
+ for (sz = 0; sz < 4 && strchr(" \t\\", buf[offs]) == NULL; sz++)
+ offs++;
+ if (sz > 0 && sz < 4)
+ tok = roffhash_find(man->manmac, buf + ppos, sz);
+ if (tok == TOKEN_NONE) {
+ mandoc_msg(MANDOCERR_MACRO, ln, ppos, "%s", buf + ppos - 1);
+ return 1;
}
- man->last = p;
+ /* Skip a leading escape sequence or tab. */
- switch (p->type) {
- case (MAN_TEXT):
- if ( ! man_valid_post(man))
- return(0);
- if ( ! man_action_post(man))
- return(0);
+ switch (buf[offs]) {
+ case '\\':
+ cp = buf + offs + 1;
+ mandoc_escape(&cp, NULL, NULL);
+ offs = cp - buf;
+ break;
+ case '\t':
+ offs++;
break;
default:
break;
}
- return(1);
-}
+ /* Jump to the next non-whitespace word. */
+ while (buf[offs] == ' ')
+ offs++;
-static struct man_node *
-man_node_alloc(int line, int pos, enum man_type type)
-{
- struct man_node *p;
+ /*
+ * Trailing whitespace. Note that tabs are allowed to be passed
+ * into the parser as "text", so we only warn about spaces here.
+ */
- if (NULL == (p = calloc(1, sizeof(struct man_node))))
- err(1, "malloc");
- p->line = line;
- p->pos = pos;
- p->type = type;
+ if (buf[offs] == '\0' && buf[offs - 1] == ' ')
+ mandoc_msg(MANDOCERR_SPACE_EOL, ln, offs - 1, NULL);
- return(p);
-}
+ /*
+ * Some macros break next-line scopes; otherwise, remember
+ * whether we are in next-line scope for a block head.
+ */
+ man_breakscope(man, tok);
+ bline = man->flags & MAN_BLINE;
-int
-man_elem_alloc(struct man *man, int line, int pos, int tok)
-{
- struct man_node *p;
+ /*
+ * If the line in next-line scope ends with \c, keep the
+ * next-line scope open for the subsequent input line.
+ * That is not at all portable, only groff >= 1.22.4
+ * does it, but *if* this weird idiom occurs in a manual
+ * page, that's very likely what the author intended.
+ */
- p = man_node_alloc(line, pos, MAN_ELEM);
- p->tok = tok;
+ if (bline && man_hasc(buf + offs))
+ bline = 0;
- return(man_node_append(man, p));
-}
+ /* Call to handler... */
+ (*man_macro(tok)->fp)(man, tok, ln, ppos, &offs, buf);
-int
-man_word_alloc(struct man *man,
- int line, int pos, const char *word)
-{
- struct man_node *p;
+ /* In quick mode (for mandocdb), abort after the NAME section. */
- p = man_node_alloc(line, pos, MAN_TEXT);
- if (NULL == (p->string = strdup(word)))
- err(1, "strdup");
+ if (man->quick && tok == MAN_SH) {
+ n = man->last;
+ if (n->type == ROFFT_BODY &&
+ strcmp(n->prev->child->string, "NAME"))
+ return 2;
+ }
- return(man_node_append(man, p));
+ /*
+ * If we are in a next-line scope for a block head,
+ * close it out now and switch to the body,
+ * unless the next-line scope is allowed to continue.
+ */
+
+ if (bline == 0 ||
+ (man->flags & MAN_BLINE) == 0 ||
+ man->flags & MAN_ELINE ||
+ man_macro(tok)->flags & MAN_NSCOPED)
+ return 1;
+
+ man_unscope(man, man->last->parent);
+ roff_body_alloc(man, ln, ppos, man->last->tok);
+ man->flags &= ~(MAN_BLINE | ROFF_NONOFILL);
+ return 1;
}
-
void
-man_node_free(struct man_node *p)
-{
-
- if (p->string)
- free(p->string);
- free(p);
-}
-
-
-void
-man_node_freelist(struct man_node *p)
-{
-
- if (p->child)
- man_node_freelist(p->child);
- if (p->next)
- man_node_freelist(p->next);
-
- man_node_free(p);
-}
-
-
-static int
-man_ptext(struct man *m, int line, char *buf)
+man_breakscope(struct roff_man *man, int tok)
{
-
- if ( ! man_word_alloc(m, line, 0, buf))
- return(0);
- m->next = MAN_NEXT_SIBLING;
- return(1);
-}
-
-
-int
-man_pmacro(struct man *m, int ln, char *buf)
-{
- int i, c;
- char mac[5];
-
- /* Comments and empties are quickly ignored. */
-
- if (0 == buf[1])
- return(1);
-
- if (' ' == buf[1]) {
- i = 2;
- while (buf[i] && ' ' == buf[i])
- i++;
- if (0 == buf[i])
- return(1);
- return(man_vwarn(m, ln, 0, "invalid syntax"));
+ struct roff_node *n;
+
+ /*
+ * An element next line scope is open,
+ * and the new macro is not allowed inside elements.
+ * Delete the element that is being broken.
+ */
+
+ if (man->flags & MAN_ELINE && (tok < MAN_TH ||
+ (man_macro(tok)->flags & MAN_NSCOPED) == 0)) {
+ n = man->last;
+ if (n->type == ROFFT_TEXT)
+ n = n->parent;
+ if (n->tok < MAN_TH ||
+ (man_macro(n->tok)->flags & (MAN_NSCOPED | MAN_ESCOPED))
+ == MAN_NSCOPED)
+ n = n->parent;
+
+ mandoc_msg(MANDOCERR_BLK_LINE, n->line, n->pos,
+ "%s breaks %s", roff_name[tok], roff_name[n->tok]);
+
+ roff_node_delete(man, n);
+ man->flags &= ~MAN_ELINE;
}
- 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++) {
- if (0 == (mac[i - 1] = buf[i]))
- break;
- else if (' ' == buf[i])
- break;
+ /*
+ * Weird special case:
+ * Switching fill mode closes section headers.
+ */
+
+ if (man->flags & MAN_BLINE &&
+ (tok == ROFF_nf || tok == ROFF_fi) &&
+ (man->last->tok == MAN_SH || man->last->tok == MAN_SS)) {
+ n = man->last;
+ man_unscope(man, n);
+ roff_body_alloc(man, n->line, n->pos, n->tok);
+ man->flags &= ~(MAN_BLINE | ROFF_NONOFILL);
}
- mac[i - 1] = 0;
-
- if (i == 5 || i <= 1) {
- if ( ! (MAN_IGN_MACRO & m->pflags)) {
- (void)man_verr(m, ln, 1,
- "ill-formed macro: %s", mac);
- goto err;
- }
- if ( ! man_vwarn(m, ln, 1, "ill-formed macro: %s", mac))
- goto err;
- return(1);
+ /*
+ * A block header next line scope is open,
+ * and the new macro is not allowed inside block headers.
+ * Delete the block that is being broken.
+ */
+
+ if (man->flags & MAN_BLINE && tok != ROFF_nf && tok != ROFF_fi &&
+ (tok < MAN_TH || man_macro(tok)->flags & MAN_XSCOPE)) {
+ n = man->last;
+ if (n->type == ROFFT_TEXT)
+ n = n->parent;
+ if (n->tok < MAN_TH ||
+ (man_macro(n->tok)->flags & MAN_XSCOPE) == 0)
+ n = n->parent;
+
+ assert(n->type == ROFFT_HEAD);
+ n = n->parent;
+ assert(n->type == ROFFT_BLOCK);
+ assert(man_macro(n->tok)->flags & MAN_BSCOPED);
+
+ mandoc_msg(MANDOCERR_BLK_LINE, n->line, n->pos,
+ "%s breaks %s", roff_name[tok], roff_name[n->tok]);
+
+ roff_node_delete(man, n);
+ man->flags &= ~(MAN_BLINE | ROFF_NONOFILL);
}
-
- if (MAN_MAX == (c = man_hash_find(m->htab, mac))) {
- if ( ! (MAN_IGN_MACRO & m->pflags)) {
- (void)man_verr(m, ln, 1,
- "unknown macro: %s", mac);
- goto err;
- }
- if ( ! man_vwarn(m, ln, 1, "unknown macro: %s", mac))
- goto err;
- return(1);
- }
-
- /* The macro is sane. Jump to the next word. */
-
- while (buf[i] && ' ' == buf[i])
- i++;
-
- /* Begin recursive parse sequence. */
-
- if ( ! man_macro(m, c, ln, 1, &i, buf))
- goto err;
-
- return(1);
-
-err: /* Error out. */
-
- m->flags |= MAN_HALT;
- return(0);
-}
-
-
-int
-man_verr(struct man *man, int ln, int pos, const char *fmt, ...)
-{
- char buf[256];
- va_list ap;
-
- if (NULL == man->cb.man_err)
- return(0);
-
- va_start(ap, fmt);
- (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
- va_end(ap);
- return((*man->cb.man_err)(man->data, ln, pos, buf));
}
-
-
-int
-man_vwarn(struct man *man, int ln, int pos, const char *fmt, ...)
-{
- char buf[256];
- va_list ap;
-
- if (NULL == man->cb.man_warn)
- return(0);
-
- va_start(ap, fmt);
- (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
- va_end(ap);
- return((*man->cb.man_warn)(man->data, ln, pos, buf));
-}
-
-
git.ckatri.com / mandoc.git / blobdiff