summaryrefslogtreecommitdiff
path: root/man/cmark.3.md
blob: 558974d825e051cb7bda4cf3c97b29c1c47a3c03 (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
---
title: cmark
section: 3
footer: libcmark manual
date: November 29, 2014
...

# NAME

cmark - parse, manipulate, and render CommonMark formatted text

    #include <cmark.h>

# SIMPLE INTERFACE

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

# PARSING

    void
    cmark_parser_push(cmark_parser *parser, const char *buffer, size_t len);

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

    cmark_node*
    cmark_parse_file(FILE *f);

# RENDERING

    char*
    cmark_render_ast(cmark_node *root);

    char*
    cmark_render_html(cmark_node *root);

# CREATING AND DESTROYING NODES

    cmark_node*
    cmark_node_new(cmark_node_type type);

    void
    cmark_node_free(cmark_node *node);

# TREE TRAVERSAL

    cmark_node*
    cmark_node_next(cmark_node *node);

    cmark_node*
    cmark_node_previous(cmark_node *node);

    cmark_node*
    cmark_node_parent(cmark_node *node);

    cmark_node*
    cmark_node_first_child(cmark_node *node);

    cmark_node*
    cmark_node_last_child(cmark_node *node);

# TREE MANIPULATION

    void
    cmark_node_unlink(cmark_node *node);

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

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

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

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

# ACCESSORS

    cmark_node_type
    cmark_node_get_type(cmark_node *node);

    const char*
    cmark_node_get_string_content(cmark_node *node);

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

    int
    cmark_node_get_header_level(cmark_node *node);

    int
    cmark_node_set_header_level(cmark_node *node, int level);

    cmark_list_type
    cmark_node_get_list_type(cmark_node *node);

    int
    cmark_node_set_list_type(cmark_node *node, cmark_list_type type);

    int
    cmark_node_get_list_start(cmark_node *node);

    int
    cmark_node_set_list_start(cmark_node *node, int start);

    int
    cmark_node_get_list_tight(cmark_node *node);

    int
    cmark_node_set_list_tight(cmark_node *node, int tight);

    const char*
    cmark_node_get_fence_info(cmark_node *node);

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

    const char*
    cmark_node_get_url(cmark_node *node);

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

    const char*
    cmark_node_get_title(cmark_node *node);

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

    int
    cmark_node_get_start_line(cmark_node *node);

    int
    cmark_node_get_start_column(cmark_node *node);

    int
    cmark_node_get_end_line(cmark_node *node);

# DEFINITIONS

    CMARK_VERSION

    typedef enum {
        // Block
        CMARK_NODE_DOCUMENT,
        CMARK_NODE_BLOCK_QUOTE,
        CMARK_NODE_LIST,
        CMARK_NODE_LIST_ITEM,
        CMARK_NODE_CODE_BLOCK,
        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_TEXT,
        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_TEXT,
        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;

# AUTHORS

John MacFarlane