Annotation of src/usr.bin/mandoc/mdoc.h, Revision 1.70
1.70 ! schwarze 1: /* $OpenBSD: mdoc.h,v 1.69 2015/11/07 13:57:55 schwarze Exp $ */
1.1 kristaps 2: /*
1.42 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.61 schwarze 4: * Copyright (c) 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: *
6: * Permission to use, copy, modify, and distribute this software for any
1.2 schwarze 7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 9: *
1.62 schwarze 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.2 schwarze 11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.62 schwarze 12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.2 schwarze 13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 17: */
18:
1.32 schwarze 19: enum mdocargt {
1.46 schwarze 20: MDOC_Split, /* -split */
21: MDOC_Nosplit, /* -nospli */
22: MDOC_Ragged, /* -ragged */
23: MDOC_Unfilled, /* -unfilled */
24: MDOC_Literal, /* -literal */
25: MDOC_File, /* -file */
26: MDOC_Offset, /* -offset */
27: MDOC_Bullet, /* -bullet */
28: MDOC_Dash, /* -dash */
29: MDOC_Hyphen, /* -hyphen */
30: MDOC_Item, /* -item */
31: MDOC_Enum, /* -enum */
32: MDOC_Tag, /* -tag */
33: MDOC_Diag, /* -diag */
34: MDOC_Hang, /* -hang */
35: MDOC_Ohang, /* -ohang */
36: MDOC_Inset, /* -inset */
37: MDOC_Column, /* -column */
38: MDOC_Width, /* -width */
39: MDOC_Compact, /* -compact */
40: MDOC_Std, /* -std */
41: MDOC_Filled, /* -filled */
42: MDOC_Words, /* -words */
43: MDOC_Emphasis, /* -emphasis */
44: MDOC_Symbolic, /* -symbolic */
45: MDOC_Nested, /* -nested */
46: MDOC_Centred, /* -centered */
1.32 schwarze 47: MDOC_ARG_MAX
48: };
1.1 kristaps 49:
1.53 schwarze 50: /*
51: * An argument to a macro (multiple values = `-column xxx yyy').
1.35 schwarze 52: */
1.1 kristaps 53: struct mdoc_argv {
1.53 schwarze 54: enum mdocargt arg; /* type of argument */
1.1 kristaps 55: int line;
56: int pos;
1.35 schwarze 57: size_t sz; /* elements in "value" */
58: char **value; /* argument strings */
1.1 kristaps 59: };
60:
1.35 schwarze 61: /*
62: * Reference-counted macro arguments. These are refcounted because
63: * blocks have multiple instances of the same arguments spread across
64: * the HEAD, BODY, TAIL, and BLOCK node types.
65: */
1.53 schwarze 66: struct mdoc_arg {
1.1 kristaps 67: size_t argc;
68: struct mdoc_argv *argv;
69: unsigned int refcnt;
70: };
71:
1.26 schwarze 72: enum mdoc_list {
73: LIST__NONE = 0,
1.46 schwarze 74: LIST_bullet, /* -bullet */
75: LIST_column, /* -column */
76: LIST_dash, /* -dash */
77: LIST_diag, /* -diag */
78: LIST_enum, /* -enum */
79: LIST_hang, /* -hang */
80: LIST_hyphen, /* -hyphen */
81: LIST_inset, /* -inset */
82: LIST_item, /* -item */
83: LIST_ohang, /* -ohang */
84: LIST_tag, /* -tag */
1.36 schwarze 85: LIST_MAX
1.26 schwarze 86: };
87:
1.28 schwarze 88: enum mdoc_disp {
89: DISP__NONE = 0,
1.55 schwarze 90: DISP_centered, /* -centered */
1.46 schwarze 91: DISP_ragged, /* -ragged */
92: DISP_unfilled, /* -unfilled */
93: DISP_filled, /* -filled */
94: DISP_literal /* -literal */
1.28 schwarze 95: };
96:
1.31 schwarze 97: enum mdoc_auth {
98: AUTH__NONE = 0,
1.46 schwarze 99: AUTH_split, /* -split */
100: AUTH_nosplit /* -nosplit */
1.31 schwarze 101: };
102:
103: enum mdoc_font {
104: FONT__NONE = 0,
1.46 schwarze 105: FONT_Em, /* Em, -emphasis */
106: FONT_Li, /* Li, -literal */
107: FONT_Sy /* Sy, -symbolic */
1.31 schwarze 108: };
109:
1.28 schwarze 110: struct mdoc_bd {
111: const char *offs; /* -offset */
112: enum mdoc_disp type; /* -ragged, etc. */
113: int comp; /* -compact */
114: };
115:
116: struct mdoc_bl {
117: const char *width; /* -width */
118: const char *offs; /* -offset */
119: enum mdoc_list type; /* -tag, -enum, etc. */
120: int comp; /* -compact */
1.31 schwarze 121: size_t ncols; /* -column arg count */
122: const char **cols; /* -column val ptr */
1.47 schwarze 123: int count; /* -enum counter */
1.31 schwarze 124: };
125:
126: struct mdoc_bf {
127: enum mdoc_font font; /* font */
128: };
129:
130: struct mdoc_an {
131: enum mdoc_auth auth; /* -split, etc. */
1.28 schwarze 132: };
133:
1.39 schwarze 134: struct mdoc_rs {
1.43 schwarze 135: int quote_T; /* whether to quote %T */
1.39 schwarze 136: };
137:
1.35 schwarze 138: /*
139: * Consists of normalised node arguments. These should be used instead
140: * of iterating through the mdoc_arg pointers of a node: defaults are
141: * provided, etc.
142: */
1.41 schwarze 143: union mdoc_data {
1.53 schwarze 144: struct mdoc_an An;
1.41 schwarze 145: struct mdoc_bd Bd;
146: struct mdoc_bf Bf;
147: struct mdoc_bl Bl;
1.63 schwarze 148: struct roff_node *Es;
1.41 schwarze 149: struct mdoc_rs Rs;
1.35 schwarze 150: };
151:
1.46 schwarze 152: /* Names of macro args. Index is enum mdocargt. */
1.1 kristaps 153: extern const char *const *mdoc_argnames;
1.68 schwarze 154:
155: void mdoc_validate(struct roff_man *);
![[BACK]](/icons/back.gif){kind=icon}
Return to mdoc.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc