man.c revision 371584c2eae4cf827fd406ba26c14f021adaaa70
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankov/* $Id: man.c,v 1.166 2015/10/22 21:54:23 schwarze Exp $ */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * Copyright (c) 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * Copyright (c) 2011 Joerg Sonnenberger <joerg@netbsd.org>
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Permission to use, copy, modify, and distribute this software for any
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * purpose with or without fee is hereby granted, provided that the above
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * copyright notice and this permission notice appear in all copies.
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankov * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankov * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amoreconst char * const *man_macronames = __man_macronames;
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankovstatic void man_descope(struct roff_man *, int, int);
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankovstatic int man_ptext(struct roff_man *, int, char *, int);
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankovstatic int man_pmacro(struct roff_man *, int, char *, int);
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankovman_parseln(struct roff_man *man, int ln, char *buf, int offs)
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankov if (man->last->type != ROFFT_EQN || ln > man->last->line)
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankovman_descope(struct roff_man *man, int line, int offs)
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Co-ordinate what happens with having a next-line scope open:
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * first close out the element scope (if applicable), then close
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * out the block scope (also if applicable).
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankov roff_body_alloc(man, line, offs, man->last->tok);
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankovman_ptext(struct roff_man *man, int line, char *buf, int offs)
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore /* Literal free-form text whitespace is preserved. */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore /* Skip leading whitespace. */ ;
698f87a48e2e945bfe5493ce168e0d0ae1cedd5cGarrett D'Amore * Blank lines are ignored right after headings
698f87a48e2e945bfe5493ce168e0d0ae1cedd5cGarrett D'Amore * but add a single vertical space elsewhere.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore /* Allocate a blank entry. */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Warn if the last un-escaped character is whitespace. Then
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * strip away the remaining spaces (tabs stay!).
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore /* Spin back to non-space. */ ;
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore /* Jump ahead of escaped whitespace. */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * End-of-sentence check. If the last character is an unescaped
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * EOS character, then flag the node as being the end of a
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * sentence. The front-end will know how to interpret this.
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankovman_pmacro(struct roff_man *man, int ln, char *buf, int offs)
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov const char *cp;
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Copy the first word into a nil-terminated buffer.
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * Stop when a space, tab, escape, or eoln is encountered.
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov while (i < 4 && strchr(" \t\\", buf[offs]) == NULL)
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankov tok = (i > 0 && i < 4) ? man_hash_find(mac) : TOKEN_NONE;
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov /* Skip a leading escape sequence or tab. */
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov /* Jump to the next non-whitespace word. */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Trailing whitespace. Note that tabs are allowed to be passed
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * into the parser as "text", so we only warn about spaces here.
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * Some macros break next-line scopes; otherwise, remember
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * whether we are in next-line scope for a block head.
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov /* Call to handler... */
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov (*man_macros[tok].fp)(man, tok, ln, ppos, &offs, buf);
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov /* In quick mode (for mandocdb), abort after the NAME section. */
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * If we are in a next-line scope for a block head,
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * close it out now and switch to the body,
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * unless the next-line scope is allowed to continue.
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * An element next line scope is open,
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * and the new macro is not allowed inside elements.
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * Delete the element that is being broken.
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankov if (man->flags & MAN_ELINE && (tok == TOKEN_NONE ||
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankov * Weird special case:
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankov * Switching fill mode closes section headers.
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankov (man->last->tok == MAN_SH || man->last->tok == MAN_SS)) {
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * A block header next line scope is open,
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * and the new macro is not allowed inside block headers.
260e9a87725c090ba5835b1f9f0b62fa2f96036fYuri Pankov * Delete the block that is being broken.
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankov if (man->flags & MAN_BLINE && (tok == TOKEN_NONE ||
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankovman_state(struct roff_man *man, struct roff_node *n)
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankov switch(n->tok) {
371584c2eae4cf827fd406ba26c14f021adaaa70Yuri Pankov if (man->flags & MAN_LITERAL && ! (n->flags & MAN_VALID))