version 1.45, 2009/03/09 14:19:59 |
version 1.70, 2009/10/15 01:33:12 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se> |
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se> |
* |
* |
* 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 |
|
|
|
|
/* What follows is a list of ALL possible macros. */ |
/* 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_Dd 1 |
#define MDOC_Dt 2 |
#define MDOC_Dt 2 |
#define MDOC_Os 3 |
#define MDOC_Os 3 |
|
|
#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_Ap 107 |
#define MDOC_Lp 107 |
#define MDOC_Lp 108 |
#define MDOC_Lk 108 |
#define MDOC_Lk 109 |
#define MDOC_Mt 109 |
#define MDOC_Mt 110 |
#define MDOC_Brq 110 |
#define MDOC_MAX 111 |
#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_br 118 |
|
#define MDOC_sp 119 |
|
#define MDOC_MAX 120 |
|
|
/* 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_Centred 26 |
|
#define MDOC_ARG_MAX 27 |
|
|
/* Warnings are either syntax or groff-compatibility. */ |
|
enum mdoc_warn { |
|
WARN_SYNTAX, |
|
WARN_COMPAT |
|
}; |
|
|
|
/* Type of a syntax node. */ |
/* Type of a syntax node. */ |
enum mdoc_type { |
enum mdoc_type { |
MDOC_TEXT, |
MDOC_TEXT, |
Line 194 enum mdoc_type { |
|
Line 195 enum mdoc_type { |
|
|
|
/* Section (named/unnamed) of `Sh'. */ |
/* Section (named/unnamed) of `Sh'. */ |
enum mdoc_sec { |
enum mdoc_sec { |
SEC_PROLOGUE = 0, |
SEC_NONE, /* No section, yet. */ |
SEC_BODY = 1, |
SEC_NAME, |
SEC_NAME = 2, |
SEC_LIBRARY, |
SEC_LIBRARY = 3, |
SEC_SYNOPSIS, |
SEC_SYNOPSIS = 4, |
SEC_DESCRIPTION, |
SEC_DESCRIPTION = 5, |
SEC_IMPLEMENTATION, |
SEC_IMPLEMENTATION = 6, |
SEC_EXIT_STATUS, |
SEC_RETURN_VALUES = 7, |
SEC_RETURN_VALUES, |
SEC_ENVIRONMENT = 8, |
SEC_ENVIRONMENT, |
SEC_FILES = 9, |
SEC_FILES, |
SEC_EXAMPLES = 10, |
SEC_EXAMPLES, |
SEC_DIAGNOSTICS = 11, |
SEC_DIAGNOSTICS, |
SEC_COMPATIBILITY = 12, |
SEC_COMPATIBILITY, |
SEC_ERRORS = 13, |
SEC_ERRORS, |
SEC_SEE_ALSO = 14, |
SEC_SEE_ALSO, |
SEC_STANDARDS = 15, |
SEC_STANDARDS, |
SEC_HISTORY = 16, |
SEC_HISTORY, |
SEC_AUTHORS = 17, |
SEC_AUTHORS, |
SEC_CAVEATS = 18, |
SEC_CAVEATS, |
SEC_BUGS = 19, |
SEC_BUGS, |
SEC_CUSTOM |
SEC_SECURITY, |
|
SEC_CUSTOM /* User-defined. */ |
}; |
}; |
|
|
/* Information from prologue. */ |
/* Information from prologue. */ |
Line 249 struct mdoc_node { |
|
Line 251 struct mdoc_node { |
|
struct mdoc_node *child; |
struct mdoc_node *child; |
struct mdoc_node *next; |
struct mdoc_node *next; |
struct mdoc_node *prev; |
struct mdoc_node *prev; |
|
int nchild; |
int line; |
int line; |
int pos; |
int pos; |
int tok; |
int tok; |
Line 258 struct mdoc_node { |
|
Line 261 struct mdoc_node { |
|
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 269 struct mdoc_node { |
|
Line 271 struct mdoc_node { |
|
#define MDOC_IGN_SCOPE (1 << 0) /* Ignore scope violations. */ |
#define MDOC_IGN_SCOPE (1 << 0) /* Ignore scope violations. */ |
#define MDOC_IGN_ESCAPE (1 << 1) /* Ignore bad escape sequences. */ |
#define MDOC_IGN_ESCAPE (1 << 1) /* Ignore bad escape sequences. */ |
#define MDOC_IGN_MACRO (1 << 2) /* Ignore unknown macros. */ |
#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_msg)(void *, int, int, const char *); |
|
int (*mdoc_err)(void *, int, int, const char *); |
int (*mdoc_err)(void *, int, int, const char *); |
int (*mdoc_warn)(void *, int, int, |
int (*mdoc_warn)(void *, int, int, const char *); |
enum mdoc_warn, const char *); |
|
}; |
}; |
|
|
/* Global table of macro names (`Bd', `Ed', etc.). */ |
/* See mdoc.3 for documentation. */ |
extern const char *const *mdoc_macronames; |
|
|
|
/* Global table of argument names (`column', `tag', etc.). */ |
extern const char *const *mdoc_macronames; |
extern const char *const *mdoc_argnames; |
extern const char *const *mdoc_argnames; |
|
|
__BEGIN_DECLS |
__BEGIN_DECLS |
|
|
struct mdoc; |
struct mdoc; |
|
|
/* Free memory allocated with mdoc_alloc. */ |
/* See mdoc.3 for documentation. */ |
void mdoc_free(struct mdoc *); |
|
|
|
/* Allocate a new parser instance. */ |
void mdoc_free(struct mdoc *); |
struct mdoc *mdoc_alloc(void *, int, const struct mdoc_cb *); |
struct mdoc *mdoc_alloc(void *, int, const struct mdoc_cb *); |
|
int mdoc_reset(struct mdoc *); |
/* Set parse options. */ |
|
void mdoc_setflags(struct mdoc *, int); |
|
|
|
/* 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); |
|
|
/* Get result first node (after mdoc_endparse!). */ |
|
const struct mdoc_node *mdoc_node(const struct mdoc *); |
const struct mdoc_node *mdoc_node(const struct mdoc *); |
|
|
/* Get result meta-information (after mdoc_endparse!). */ |
|
const struct mdoc_meta *mdoc_meta(const struct mdoc *); |
const struct mdoc_meta *mdoc_meta(const struct mdoc *); |
|
|
/* Signal end of parse sequence (boolean retval). */ |
|
int mdoc_endparse(struct mdoc *); |
int mdoc_endparse(struct mdoc *); |
|
|
/* The following are utility functions. */ |
|
|
|
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 |
__END_DECLS |
|
|