X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/6e133feff5b8dab64f8a349610b937c9502008a4..f1120c542b0577e236401251c9af324555049408:/libmdoc.h?ds=sidebyside

diff --git a/libmdoc.h b/libmdoc.h
index 880d7ea5..9d03e084 100644
--- a/libmdoc.h
+++ b/libmdoc.h
@@ -1,6 +1,6 @@
-/*	$Id: libmdoc.h,v 1.7 2009/06/10 20:18:43 kristaps Exp $ */
+/*	$Id: libmdoc.h,v 1.79 2012/05/27 17:48:57 schwarze Exp $ */
 /*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010, 2011 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
@@ -17,32 +17,38 @@
 #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;
-	void		 *htab;
-	int		  flags;
-#define	MDOC_HALT	 (1 << 0)
-#define	MDOC_LITERAL	 (1 << 1)
-	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;
 };
 
-
-#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);
@@ -55,96 +61,81 @@ struct	mdoc_macro {
 	/* Reserved words in arguments treated as text. */
 };
 
-#define	mdoc_nwarn(mdoc, node, type, fmt, ...) \
-		  mdoc_vwarn((mdoc), (node)->line, \
-		  (node)->pos, (type), (fmt), ##__VA_ARGS__)
-
-#define	mdoc_nerr(mdoc, node, fmt, ...) \
-		  mdoc_verr((mdoc), (node)->line, \
-		  (node)->pos, (fmt), ##__VA_ARGS__)
-
-#define	mdoc_warn(mdoc, type, fmt, ...) \
-		  mdoc_vwarn((mdoc), (mdoc)->last->line, \
-		  (mdoc)->last->pos, (type), (fmt), ##__VA_ARGS__)
-
-#define	mdoc_err(mdoc, fmt, ...) \
-		  mdoc_verr((mdoc), (mdoc)->last->line, \
-		  (mdoc)->last->pos, (fmt), ##__VA_ARGS__)
-
-#define	mdoc_msg(mdoc, fmt, ...) \
-		  mdoc_vmsg((mdoc), (mdoc)->last->line, \
-		  (mdoc)->last->pos, (fmt), ##__VA_ARGS__)
-
-#define	mdoc_pmsg(mdoc, line, pos, fmt, ...) \
-		  mdoc_vmsg((mdoc), (line), \
-	  	  (pos), (fmt), ##__VA_ARGS__)
+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) */
+};
 
-#define	mdoc_pwarn(mdoc, line, pos, type, fmt, ...) \
-		  mdoc_vwarn((mdoc), (line), \
-	  	  (pos), (type), (fmt), ##__VA_ARGS__)
+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(mdoc, line, pos, fmt, ...) \
-		  mdoc_verr((mdoc), (line), \
-	  	  (pos), (fmt), ##__VA_ARGS__)
+/*
+ * 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
 
-int		  mdoc_vwarn(struct mdoc *, int, int, 
-			enum mdoc_warn, const char *, ...);
-void		  mdoc_vmsg(struct mdoc *, int, int, 
-			const char *, ...);
-int		  mdoc_verr(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 *);
 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 *);
-size_t		  mdoc_isescape(const char *);
-enum	mdoc_sec  mdoc_atosec(const char *);
-time_t		  mdoc_atotime(const char *);
-
-size_t		  mdoc_macro2len(int);
+			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 *);
+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 *);
-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 **);
-#define	ARGS_ERROR	(-1)
-#define	ARGS_EOLN	(0)
-#define	ARGS_WORD	(1)
-#define	ARGS_PUNCT	(2)
-#define	ARGS_QWORD	(3)
-#define	ARGS_PHRASE	(4)
-
+enum margserr	  mdoc_args(struct mdoc *, int,
+			int *, char *, enum mdoct, char **);
+enum margserr	  mdoc_zargs(struct mdoc *, int, 
+			int *, char *, char **);
 int		  mdoc_macroend(struct mdoc *);
+enum mdelim	  mdoc_isdelim(const char *);
 
 __END_DECLS