Return to libmdocml.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Made noop the default filter.

/* $Id: libmdocml.h,v 1.14 2008/12/10 14:42:46 kristaps Exp $ */
/*
 * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
 *
 * 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.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
 * AUTHOR BE LIABLE FOR 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.
 */
#ifndef LIBMDOCML_H
#define LIBMDOCML_H

#include <sys/types.h>

struct 	md_params_html {
	char		*css;
	int		 flags;
#define	HTML_CSS_EMBED	(1 << 0)
};

union	md_params {
	struct md_params_html html;
};

enum	md_type {
	MD_XML,			/* XML. */
	MD_HTML,		/* HTML4.01-strict. */
	MD_NOOP			/* Validates only. */
};

struct	md_args {
	union md_params	 params;/* Parameters for parser. */
	enum md_type	 type;	/* Type of parser. */

	int		 warnings;
#define	MD_WARN_ALL	(1 << 0)
#define	MD_WARN_ERROR	(1 << 1)
	int		 verbosity;
};

struct	md_buf {
	int		 fd;	/* Open file descriptor. */
	char		*name;	/* Name of file/socket/whatever. */
	char		*buf;	/* Buffer for storing data. */
	size_t		 bufsz;	/* Size of buf. */
};

__BEGIN_DECLS

/* Run the parser over prepared input and output buffers.  Returns -1 on
 * failure and 0 on success.
 */
int	md_run(const struct md_args *,
		const struct md_buf *, const struct md_buf *);

__END_DECLS

#endif /*!LIBMDOCML_H*/