summaryrefslogtreecommitdiff
path: root/src/cmark.h
blob: b83f886bf4dd10defdae0aade9239e734956e09e (plain)
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
#ifndef CMARK_H
#define CMARK_H

#include <stdio.h>
#include "cmark_export.h"

#ifdef __cplusplus
extern "C" {
#endif

#define CMARK_VERSION "0.1"

typedef enum {
    // Block
    CMARK_NODE_DOCUMENT,
    CMARK_NODE_BLOCK_QUOTE,
    CMARK_NODE_LIST,
    CMARK_NODE_LIST_ITEM,
    CMARK_NODE_FENCED_CODE,
    CMARK_NODE_INDENTED_CODE,
    CMARK_NODE_HTML,
    CMARK_NODE_PARAGRAPH,
    CMARK_NODE_HEADER,
    CMARK_NODE_HRULE,
    CMARK_NODE_REFERENCE_DEF,

    CMARK_NODE_FIRST_BLOCK = CMARK_NODE_DOCUMENT,
    CMARK_NODE_LAST_BLOCK  = CMARK_NODE_REFERENCE_DEF,

    // Inline
    CMARK_NODE_STRING,
    CMARK_NODE_SOFTBREAK,
    CMARK_NODE_LINEBREAK,
    CMARK_NODE_INLINE_CODE,
    CMARK_NODE_INLINE_HTML,
    CMARK_NODE_EMPH,
    CMARK_NODE_STRONG,
    CMARK_NODE_LINK,
    CMARK_NODE_IMAGE,

    CMARK_NODE_FIRST_INLINE = CMARK_NODE_STRING,
    CMARK_NODE_LAST_INLINE  = CMARK_NODE_IMAGE,
} cmark_node_type;

typedef enum {
	CMARK_NO_LIST,
	CMARK_BULLET_LIST,
	CMARK_ORDERED_LIST
}  cmark_list_type;

typedef enum {
	CMARK_PERIOD_DELIM,
	CMARK_PAREN_DELIM
} cmark_delim_type;

typedef struct cmark_node cmark_node;
typedef struct cmark_doc_parser cmark_doc_parser;

// Construction and destruction

CMARK_EXPORT cmark_node*
cmark_node_new(cmark_node_type type);

CMARK_EXPORT void
cmark_node_destroy(cmark_node *node);

CMARK_EXPORT void
cmark_free_nodes(cmark_node *e);

// Tree traversal

CMARK_EXPORT cmark_node*
cmark_node_next(cmark_node *node);

CMARK_EXPORT cmark_node*
cmark_node_previous(cmark_node *node);

CMARK_EXPORT cmark_node*
cmark_node_parent(cmark_node *node);

CMARK_EXPORT cmark_node*
cmark_node_first_child(cmark_node *node);

CMARK_EXPORT cmark_node*
cmark_node_last_child(cmark_node *node);

// Accessors

CMARK_EXPORT cmark_node_type
cmark_node_get_type(cmark_node *node);

CMARK_EXPORT const char*
cmark_node_get_string_content(cmark_node *node);

CMARK_EXPORT int
cmark_node_set_string_content(cmark_node *node, const char *content);

CMARK_EXPORT int
cmark_node_get_header_level(cmark_node *node);

CMARK_EXPORT int
cmark_node_set_header_level(cmark_node *node, int level);

CMARK_EXPORT cmark_list_type
cmark_node_get_list_type(cmark_node *node);

CMARK_EXPORT int
cmark_node_set_list_type(cmark_node *node, cmark_list_type type);

CMARK_EXPORT int
cmark_node_get_list_start(cmark_node *node);

CMARK_EXPORT int
cmark_node_set_list_start(cmark_node *node, int start);

CMARK_EXPORT int
cmark_node_get_list_tight(cmark_node *node);

CMARK_EXPORT int
cmark_node_set_list_tight(cmark_node *node, int tight);

CMARK_EXPORT const char*
cmark_node_get_fence_info(cmark_node *node);

CMARK_EXPORT int
cmark_node_set_fence_info(cmark_node *node, const char *info);

CMARK_EXPORT const char*
cmark_node_get_url(cmark_node *node);

CMARK_EXPORT int
cmark_node_set_url(cmark_node *node, const char *url);

CMARK_EXPORT const char*
cmark_node_get_title(cmark_node *node);

CMARK_EXPORT int
cmark_node_set_title(cmark_node *node, const char *title);

CMARK_EXPORT int
cmark_node_get_start_line(cmark_node *node);

CMARK_EXPORT int
cmark_node_get_start_column(cmark_node *node);

CMARK_EXPORT int
cmark_node_get_end_line(cmark_node *node);

// Tree manipulation

CMARK_EXPORT void
cmark_node_unlink(cmark_node *node);

CMARK_EXPORT int
cmark_node_insert_before(cmark_node *node, cmark_node *sibling);

CMARK_EXPORT int
cmark_node_insert_after(cmark_node *node, cmark_node *sibling);

CMARK_EXPORT int
cmark_node_prepend_child(cmark_node *node, cmark_node *child);

CMARK_EXPORT int
cmark_node_append_child(cmark_node *node, cmark_node *child);

// Parser

CMARK_EXPORT
cmark_doc_parser *cmark_new_doc_parser();

CMARK_EXPORT
void cmark_free_doc_parser(cmark_doc_parser *parser);

CMARK_EXPORT
cmark_node *cmark_finish(cmark_doc_parser *parser);

CMARK_EXPORT
void cmark_process_line(cmark_doc_parser *parser, const char *buffer, size_t bytes);

CMARK_EXPORT
cmark_node *cmark_parse_document(const char *buffer, size_t len);

CMARK_EXPORT
cmark_node *cmark_parse_file(FILE *f);

// Renderer

CMARK_EXPORT
void cmark_debug_print(cmark_node *root);

CMARK_EXPORT
char *cmark_render_html(cmark_node *root);

CMARK_EXPORT
char *cmark_markdown_to_html(const char *text, int len);

#ifndef CMARK_NO_SHORT_NAMES
  #define NODE_DOCUMENT             CMARK_NODE_DOCUMENT
  #define NODE_BLOCK_QUOTE          CMARK_NODE_BLOCK_QUOTE
  #define NODE_LIST                 CMARK_NODE_LIST
  #define NODE_LIST_ITEM            CMARK_NODE_LIST_ITEM
  #define NODE_FENCED_CODE          CMARK_NODE_FENCED_CODE
  #define NODE_INDENTED_CODE        CMARK_NODE_INDENTED_CODE
  #define NODE_HTML                 CMARK_NODE_HTML
  #define NODE_PARAGRAPH            CMARK_NODE_PARAGRAPH
  #define NODE_HEADER		    CMARK_NODE_HEADER
  #define NODE_HRULE                CMARK_NODE_HRULE
  #define NODE_REFERENCE_DEF        CMARK_NODE_REFERENCE_DEF
  #define NODE_STRING               CMARK_NODE_STRING
  #define NODE_SOFTBREAK            CMARK_NODE_SOFTBREAK
  #define NODE_LINEBREAK            CMARK_NODE_LINEBREAK
  #define NODE_INLINE_CODE          CMARK_NODE_INLINE_CODE
  #define NODE_INLINE_HTML          CMARK_NODE_INLINE_HTML
  #define NODE_EMPH                 CMARK_NODE_EMPH
  #define NODE_STRONG               CMARK_NODE_STRONG
  #define NODE_LINK                 CMARK_NODE_LINK
  #define NODE_IMAGE                CMARK_NODE_IMAGE
  #define NODE_LINK_LABEL           CMARK_NODE_LINK_LABEL
  #define BULLET_LIST               CMARK_BULLET_LIST
  #define ORDERED_LIST              CMARK_ORDERED_LIST
  #define PERIOD_DELIM              CMARK_PERIOD_DELIM
  #define PAREN_DELIM               CMARK_PAREN_DELIM
  #define free_simple               cmark_free_simple
  #define free_blocks               cmark_free_blocks
  #define doc_parser                cmark_doc_parser
  #define new_doc_parser            cmark_new_doc_parser
  #define free_doc_parser           cmark_free_doc_parser
  #define process_line              cmark_process_line
  #define finish                    cmark_finish
  #define block_next                cmark_block_next
  #define block_previous            cmark_block_previous
  #define block_parent              cmark_block_parent
  #define block_children            cmark_block_children
  #define block_delete              cmark_block_delete
  #define block_insert_before       cmark_block_insert_before
  #define block_insert_after        cmark_block_insert_after
#endif

#ifdef __cplusplus
}
#endif

#endif