version 1.47, 2010/12/06 15:31:19 |
version 1.72, 2015/04/02 23:48:19 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
|
* Copyright (c) 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 MAN_H |
|
#define MAN_H |
|
|
|
/* |
#define MAN_br 0 |
* What follows is a list of ALL possible macros. |
#define MAN_TH 1 |
*/ |
#define MAN_SH 2 |
enum mant { |
#define MAN_SS 3 |
MAN_br = 0, |
#define MAN_TP 4 |
MAN_TH, |
#define MAN_LP 5 |
MAN_SH, |
#define MAN_PP 6 |
MAN_SS, |
#define MAN_P 7 |
MAN_TP, |
#define MAN_IP 8 |
MAN_LP, |
#define MAN_HP 9 |
MAN_PP, |
#define MAN_SM 10 |
MAN_P, |
#define MAN_SB 11 |
MAN_IP, |
#define MAN_BI 12 |
MAN_HP, |
#define MAN_IB 13 |
MAN_SM, |
#define MAN_BR 14 |
MAN_SB, |
#define MAN_RB 15 |
MAN_BI, |
#define MAN_R 16 |
MAN_IB, |
#define MAN_B 17 |
MAN_BR, |
#define MAN_I 18 |
MAN_RB, |
#define MAN_IR 19 |
MAN_R, |
#define MAN_RI 20 |
MAN_B, |
#define MAN_sp 21 |
MAN_I, |
#define MAN_nf 22 |
MAN_IR, |
#define MAN_fi 23 |
MAN_RI, |
#define MAN_RE 24 |
MAN_na, |
#define MAN_RS 25 |
MAN_i, |
#define MAN_DT 26 |
MAN_sp, |
#define MAN_UC 27 |
MAN_nf, |
#define MAN_PD 28 |
MAN_fi, |
#define MAN_AT 29 |
MAN_r, |
#define MAN_in 30 |
MAN_RE, |
#define MAN_ft 31 |
MAN_RS, |
#define MAN_OP 32 |
MAN_DT, |
#define MAN_EX 33 |
MAN_UC, |
#define MAN_EE 34 |
MAN_PD, |
#define MAN_UR 35 |
MAN_AT, |
#define MAN_UE 36 |
MAN_in, |
#define MAN_ll 37 |
MAN_ft, |
#define MAN_MAX 38 |
MAN_MAX |
|
}; |
|
|
|
/* |
/* Names of macros. */ |
* Type of a syntax node. |
|
*/ |
|
enum man_type { |
|
MAN_TEXT, |
|
MAN_ELEM, |
|
MAN_ROOT, |
|
MAN_BLOCK, |
|
MAN_HEAD, |
|
MAN_BODY |
|
}; |
|
|
|
/* |
|
* Information from prologue. |
|
*/ |
|
struct man_meta { |
|
char *msec; /* `TH' section (1, 3p, etc.) */ |
|
time_t date; /* `TH' normalised date */ |
|
char *rawdate; /* raw `TH' date */ |
|
char *vol; /* `TH' volume */ |
|
char *title; /* `TH' title (e.g., FOO) */ |
|
char *source; /* `TH' source (e.g., GNU) */ |
|
}; |
|
|
|
/* |
|
* Single node in tree-linked AST. |
|
*/ |
|
struct man_node { |
|
struct man_node *parent; /* parent AST node */ |
|
struct man_node *child; /* first child AST node */ |
|
struct man_node *next; /* sibling AST node */ |
|
struct man_node *prev; /* prior sibling AST node */ |
|
int nchild; /* number children */ |
|
int line; |
|
int pos; |
|
enum mant tok; /* tok or MAN__MAX if none */ |
|
int flags; |
|
#define MAN_VALID (1 << 0) /* has been validated */ |
|
#define MAN_ACTED (1 << 1) /* has been acted upon */ |
|
#define MAN_EOS (1 << 2) /* at sentence boundary */ |
|
enum man_type type; /* AST node type */ |
|
char *string; /* TEXT node argument */ |
|
struct man_node *head; /* BLOCK node HEAD ptr */ |
|
struct man_node *body; /* BLOCK node BODY ptr */ |
|
}; |
|
|
|
/* |
|
* Names of macros. Index is enum mant. Indexing into this returns |
|
* the normalised name, e.g., man_macronames[MAN_SH] -> "SH". |
|
*/ |
|
extern const char *const *man_macronames; |
extern const char *const *man_macronames; |
|
|
__BEGIN_DECLS |
__BEGIN_DECLS |
|
|
struct man; |
struct man; |
|
|
void man_free(struct man *); |
const struct roff_node *man_node(const struct man *); |
struct man *man_alloc(struct regset *, void *, mandocmsg); |
const struct roff_meta *man_meta(const struct man *); |
void man_reset(struct man *); |
const struct mparse *man_mparse(const struct man *); |
int man_parseln(struct man *, int, char *, int); |
void man_deroff(char **, const struct roff_node *); |
int man_endparse(struct man *); |
|
|
|
const struct man_node *man_node(const struct man *); |
|
const struct man_meta *man_meta(const struct man *); |
|
|
|
__END_DECLS |
__END_DECLS |
|
|
#endif /*!MAN_H*/ |
|