version 1.92, 2014/11/28 04:47:03 |
version 1.105, 2015/04/23 15:35:59 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2013, 2014 Ingo Schwarze <schwarze@openbsd.org> |
* Copyright (c) 2013, 2014, 2015 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 above |
* purpose with or without fee is hereby granted, provided that the above |
* copyright notice and this permission notice appear in all copies. |
* copyright notice and this permission notice appear in all copies. |
* |
* |
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES |
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR |
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
*/ |
*/ |
#ifndef LIBMDOC_H |
|
#define LIBMDOC_H |
|
|
|
enum mdoc_next { |
#define MACRO_PROT_ARGS struct roff_man *mdoc, \ |
MDOC_NEXT_SIBLING = 0, |
int tok, \ |
MDOC_NEXT_CHILD |
|
}; |
|
|
|
struct mdoc { |
|
struct mparse *parse; /* parse pointer */ |
|
const char *defos; /* default argument for .Os */ |
|
int quick; /* abort parse early */ |
|
int flags; /* parse flags */ |
|
#define MDOC_LITERAL (1 << 1) /* in a literal scope */ |
|
#define MDOC_PBODY (1 << 2) /* in the document body */ |
|
#define MDOC_NEWLINE (1 << 3) /* first macro/text in a line */ |
|
#define MDOC_PHRASELIT (1 << 4) /* literal within a partila phrase */ |
|
#define MDOC_PPHRASE (1 << 5) /* within a partial phrase */ |
|
#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 */ |
|
#define MDOC_NODELIMC (1 << 10) /* disable closing delimiter handling */ |
|
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_node *last_es; /* the most recent Es node */ |
|
struct mdoc_meta meta; /* document meta-data */ |
|
enum mdoc_sec lastnamed; |
|
enum mdoc_sec lastsec; |
|
struct roff *roff; |
|
}; |
|
|
|
#define MACRO_PROT_ARGS struct mdoc *mdoc, \ |
|
enum mdoct tok, \ |
|
int line, \ |
int line, \ |
int ppos, \ |
int ppos, \ |
int *pos, \ |
int *pos, \ |
|
|
ARGS_PEND /* last phrase (-column) */ |
ARGS_PEND /* last phrase (-column) */ |
}; |
}; |
|
|
enum margverr { |
|
ARGV_ERROR, |
|
ARGV_EOLN, /* end of line */ |
|
ARGV_ARG, /* valid argument */ |
|
ARGV_WORD /* normal word (or bad argument---same thing) */ |
|
}; |
|
|
|
/* |
/* |
* A punctuation delimiter is opening, closing, or "middle mark" |
* A punctuation delimiter is opening, closing, or "middle mark" |
* punctuation. These govern spacing. |
* punctuation. These govern spacing. |
Line 106 extern const struct mdoc_macro *const mdoc_macros; |
|
Line 67 extern const struct mdoc_macro *const mdoc_macros; |
|
__BEGIN_DECLS |
__BEGIN_DECLS |
|
|
void mdoc_macro(MACRO_PROT_ARGS); |
void mdoc_macro(MACRO_PROT_ARGS); |
void mdoc_word_alloc(struct mdoc *, int, int, const char *); |
void mdoc_elem_alloc(struct roff_man *, int, int, |
void mdoc_word_append(struct mdoc *, const char *); |
int, struct mdoc_arg *); |
void mdoc_elem_alloc(struct mdoc *, int, int, |
struct roff_node *mdoc_block_alloc(struct roff_man *, int, int, |
enum mdoct, struct mdoc_arg *); |
int, struct mdoc_arg *); |
struct mdoc_node *mdoc_block_alloc(struct mdoc *, int, int, |
void mdoc_tail_alloc(struct roff_man *, int, int, int); |
enum mdoct, struct mdoc_arg *); |
struct roff_node *mdoc_endbody_alloc(struct roff_man *, int, int, int, |
struct mdoc_node *mdoc_head_alloc(struct mdoc *, int, int, enum mdoct); |
struct roff_node *, enum mdoc_endbody); |
void mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct); |
void mdoc_node_relink(struct roff_man *, struct roff_node *); |
struct mdoc_node *mdoc_body_alloc(struct mdoc *, int, int, enum mdoct); |
int mdoc_hash_find(const char *); |
void mdoc_endbody_alloc(struct mdoc *, int, int, enum mdoct, |
|
struct mdoc_node *, enum mdoc_endbody); |
|
void mdoc_node_delete(struct mdoc *, struct mdoc_node *); |
|
void mdoc_node_relink(struct mdoc *, struct mdoc_node *); |
|
void mdoc_hash_init(void); |
|
enum mdoct mdoc_hash_find(const char *); |
|
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 *); |
const char *mdoc_a2arch(const char *); |
const char *mdoc_a2arch(const char *); |
const char *mdoc_a2vol(const char *); |
void mdoc_argv(struct roff_man *, int, int, |
void mdoc_valid_pre(struct mdoc *, struct mdoc_node *); |
|
void mdoc_valid_post(struct mdoc *); |
|
enum margverr mdoc_argv(struct mdoc *, int, enum mdoct, |
|
struct mdoc_arg **, int *, char *); |
struct mdoc_arg **, int *, char *); |
void mdoc_argv_free(struct mdoc_arg *); |
enum margserr mdoc_args(struct roff_man *, int, |
enum margserr mdoc_args(struct mdoc *, int, |
int *, char *, int, char **); |
int *, char *, enum mdoct, char **); |
|
enum margserr mdoc_zargs(struct mdoc *, int, |
|
int *, char *, char **); |
|
void mdoc_macroend(struct mdoc *); |
|
enum mdelim mdoc_isdelim(const char *); |
enum mdelim mdoc_isdelim(const char *); |
|
|
__END_DECLS |
__END_DECLS |
|
|
#endif /*!LIBMDOC_H*/ |
|