=================================================================== RCS file: /cvs/mandoc/libmdoc.h,v retrieving revision 1.37 retrieving revision 1.80 diff -u -p -r1.37 -r1.80 --- mandoc/libmdoc.h 2010/05/07 05:54:09 1.37 +++ mandoc/libmdoc.h 2012/07/18 11:11:12 1.80 @@ -1,6 +1,6 @@ -/* $Id: libmdoc.h,v 1.37 2010/05/07 05:54:09 kristaps Exp $ */ +/* $Id: libmdoc.h,v 1.80 2012/07/18 11:11:12 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -17,89 +17,39 @@ #ifndef LIBMDOC_H #define LIBMDOC_H -#include "mdoc.h" - enum mdoc_next { MDOC_NEXT_SIBLING = 0, MDOC_NEXT_CHILD }; struct mdoc { - void *data; - struct mdoc_cb cb; - 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. */ - int pflags; - enum mdoc_next next; - struct mdoc_node *last; - struct mdoc_node *first; - struct mdoc_meta meta; + struct mparse *parse; /* parse pointer */ + char *defos; /* default argument for .Os */ + int flags; /* parse 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_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 */ + 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_meta meta; /* document meta-data */ enum mdoc_sec lastnamed; enum mdoc_sec lastsec; + struct roff *roff; }; -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, - EBADMSEC, - EBADSEC, - EFONT, - EBADDATE, - ENUMFMT, - ENOWIDTH, - EUTSNAME, - EOBS, - EIMPBRK, - EIGNE, - EOPEN, - EQUOTPHR, - ENOCTX, - ELIB, - EBADCHILD, - ENOTYPE, - EBADCOMMENT, - MERRMAX -}; +#define MACRO_PROT_ARGS struct mdoc *m, \ + enum mdoct 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); int flags; @@ -113,37 +63,47 @@ struct mdoc_macro { enum margserr { ARGS_ERROR, - ARGS_EOLN, - ARGS_WORD, - ARGS_PUNCT, - ARGS_QWORD, - ARGS_PHRASE + 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) */ }; enum margverr { ARGV_ERROR, - ARGV_EOLN, - ARGV_ARG, - ARGV_WORD + 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" + * punctuation. These govern spacing. + * Opening punctuation (e.g., the opening parenthesis) suppresses the + * following space; closing punctuation (e.g., the closing parenthesis) + * suppresses the leading space; middle punctuation (e.g., the vertical + * bar) can do either. The middle punctuation delimiter bends the rules + * depending on usage. + */ +enum mdelim { + DELIM_NONE = 0, + DELIM_OPEN, + DELIM_MIDDLE, + DELIM_CLOSE, + DELIM_MAX +}; + extern const struct mdoc_macro *const mdoc_macros; __BEGIN_DECLS -#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 *, ...); - +#define mdoc_pmsg(m, l, p, t) \ + mandoc_msg((t), (m)->parse, (l), (p), NULL) +#define mdoc_nmsg(m, n, t) \ + mandoc_msg((t), (m)->parse, (n)->line, (n)->pos, NULL) int mdoc_macro(MACRO_PROT_ARGS); int mdoc_word_alloc(struct mdoc *, int, int, const char *); @@ -154,41 +114,29 @@ int mdoc_block_alloc(struct mdoc *, int, int, 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); +int mdoc_endbody_alloc(struct mdoc *m, int line, int pos, + enum mdoct tok, struct mdoc_node *body, + enum mdoc_endbody end); void mdoc_node_delete(struct mdoc *, struct mdoc_node *); +int mdoc_node_relink(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 *); -time_t mdoc_atotime(const char *); - -size_t mdoc_macro2len(int); 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_valid_pre(struct mdoc *, - const struct mdoc_node *); +int mdoc_valid_pre(struct mdoc *, 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 *); enum margverr mdoc_argv(struct mdoc *, int, enum mdoct, struct mdoc_arg **, int *, char *); void mdoc_argv_free(struct mdoc_arg *); -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_DELIM (1 << 1) /* See args(). */ -#define ARGS_TABSEP (1 << 2) /* See args(). */ -#define ARGS_NOWARN (1 << 3) /* See args(). */ - + int *, char *, char **); int mdoc_macroend(struct mdoc *); +enum mdelim mdoc_isdelim(const char *); __END_DECLS