Return to mdoc.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/mdoc.h, Revision 1.104

1.104   ! kristaps    1: /*     $Id: mdoc.h,v 1.103 2010/08/20 01:02:07 schwarze Exp $ */
1.1       kristaps    2: /*
1.101     schwarze    3:  * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
1.1       kristaps    4:  *
                      5:  * Permission to use, copy, modify, and distribute this software for any
1.56      kristaps    6:  * purpose with or without fee is hereby granted, provided that the above
                      7:  * copyright notice and this permission notice appear in all copies.
1.1       kristaps    8:  *
1.56      kristaps    9:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     10:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     11:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     12:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     13:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     14:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     15:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1       kristaps   16:  */
                     17: #ifndef MDOC_H
                     18: #define MDOC_H
                     19:
1.33      kristaps   20: /*
                     21:  * This library implements a validating scanner/parser for ``mdoc'' roff
                     22:  * macro documents, a.k.a. BSD manual page documents.  The mdoc.c file
                     23:  * drives the parser, while macro.c describes the macro ontologies.
                     24:  * validate.c pre- and post-validates parsed macros, and action.c
                     25:  * performs actions on parsed and validated macros.
                     26:  */
1.1       kristaps   27:
1.60      kristaps   28: /* See mdoc.3 for documentation. */
                     29:
1.1       kristaps   30: extern const char *const *mdoc_macronames;
                     31: extern const char *const *mdoc_argnames;
                     32:
                     33: __BEGIN_DECLS
                     34:
                     35: struct mdoc;
                     36:
1.60      kristaps   37: /* See mdoc.3 for documentation. */
                     38:
1.1       kristaps   39: void             mdoc_free(struct mdoc *);
1.103     schwarze   40: struct mdoc     *mdoc_alloc(struct regset *, void *, mandocmsg);
1.73      kristaps   41: void             mdoc_reset(struct mdoc *);
1.93      kristaps   42: int              mdoc_parseln(struct mdoc *, int, char *, int);
1.32      kristaps   43: const struct mdoc_node *mdoc_node(const struct mdoc *);
                     44: const struct mdoc_meta *mdoc_meta(const struct mdoc *);
1.16      kristaps   45: int              mdoc_endparse(struct mdoc *);
1.1       kristaps   46:
                     47: __END_DECLS
                     48:
                     49: #endif /*!MDOC_H*/