-
Notifications
You must be signed in to change notification settings - Fork 34
/
Copy pathlowdown.h
340 lines (309 loc) · 8.75 KB
/
lowdown.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
/* $Id$ */
/*
* Copyright (c) 2017 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.
*
* 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 LOWDOWN_H
#define LOWDOWN_H
/*
* All of this is documented in lowdown.3.
* If it's not documented, don't use it.
* Or report it as a bug.
*/
/* We need this for compilation on musl systems. */
#ifndef __BEGIN_DECLS
# ifdef __cplusplus
# define __BEGIN_DECLS extern "C" {
# else
# define __BEGIN_DECLS
# endif
#endif
#ifndef __END_DECLS
# ifdef __cplusplus
# define __END_DECLS }
# else
# define __END_DECLS
# endif
#endif
enum lowdown_type {
LOWDOWN_HTML,
LOWDOWN_MAN,
LOWDOWN_NROFF,
LOWDOWN_TERM,
LOWDOWN_TREE
};
enum lowdown_err {
LOWDOWN_ERR_SPACE_BEFORE_LINK = 0,
LOWDOWN_ERR_METADATA_BAD_CHAR,
LOWDOWN_ERR_UNKNOWN_FOOTNOTE,
LOWDOWN_ERR_DUPE_FOOTNOTE,
LOWDOWN_ERR__MAX
};
typedef void (*lowdown_msg)(enum lowdown_err, void *, const char *);
/*
* All types of Markdown nodes that lowdown understands.
*/
enum lowdown_rndrt {
LOWDOWN_ROOT,
LOWDOWN_BLOCKCODE,
LOWDOWN_BLOCKQUOTE,
LOWDOWN_HEADER,
LOWDOWN_HRULE,
LOWDOWN_LIST,
LOWDOWN_LISTITEM,
LOWDOWN_PARAGRAPH,
LOWDOWN_TABLE_BLOCK,
LOWDOWN_TABLE_HEADER,
LOWDOWN_TABLE_BODY,
LOWDOWN_TABLE_ROW,
LOWDOWN_TABLE_CELL,
LOWDOWN_FOOTNOTES_BLOCK,
LOWDOWN_FOOTNOTE_DEF,
LOWDOWN_BLOCKHTML,
LOWDOWN_LINK_AUTO,
LOWDOWN_CODESPAN,
LOWDOWN_DOUBLE_EMPHASIS,
LOWDOWN_EMPHASIS,
LOWDOWN_HIGHLIGHT,
LOWDOWN_IMAGE,
LOWDOWN_LINEBREAK,
LOWDOWN_LINK,
LOWDOWN_TRIPLE_EMPHASIS,
LOWDOWN_STRIKETHROUGH,
LOWDOWN_SUPERSCRIPT,
LOWDOWN_FOOTNOTE_REF,
LOWDOWN_MATH_BLOCK,
LOWDOWN_RAW_HTML,
LOWDOWN_ENTITY,
LOWDOWN_NORMAL_TEXT,
LOWDOWN_DOC_HEADER,
LOWDOWN_META,
LOWDOWN_DOC_FOOTER,
LOWDOWN__MAX
};
typedef struct hbuf {
char *data; /* actual character data */
size_t size; /* size of the string */
size_t asize; /* allocated size (0 = volatile) */
size_t unit; /* realloc unit size (0 = read-only) */
int buffer_free; /* obj should be freed */
} hbuf;
TAILQ_HEAD(lowdown_nodeq, lowdown_node);
enum htbl_flags {
HTBL_FL_ALIGN_LEFT = 1,
HTBL_FL_ALIGN_RIGHT = 2,
HTBL_FL_ALIGN_CENTER = 3,
HTBL_FL_ALIGNMASK = 3,
HTBL_FL_HEADER = 4
};
enum halink_type {
HALINK_NONE, /* used internally when it is not an autolink */
HALINK_NORMAL, /* normal http/http/ftp/mailto/etc link */
HALINK_EMAIL /* e-mail link without explit mailto: */
};
enum hlist_fl {
HLIST_FL_ORDERED = (1 << 0),
HLIST_FL_BLOCK = (1 << 1) /* <li> containing block data */
};
/*
* Meta-data keys and values.
* Both of these are non-NULL (but possibly empty).
*/
struct lowdown_meta {
char *key;
char *value;
TAILQ_ENTRY(lowdown_meta) entries;
};
TAILQ_HEAD(lowdown_metaq, lowdown_meta);
enum lowdown_chng {
LOWDOWN_CHNG_NONE = 0,
LOWDOWN_CHNG_INSERT,
LOWDOWN_CHNG_DELETE,
};
/*
* Node parsed from input document.
* Each node is part of the parse tree.
*/
struct lowdown_node {
enum lowdown_rndrt type;
enum lowdown_chng chng; /* change type */
size_t id; /* unique identifier */
union {
struct rndr_meta {
hbuf key;
} rndr_meta;
struct rndr_list {
enum hlist_fl flags; /* only HLIST_FL_ORDERED */
/*
* This is string of size >0 iff
* HLIST_FL_ORDERED and we're parsing
* CommonMark, else it's an empty string.
*/
char start[10];
} rndr_list;
struct rndr_listitem {
enum hlist_fl flags; /* all possible flags */
uint32_t num; /* index in ordered */
} rndr_listitem;
struct rndr_header {
size_t level; /* hN level */
} rndr_header;
struct rndr_normal_text {
hbuf text; /* basic text */
size_t offs; /* in-render offset */
} rndr_normal_text;
struct rndr_entity {
hbuf text; /* entity text */
} rndr_entity;
struct rndr_autolink {
hbuf link; /* link address */
hbuf text; /* shown address */
enum halink_type type; /* type of link */
} rndr_autolink;
struct rndr_raw_html {
hbuf text; /* raw html buffer */
} rndr_raw_html;
struct rndr_link {
hbuf link; /* link address */
hbuf title; /* title of link */
} rndr_link;
struct rndr_blockcode {
hbuf text; /* raw code buffer */
hbuf lang; /* fence language */
} rndr_blockcode;
struct rndr_codespan {
hbuf text; /* raw code buffer */
} rndr_codespan;
struct rndr_table_header {
enum htbl_flags *flags; /* per-column flags */
size_t columns; /* number of columns */
} rndr_table_header;
struct rndr_table_cell {
enum htbl_flags flags; /* flags for cell */
size_t col; /* column number */
size_t columns; /* number of columns */
} rndr_table_cell;
struct rndr_footnote_def {
size_t num; /* footnote number */
} rndr_footnote_def;
struct rndr_footnote_ref {
size_t num; /* footnote number */
} rndr_footnote_ref;
struct rndr_image {
hbuf link; /* image address */
hbuf title; /* title of image */
hbuf dims; /* dimensions of image */
hbuf alt; /* alt-text of image */
} rndr_image;
struct rndr_math {
hbuf text; /* equation (opaque) */
int blockmode;
} rndr_math;
struct rndr_blockhtml {
hbuf text;
} rndr_blockhtml;
};
struct lowdown_node *parent;
struct lowdown_nodeq children;
TAILQ_ENTRY(lowdown_node) entries;
};
/*
* These options contain everything needed to parse and render content.
*/
struct lowdown_opts {
lowdown_msg msg;
enum lowdown_type type;
void *arg;
unsigned int feat;
#define LOWDOWN_TABLES 0x01
#define LOWDOWN_FENCED 0x02
#define LOWDOWN_FOOTNOTES 0x04
#define LOWDOWN_AUTOLINK 0x08
#define LOWDOWN_STRIKE 0x10
/* Omitted 0x20 */
#define LOWDOWN_HILITE 0x40
/* Omitted 0x80 */
#define LOWDOWN_SUPER 0x100
#define LOWDOWN_MATH 0x200
#define LOWDOWN_NOINTEM 0x400
/* Disabled LOWDOWN_MATHEXP 0x1000 */
#define LOWDOWN_NOCODEIND 0x2000
#define LOWDOWN_METADATA 0x4000
#define LOWDOWN_COMMONMARK 0x8000
unsigned int oflags;
#define LOWDOWN_HTML_SKIP_HTML 0x01
#define LOWDOWN_HTML_ESCAPE 0x02
#define LOWDOWN_HTML_HARD_WRAP 0x04
#define LOWDOWN_NROFF_SKIP_HTML 0x08
#define LOWDOWN_NROFF_HARD_WRAP 0x10
#define LOWDOWN_NROFF_GROFF 0x20
#define LOWDOWN_SMARTY 0x40
#define LOWDOWN_NROFF_NUMBERED 0x80
#define LOWDOWN_HTML_HEAD_IDS 0x100
#define LOWDOWN_STANDALONE 0x200
};
struct hdoc;
typedef struct hdoc hdoc;
__BEGIN_DECLS
const char *lowdown_errstr(enum lowdown_err);
/*
* High-level functions.
* These use the "lowdown_opts" to determine how to parse and render
* content, and extract that content from a buffer, file, or descriptor.
*/
void lowdown_buf(const struct lowdown_opts *,
const char *, size_t,
char **, size_t *, struct lowdown_metaq *);
void lowdown_buf_diff(const struct lowdown_opts *,
const char *, size_t,
const struct lowdown_opts *,
const char *, size_t,
char **, size_t *, struct lowdown_metaq *);
int lowdown_file(const struct lowdown_opts *,
FILE *, char **, size_t *, struct lowdown_metaq *);
int lowdown_file_diff(const struct lowdown_opts *, FILE *,
const struct lowdown_opts *, FILE *,
char **, size_t *, struct lowdown_metaq *);
/*
* Low-level functions.
* These actually parse and render the AST from a buffer in various
* ways.
*/
hdoc *lowdown_doc_new(const struct lowdown_opts *);
struct lowdown_node
*lowdown_doc_parse(hdoc *, size_t *, const char *, size_t);
struct lowdown_node
*lowdown_diff(const struct lowdown_node *,
const struct lowdown_node *, size_t *);
void lowdown_doc_free(hdoc *);
void lowdown_metaq_free(struct lowdown_metaq *);
void lowdown_node_free(struct lowdown_node *);
void lowdown_html_free(void *);
void *lowdown_html_new(const struct lowdown_opts *);
void lowdown_html_rndr(hbuf *, struct lowdown_metaq *,
void *, struct lowdown_node *);
void lowdown_term_free(void *);
void *lowdown_term_new(void);
void lowdown_term_rndr(hbuf *, struct lowdown_metaq *,
void *, struct lowdown_node *);
void lowdown_nroff_free(void *);
void *lowdown_nroff_new(const struct lowdown_opts *);
void lowdown_nroff_rndr(hbuf *, struct lowdown_metaq *,
void *, struct lowdown_node *);
void lowdown_tree_free(void *);
void *lowdown_tree_new(void);
void lowdown_tree_rndr(hbuf *, struct lowdown_metaq *,
void *, struct lowdown_node *);
__END_DECLS
#endif /* !EXTERN_H */