man.h revision 95c635efb7c3b86efc493e0447eaec7aecca3f0f
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore/* $Id: man.h,v 1.60 2012/01/03 15:16:24 kristaps Exp $ */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
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.
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR 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'Amore char *msec; /* `TH' section (1, 3p, etc.) */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore struct man_node *parent; /* parent AST node */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore struct man_node *child; /* first child AST node */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore struct man_node *next; /* sibling AST node */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore struct man_node *prev; /* prior sibling AST node */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore enum mant tok; /* tok or MAN__MAX if none */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore#define MAN_VALID (1 << 0) /* has been validated */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore#define MAN_EOS (1 << 2) /* at sentence boundary */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore#define MAN_LINE (1 << 3) /* first macro/text on line */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore struct man_node *head; /* BLOCK node HEAD ptr */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore struct man_node *tail; /* BLOCK node TAIL ptr */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore struct man_node *body; /* BLOCK node BODY ptr */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore/* Names of macros. Index is enum mant. */
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amoreextern const char *const *man_macronames;
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amoreconst struct man_node *man_node(const struct man *);
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amoreconst struct man_meta *man_meta(const struct man *);
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amoreconst struct mparse *man_mparse(const struct man *);
95c635efb7c3b86efc493e0447eaec7aecca3f0fGarrett D'Amore#endif /*!MAN_H*/