-/* $Id: libmdoc.h,v 1.11 2009/06/17 10:53:32 kristaps Exp $ */
+/* $Id: libmdoc.h,v 1.44 2010/05/14 17:31:25 kristaps Exp $ */
/*
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
*
struct mdoc {
void *data;
struct mdoc_cb cb;
- void *htab;
int flags;
-#define MDOC_HALT (1 << 0) /* Error in parse. Halt. */
-#define MDOC_LITERAL (1 << 1) /* In a literal scope. */
-#define MDOC_PBODY (1 << 2) /* In the document body. */
+#define MDOC_HALT (1 << 0) /* error in parse: halt */
+#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) /* in a literal within a phrase */
int pflags;
enum mdoc_next next;
struct mdoc_node *last;
enum mdoc_sec lastsec;
};
+enum merr {
+ ETAILWS = 0,
+ EQUOTPARM,
+ EQUOTTERM,
+ EARGVAL,
+ 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,
+ EBADSEC,
+ EFONT,
+ EBADDATE,
+ ENUMFMT,
+ ENOWIDTH,
+ EUTSNAME,
+ EOBS,
+ EIMPBRK,
+ EIGNE,
+ EOPEN,
+ EQUOTPHR,
+ ENOCTX,
+ ELIB,
+ EBADCHILD,
+ ENOTYPE,
+ EBADCOMMENT,
+ MERRMAX
+};
-#define MACRO_PROT_ARGS struct mdoc *mdoc, int tok, int line, \
- int ppos, int *pos, char *buf
+#define MACRO_PROT_ARGS struct mdoc *m, enum mdoct tok, \
+ int line, int ppos, int *pos, char *buf
struct mdoc_macro {
int (*fp)(MACRO_PROT_ARGS);
/* Reserved words in arguments treated as text. */
};
+enum margserr {
+ ARGS_ERROR,
+ ARGS_EOLN,
+ ARGS_WORD,
+ ARGS_PUNCT,
+ ARGS_QWORD,
+ ARGS_PHRASE,
+ ARGS_PPHRASE,
+ ARGS_PEND
+};
+
+enum margverr {
+ ARGV_ERROR,
+ ARGV_EOLN,
+ ARGV_ARG,
+ ARGV_WORD
+};
+
extern const struct mdoc_macro *const mdoc_macros;
__BEGIN_DECLS
-/*
- * When GCC2 is deprecated, most of these can be reverted to #define
- * as mdoc_vXXX using __VA_ARGS__. Until then, use real functions.
- */
-int mdoc_vwarn(struct mdoc *, int, int,
- enum mdoc_warn, const char *, ...);
-int mdoc_verr(struct mdoc *, int, int,
- const char *, ...);
-int mdoc_nerr(struct mdoc *, const struct mdoc_node *,
- const char *, ...);
-int mdoc_warn(struct mdoc *, enum mdoc_warn, const char *, ...);
-int mdoc_err(struct mdoc *, const char *, ...);
-int mdoc_pwarn(struct mdoc *, int, int,
- enum mdoc_warn,const char *, ...);
-int mdoc_perr(struct mdoc *, int, int, const char *, ...);
+#define mdoc_perr(m, l, p, t) \
+ mdoc_err((m), (l), (p), 1, (t))
+#define mdoc_pwarn(m, l, p, t) \
+ mdoc_err((m), (l), (p), 0, (t))
+#define mdoc_nerr(m, n, t) \
+ mdoc_err((m), (n)->line, (n)->pos, 1, (t))
+#define mdoc_nwarn(m, n, t) \
+ mdoc_err((m), (n)->line, (n)->pos, 0, (t))
+
+int mdoc_err(struct mdoc *, int, int, int, enum merr);
+int mdoc_verr(struct mdoc *, int, int, const char *, ...);
+int mdoc_vwarn(struct mdoc *, int, int, const char *, ...);
+
int mdoc_macro(MACRO_PROT_ARGS);
int mdoc_word_alloc(struct mdoc *,
int, int, const char *);
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, 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_alloc(void);
-int mdoc_hash_find(const void *, const char *);
-void mdoc_hash_free(void *);
+ enum mdoct, struct mdoc_arg *);
+int mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
+int mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
+int mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
+void mdoc_node_delete(struct mdoc *, struct mdoc_node *);
+void mdoc_hash_init(void);
+enum mdoct 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 *);
+enum mdoc_sec mdoc_str2sec(const char *);
time_t mdoc_atotime(const char *);
-
-size_t mdoc_macro2len(int);
+size_t mdoc_macro2len(enum mdoct);
+const char *mdoc_a2att(const char *);
+const char *mdoc_a2lib(const char *);
+const char *mdoc_a2st(const char *);
const char *mdoc_a2arch(const char *);
const char *mdoc_a2vol(const char *);
const char *mdoc_a2msec(const char *);
int mdoc_action_pre(struct mdoc *,
const struct mdoc_node *);
int mdoc_action_post(struct mdoc *);
-int mdoc_argv(struct mdoc *, int, int,
+enum margverr mdoc_argv(struct mdoc *, int, enum mdoct,
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 *);
-int mdoc_args(struct mdoc *, int,
+void mdoc_argn_free(struct mdoc_arg *, int);
+enum margserr mdoc_args(struct mdoc *, int,
+ int *, char *, enum mdoct, char **);
+enum margserr mdoc_zargs(struct mdoc *, int,
int *, char *, int, char **);
-#define ARGS_ERROR (-1)
-#define ARGS_EOLN (0)
-#define ARGS_WORD (1)
-#define ARGS_PUNCT (2)
-#define ARGS_QWORD (3)
-#define ARGS_PHRASE (4)
+#define ARGS_DELIM (1 << 1)
+#define ARGS_TABSEP (1 << 2)
+#define ARGS_NOWARN (1 << 3)
+#define ARGS_PPHRASED (1 << 4)
int mdoc_macroend(struct mdoc *);