X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/59221c379641a8d3a180c8b0cca2022c763c2a6b..8765ed73026f2c53a95c98e2c9cfed27a5de90a6:/mdoc.h

diff --git a/mdoc.h b/mdoc.h
index 69a11005..ebe4391e 100644
--- a/mdoc.h
+++ b/mdoc.h
@@ -1,246 +1,182 @@
-/*	$Id: mdoc.h,v 1.110 2010/12/24 14:00:40 kristaps Exp $ */
+/*	$Id: mdoc.h,v 1.144 2015/11/07 14:01:16 schwarze Exp $ */
 /*
- * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
  *
  * 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.
  *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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
 
-/* 
- * What follows is a list of ALL possible macros. 
- */
-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
-};
+#define	MDOC_Ap    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_Lb  106
+#define	MDOC_Lp  107
+#define	MDOC_Lk  108
+#define	MDOC_Mt  109
+#define	MDOC_Brq 110
+#define	MDOC_Bro 111
+#define	MDOC_Brc 112
+#define	MDOC__C  113
+#define	MDOC_Es  114
+#define	MDOC_En  115
+#define	MDOC_Dx  116
+#define	MDOC__Q  117
+#define	MDOC_br  118
+#define	MDOC_sp  119
+#define	MDOC__U  120
+#define	MDOC_Ta  121
+#define	MDOC_ll  122
+#define	MDOC_MAX 123
 
-/* 
- * What follows is a list of ALL possible macro arguments. 
- */
 enum	mdocargt {
-	MDOC_Split,
-	MDOC_Nosplit,
-	MDOC_Ragged,
-	MDOC_Unfilled,
-	MDOC_Literal,
-	MDOC_File,
-	MDOC_Offset,
-	MDOC_Bullet,
-	MDOC_Dash,
-	MDOC_Hyphen,
-	MDOC_Item,
-	MDOC_Enum,
-	MDOC_Tag,
-	MDOC_Diag,
-	MDOC_Hang,
-	MDOC_Ohang,
-	MDOC_Inset,
-	MDOC_Column,
-	MDOC_Width,
-	MDOC_Compact,
-	MDOC_Std,
-	MDOC_Filled,
-	MDOC_Words,
-	MDOC_Emphasis,
-	MDOC_Symbolic,
-	MDOC_Nested,
-	MDOC_Centred,
+	MDOC_Split, /* -split */
+	MDOC_Nosplit, /* -nospli */
+	MDOC_Ragged, /* -ragged */
+	MDOC_Unfilled, /* -unfilled */
+	MDOC_Literal, /* -literal */
+	MDOC_File, /* -file */
+	MDOC_Offset, /* -offset */
+	MDOC_Bullet, /* -bullet */
+	MDOC_Dash, /* -dash */
+	MDOC_Hyphen, /* -hyphen */
+	MDOC_Item, /* -item */
+	MDOC_Enum, /* -enum */
+	MDOC_Tag, /* -tag */
+	MDOC_Diag, /* -diag */
+	MDOC_Hang, /* -hang */
+	MDOC_Ohang, /* -ohang */
+	MDOC_Inset, /* -inset */
+	MDOC_Column, /* -column */
+	MDOC_Width, /* -width */
+	MDOC_Compact, /* -compact */
+	MDOC_Std, /* -std */
+	MDOC_Filled, /* -filled */
+	MDOC_Words, /* -words */
+	MDOC_Emphasis, /* -emphasis */
+	MDOC_Symbolic, /* -symbolic */
+	MDOC_Nested, /* -nested */
+	MDOC_Centred, /* -centered */
 	MDOC_ARG_MAX
 };
 
-/* 
- * Type of a syntax node. 
- */
-enum	mdoc_type {
-	MDOC_TEXT,
-	MDOC_ELEM,
-	MDOC_HEAD,
-	MDOC_TAIL,
-	MDOC_BODY,
-	MDOC_BLOCK,
-	MDOC_ROOT
-};
-
-/* 
- * Section (named/unnamed) of `Sh'.   Note that these appear in the
- * conventional order imposed by mdoc.7.
- */
-enum	mdoc_sec {
-	SEC_NONE = 0, /* No section, yet. */
-	SEC_NAME,
-	SEC_LIBRARY,
-	SEC_SYNOPSIS,
-	SEC_DESCRIPTION,
-	SEC_IMPLEMENTATION,
-	SEC_RETURN_VALUES,
-	SEC_ENVIRONMENT, 
-	SEC_FILES,
-	SEC_EXIT_STATUS,
-	SEC_EXAMPLES,
-	SEC_DIAGNOSTICS,
-	SEC_COMPATIBILITY,
-	SEC_ERRORS,
-	SEC_SEE_ALSO,
-	SEC_STANDARDS,
-	SEC_HISTORY,
-	SEC_AUTHORS,
-	SEC_CAVEATS,
-	SEC_BUGS,
-	SEC_SECURITY,
-	SEC_CUSTOM, /* User-defined. */
-	SEC__MAX
-};
-
-/* 
- * Information from prologue. 
- */
-struct	mdoc_meta {
-	char		 *msec; /* `Dt' section (1, 3p, etc.) */
-	char		 *vol; /* `Dt' volume (implied) */
-	char		 *arch; /* `Dt' arch (i386, etc.) */
-	time_t		  date; /* `Dd' normalised date */
-	char		 *title; /* `Dt' title (FOO, etc.) */
-	char		 *os; /* `Os' system (OpenBSD, etc.) */
-	char		 *name; /* leading `Nm' name */
-};
-
-/* 
- * An argument to a macro (multiple values = `-column xxx yyy'). 
+/*
+ * An argument to a macro (multiple values = `-column xxx yyy').
  */
 struct	mdoc_argv {
-	enum mdocargt  	  arg; /* type of argument */
+	enum mdocargt	  arg; /* type of argument */
 	int		  line;
 	int		  pos;
 	size_t		  sz; /* elements in "value" */
@@ -252,84 +188,56 @@ struct	mdoc_argv {
  * blocks have multiple instances of the same arguments spread across
  * the HEAD, BODY, TAIL, and BLOCK node types.
  */
-struct 	mdoc_arg {
+struct	mdoc_arg {
 	size_t		  argc;
 	struct mdoc_argv *argv;
 	unsigned int	  refcnt;
 };
 
-/*
- * Indicates that a BODY's formatting has ended, but the scope is still
- * open.  Used for syntax-broken blocks.
- */
-enum	mdoc_endbody {
-	ENDBODY_NOT = 0,
-	ENDBODY_SPACE, /* is broken: append a space */
-	ENDBODY_NOSPACE /* is broken: don't append a space */
-};
-
-/*
- * Normalised `Bl' list type.
- */
 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,
+	LIST_bullet, /* -bullet */
+	LIST_column, /* -column */
+	LIST_dash, /* -dash */
+	LIST_diag, /* -diag */
+	LIST_enum, /* -enum */
+	LIST_hang, /* -hang */
+	LIST_hyphen, /* -hyphen */
+	LIST_inset, /* -inset */
+	LIST_item, /* -item */
+	LIST_ohang, /* -ohang */
+	LIST_tag, /* -tag */
 	LIST_MAX
 };
 
-/*
- * Normalised `Bd' display type.
- */
 enum	mdoc_disp {
 	DISP__NONE = 0,
-	DISP_centred,
-	DISP_ragged,
-	DISP_unfilled,
-	DISP_filled,
-	DISP_literal
+	DISP_centered, /* -centered */
+	DISP_ragged, /* -ragged */
+	DISP_unfilled, /* -unfilled */
+	DISP_filled, /* -filled */
+	DISP_literal /* -literal */
 };
 
-/*
- * Normalised `An' splitting argument. 
- */
 enum	mdoc_auth {
 	AUTH__NONE = 0,
-	AUTH_split,
-	AUTH_nosplit
+	AUTH_split, /* -split */
+	AUTH_nosplit /* -nosplit */
 };
 
-/*
- * Normalised `Bf' font type.
- */
 enum	mdoc_font {
 	FONT__NONE = 0,
-	FONT_Em,
-	FONT_Li,
-	FONT_Sy
+	FONT_Em, /* Em, -emphasis */
+	FONT_Li, /* Li, -literal */
+	FONT_Sy /* Sy, -symbolic */
 };
 
-/*
- * Normalised arguments for `Bd'.
- */
 struct	mdoc_bd {
 	const char	 *offs; /* -offset */
 	enum mdoc_disp	  type; /* -ragged, etc. */
 	int		  comp; /* -compact */
 };
 
-/*
- * Normalised arguments for `Bl'.
- */
 struct	mdoc_bl {
 	const char	 *width; /* -width */
 	const char	 *offs; /* -offset */
@@ -337,92 +245,40 @@ struct	mdoc_bl {
 	int		  comp; /* -compact */
 	size_t		  ncols; /* -column arg count */
 	const char	**cols; /* -column val ptr */
+	int		  count; /* -enum counter */
 };
 
-/*
- * Normalised arguments for `Bf'.
- */
 struct	mdoc_bf {
 	enum mdoc_font	  font; /* font */
 };
 
-/*
- * Normalised arguments for `An'.
- */
 struct	mdoc_an {
 	enum mdoc_auth	  auth; /* -split, etc. */
 };
 
+struct	mdoc_rs {
+	int		  quote_T; /* whether to quote %T */
+};
+
 /*
  * Consists of normalised node arguments.  These should be used instead
  * of iterating through the mdoc_arg pointers of a node: defaults are
  * provided, etc.
  */
 union	mdoc_data {
-	struct mdoc_an 	  An;
+	struct mdoc_an	  An;
 	struct mdoc_bd	  Bd;
 	struct mdoc_bf	  Bf;
 	struct mdoc_bl	  Bl;
+	struct roff_node *Es;
+	struct mdoc_rs	  Rs;
 };
 
-/* 
- * Single node in tree-linked AST. 
- */
-struct	mdoc_node {
-	struct mdoc_node *parent; /* parent AST node */
-	struct mdoc_node *child; /* first child AST node */
-	struct mdoc_node *last; /* last 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) /* 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 */
-#define	MDOC_SYNPRETTY	 (1 << 4) /* SYNOPSIS-style formatting */
-#define	MDOC_ENDED	 (1 << 5) /* rendering has been ended */
-	enum mdoc_type	  type; /* AST node type */
-	enum mdoc_sec	  sec; /* current named section */
-	union mdoc_data	 *norm; /* normalised args */
-	/* FIXME: these can be union'd to shave a few bytes. */
-	struct mdoc_arg	 *args; /* BLOCK/ELEM */
-	struct mdoc_node *pending; /* BLOCK */
-	struct mdoc_node *head; /* BLOCK */
-	struct mdoc_node *body; /* BLOCK */
-	struct mdoc_node *tail; /* BLOCK */
-	char		 *string; /* TEXT */
-	enum mdoc_endbody end; /* BODY */
-};
-
-/*
- * Names of macros.  Index is enum mdoct.  Indexing into this returns
- * the normalised name, e.g., mdoc_macronames[MDOC_Sh] -> "Sh".
- */
+/* Names of macros. */
 extern	const char *const *mdoc_macronames;
 
-/*
- * Names of macro args.  Index is enum mdocargt.  Indexing into this
- * returns the normalised name, e.g., mdoc_argnames[MDOC_File] ->
- * "file".
- */
+/* Names of macro args.  Index is enum mdocargt. */
 extern	const char *const *mdoc_argnames;
 
-__BEGIN_DECLS
-
-struct	mdoc;
-
-void	 	  mdoc_free(struct mdoc *);
-struct	mdoc	 *mdoc_alloc(struct regset *, void *, mandocmsg);
-void		  mdoc_reset(struct mdoc *);
-int	 	  mdoc_parseln(struct mdoc *, int, char *, int);
-const struct mdoc_node *mdoc_node(const struct mdoc *);
-const struct mdoc_meta *mdoc_meta(const struct mdoc *);
-int		  mdoc_endparse(struct mdoc *);
-
-__END_DECLS
 
-#endif /*!MDOC_H*/
+void		 mdoc_validate(struct roff_man *);