X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/b96fa66b3bba1ea8e09fda0e994688409dbe30ce..2bcccf0dba8f2c504e9c3597a11177aaca90023c:/mdoc.h

diff --git a/mdoc.h b/mdoc.h
index 8c827ae3..dc4be587 100644
--- a/mdoc.h
+++ b/mdoc.h
@@ -1,136 +1,161 @@
-/* $Id: mdoc.h,v 1.32 2009/02/22 22:58:39 kristaps Exp $ */
+/*	$Id: mdoc.h,v 1.92 2010/06/26 15:36:37 kristaps Exp $ */
 /*
- * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009 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 copyright notice and this permission notice appear in all
- * copies.
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
  *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
- * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
- * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
- * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
- * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- * PERFORMANCE OF THIS SOFTWARE.
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 #ifndef MDOC_H
 #define MDOC_H
 
+/*
+ * This library implements a validating scanner/parser for ``mdoc'' roff
+ * macro documents, a.k.a. BSD manual page documents.  The mdoc.c file
+ * drives the parser, while macro.c describes the macro ontologies.
+ * validate.c pre- and post-validates parsed macros, and action.c
+ * performs actions on parsed and validated macros.
+ */
+
 /* What follows is a list of ALL possible macros. */
 
-#define	MDOC___	 	 0
-#define	MDOC_Dd		 1
-#define	MDOC_Dt		 2
-#define	MDOC_Os		 3
-#define	MDOC_Sh		 4
-#define	MDOC_Ss		 5
-#define	MDOC_Pp		 6
-#define	MDOC_D1		 7
-#define	MDOC_Dl		 8
-#define	MDOC_Bd		 9
-#define	MDOC_Ed		 10
-#define	MDOC_Bl		 11
-#define	MDOC_El		 12
-#define	MDOC_It		 13
-#define	MDOC_Ad		 14
-#define	MDOC_An		 15
-#define	MDOC_Ar		 16
-#define	MDOC_Cd		 17
-#define	MDOC_Cm		 18
-#define	MDOC_Dv		 19
-#define	MDOC_Er		 20
-#define	MDOC_Ev		 21
-#define	MDOC_Ex		 22
-#define	MDOC_Fa		 23
-#define	MDOC_Fd		 24
-#define	MDOC_Fl		 25
-#define	MDOC_Fn		 26
-#define	MDOC_Ft		 27
-#define	MDOC_Ic		 28
-#define	MDOC_In		 29
-#define	MDOC_Li		 30
-#define	MDOC_Nd		 31
-#define	MDOC_Nm		 32
-#define	MDOC_Op		 33
-#define	MDOC_Ot		 34
-#define	MDOC_Pa		 35
-#define	MDOC_Rv		 36
-#define	MDOC_St		 37
-#define	MDOC_Va		 38
-#define	MDOC_Vt		 39
-#define	MDOC_Xr		 40
-#define	MDOC__A		 41
-#define	MDOC__B		 42
-#define	MDOC__D		 43
-#define	MDOC__I		 44
-#define	MDOC__J		 45
-#define	MDOC__N		 46
-#define	MDOC__O		 47
-#define	MDOC__P		 48
-#define	MDOC__R		 49
-#define	MDOC__T		 50
-#define	MDOC__V		 51
-#define MDOC_Ac		 52
-#define MDOC_Ao		 53
-#define MDOC_Aq		 54
-#define MDOC_At		 55
-#define MDOC_Bc		 56
-#define MDOC_Bf		 57
-#define MDOC_Bo		 58
-#define MDOC_Bq		 59
-#define MDOC_Bsx	 60
-#define MDOC_Bx		 61
-#define MDOC_Db		 62
-#define MDOC_Dc		 63
-#define MDOC_Do		 64
-#define MDOC_Dq		 65
-#define MDOC_Ec		 66
-#define MDOC_Ef		 67
-#define MDOC_Em		 68
-#define MDOC_Eo		 69
-#define MDOC_Fx		 70
-#define MDOC_Ms		 71
-#define MDOC_No		 72
-#define MDOC_Ns		 73
-#define MDOC_Nx		 74
-#define MDOC_Ox		 75
-#define MDOC_Pc		 76
-#define MDOC_Pf		 77
-#define MDOC_Po		 78
-#define MDOC_Pq		 79
-#define MDOC_Qc		 80
-#define MDOC_Ql		 81
-#define MDOC_Qo		 82
-#define MDOC_Qq		 83
-#define MDOC_Re		 84
-#define MDOC_Rs		 85
-#define MDOC_Sc		 86
-#define MDOC_So		 87
-#define MDOC_Sq		 88
-#define MDOC_Sm		 89
-#define MDOC_Sx		 90
-#define MDOC_Sy		 91
-#define MDOC_Tn		 92
-#define MDOC_Ux		 93
-#define MDOC_Xc		 94
-#define MDOC_Xo		 95
-#define	MDOC_Fo		 96
-#define	MDOC_Fc		 97
-#define	MDOC_Oo		 98
-#define	MDOC_Oc		 99
-#define	MDOC_Bk		 100
-#define	MDOC_Ek		 101
-#define	MDOC_Bt		 102
-#define	MDOC_Hf		 103
-#define	MDOC_Fr		 104
-#define	MDOC_Ud		 105
-#define	MDOC_MAX	 106
+enum	mdoct {
+	MDOC_Ap = 0,
+	MDOC_Dd,
+	MDOC_Dt,
+	MDOC_Os,
+	MDOC_Sh,
+	MDOC_Ss,
+	MDOC_Pp,
+	MDOC_D1,
+	MDOC_Dl,
+	MDOC_Bd,
+	MDOC_Ed,
+	MDOC_Bl,
+	MDOC_El,
+	MDOC_It,
+	MDOC_Ad,
+	MDOC_An,
+	MDOC_Ar,
+	MDOC_Cd,
+	MDOC_Cm,
+	MDOC_Dv,
+	MDOC_Er,
+	MDOC_Ev,
+	MDOC_Ex,
+	MDOC_Fa,
+	MDOC_Fd,
+	MDOC_Fl,
+	MDOC_Fn,
+	MDOC_Ft,
+	MDOC_Ic,
+	MDOC_In,
+	MDOC_Li,
+	MDOC_Nd,
+	MDOC_Nm,
+	MDOC_Op,
+	MDOC_Ot,
+	MDOC_Pa,
+	MDOC_Rv,
+	MDOC_St,
+	MDOC_Va,
+	MDOC_Vt,
+	MDOC_Xr,
+	MDOC__A,
+	MDOC__B,
+	MDOC__D,
+	MDOC__I,
+	MDOC__J,
+	MDOC__N,
+	MDOC__O,
+	MDOC__P,
+	MDOC__R,
+	MDOC__T,
+	MDOC__V,
+	MDOC_Ac,
+	MDOC_Ao,
+	MDOC_Aq,
+	MDOC_At,
+	MDOC_Bc,
+	MDOC_Bf,
+	MDOC_Bo,
+	MDOC_Bq,
+	MDOC_Bsx,
+	MDOC_Bx,
+	MDOC_Db,
+	MDOC_Dc,
+	MDOC_Do,
+	MDOC_Dq,
+	MDOC_Ec,
+	MDOC_Ef,
+	MDOC_Em,
+	MDOC_Eo,
+	MDOC_Fx,
+	MDOC_Ms,
+	MDOC_No,
+	MDOC_Ns,
+	MDOC_Nx,
+	MDOC_Ox,
+	MDOC_Pc,
+	MDOC_Pf,
+	MDOC_Po,
+	MDOC_Pq,
+	MDOC_Qc,
+	MDOC_Ql,
+	MDOC_Qo,
+	MDOC_Qq,
+	MDOC_Re,
+	MDOC_Rs,
+	MDOC_Sc,
+	MDOC_So,
+	MDOC_Sq,
+	MDOC_Sm,
+	MDOC_Sx,
+	MDOC_Sy,
+	MDOC_Tn,
+	MDOC_Ux,
+	MDOC_Xc,
+	MDOC_Xo,
+	MDOC_Fo,
+	MDOC_Fc,
+	MDOC_Oo,
+	MDOC_Oc,
+	MDOC_Bk,
+	MDOC_Ek,
+	MDOC_Bt,
+	MDOC_Hf,
+	MDOC_Fr,
+	MDOC_Ud,
+	MDOC_Lb,
+	MDOC_Lp,
+	MDOC_Lk,
+	MDOC_Mt,
+	MDOC_Brq,
+	MDOC_Bro,
+	MDOC_Brc,
+	MDOC__C,
+	MDOC_Es,
+	MDOC_En,
+	MDOC_Dx,
+	MDOC__Q,
+	MDOC_br,
+	MDOC_sp,
+	MDOC__U,
+	MDOC_Ta,
+	MDOC_MAX
+};
 
 /* What follows is a list of ALL possible macro arguments. */
 
+/* FIXME: make this into an enum. */
 #define	MDOC_Split	 0
 #define	MDOC_Nosplit	 1
 #define	MDOC_Ragged	 2
@@ -152,80 +177,13 @@
 #define	MDOC_Width	 18
 #define	MDOC_Compact	 19
 #define	MDOC_Std	 20
-#define MDOC_p1003_1_88	 21
-#define MDOC_p1003_1_90	 22
-#define MDOC_p1003_1_96	 23
-#define MDOC_p1003_1_2001 24
-#define MDOC_p1003_1_2004 25
-#define MDOC_p1003_1	 26
-#define MDOC_p1003_1b	 27
-#define MDOC_p1003_1b_93 28
-#define MDOC_p1003_1c_95 29
-#define MDOC_p1003_1g_2000 30
-#define MDOC_p1003_2_92	 31
-#define MDOC_p1387_2_95	 32
-#define MDOC_p1003_2	 33
-#define MDOC_p1387_2	 34
-#define MDOC_isoC_90	 35
-#define MDOC_isoC_amd1	 36
-#define MDOC_isoC_tcor1	 37
-#define MDOC_isoC_tcor2	 38
-#define MDOC_isoC_99	 39
-#define MDOC_ansiC	 40
-#define MDOC_ansiC_89	 41
-#define MDOC_ansiC_99	 42
-#define MDOC_ieee754	 43
-#define MDOC_iso8802_3	 44
-#define MDOC_xpg3	 45
-#define MDOC_xpg4	 46
-#define MDOC_xpg4_2	 47
-#define MDOC_xpg4_3	 48
-#define MDOC_xbd5	 49
-#define MDOC_xcu5	 50
-#define MDOC_xsh5	 51
-#define MDOC_xns5	 52
-#define MDOC_xns5_2d2_0	 53
-#define MDOC_xcurses4_2	 54
-#define MDOC_susv2	 55
-#define MDOC_susv3	 56
-#define MDOC_svid4	 57
-#define	MDOC_Filled	 58
-#define	MDOC_Words	 59
-#define	MDOC_Emphasis	 60
-#define	MDOC_Symbolic	 61
-#define	MDOC_ARG_MAX	 62
-
-/* Warnings are either syntax or groff-compatibility. */
-enum	mdoc_warn {
-	WARN_SYNTAX,
-	WARN_COMPAT
-};
-
-/* Possible values for the `At' macro. */
-enum	mdoc_att {
-	ATT_DEFAULT = 0,
-	ATT_v1,
-	ATT_v2,
-	ATT_v3,
-	ATT_v4,
-	ATT_v5,
-	ATT_v6,
-	ATT_v7,
-	ATT_32v,
-	ATT_V1,
-	ATT_V2,
-	ATT_V3,
-	ATT_V4
-};
-
-/* An argument to a macro (multiple values = `It -column'). */
-struct	mdoc_arg {
-	int	  	  arg;
-	int		  line;
-	int		  pos;
-	size_t		  sz;
-	char		**value;
-};
+#define	MDOC_Filled	 21
+#define	MDOC_Words	 22
+#define	MDOC_Emphasis	 23
+#define	MDOC_Symbolic	 24
+#define	MDOC_Nested	 25
+#define	MDOC_Centred	 26
+#define	MDOC_ARG_MAX	 27
 
 /* Type of a syntax node. */
 enum	mdoc_type {
@@ -238,41 +196,21 @@ enum	mdoc_type {
 	MDOC_ROOT
 };
 
-/* Manual section. */
-enum	mdoc_msec {
-	MSEC_DEFAULT = 0,
-	MSEC_1,
-	MSEC_2,
-	MSEC_3,
-	MSEC_3f,
-	MSEC_3p,
-	MSEC_4,
-	MSEC_5,
-	MSEC_6,
-	MSEC_7,
-	MSEC_8,
-	MSEC_9,
-	MSEC_X11,
-	MSEC_X11R6,
-	MSEC_local,
-	MSEC_n,
-	MSEC_unass,
-	MSEC_draft,
-	MSEC_paper
-};
-
-/* Section (named/unnamed) of `Ss'. */
+/* Section (named/unnamed) of `Sh'. */
 enum	mdoc_sec {
-	SEC_PROLOGUE = 0,
-	SEC_BODY,
+	SEC_NONE,		/* No section, yet. */
 	SEC_NAME,
+	SEC_LIBRARY,
 	SEC_SYNOPSIS,
 	SEC_DESCRIPTION,
+	SEC_IMPLEMENTATION,
 	SEC_RETURN_VALUES,
-	SEC_ENVIRONMENT,
+	SEC_ENVIRONMENT, 
 	SEC_FILES,
+	SEC_EXIT_STATUS,
 	SEC_EXAMPLES,
 	SEC_DIAGNOSTICS,
+	SEC_COMPATIBILITY,
 	SEC_ERRORS,
 	SEC_SEE_ALSO,
 	SEC_STANDARDS,
@@ -280,155 +218,131 @@ enum	mdoc_sec {
 	SEC_AUTHORS,
 	SEC_CAVEATS,
 	SEC_BUGS,
-	SEC_CUSTOM
-};
-
-/* Volume of `Dt'. */
-enum	mdoc_vol {
-	VOL_DEFAULT = 0,
-	VOL_AMD,
-	VOL_IND,
-	VOL_KM,
-	VOL_LOCAL,
-	VOL_PRM,
-	VOL_PS1,
-	VOL_SMM,
-	VOL_URM,
-	VOL_USD
-};
-
-/* Architecture of `Dt'. */
-enum	mdoc_arch {
-	ARCH_DEFAULT = 0,
-	ARCH_alpha, 
-	ARCH_amd64, 
-	ARCH_amiga, 
-	ARCH_arc, 
-	ARCH_arm, 
-	ARCH_armish, 
-	ARCH_aviion, 
-	ARCH_hp300,
-	ARCH_hppa, 
-	ARCH_hppa64, 
-	ARCH_i386, 
-	ARCH_landisk, 
-	ARCH_luna88k, 
-	ARCH_mac68k, 
-	ARCH_macppc,
-	ARCH_mvme68k, 
-	ARCH_mvme88k, 
-	ARCH_mvmeppc, 
-	ARCH_pmax, 
-	ARCH_sgi, 
-	ARCH_socppc, 
-	ARCH_sparc,
-	ARCH_sparc64, 
-	ARCH_sun3, 
-	ARCH_vax, 
-	ARCH_zaurus
+	SEC_SECURITY,
+	SEC_CUSTOM,		/* User-defined. */
+	SEC__MAX
 };
 
 /* Information from prologue. */
 struct	mdoc_meta {
-	enum mdoc_msec	  msec;
-	enum mdoc_vol	  vol;
-	enum mdoc_arch	  arch;
+	char		 *msec;
+	char		 *vol;
+	char		 *arch;
 	time_t		  date;
 	char		 *title;
 	char		 *os;
 	char		 *name;
 };
 
-/* Text-only node. */
-struct	mdoc_text {
-	char		 *string;
+/* An argument to a macro (multiple values = `It -column'). */
+struct	mdoc_argv {
+	int	  	  arg;
+	int		  line;
+	int		  pos;
+	size_t		  sz;
+	char		**value;
 };
 
-/* Block (scoped) node. */
-struct	mdoc_block {
+struct 	mdoc_arg {
 	size_t		  argc;
-	struct mdoc_arg	 *argv;
-	struct mdoc_node *head;
-	struct mdoc_node *body;
-	struct mdoc_node *tail;
+	struct mdoc_argv *argv;
+	unsigned int	  refcnt;
 };
 
-/* In-line element node. */
-struct	mdoc_elem {
-	size_t		  sz;
-	char		**args;
-	size_t		  argc;
-	struct mdoc_arg	 *argv;
+enum	mdoc_list {
+	LIST__NONE = 0,
+	LIST_bullet,
+	LIST_column,
+	LIST_dash,
+	LIST_diag,
+	LIST_enum,
+	LIST_hang,
+	LIST_hyphen,
+	LIST_inset,
+	LIST_item,
+	LIST_ohang,
+	LIST_tag
+};
+
+enum	mdoc_disp {
+	DISP__NONE = 0,
+	DISP_centred,
+	DISP_ragged,
+	DISP_unfilled,
+	DISP_filled,
+	DISP_literal
+};
+
+struct	mdoc_bd {
+	const char	 *offs; /* -offset */
+	enum mdoc_disp	  type; /* -ragged, etc. */
+	int		  comp; /* -compact */
 };
 
-/* Typed nodes of an AST node. */
-union	mdoc_data {
-	struct mdoc_text  text;
-	struct mdoc_elem  elem;
-	struct mdoc_block block;
+struct	mdoc_bl {
+	const char	 *width; /* -width */
+	const char	 *offs; /* -offset */
+	enum mdoc_list	  type; /* -tag, -enum, etc. */
+	int		  comp; /* -compact */
 };
 
 /* Node in AST. */
 struct	mdoc_node {
-	struct mdoc_node *parent;
-	struct mdoc_node *child;
-	struct mdoc_node *next;
-	struct mdoc_node *prev;
-	int		  line;
-	int		  pos;
-	int		  tok;
+	struct mdoc_node *parent; /* parent AST node */
+	struct mdoc_node *child; /* first child AST node */
+	struct mdoc_node *next; /* sibling AST node */
+	struct mdoc_node *prev; /* prior sibling AST node */
+	int		  nchild; /* number children */
+	int		  line; /* parse line */
+	int		  pos; /* parse column */
+	enum mdoct	  tok; /* tok or MDOC__MAX if none */
 	int		  flags;
-#define	MDOC_VALID	 (1 << 0)
-#define	MDOC_ACTED	 (1 << 1)
-	enum mdoc_type	  type;
-	union mdoc_data	  data;
-	enum mdoc_sec	  sec;
+#define	MDOC_VALID	 (1 << 0) /* has been validated */
+#define	MDOC_ACTED	 (1 << 1) /* has been acted upon */
+#define	MDOC_EOS	 (1 << 2) /* at sentence boundary */
+#define	MDOC_LINE	 (1 << 3) /* first macro/text on line */
+	enum mdoc_type	  type; /* AST node type */
+	enum mdoc_sec	  sec; /* current named section */
+	struct mdoc_arg	 *args; 	/* BLOCK/ELEM */
+#ifdef	UGLY
+	struct mdoc_node *pending;	/* BLOCK */
+#endif
+	struct mdoc_node *head;		/* BLOCK */
+	struct mdoc_node *body;		/* BLOCK */
+	struct mdoc_node *tail;		/* BLOCK */
+	char		 *string;	/* TEXT */
+
+	union {
+		struct mdoc_bl Bl;
+		struct mdoc_bd Bd;
+	} data;
 };
 
-/* Call-backs for parse messages. */
-struct	mdoc_cb {
-	void	(*mdoc_msg)(void *, int, int, const char *);
-	int	(*mdoc_err)(void *, int, int, const char *);
-	int	(*mdoc_warn)(void *, int, int, 
-			enum mdoc_warn, const char *);
-};
+#define	MDOC_IGN_SCOPE	 (1 << 0) /* Ignore scope violations. */
+#define	MDOC_IGN_ESCAPE	 (1 << 1) /* Ignore bad escape sequences. */
+#define	MDOC_IGN_MACRO	 (1 << 2) /* Ignore unknown macros. */
 
-/* Global table of macro names (`Bd', `Ed', etc.). */
-extern	const char *const *mdoc_macronames;
+/* See mdoc.3 for documentation. */
 
-/* Global table of argument names (`column', `tag', etc.). */
+extern	const char *const *mdoc_macronames;
 extern	const char *const *mdoc_argnames;
 
 __BEGIN_DECLS
 
 struct	mdoc;
 
-/* Free memory allocated with mdoc_alloc. */
-void	 	  mdoc_free(struct mdoc *);
-
-/* Allocate a new parser instance. */
-struct	mdoc	 *mdoc_alloc(void *data, const struct mdoc_cb *);
-
-/* Parse a single line in a stream (boolean retval). */
-int	 	  mdoc_parseln(struct mdoc *, int, char *buf);
+/* See mdoc.3 for documentation. */
 
-/* Get result first node (after mdoc_endparse!). */
+void	 	  mdoc_free(struct mdoc *);
+struct	mdoc	 *mdoc_alloc(void *, int, mandocmsg);
+void		  mdoc_reset(struct mdoc *);
+int	 	  mdoc_parseln(struct mdoc *, 
+			const struct regset *,
+			int, char *, int);
 const struct mdoc_node *mdoc_node(const struct mdoc *);
-
-/* Get result meta-information (after mdoc_endparse!). */
 const struct mdoc_meta *mdoc_meta(const struct mdoc *);
-
-/* Signal end of parse sequence (boolean retval). */
 int		  mdoc_endparse(struct mdoc *);
 
-const char 	 *mdoc_arch2a(enum mdoc_arch);
-
-const char 	 *mdoc_vol2a(enum mdoc_vol);
-
-const char 	 *mdoc_msec2a(enum mdoc_msec);
-
-int		  mdoc_isdelim(const char *);
-
 __END_DECLS
 
 #endif /*!MDOC_H*/