mandoc/mdoc.h - diff

Return to mdoc.h CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mdoc.h between version 1.42 and 1.59

version 1.42, 2009/03/08 20:57:35

version 1.59, 2009/06/16 19:45:51

Line 1

/* $Id$ */

* Permission to use, copy, modify, and distribute this software for any

* purpose with or without fee is hereby granted, provided that the

* purpose with or without fee is hereby granted, provided that the above

* above copyright notice and this permission notice appear in all

* copyright notice and this permission notice appear in all copies.

* copies.

* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL

* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES

* WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED

* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF

* WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE

* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR

* AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL

* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES

* DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR

* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN

* PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER

* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF

* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR

* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

* PERFORMANCE OF THIS SOFTWARE.

#ifndef MDOC_H

#define MDOC_H

#include <time.h>

* This library implements a validating scanner/parser for ``mdoc'' roff

* macro documents, a.k.a. BSD manual page documents. The mdoc.c file

Line 29

/* What follows is a list of ALL possible macros. */

/* TODO: Brq et al. */

#define MDOC_Ap 0

#define MDOC___ 0

#define MDOC_Dd 1

#define MDOC_Dt 2

#define MDOC_Os 3

Line 138

Line 136

#define MDOC_Fr 104

#define MDOC_Ud 105

#define MDOC_Lb 106

#define MDOC_Ap 107

#define MDOC_Lp 107

#define MDOC_Lp 108

#define MDOC_Lk 108

#define MDOC_MAX 109

#define MDOC_Mt 109

#define MDOC_Brq 110

#define MDOC_Bro 111

#define MDOC_Brc 112

#define MDOC__C 113

#define MDOC_Es 114

#define MDOC_En 115

#define MDOC_Dx 116

#define MDOC__Q 117

#define MDOC_MAX 118

/* What follows is a list of ALL possible macro arguments. */

Line 169

Line 176

#define MDOC_Words 22

#define MDOC_Emphasis 23

#define MDOC_Symbolic 24

#define MDOC_ARG_MAX 25

#define MDOC_Nested 25

#define MDOC_ARG_MAX 26

/* Warnings are either syntax or groff-compatibility. */

enum mdoc_warn {

Line 264 struct mdoc_node {

Line 272 struct mdoc_node {

#define MDOC_IGN_SCOPE (1 << 0) /* Ignore scope violations. */

#define MDOC_IGN_ESCAPE (1 << 1) /* Ignore bad escape sequences. */

#define MDOC_IGN_MACRO (1 << 2) /* Ignore unknown macros. */

#define MDOC_IGN_CHARS (1 << 3) /* Ignore disallowed chars. */

/* Call-backs for parse messages. */

struct mdoc_cb {

void (*mdoc_msg)(void *, int, int, const char *);

int (*mdoc_err)(void *, int, int, const char *);

int (*mdoc_warn)(void *, int, int,

enum mdoc_warn, const char *);

Line 289 void mdoc_free(struct mdoc *);

Line 298 void mdoc_free(struct mdoc *);

/* Allocate a new parser instance. */

struct mdoc *mdoc_alloc(void *, int, const struct mdoc_cb *);

/* Set parse options. */

/* Gets system ready for another parse. */

void mdoc_setflags(struct mdoc *, int);

int mdoc_reset(struct mdoc *);

/* Parse a single line in a stream (boolean retval). */

int mdoc_parseln(struct mdoc *, int, char *buf);

Line 309 int mdoc_endparse(struct mdoc *);

Line 318 int mdoc_endparse(struct mdoc *);

const char *mdoc_a2att(const char *);

const char *mdoc_a2lib(const char *);

const char *mdoc_a2st(const char *);

int mdoc_isdelim(const char *);

__END_DECLS

CVSweb