2019-03-29 13:13:30 +00:00
|
|
|
/* $Id: man.c,v 1.187 2019/01/05 00:36:50 schwarze Exp $ */
|
2012-10-18 09:55:16 +00:00
|
|
|
/*
|
|
|
|
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
|
2019-03-29 13:13:30 +00:00
|
|
|
* Copyright (c) 2013-2015, 2017-2019 Ingo Schwarze <schwarze@openbsd.org>
|
2014-11-22 18:08:25 +00:00
|
|
|
* Copyright (c) 2011 Joerg Sonnenberger <joerg@netbsd.org>
|
2012-10-18 09:55:16 +00:00
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*
|
2016-01-15 23:08:59 +00:00
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
|
2012-10-18 09:55:16 +00:00
|
|
|
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
2016-01-15 23:08:59 +00:00
|
|
|
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
|
2012-10-18 09:55:16 +00:00
|
|
|
* 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>
|
2014-11-22 18:08:25 +00:00
|
|
|
#include <ctype.h>
|
2012-10-18 09:55:16 +00:00
|
|
|
#include <stdarg.h>
|
|
|
|
#include <stdlib.h>
|
|
|
|
#include <stdio.h>
|
|
|
|
#include <string.h>
|
|
|
|
|
2014-11-22 18:08:25 +00:00
|
|
|
#include "mandoc_aux.h"
|
2016-01-15 23:08:59 +00:00
|
|
|
#include "mandoc.h"
|
|
|
|
#include "roff.h"
|
|
|
|
#include "man.h"
|
2012-10-18 09:55:16 +00:00
|
|
|
#include "libmandoc.h"
|
2016-01-15 23:08:59 +00:00
|
|
|
#include "roff_int.h"
|
|
|
|
#include "libman.h"
|
2012-10-18 09:55:16 +00:00
|
|
|
|
2019-03-29 13:13:30 +00:00
|
|
|
static char *man_hasc(char *);
|
2016-01-15 23:08:59 +00:00
|
|
|
static int man_ptext(struct roff_man *, int, char *, int);
|
|
|
|
static int man_pmacro(struct roff_man *, int, char *, int);
|
2012-10-18 09:55:16 +00:00
|
|
|
|
|
|
|
|
|
|
|
int
|
2016-01-15 23:08:59 +00:00
|
|
|
man_parseln(struct roff_man *man, int ln, char *buf, int offs)
|
2012-10-18 09:55:16 +00:00
|
|
|
{
|
|
|
|
|
2016-01-15 23:08:59 +00:00
|
|
|
if (man->last->type != ROFFT_EQN || ln > man->last->line)
|
2014-12-02 07:34:06 +00:00
|
|
|
man->flags |= MAN_NEWLINE;
|
2012-10-18 09:55:16 +00:00
|
|
|
|
2016-01-15 23:08:59 +00:00
|
|
|
return roff_getcontrol(man->roff, buf, &offs) ?
|
2014-11-22 18:08:25 +00:00
|
|
|
man_pmacro(man, ln, buf, offs) :
|
2016-01-15 23:08:59 +00:00
|
|
|
man_ptext(man, ln, buf, offs);
|
2012-10-18 09:55:16 +00:00
|
|
|
}
|
|
|
|
|
2019-03-29 13:13:30 +00:00
|
|
|
/*
|
|
|
|
* If the string ends with \c, return a pointer to the backslash.
|
|
|
|
* Otherwise, return NULL.
|
|
|
|
*/
|
|
|
|
static char *
|
|
|
|
man_hasc(char *start)
|
2012-10-18 09:55:16 +00:00
|
|
|
{
|
2019-03-29 13:13:30 +00:00
|
|
|
char *cp, *ep;
|
|
|
|
|
|
|
|
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_descope(struct roff_man *man, int line, int offs, char *start)
|
|
|
|
{
|
|
|
|
/* Trailing \c keeps next-line scope open. */
|
|
|
|
|
|
|
|
if (start != NULL && man_hasc(start) != NULL)
|
|
|
|
return;
|
|
|
|
|
2012-10-18 09:55:16 +00:00
|
|
|
/*
|
|
|
|
* Co-ordinate what happens with having a next-line scope open:
|
2019-03-29 13:13:30 +00:00
|
|
|
* first close out the element scopes (if applicable),
|
|
|
|
* then close out the block scope (also if applicable).
|
2012-10-18 09:55:16 +00:00
|
|
|
*/
|
|
|
|
|
2014-12-02 07:34:06 +00:00
|
|
|
if (man->flags & MAN_ELINE) {
|
2019-03-29 13:13:30 +00:00
|
|
|
while (man->last->parent->type != ROFFT_ROOT &&
|
|
|
|
man_macro(man->last->parent->tok)->flags & MAN_ESCOPED)
|
|
|
|
man_unscope(man, man->last->parent);
|
2014-01-31 19:59:03 +00:00
|
|
|
man->flags &= ~MAN_ELINE;
|
2012-10-18 09:55:16 +00:00
|
|
|
}
|
2014-12-02 07:34:06 +00:00
|
|
|
if ( ! (man->flags & MAN_BLINE))
|
|
|
|
return;
|
|
|
|
man_unscope(man, man->last->parent);
|
2016-01-15 23:08:59 +00:00
|
|
|
roff_body_alloc(man, line, offs, man->last->tok);
|
2019-03-29 13:13:30 +00:00
|
|
|
man->flags &= ~(MAN_BLINE | ROFF_NONOFILL);
|
2012-10-18 09:55:16 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static int
|
2016-01-15 23:08:59 +00:00
|
|
|
man_ptext(struct roff_man *man, int line, char *buf, int offs)
|
2012-10-18 09:55:16 +00:00
|
|
|
{
|
|
|
|
int i;
|
2017-07-31 19:17:54 +00:00
|
|
|
char *ep;
|
2012-10-18 09:55:16 +00:00
|
|
|
|
2019-03-29 13:13:30 +00:00
|
|
|
/* In no-fill mode, whitespace is preserved on text lines. */
|
2012-10-18 09:55:16 +00:00
|
|
|
|
2019-03-29 13:13:30 +00:00
|
|
|
if (man->flags & ROFF_NOFILL) {
|
2016-01-15 23:08:59 +00:00
|
|
|
roff_word_alloc(man, line, offs, buf + offs);
|
2019-03-29 13:13:30 +00:00
|
|
|
man_descope(man, line, offs, buf + offs);
|
2016-01-15 23:08:59 +00:00
|
|
|
return 1;
|
2012-10-18 09:55:16 +00:00
|
|
|
}
|
|
|
|
|
2014-12-02 07:34:06 +00:00
|
|
|
for (i = offs; buf[i] == ' '; i++)
|
2012-10-18 09:55:16 +00:00
|
|
|
/* Skip leading whitespace. */ ;
|
|
|
|
|
2014-01-31 19:59:03 +00:00
|
|
|
/*
|
2017-07-31 19:17:54 +00:00
|
|
|
* Blank lines are ignored in next line scope
|
|
|
|
* and right after headings and cancel preceding \c,
|
|
|
|
* but add a single vertical space elsewhere.
|
2014-01-31 19:59:03 +00:00
|
|
|
*/
|
|
|
|
|
2014-12-02 07:34:06 +00:00
|
|
|
if (buf[i] == '\0') {
|
2017-07-31 19:17:54 +00:00
|
|
|
if (man->flags & (MAN_ELINE | MAN_BLINE)) {
|
2019-03-29 13:13:30 +00:00
|
|
|
mandoc_msg(MANDOCERR_BLK_BLANK, line, 0, NULL);
|
2017-07-31 19:17:54 +00:00
|
|
|
return 1;
|
2014-01-31 19:59:03 +00:00
|
|
|
}
|
2017-07-31 19:17:54 +00:00
|
|
|
if (man->last->tok == MAN_SH || man->last->tok == MAN_SS)
|
|
|
|
return 1;
|
2019-03-29 13:13:30 +00:00
|
|
|
if (man->last->type == ROFFT_TEXT &&
|
|
|
|
((ep = man_hasc(man->last->string)) != NULL)) {
|
2017-07-31 19:17:54 +00:00
|
|
|
*ep = '\0';
|
|
|
|
return 1;
|
|
|
|
}
|
|
|
|
roff_elem_alloc(man, line, offs, ROFF_sp);
|
|
|
|
man->next = ROFF_NEXT_SIBLING;
|
2016-01-15 23:08:59 +00:00
|
|
|
return 1;
|
2012-10-18 09:55:16 +00:00
|
|
|
}
|
|
|
|
|
2014-11-22 18:08:25 +00:00
|
|
|
/*
|
2012-10-18 09:55:16 +00:00
|
|
|
* Warn if the last un-escaped character is whitespace. Then
|
2014-11-22 18:08:25 +00:00
|
|
|
* strip away the remaining spaces (tabs stay!).
|
2012-10-18 09:55:16 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
i = (int)strlen(buf);
|
|
|
|
assert(i);
|
|
|
|
|
|
|
|
if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
|
|
|
|
if (i > 1 && '\\' != buf[i - 2])
|
2019-03-29 13:13:30 +00:00
|
|
|
mandoc_msg(MANDOCERR_SPACE_EOL, line, i - 1, NULL);
|
2012-10-18 09:55:16 +00:00
|
|
|
|
|
|
|
for (--i; i && ' ' == buf[i]; i--)
|
|
|
|
/* Spin back to non-space. */ ;
|
|
|
|
|
|
|
|
/* Jump ahead of escaped whitespace. */
|
|
|
|
i += '\\' == buf[i] ? 2 : 1;
|
|
|
|
|
|
|
|
buf[i] = '\0';
|
|
|
|
}
|
2016-01-15 23:08:59 +00:00
|
|
|
roff_word_alloc(man, line, offs, buf + offs);
|
2012-10-18 09:55:16 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
|
|
|
assert(i);
|
2014-11-22 18:08:25 +00:00
|
|
|
if (mandoc_eos(buf, (size_t)i))
|
2017-01-21 13:01:39 +00:00
|
|
|
man->last->flags |= NODE_EOS;
|
2012-10-18 09:55:16 +00:00
|
|
|
|
2019-03-29 13:13:30 +00:00
|
|
|
man_descope(man, line, offs, buf + offs);
|
2016-01-15 23:08:59 +00:00
|
|
|
return 1;
|
2012-10-18 09:55:16 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static int
|
2016-01-15 23:08:59 +00:00
|
|
|
man_pmacro(struct roff_man *man, int ln, char *buf, int offs)
|
2012-10-18 09:55:16 +00:00
|
|
|
{
|
2016-01-15 23:08:59 +00:00
|
|
|
struct roff_node *n;
|
2014-12-02 07:34:06 +00:00
|
|
|
const char *cp;
|
2017-06-08 19:29:07 +00:00
|
|
|
size_t sz;
|
|
|
|
enum roff_tok tok;
|
|
|
|
int ppos;
|
2014-11-22 18:08:25 +00:00
|
|
|
int bline;
|
2012-10-18 09:55:16 +00:00
|
|
|
|
2017-06-08 19:29:07 +00:00
|
|
|
/* Determine the line macro. */
|
2012-10-18 09:55:16 +00:00
|
|
|
|
2017-06-08 19:29:07 +00:00
|
|
|
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);
|
2016-01-15 23:08:59 +00:00
|
|
|
if (tok == TOKEN_NONE) {
|
2019-03-29 13:13:30 +00:00
|
|
|
mandoc_msg(MANDOCERR_MACRO, ln, ppos, "%s", buf + ppos - 1);
|
2016-01-15 23:08:59 +00:00
|
|
|
return 1;
|
2012-10-18 09:55:16 +00:00
|
|
|
}
|
|
|
|
|
2014-12-02 07:34:06 +00:00
|
|
|
/* Skip a leading escape sequence or tab. */
|
|
|
|
|
|
|
|
switch (buf[offs]) {
|
|
|
|
case '\\':
|
|
|
|
cp = buf + offs + 1;
|
|
|
|
mandoc_escape(&cp, NULL, NULL);
|
|
|
|
offs = cp - buf;
|
|
|
|
break;
|
|
|
|
case '\t':
|
|
|
|
offs++;
|
|
|
|
break;
|
|
|
|
default:
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Jump to the next non-whitespace word. */
|
2012-10-18 09:55:16 +00:00
|
|
|
|
2017-06-08 19:29:07 +00:00
|
|
|
while (buf[offs] == ' ')
|
2012-10-18 09:55:16 +00:00
|
|
|
offs++;
|
|
|
|
|
2014-11-22 18:08:25 +00:00
|
|
|
/*
|
2012-10-18 09:55:16 +00:00
|
|
|
* Trailing whitespace. Note that tabs are allowed to be passed
|
|
|
|
* into the parser as "text", so we only warn about spaces here.
|
|
|
|
*/
|
|
|
|
|
2014-12-02 07:34:06 +00:00
|
|
|
if (buf[offs] == '\0' && buf[offs - 1] == ' ')
|
2019-03-29 13:13:30 +00:00
|
|
|
mandoc_msg(MANDOCERR_SPACE_EOL, ln, offs - 1, NULL);
|
2012-10-18 09:55:16 +00:00
|
|
|
|
2014-11-22 18:08:25 +00:00
|
|
|
/*
|
2015-03-02 16:45:41 +00:00
|
|
|
* Some macros break next-line scopes; otherwise, remember
|
|
|
|
* whether we are in next-line scope for a block head.
|
2012-10-18 09:55:16 +00:00
|
|
|
*/
|
|
|
|
|
2015-03-02 16:45:41 +00:00
|
|
|
man_breakscope(man, tok);
|
2014-11-22 18:08:25 +00:00
|
|
|
bline = man->flags & MAN_BLINE;
|
2012-10-18 09:55:16 +00:00
|
|
|
|
2017-06-08 19:29:07 +00:00
|
|
|
/*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
2019-03-29 13:13:30 +00:00
|
|
|
if (bline && man_hasc(buf + offs))
|
|
|
|
bline = 0;
|
2017-06-08 19:29:07 +00:00
|
|
|
|
2012-10-18 09:55:16 +00:00
|
|
|
/* Call to handler... */
|
|
|
|
|
2019-03-29 13:13:30 +00:00
|
|
|
(*man_macro(tok)->fp)(man, tok, ln, ppos, &offs, buf);
|
2012-10-18 09:55:16 +00:00
|
|
|
|
2014-11-22 18:08:25 +00:00
|
|
|
/* In quick mode (for mandocdb), abort after the NAME section. */
|
2012-10-18 09:55:16 +00:00
|
|
|
|
2014-12-02 07:34:06 +00:00
|
|
|
if (man->quick && tok == MAN_SH) {
|
2014-11-22 18:08:25 +00:00
|
|
|
n = man->last;
|
2016-01-15 23:08:59 +00:00
|
|
|
if (n->type == ROFFT_BODY &&
|
2014-11-22 18:08:25 +00:00
|
|
|
strcmp(n->prev->child->string, "NAME"))
|
2016-01-15 23:08:59 +00:00
|
|
|
return 2;
|
2012-10-18 09:55:16 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
2014-11-22 18:08:25 +00:00
|
|
|
* 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.
|
2012-10-18 09:55:16 +00:00
|
|
|
*/
|
|
|
|
|
2019-03-29 13:13:30 +00:00
|
|
|
if (bline == 0 ||
|
|
|
|
(man->flags & MAN_BLINE) == 0 ||
|
|
|
|
man->flags & MAN_ELINE ||
|
|
|
|
man_macro(tok)->flags & MAN_NSCOPED)
|
2016-01-15 23:08:59 +00:00
|
|
|
return 1;
|
2012-10-18 09:55:16 +00:00
|
|
|
|
2014-12-02 07:34:06 +00:00
|
|
|
man_unscope(man, man->last->parent);
|
2016-01-15 23:08:59 +00:00
|
|
|
roff_body_alloc(man, ln, ppos, man->last->tok);
|
2019-03-29 13:13:30 +00:00
|
|
|
man->flags &= ~(MAN_BLINE | ROFF_NONOFILL);
|
2016-01-15 23:08:59 +00:00
|
|
|
return 1;
|
2012-10-18 09:55:16 +00:00
|
|
|
}
|
|
|
|
|
2015-03-02 16:45:41 +00:00
|
|
|
void
|
2016-01-15 23:08:59 +00:00
|
|
|
man_breakscope(struct roff_man *man, int tok)
|
2015-03-02 16:45:41 +00:00
|
|
|
{
|
2016-01-15 23:08:59 +00:00
|
|
|
struct roff_node *n;
|
2015-03-02 16:45:41 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* An element next line scope is open,
|
|
|
|
* and the new macro is not allowed inside elements.
|
|
|
|
* Delete the element that is being broken.
|
|
|
|
*/
|
|
|
|
|
2017-06-08 19:29:07 +00:00
|
|
|
if (man->flags & MAN_ELINE && (tok < MAN_TH ||
|
2019-03-29 13:13:30 +00:00
|
|
|
(man_macro(tok)->flags & MAN_NSCOPED) == 0)) {
|
2015-03-02 16:45:41 +00:00
|
|
|
n = man->last;
|
2017-07-31 19:17:54 +00:00
|
|
|
if (n->type == ROFFT_TEXT)
|
|
|
|
n = n->parent;
|
|
|
|
if (n->tok < MAN_TH ||
|
2019-03-29 13:13:30 +00:00
|
|
|
(man_macro(n->tok)->flags & (MAN_NSCOPED | MAN_ESCOPED))
|
|
|
|
== MAN_NSCOPED)
|
2015-03-02 16:45:41 +00:00
|
|
|
n = n->parent;
|
|
|
|
|
2019-03-29 13:13:30 +00:00
|
|
|
mandoc_msg(MANDOCERR_BLK_LINE, n->line, n->pos,
|
|
|
|
"%s breaks %s", roff_name[tok], roff_name[n->tok]);
|
2015-03-02 16:45:41 +00:00
|
|
|
|
2016-01-15 23:08:59 +00:00
|
|
|
roff_node_delete(man, n);
|
2015-03-02 16:45:41 +00:00
|
|
|
man->flags &= ~MAN_ELINE;
|
|
|
|
}
|
|
|
|
|
2016-01-15 23:08:59 +00:00
|
|
|
/*
|
|
|
|
* Weird special case:
|
|
|
|
* Switching fill mode closes section headers.
|
|
|
|
*/
|
|
|
|
|
|
|
|
if (man->flags & MAN_BLINE &&
|
2019-03-29 13:13:30 +00:00
|
|
|
(tok == ROFF_nf || tok == ROFF_fi) &&
|
2016-01-15 23:08:59 +00:00
|
|
|
(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);
|
2019-03-29 13:13:30 +00:00
|
|
|
man->flags &= ~(MAN_BLINE | ROFF_NONOFILL);
|
2016-01-15 23:08:59 +00:00
|
|
|
}
|
|
|
|
|
2015-03-02 16:45:41 +00:00
|
|
|
/*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
2019-03-29 13:13:30 +00:00
|
|
|
if (man->flags & MAN_BLINE && tok != ROFF_nf && tok != ROFF_fi &&
|
|
|
|
(tok < MAN_TH || man_macro(tok)->flags & MAN_XSCOPE)) {
|
2015-03-02 16:45:41 +00:00
|
|
|
n = man->last;
|
2016-01-15 23:08:59 +00:00
|
|
|
if (n->type == ROFFT_TEXT)
|
2015-03-02 16:45:41 +00:00
|
|
|
n = n->parent;
|
2017-07-31 19:17:54 +00:00
|
|
|
if (n->tok < MAN_TH ||
|
2019-03-29 13:13:30 +00:00
|
|
|
(man_macro(n->tok)->flags & MAN_XSCOPE) == 0)
|
2015-03-02 16:45:41 +00:00
|
|
|
n = n->parent;
|
|
|
|
|
2016-01-15 23:08:59 +00:00
|
|
|
assert(n->type == ROFFT_HEAD);
|
2015-03-02 16:45:41 +00:00
|
|
|
n = n->parent;
|
2016-01-15 23:08:59 +00:00
|
|
|
assert(n->type == ROFFT_BLOCK);
|
2019-03-29 13:13:30 +00:00
|
|
|
assert(man_macro(n->tok)->flags & MAN_BSCOPED);
|
2015-03-02 16:45:41 +00:00
|
|
|
|
2019-03-29 13:13:30 +00:00
|
|
|
mandoc_msg(MANDOCERR_BLK_LINE, n->line, n->pos,
|
|
|
|
"%s breaks %s", roff_name[tok], roff_name[n->tok]);
|
2015-03-02 16:45:41 +00:00
|
|
|
|
2016-01-15 23:08:59 +00:00
|
|
|
roff_node_delete(man, n);
|
2019-03-29 13:13:30 +00:00
|
|
|
man->flags &= ~(MAN_BLINE | ROFF_NONOFILL);
|
2015-03-02 16:45:41 +00:00
|
|
|
}
|
|
|
|
}
|