xref: /freebsd/contrib/mandoc/eqn.h (revision 7648bc9fee8dec6cb3c4941e0165a930fbe8dcb0)
1*7295610fSBaptiste Daroussin /*	$Id: eqn.h,v 1.1 2018/12/13 05:23:38 schwarze Exp $ */
2*7295610fSBaptiste Daroussin /*
3*7295610fSBaptiste Daroussin  * Copyright (c) 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
4*7295610fSBaptiste Daroussin  *
5*7295610fSBaptiste Daroussin  * Permission to use, copy, modify, and distribute this software for any
6*7295610fSBaptiste Daroussin  * purpose with or without fee is hereby granted, provided that the above
7*7295610fSBaptiste Daroussin  * copyright notice and this permission notice appear in all copies.
8*7295610fSBaptiste Daroussin  *
9*7295610fSBaptiste Daroussin  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
10*7295610fSBaptiste Daroussin  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11*7295610fSBaptiste Daroussin  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
12*7295610fSBaptiste Daroussin  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13*7295610fSBaptiste Daroussin  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14*7295610fSBaptiste Daroussin  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15*7295610fSBaptiste Daroussin  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16*7295610fSBaptiste Daroussin  *
17*7295610fSBaptiste Daroussin  * Public data types for eqn(7) syntax trees.
18*7295610fSBaptiste Daroussin  */
19*7295610fSBaptiste Daroussin 
20*7295610fSBaptiste Daroussin enum	eqn_boxt {
21*7295610fSBaptiste Daroussin 	EQN_TEXT,	/* Text, e.g. number, variable, operator, ... */
22*7295610fSBaptiste Daroussin 	EQN_SUBEXPR,	/* Nested eqn(7) subexpression. */
23*7295610fSBaptiste Daroussin 	EQN_LIST,	/* List, for example in braces. */
24*7295610fSBaptiste Daroussin 	EQN_PILE,	/* Vertical pile. */
25*7295610fSBaptiste Daroussin 	EQN_MATRIX	/* List of columns. */
26*7295610fSBaptiste Daroussin };
27*7295610fSBaptiste Daroussin 
28*7295610fSBaptiste Daroussin enum	eqn_fontt {
29*7295610fSBaptiste Daroussin 	EQNFONT_NONE = 0,
30*7295610fSBaptiste Daroussin 	EQNFONT_ROMAN,
31*7295610fSBaptiste Daroussin 	EQNFONT_BOLD,
32*7295610fSBaptiste Daroussin 	EQNFONT_FAT,
33*7295610fSBaptiste Daroussin 	EQNFONT_ITALIC,
34*7295610fSBaptiste Daroussin 	EQNFONT__MAX
35*7295610fSBaptiste Daroussin };
36*7295610fSBaptiste Daroussin 
37*7295610fSBaptiste Daroussin enum	eqn_post {
38*7295610fSBaptiste Daroussin 	EQNPOS_NONE = 0,
39*7295610fSBaptiste Daroussin 	EQNPOS_SUP,
40*7295610fSBaptiste Daroussin 	EQNPOS_SUBSUP,
41*7295610fSBaptiste Daroussin 	EQNPOS_SUB,
42*7295610fSBaptiste Daroussin 	EQNPOS_TO,
43*7295610fSBaptiste Daroussin 	EQNPOS_FROM,
44*7295610fSBaptiste Daroussin 	EQNPOS_FROMTO,
45*7295610fSBaptiste Daroussin 	EQNPOS_OVER,
46*7295610fSBaptiste Daroussin 	EQNPOS_SQRT,
47*7295610fSBaptiste Daroussin 	EQNPOS__MAX
48*7295610fSBaptiste Daroussin };
49*7295610fSBaptiste Daroussin 
50*7295610fSBaptiste Daroussin  /*
51*7295610fSBaptiste Daroussin  * A "box" is a parsed mathematical expression as defined by the eqn.7
52*7295610fSBaptiste Daroussin  * grammar.
53*7295610fSBaptiste Daroussin  */
54*7295610fSBaptiste Daroussin struct	eqn_box {
55*7295610fSBaptiste Daroussin 	struct eqn_box	 *parent;
56*7295610fSBaptiste Daroussin 	struct eqn_box	 *prev;
57*7295610fSBaptiste Daroussin 	struct eqn_box	 *next;
58*7295610fSBaptiste Daroussin 	struct eqn_box	 *first;   /* First child node. */
59*7295610fSBaptiste Daroussin 	struct eqn_box	 *last;    /* Last child node. */
60*7295610fSBaptiste Daroussin 	char		 *text;    /* Text (or NULL). */
61*7295610fSBaptiste Daroussin 	char		 *left;    /* Left-hand fence. */
62*7295610fSBaptiste Daroussin 	char		 *right;   /* Right-hand fence. */
63*7295610fSBaptiste Daroussin 	char		 *top;     /* Symbol above. */
64*7295610fSBaptiste Daroussin 	char		 *bottom;  /* Symbol below. */
65*7295610fSBaptiste Daroussin 	size_t		  expectargs; /* Maximal number of arguments. */
66*7295610fSBaptiste Daroussin 	size_t		  args;    /* Actual number of arguments. */
67*7295610fSBaptiste Daroussin 	int		  size;    /* Font size. */
68*7295610fSBaptiste Daroussin #define	EQN_DEFSIZE	  INT_MIN
69*7295610fSBaptiste Daroussin 	enum eqn_boxt	  type;    /* Type of node. */
70*7295610fSBaptiste Daroussin 	enum eqn_fontt	  font;    /* Font in this box. */
71*7295610fSBaptiste Daroussin 	enum eqn_post	  pos;     /* Position of the next box. */
72*7295610fSBaptiste Daroussin };
73