version 1.28, 2009/09/24 15:01:06 |
version 1.93, 2014/11/28 18:36:35 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se> |
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
|
* Copyright (c) 2013, 2014 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 |
|
|
#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; |
const char *defos; /* default argument for .Os */ |
int flags; |
int quick; /* abort parse early */ |
#define MDOC_HALT (1 << 0) /* Error in parse. Halt. */ |
int flags; /* parse flags */ |
#define MDOC_LITERAL (1 << 1) /* In a literal scope. */ |
#define MDOC_LITERAL (1 << 1) /* in a literal scope */ |
#define MDOC_PBODY (1 << 2) /* In the document body. */ |
#define MDOC_PBODY (1 << 2) /* in the document body */ |
int pflags; |
#define MDOC_NEWLINE (1 << 3) /* first macro/text in a line */ |
enum mdoc_next next; |
#define MDOC_PHRASELIT (1 << 4) /* literal within a partila phrase */ |
struct mdoc_node *last; |
#define MDOC_PPHRASE (1 << 5) /* within a partial phrase */ |
struct mdoc_node *first; |
#define MDOC_FREECOL (1 << 6) /* `It' invocation should close */ |
struct mdoc_meta meta; |
#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 lastnamed; |
enum mdoc_sec lastsec; |
enum mdoc_sec lastsec; |
|
struct roff *roff; |
}; |
}; |
|
|
enum merr { |
#define MACRO_PROT_ARGS struct mdoc *mdoc, \ |
ETAILWS = 0, |
enum mdoct tok, \ |
EQUOTPARM, |
int line, \ |
EQUOTTERM, |
int ppos, \ |
EMALLOC, |
int *pos, \ |
EARGVAL, |
char *buf |
EBODYPROL, |
|
EPROLBODY, |
|
ETEXTPROL, |
|
ENOBLANK, |
|
ETOOLONG, |
|
EESCAPE, |
|
EPRINT, |
|
ENODAT, |
|
ENOPROLOGUE, |
|
ELINE, |
|
EATT, |
|
ENAME, |
|
ELISTTYPE, |
|
EDISPTYPE, |
|
EMULTIDISP, |
|
EMULTILIST, |
|
ESECNAME, |
|
ENAMESECINC, |
|
EARGREP, |
|
EBOOL, |
|
ECOLMIS, |
|
ENESTDISP, |
|
EMISSWIDTH, |
|
EWRONGMSEC, |
|
ESECOOO, |
|
ESECREP, |
|
EBADSTAND, |
|
ENOMULTILINE, |
|
EMULTILINE, |
|
ENOLINE, |
|
EPROLOOO, |
|
EPROLREP, |
|
EBADMSEC, |
|
EBADSEC, |
|
EFONT, |
|
EBADDATE, |
|
ENUMFMT, |
|
ENOWIDTH, |
|
EUTSNAME, |
|
EOBS, |
|
EIMPBRK, |
|
EIGNE, |
|
EOPEN, |
|
EQUOTPHR, |
|
ENOCTX, |
|
ELIB, |
|
EBADCHILD, |
|
MERRMAX |
|
}; |
|
|
|
#define MACRO_PROT_ARGS struct mdoc *m, int tok, int line, \ |
|
int ppos, int *pos, char *buf |
|
|
|
struct mdoc_macro { |
struct mdoc_macro { |
int (*fp)(MACRO_PROT_ARGS); |
void (*fp)(MACRO_PROT_ARGS); |
int flags; |
int flags; |
#define MDOC_CALLABLE (1 << 0) |
#define MDOC_CALLABLE (1 << 0) |
#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) |
}; |
}; |
|
|
extern const struct mdoc_macro *const mdoc_macros; |
enum margserr { |
|
ARGS_ERROR, |
|
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) */ |
|
}; |
|
|
__BEGIN_DECLS |
enum margverr { |
|
ARGV_ERROR, |
|
ARGV_EOLN, /* end of line */ |
|
ARGV_ARG, /* valid argument */ |
|
ARGV_WORD /* normal word (or bad argument---same thing) */ |
|
}; |
|
|
#define mdoc_perr(m, l, p, t) \ |
/* |
mdoc_err((m), (l), (p), 1, (t)) |
* A punctuation delimiter is opening, closing, or "middle mark" |
#define mdoc_pwarn(m, l, p, t) \ |
* punctuation. These govern spacing. |
mdoc_err((m), (l), (p), 0, (t)) |
* Opening punctuation (e.g., the opening parenthesis) suppresses the |
#define mdoc_nerr(m, n, t) \ |
* following space; closing punctuation (e.g., the closing parenthesis) |
mdoc_err((m), (n)->line, (n)->pos, 1, (t)) |
* suppresses the leading space; middle punctuation (e.g., the vertical |
#define mdoc_nwarn(m, n, t) \ |
* bar) can do either. The middle punctuation delimiter bends the rules |
mdoc_err((m), (n)->line, (n)->pos, 0, (t)) |
* depending on usage. |
|
*/ |
|
enum mdelim { |
|
DELIM_NONE = 0, |
|
DELIM_OPEN, |
|
DELIM_MIDDLE, |
|
DELIM_CLOSE, |
|
DELIM_MAX |
|
}; |
|
|
int mdoc_err(struct mdoc *, int, int, int, enum merr); |
extern const struct mdoc_macro *const mdoc_macros; |
int mdoc_verr(struct mdoc *, int, int, const char *, ...); |
|
int mdoc_vwarn(struct mdoc *, int, int, const char *, ...); |
|
|
|
int mdoc_macro(MACRO_PROT_ARGS); |
__BEGIN_DECLS |
int mdoc_word_alloc(struct mdoc *, |
|
int, int, const char *); |
|
int mdoc_elem_alloc(struct mdoc *, int, int, |
|
int, struct mdoc_arg *); |
|
int mdoc_block_alloc(struct mdoc *, int, int, |
|
int, struct mdoc_arg *); |
|
int mdoc_head_alloc(struct mdoc *, int, int, int); |
|
int mdoc_tail_alloc(struct mdoc *, int, int, int); |
|
int mdoc_body_alloc(struct mdoc *, int, int, int); |
|
void mdoc_node_free(struct mdoc_node *); |
|
void mdoc_node_freelist(struct mdoc_node *); |
|
void mdoc_hash_init(void); |
|
int mdoc_hash_find(const char *); |
|
int mdoc_iscdelim(char); |
|
int mdoc_isdelim(const char *); |
|
size_t mdoc_isescape(const char *); |
|
enum mdoc_sec mdoc_atosec(const char *); |
|
time_t mdoc_atotime(const char *); |
|
|
|
size_t mdoc_macro2len(int); |
void mdoc_macro(MACRO_PROT_ARGS); |
|
void mdoc_word_alloc(struct mdoc *, int, int, const char *); |
|
void mdoc_word_append(struct mdoc *, const char *); |
|
void mdoc_elem_alloc(struct mdoc *, int, int, |
|
enum mdoct, struct mdoc_arg *); |
|
struct mdoc_node *mdoc_block_alloc(struct mdoc *, int, int, |
|
enum mdoct, struct mdoc_arg *); |
|
struct mdoc_node *mdoc_head_alloc(struct mdoc *, int, int, enum mdoct); |
|
void mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct); |
|
struct mdoc_node *mdoc_body_alloc(struct mdoc *, int, int, enum mdoct); |
|
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_valid_pre(struct mdoc *, struct mdoc_node *); |
const char *mdoc_a2msec(const char *); |
void mdoc_valid_post(struct mdoc *); |
int mdoc_valid_pre(struct mdoc *, |
enum margverr mdoc_argv(struct mdoc *, int, enum mdoct, |
const struct mdoc_node *); |
|
int mdoc_valid_post(struct mdoc *); |
|
int mdoc_action_pre(struct mdoc *, |
|
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 **); |
int mdoc_zargs(struct mdoc *, int, |
enum margserr mdoc_zargs(struct mdoc *, int, |
int *, char *, int, char **); |
int *, char *, char **); |
#define ARGS_DELIM (1 << 1) /* See args(). */ |
void mdoc_macroend(struct mdoc *); |
#define ARGS_TABSEP (1 << 2) /* See args(). */ |
enum mdelim mdoc_isdelim(const char *); |
#define ARGS_NOWARN (1 << 3) /* See args(). */ |
|
#define ARGS_ERROR (-1) |
|
#define ARGS_EOLN (0) |
|
#define ARGS_WORD (1) |
|
#define ARGS_PUNCT (2) |
|
#define ARGS_QWORD (3) |
|
#define ARGS_PHRASE (4) |
|
int mdoc_macroend(struct mdoc *); |
|
|
|
__END_DECLS |
__END_DECLS |
|
|