xref: /illumos-gate/usr/src/cmd/mandoc/eqn_parse.h (revision cec8643b)
1*cec8643bSMichal Nowak /*	$Id: eqn_parse.h,v 1.3 2018/12/14 06:33:14 schwarze Exp $ */
2*cec8643bSMichal Nowak /*
3*cec8643bSMichal Nowak  * Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4*cec8643bSMichal Nowak  * Copyright (c) 2014, 2017, 2018 Ingo Schwarze <schwarze@openbsd.org>
5*cec8643bSMichal Nowak  *
6*cec8643bSMichal Nowak  * Permission to use, copy, modify, and distribute this software for any
7*cec8643bSMichal Nowak  * purpose with or without fee is hereby granted, provided that the above
8*cec8643bSMichal Nowak  * copyright notice and this permission notice appear in all copies.
9*cec8643bSMichal Nowak  *
10*cec8643bSMichal Nowak  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
11*cec8643bSMichal Nowak  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12*cec8643bSMichal Nowak  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
13*cec8643bSMichal Nowak  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14*cec8643bSMichal Nowak  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15*cec8643bSMichal Nowak  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16*cec8643bSMichal Nowak  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17*cec8643bSMichal Nowak  *
18*cec8643bSMichal Nowak  * External interface of the eqn(7) parser.
19*cec8643bSMichal Nowak  * For use in the roff(7) and eqn(7) parsers only.
20*cec8643bSMichal Nowak  */
21*cec8643bSMichal Nowak 
22*cec8643bSMichal Nowak struct roff_node;
23*cec8643bSMichal Nowak struct eqn_box;
24*cec8643bSMichal Nowak struct eqn_def;
25*cec8643bSMichal Nowak 
26*cec8643bSMichal Nowak struct	eqn_node {
27*cec8643bSMichal Nowak 	struct roff_node *node;    /* Syntax tree of this equation. */
28*cec8643bSMichal Nowak 	struct eqn_def	 *defs;    /* Array of definitions. */
29*cec8643bSMichal Nowak 	char		 *data;    /* Source code of this equation. */
30*cec8643bSMichal Nowak 	char		 *start;   /* First byte of the current token. */
31*cec8643bSMichal Nowak 	char		 *end;	   /* First byte of the next token. */
32*cec8643bSMichal Nowak 	size_t		  defsz;   /* Number of definitions. */
33*cec8643bSMichal Nowak 	size_t		  sz;      /* Length of the source code. */
34*cec8643bSMichal Nowak 	size_t		  toksz;   /* Length of the current token. */
35*cec8643bSMichal Nowak 	int		  gsize;   /* Default point size. */
36*cec8643bSMichal Nowak 	int		  delim;   /* In-line delimiters enabled. */
37*cec8643bSMichal Nowak 	char		  odelim;  /* In-line opening delimiter. */
38*cec8643bSMichal Nowak 	char		  cdelim;  /* In-line closing delimiter. */
39*cec8643bSMichal Nowak };
40*cec8643bSMichal Nowak 
41*cec8643bSMichal Nowak 
42*cec8643bSMichal Nowak struct eqn_node	*eqn_alloc(void);
43*cec8643bSMichal Nowak struct eqn_box	*eqn_box_new(void);
44*cec8643bSMichal Nowak void		 eqn_box_free(struct eqn_box *);
45*cec8643bSMichal Nowak void		 eqn_free(struct eqn_node *);
46*cec8643bSMichal Nowak void		 eqn_parse(struct eqn_node *);
47*cec8643bSMichal Nowak void		 eqn_read(struct eqn_node *, const char *);
48*cec8643bSMichal Nowak void		 eqn_reset(struct eqn_node *);
49