X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/f24d1eb949107ccd1cf44312815cdf8e34915d21..92d36306307652f916347656b5c31928db651c45:/libmdoc.h

diff --git a/libmdoc.h b/libmdoc.h
index eca0f54d..eb917524 100644
--- a/libmdoc.h
+++ b/libmdoc.h
@@ -1,6 +1,6 @@
-/*	$Id: libmdoc.h,v 1.25 2009/08/20 08:59:12 kristaps Exp $ */
+/*	$Id: libmdoc.h,v 1.62 2010/08/20 01:02:07 schwarze Exp $ */
 /*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -25,79 +25,32 @@ enum	mdoc_next {
 };
 
 struct	mdoc {
-	void		 *data;
-	struct mdoc_cb	  cb;
-	void		 *htab;
+	void		 *data; /* private application data */
+	mandocmsg	  msg; /* message callback */
 	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;
+#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 regset	 *regs; /* registers */
 };
 
-enum	merr {
-	ETAILWS = 0,
-	EQUOTPARM,
-	EQUOTTERM,
-	EMALLOC,
-	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,
-	MERRMAX
-};
-
-#define	MACRO_PROT_ARGS	struct mdoc *m, 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);
@@ -110,77 +63,86 @@ struct	mdoc_macro {
 	/* Reserved words in arguments treated as text. */
 };
 
-extern	const struct mdoc_macro *const mdoc_macros;
+enum	margserr {
+	ARGS_ERROR,
+	ARGS_EOLN,
+	ARGS_WORD,
+	ARGS_PUNCT,
+	ARGS_QWORD,
+	ARGS_PHRASE,
+	ARGS_PPHRASE,
+	ARGS_PEND
+};
 
-__BEGIN_DECLS
+enum	margverr {
+	ARGV_ERROR,
+	ARGV_EOLN,
+	ARGV_ARG,
+	ARGV_WORD
+};
 
-#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))
+enum	mdelim {
+	DELIM_NONE = 0,
+	DELIM_OPEN,
+	DELIM_MIDDLE,
+	DELIM_CLOSE
+};
 
-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 *, ...);
+extern	const struct mdoc_macro *const mdoc_macros;
+
+__BEGIN_DECLS
 
+#define		  mdoc_pmsg(m, l, p, t) \
+		  (*(m)->msg)((t), (m)->data, (l), (p), NULL)
+#define		  mdoc_nmsg(m, n, t) \
+		  (*(m)->msg)((t), (m)->data, (n)->line, (n)->pos, NULL)
+int		  mdoc_vmsg(struct mdoc *, enum mandocerr, 
+			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 *);
-int		  mdoc_iscdelim(char);
-int		  mdoc_isdelim(const char *);
+			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);
+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 *);
+void		  mdoc_hash_init(void);
+enum mdoct	  mdoc_hash_find(const char *);
+enum mdelim	  mdoc_iscdelim(char);
+enum mdelim	  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_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 *);
+			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,
-			int *, char *, int, char **);
-int		  mdoc_zargs(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_DELIM	(1 << 1)
 #define	ARGS_TABSEP	(1 << 2)
 #define	ARGS_NOWARN	(1 << 3)
-#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