version 1.38, 2009/03/08 11:41:22 |
version 1.56, 2009/04/12 19:45:26 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se> |
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org> |
* |
* |
* Permission to use, copy, modify, and distribute this software for any |
* 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 |
#ifndef MDOC_H |
#define MDOC_H |
#define MDOC_H |
|
|
|
#include <time.h> |
|
|
/* |
/* |
* This library implements a validating scanner/parser for ``mdoc'' roff |
* This library implements a validating scanner/parser for ``mdoc'' roff |
* macro documents, a.k.a. BSD manual page documents. The mdoc.c file |
* macro documents, a.k.a. BSD manual page documents. The mdoc.c file |
|
|
#define MDOC_Fr 104 |
#define MDOC_Fr 104 |
#define MDOC_Ud 105 |
#define MDOC_Ud 105 |
#define MDOC_Lb 106 |
#define MDOC_Lb 106 |
#define MDOC_MAX 107 |
#define MDOC_Ap 107 |
|
#define MDOC_Lp 108 |
|
#define MDOC_Lk 109 |
|
#define MDOC_Mt 110 |
|
#define MDOC_Brq 111 |
|
#define MDOC_Bro 112 |
|
#define MDOC_Brc 113 |
|
#define MDOC__C 114 |
|
#define MDOC_Es 115 |
|
#define MDOC_En 116 |
|
#define MDOC_Dx 117 |
|
#define MDOC__Q 118 |
|
#define MDOC_MAX 119 |
|
|
/* What follows is a list of ALL possible macro arguments. */ |
/* What follows is a list of ALL possible macro arguments. */ |
|
|
|
|
#define MDOC_Words 22 |
#define MDOC_Words 22 |
#define MDOC_Emphasis 23 |
#define MDOC_Emphasis 23 |
#define MDOC_Symbolic 24 |
#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. */ |
/* Warnings are either syntax or groff-compatibility. */ |
enum mdoc_warn { |
enum mdoc_warn { |
Line 249 struct mdoc_node { |
|
Line 262 struct mdoc_node { |
|
#define MDOC_ACTED (1 << 1) |
#define MDOC_ACTED (1 << 1) |
enum mdoc_type type; |
enum mdoc_type type; |
enum mdoc_sec sec; |
enum mdoc_sec sec; |
|
|
|
/* FIXME: union/struct this with #defines. */ |
struct mdoc_arg *args; /* BLOCK/ELEM */ |
struct mdoc_arg *args; /* BLOCK/ELEM */ |
struct mdoc_node *head; /* BLOCK */ |
struct mdoc_node *head; /* BLOCK */ |
struct mdoc_node *body; /* BLOCK */ |
struct mdoc_node *body; /* BLOCK */ |
Line 256 struct mdoc_node { |
|
Line 271 struct mdoc_node { |
|
char *string; /* TEXT */ |
char *string; /* TEXT */ |
}; |
}; |
|
|
#define MDOC_IGN_SCOPE (1 << 0) |
#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. */ |
/* Call-backs for parse messages. */ |
struct mdoc_cb { |
struct mdoc_cb { |
|
|
void mdoc_free(struct mdoc *); |
void mdoc_free(struct mdoc *); |
|
|
/* Allocate a new parser instance. */ |
/* Allocate a new parser instance. */ |
struct mdoc *mdoc_alloc(void *data, const struct mdoc_cb *); |
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). */ |
/* Parse a single line in a stream (boolean retval). */ |
int mdoc_parseln(struct mdoc *, int, char *buf); |
int mdoc_parseln(struct mdoc *, int, char *buf); |
Line 302 int mdoc_endparse(struct mdoc *); |
|
Line 320 int mdoc_endparse(struct mdoc *); |
|
const char *mdoc_a2att(const char *); |
const char *mdoc_a2att(const char *); |
const char *mdoc_a2lib(const char *); |
const char *mdoc_a2lib(const char *); |
const char *mdoc_a2st(const char *); |
const char *mdoc_a2st(const char *); |
|
|
int mdoc_isdelim(const char *); |
|
|
|
__END_DECLS |
__END_DECLS |
|
|