version 1.40, 2010/06/27 16:18:13 |
version 1.54, 2011/03/07 01:35:51 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2009 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
* |
* |
* 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 |
|
|
#ifndef MAN_H |
#ifndef MAN_H |
#define MAN_H |
#define MAN_H |
|
|
#include <time.h> |
/* |
|
* What follows is a list of ALL possible macros. |
|
*/ |
enum mant { |
enum mant { |
MAN_br = 0, |
MAN_br = 0, |
MAN_TH, |
MAN_TH, |
|
|
MAN_IR, |
MAN_IR, |
MAN_RI, |
MAN_RI, |
MAN_na, |
MAN_na, |
MAN_i, |
|
MAN_sp, |
MAN_sp, |
MAN_nf, |
MAN_nf, |
MAN_fi, |
MAN_fi, |
MAN_r, |
|
MAN_RE, |
MAN_RE, |
MAN_RS, |
MAN_RS, |
MAN_DT, |
MAN_DT, |
MAN_UC, |
MAN_UC, |
MAN_PD, |
MAN_PD, |
MAN_Sp, |
|
MAN_Vb, |
|
MAN_Ve, |
|
MAN_AT, |
MAN_AT, |
|
MAN_in, |
|
MAN_ft, |
MAN_MAX |
MAN_MAX |
}; |
}; |
|
|
|
/* |
|
* Type of a syntax node. |
|
*/ |
enum man_type { |
enum man_type { |
MAN_TEXT, |
MAN_TEXT, |
MAN_ELEM, |
MAN_ELEM, |
MAN_ROOT, |
MAN_ROOT, |
MAN_BLOCK, |
MAN_BLOCK, |
MAN_HEAD, |
MAN_HEAD, |
MAN_BODY |
MAN_BODY, |
|
MAN_TBL, |
|
MAN_EQN |
}; |
}; |
|
|
|
/* |
|
* Information from prologue. |
|
*/ |
struct man_meta { |
struct man_meta { |
char *msec; |
char *msec; /* `TH' section (1, 3p, etc.) */ |
time_t date; |
char *date; /* `TH' normalised date */ |
char *rawdate; |
char *vol; /* `TH' volume */ |
char *vol; |
char *title; /* `TH' title (e.g., FOO) */ |
char *title; |
char *source; /* `TH' source (e.g., GNU) */ |
char *source; |
|
}; |
}; |
|
|
|
/* |
|
* Single node in tree-linked AST. |
|
*/ |
struct man_node { |
struct man_node { |
struct man_node *parent; |
struct man_node *parent; /* parent AST node */ |
struct man_node *child; |
struct man_node *child; /* first child AST node */ |
struct man_node *next; |
struct man_node *next; /* sibling AST node */ |
struct man_node *prev; |
struct man_node *prev; /* prior sibling AST node */ |
int nchild; |
int nchild; /* number children */ |
int line; |
int line; |
int pos; |
int pos; |
enum mant tok; |
enum mant tok; /* tok or MAN__MAX if none */ |
int flags; |
int flags; |
#define MAN_VALID (1 << 0) |
#define MAN_VALID (1 << 0) /* has been validated */ |
#define MAN_ACTED (1 << 1) |
#define MAN_EOS (1 << 2) /* at sentence boundary */ |
#define MAN_EOS (1 << 2) |
#define MAN_LINE (1 << 3) /* first macro/text on line */ |
enum man_type type; |
enum man_type type; /* AST node type */ |
char *string; |
char *string; /* TEXT node argument */ |
struct man_node *head; |
struct man_node *head; /* BLOCK node HEAD ptr */ |
struct man_node *body; |
struct man_node *body; /* BLOCK node BODY ptr */ |
|
const struct tbl_span *span; /* TBL */ |
|
const struct eqn *eqn; /* EQN */ |
}; |
}; |
|
|
#define MAN_IGN_MACRO (1 << 0) |
/* |
#define MAN_IGN_ESCAPE (1 << 2) |
* 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 *); |
void man_free(struct man *); |
struct man *man_alloc(struct regset *, void *, int, mandocmsg); |
struct man *man_alloc(struct regset *, void *, mandocmsg); |
void man_reset(struct man *); |
void man_reset(struct man *); |
int man_parseln(struct man *, int, char *, int); |
int man_parseln(struct man *, int, char *, int); |
int man_endparse(struct man *); |
int man_endparse(struct man *); |
|
int man_addspan(struct man *, |
|
const struct tbl_span *); |
|
int man_addeqn(struct man *, const struct eqn *); |
|
|
const struct man_node *man_node(const struct man *); |
const struct man_node *man_node(const struct man *); |
const struct man_meta *man_meta(const struct man *); |
const struct man_meta *man_meta(const struct man *); |