Annotation of mandoc/libmdocml.h, Revision 1.13
1.13 ! kristaps 1: /* $Id: libmdocml.h,v 1.12 2008/12/04 11:25:29 kristaps Exp $ */
1.1 kristaps 2: /*
3: * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
4: *
5: * Permission to use, copy, modify, and distribute this software for any
6: * purpose with or without fee is hereby granted, provided that the
7: * above copyright notice and this permission notice appear in all
8: * copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11: * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12: * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13: * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14: * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15: * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16: * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17: * PERFORMANCE OF THIS SOFTWARE.
18: */
19: #ifndef LIBMDOCML_H
20: #define LIBMDOCML_H
21:
1.2 kristaps 22: #include <sys/types.h>
23:
1.10 kristaps 24: struct md_params_xml {
1.3 kristaps 25: int dummy;
1.2 kristaps 26: };
27:
1.11 kristaps 28: struct md_params_html {
1.12 kristaps 29: char *css;
30: int flags;
31: #define HTML_CSS_EMBED (1 << 0)
1.3 kristaps 32: };
33:
34: union md_params {
1.10 kristaps 35: struct md_params_xml xml;
1.11 kristaps 36: struct md_params_html html;
1.2 kristaps 37: };
38:
39: enum md_type {
1.10 kristaps 40: MD_XML, /* XML. */
1.11 kristaps 41: MD_HTML /* HTML4.01-strict. */
1.3 kristaps 42: };
43:
44: struct md_args {
45: union md_params params;/* Parameters for parser. */
46: enum md_type type; /* Type of parser. */
1.8 kristaps 47:
48: int warnings;
49: #define MD_WARN_ALL (1 << 0)
1.13 ! kristaps 50: #define MD_WARN_ERROR (1 << 1)
1.8 kristaps 51: int verbosity;
1.3 kristaps 52: };
53:
54: struct md_buf {
55: int fd; /* Open file descriptor. */
56: char *name; /* Name of file/socket/whatever. */
57: char *buf; /* Buffer for storing data. */
58: size_t bufsz; /* Size of buf. */
1.2 kristaps 59: };
60:
1.1 kristaps 61: __BEGIN_DECLS
62:
1.3 kristaps 63: /* Run the parser over prepared input and output buffers. Returns -1 on
64: * failure and 0 on success.
65: */
66: int md_run(const struct md_args *,
67: const struct md_buf *, const struct md_buf *);
1.2 kristaps 68:
1.1 kristaps 69: __END_DECLS
70:
71: #endif /*!LIBMDOCML_H*/
CVSweb