version 1.5, 2009/04/12 19:29:53 |
version 1.83, 2014/01/05 20:26:36 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org> |
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
|
* Copyright (c) 2013 Ingo Schwarze <schwarze@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 LIBMDOC_H |
#ifndef LIBMDOC_H |
#define LIBMDOC_H |
#define LIBMDOC_H |
|
|
#include "mdoc.h" |
|
|
|
enum mdoc_next { |
enum mdoc_next { |
MDOC_NEXT_SIBLING = 0, |
MDOC_NEXT_SIBLING = 0, |
MDOC_NEXT_CHILD |
MDOC_NEXT_CHILD |
}; |
}; |
|
|
struct mdoc { |
struct mdoc { |
void *data; |
struct mparse *parse; /* parse pointer */ |
struct mdoc_cb cb; |
char *defos; /* default argument for .Os */ |
void *htab; |
int quick; /* abort parse early */ |
int flags; |
int flags; /* parse flags */ |
#define MDOC_HALT (1 << 0) |
#define MDOC_HALT (1 << 0) /* error in parse: halt */ |
#define MDOC_LITERAL (1 << 1) |
#define MDOC_LITERAL (1 << 1) /* in a literal scope */ |
int pflags; |
#define MDOC_PBODY (1 << 2) /* in the document body */ |
enum mdoc_next next; |
#define MDOC_NEWLINE (1 << 3) /* first macro/text in a line */ |
struct mdoc_node *last; |
#define MDOC_PHRASELIT (1 << 4) /* literal within a partila phrase */ |
struct mdoc_node *first; |
#define MDOC_PPHRASE (1 << 5) /* within a partial phrase */ |
struct mdoc_meta meta; |
#define MDOC_FREECOL (1 << 6) /* `It' invocation should close */ |
|
#define MDOC_SYNOPSIS (1 << 7) /* SYNOPSIS-style formatting */ |
|
#define MDOC_KEEP (1 << 8) /* in a word keep */ |
|
#define MDOC_SMOFF (1 << 9) /* spacing is off */ |
|
enum mdoc_next next; /* where to put the next node */ |
|
struct mdoc_node *last; /* the last node parsed */ |
|
struct mdoc_node *first; /* the first node parsed */ |
|
struct mdoc_meta meta; /* document meta-data */ |
enum mdoc_sec lastnamed; |
enum mdoc_sec lastnamed; |
enum mdoc_sec lastsec; |
enum mdoc_sec lastsec; |
|
struct roff *roff; |
}; |
}; |
|
|
|
#define MACRO_PROT_ARGS struct mdoc *mdoc, \ |
|
enum mdoct tok, \ |
|
int line, \ |
|
int ppos, \ |
|
int *pos, \ |
|
char *buf |
|
|
#define MACRO_PROT_ARGS struct mdoc *mdoc, int tok, int line, \ |
|
int ppos, int *pos, char *buf |
|
|
|
struct mdoc_macro { |
struct mdoc_macro { |
int (*fp)(MACRO_PROT_ARGS); |
int (*fp)(MACRO_PROT_ARGS); |
int flags; |
int flags; |
Line 53 struct mdoc_macro { |
|
Line 61 struct mdoc_macro { |
|
#define MDOC_PARSED (1 << 1) |
#define MDOC_PARSED (1 << 1) |
#define MDOC_EXPLICIT (1 << 2) |
#define MDOC_EXPLICIT (1 << 2) |
#define MDOC_PROLOGUE (1 << 3) |
#define MDOC_PROLOGUE (1 << 3) |
#define MDOC_IGNDELIM (1 << 4) |
#define MDOC_IGNDELIM (1 << 4) |
/* Reserved words in arguments treated as text. */ |
#define MDOC_JOIN (1 << 5) |
}; |
}; |
|
|
#define mdoc_nwarn(mdoc, node, type, fmt, ...) \ |
enum margserr { |
mdoc_vwarn((mdoc), (node)->line, \ |
ARGS_ERROR, |
(node)->pos, (type), (fmt), ##__VA_ARGS__) |
ARGS_EOLN, /* end-of-line */ |
|
ARGS_WORD, /* normal word */ |
|
ARGS_PUNCT, /* series of punctuation */ |
|
ARGS_QWORD, /* quoted word */ |
|
ARGS_PHRASE, /* Ta'd phrase (-column) */ |
|
ARGS_PPHRASE, /* tabbed phrase (-column) */ |
|
ARGS_PEND /* last phrase (-column) */ |
|
}; |
|
|
#define mdoc_nerr(mdoc, node, fmt, ...) \ |
enum margverr { |
mdoc_verr((mdoc), (node)->line, \ |
ARGV_ERROR, |
(node)->pos, (fmt), ##__VA_ARGS__) |
ARGV_EOLN, /* end of line */ |
|
ARGV_ARG, /* valid argument */ |
|
ARGV_WORD /* normal word (or bad argument---same thing) */ |
|
}; |
|
|
#define mdoc_warn(mdoc, type, fmt, ...) \ |
/* |
mdoc_vwarn((mdoc), (mdoc)->last->line, \ |
* A punctuation delimiter is opening, closing, or "middle mark" |
(mdoc)->last->pos, (type), (fmt), ##__VA_ARGS__) |
* punctuation. These govern spacing. |
|
* Opening punctuation (e.g., the opening parenthesis) suppresses the |
|
* following space; closing punctuation (e.g., the closing parenthesis) |
|
* suppresses the leading space; middle punctuation (e.g., the vertical |
|
* bar) can do either. The middle punctuation delimiter bends the rules |
|
* depending on usage. |
|
*/ |
|
enum mdelim { |
|
DELIM_NONE = 0, |
|
DELIM_OPEN, |
|
DELIM_MIDDLE, |
|
DELIM_CLOSE, |
|
DELIM_MAX |
|
}; |
|
|
#define mdoc_err(mdoc, fmt, ...) \ |
|
mdoc_verr((mdoc), (mdoc)->last->line, \ |
|
(mdoc)->last->pos, (fmt), ##__VA_ARGS__) |
|
|
|
#define mdoc_msg(mdoc, fmt, ...) \ |
|
mdoc_vmsg((mdoc), (mdoc)->last->line, \ |
|
(mdoc)->last->pos, (fmt), ##__VA_ARGS__) |
|
|
|
#define mdoc_pmsg(mdoc, line, pos, fmt, ...) \ |
|
mdoc_vmsg((mdoc), (line), \ |
|
(pos), (fmt), ##__VA_ARGS__) |
|
|
|
#define mdoc_pwarn(mdoc, line, pos, type, fmt, ...) \ |
|
mdoc_vwarn((mdoc), (line), \ |
|
(pos), (type), (fmt), ##__VA_ARGS__) |
|
|
|
#define mdoc_perr(mdoc, line, pos, fmt, ...) \ |
|
mdoc_verr((mdoc), (line), \ |
|
(pos), (fmt), ##__VA_ARGS__) |
|
|
|
extern const struct mdoc_macro *const mdoc_macros; |
extern const struct mdoc_macro *const mdoc_macros; |
|
|
__BEGIN_DECLS |
__BEGIN_DECLS |
|
|
int mdoc_vwarn(struct mdoc *, int, int, |
#define mdoc_pmsg(mdoc, l, p, t) \ |
enum mdoc_warn, const char *, ...); |
mandoc_msg((t), (mdoc)->parse, (l), (p), NULL) |
void mdoc_vmsg(struct mdoc *, int, int, |
#define mdoc_nmsg(mdoc, n, t) \ |
const char *, ...); |
mandoc_msg((t), (mdoc)->parse, (n)->line, (n)->pos, NULL) |
int mdoc_verr(struct mdoc *, int, int, |
|
const char *, ...); |
|
int mdoc_macro(MACRO_PROT_ARGS); |
int mdoc_macro(MACRO_PROT_ARGS); |
int mdoc_word_alloc(struct mdoc *, |
int mdoc_word_alloc(struct mdoc *, |
int, int, const char *); |
int, int, const char *); |
|
void mdoc_word_append(struct mdoc *, const char *); |
int mdoc_elem_alloc(struct mdoc *, int, int, |
int mdoc_elem_alloc(struct mdoc *, int, int, |
int, struct mdoc_arg *); |
enum mdoct, struct mdoc_arg *); |
int mdoc_block_alloc(struct mdoc *, int, int, |
int mdoc_block_alloc(struct mdoc *, int, int, |
int, struct mdoc_arg *); |
enum mdoct, struct mdoc_arg *); |
int mdoc_head_alloc(struct mdoc *, int, int, int); |
int mdoc_head_alloc(struct mdoc *, int, int, enum mdoct); |
int mdoc_tail_alloc(struct mdoc *, int, int, int); |
int mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct); |
int mdoc_body_alloc(struct mdoc *, int, int, int); |
int mdoc_body_alloc(struct mdoc *, int, int, enum mdoct); |
void mdoc_node_free(struct mdoc_node *); |
int mdoc_endbody_alloc(struct mdoc *, int, int, enum mdoct, |
void mdoc_node_freelist(struct mdoc_node *); |
struct mdoc_node *, enum mdoc_endbody); |
void *mdoc_hash_alloc(void); |
void mdoc_node_delete(struct mdoc *, struct mdoc_node *); |
int mdoc_hash_find(const void *, const char *); |
int mdoc_node_relink(struct mdoc *, struct mdoc_node *); |
void mdoc_hash_free(void *); |
void mdoc_hash_init(void); |
int mdoc_iscdelim(char); |
enum mdoct mdoc_hash_find(const char *); |
int mdoc_isdelim(const char *); |
const char *mdoc_a2att(const char *); |
size_t mdoc_isescape(const char *); |
const char *mdoc_a2lib(const char *); |
enum mdoc_sec mdoc_atosec(const char *); |
const char *mdoc_a2st(const char *); |
time_t mdoc_atotime(const char *); |
|
|
|
size_t mdoc_macro2len(int); |
|
const char *mdoc_a2arch(const char *); |
const char *mdoc_a2arch(const char *); |
const char *mdoc_a2vol(const char *); |
const char *mdoc_a2vol(const char *); |
const char *mdoc_a2msec(const char *); |
int mdoc_valid_pre(struct mdoc *, struct mdoc_node *); |
int mdoc_valid_pre(struct mdoc *, |
|
const struct mdoc_node *); |
|
int mdoc_valid_post(struct mdoc *); |
int mdoc_valid_post(struct mdoc *); |
int mdoc_action_pre(struct mdoc *, |
enum margverr mdoc_argv(struct mdoc *, int, enum mdoct, |
const struct mdoc_node *); |
|
int mdoc_action_post(struct mdoc *); |
|
int mdoc_argv(struct mdoc *, int, int, |
|
struct mdoc_arg **, int *, char *); |
struct mdoc_arg **, int *, char *); |
#define ARGV_ERROR (-1) |
|
#define ARGV_EOLN (0) |
|
#define ARGV_ARG (1) |
|
#define ARGV_WORD (2) |
|
void mdoc_argv_free(struct mdoc_arg *); |
void mdoc_argv_free(struct mdoc_arg *); |
int mdoc_args(struct mdoc *, int, |
enum margserr mdoc_args(struct mdoc *, int, |
int *, char *, int, char **); |
int *, char *, enum mdoct, char **); |
#define ARGS_ERROR (-1) |
enum margserr mdoc_zargs(struct mdoc *, int, |
#define ARGS_EOLN (0) |
int *, char *, char **); |
#define ARGS_WORD (1) |
|
#define ARGS_PUNCT (2) |
|
#define ARGS_QWORD (3) |
|
#define ARGS_PHRASE (4) |
|
|
|
int mdoc_macroend(struct mdoc *); |
int mdoc_macroend(struct mdoc *); |
|
enum mdelim mdoc_isdelim(const char *); |
|
|
__END_DECLS |
__END_DECLS |
|
|