aboutsummaryrefslogtreecommitdiff
path: root/src/cmark.h
blob: f96cea9df457ff7a8af55929847f218275911c01 (plain)
  1. #ifndef CMARK_H
  2. #define CMARK_H
  3. #include <stdio.h>
  4. #include "cmark_export.h"
  5. #ifdef __cplusplus
  6. extern "C" {
  7. #endif
  8. /** .SH NAME
  9. *
  10. * .B cmark
  11. * \- CommonMark parsing, manipulating, and rendering
  12. */
  13. /** .SH SIMPLE INTERFACE
  14. */
  15. /** Current version of library.
  16. */
  17. #define CMARK_VERSION "0.1"
  18. /** Convert 'text' (assumed to be a UTF-8 encoded string with length
  19. * 'len' from CommonMark Markdown to HTML, returning a null-terminated,
  20. * UTF-8-encoded string.
  21. */
  22. CMARK_EXPORT
  23. char *cmark_markdown_to_html(const char *text, int len);
  24. /** .SH NODE STRUCTURE
  25. */
  26. /**
  27. */
  28. typedef enum {
  29. /* Error status */
  30. CMARK_NODE_NONE,
  31. /* Block */
  32. CMARK_NODE_DOCUMENT,
  33. CMARK_NODE_BLOCK_QUOTE,
  34. CMARK_NODE_LIST,
  35. CMARK_NODE_LIST_ITEM,
  36. CMARK_NODE_CODE_BLOCK,
  37. CMARK_NODE_HTML,
  38. CMARK_NODE_PARAGRAPH,
  39. CMARK_NODE_HEADER,
  40. CMARK_NODE_HRULE,
  41. CMARK_NODE_REFERENCE_DEF,
  42. CMARK_NODE_FIRST_BLOCK = CMARK_NODE_DOCUMENT,
  43. CMARK_NODE_LAST_BLOCK = CMARK_NODE_REFERENCE_DEF,
  44. /* Inline */
  45. CMARK_NODE_TEXT,
  46. CMARK_NODE_SOFTBREAK,
  47. CMARK_NODE_LINEBREAK,
  48. CMARK_NODE_INLINE_CODE,
  49. CMARK_NODE_INLINE_HTML,
  50. CMARK_NODE_EMPH,
  51. CMARK_NODE_STRONG,
  52. CMARK_NODE_LINK,
  53. CMARK_NODE_IMAGE,
  54. CMARK_NODE_FIRST_INLINE = CMARK_NODE_TEXT,
  55. CMARK_NODE_LAST_INLINE = CMARK_NODE_IMAGE,
  56. } cmark_node_type;
  57. /**
  58. */
  59. typedef enum {
  60. CMARK_NO_LIST,
  61. CMARK_BULLET_LIST,
  62. CMARK_ORDERED_LIST
  63. } cmark_list_type;
  64. /**
  65. */
  66. typedef enum {
  67. CMARK_PERIOD_DELIM,
  68. CMARK_PAREN_DELIM
  69. } cmark_delim_type;
  70. typedef struct cmark_node cmark_node;
  71. typedef struct cmark_parser cmark_parser;
  72. /**
  73. * .SH CREATING AND DESTROYING NODES
  74. */
  75. /**
  76. */
  77. CMARK_EXPORT cmark_node*
  78. cmark_node_new(cmark_node_type type);
  79. /**
  80. */
  81. CMARK_EXPORT void
  82. cmark_node_free(cmark_node *node);
  83. /**
  84. * .SH TREE TRAVERSAL
  85. */
  86. CMARK_EXPORT cmark_node*
  87. cmark_node_next(cmark_node *node);
  88. /**
  89. */
  90. CMARK_EXPORT cmark_node*
  91. cmark_node_previous(cmark_node *node);
  92. /**
  93. */
  94. CMARK_EXPORT cmark_node*
  95. cmark_node_parent(cmark_node *node);
  96. /**
  97. */
  98. CMARK_EXPORT cmark_node*
  99. cmark_node_first_child(cmark_node *node);
  100. /**
  101. */
  102. CMARK_EXPORT cmark_node*
  103. cmark_node_last_child(cmark_node *node);
  104. /**
  105. * .SH ACCESSORS
  106. */
  107. /**
  108. */
  109. CMARK_EXPORT cmark_node_type
  110. cmark_node_get_type(cmark_node *node);
  111. /**
  112. */
  113. CMARK_EXPORT const char*
  114. cmark_node_get_string_content(cmark_node *node);
  115. /**
  116. */
  117. CMARK_EXPORT int
  118. cmark_node_set_string_content(cmark_node *node, const char *content);
  119. /**
  120. */
  121. CMARK_EXPORT int
  122. cmark_node_get_header_level(cmark_node *node);
  123. /**
  124. */
  125. CMARK_EXPORT int
  126. cmark_node_set_header_level(cmark_node *node, int level);
  127. /**
  128. */
  129. CMARK_EXPORT cmark_list_type
  130. cmark_node_get_list_type(cmark_node *node);
  131. /**
  132. */
  133. CMARK_EXPORT int
  134. cmark_node_set_list_type(cmark_node *node, cmark_list_type type);
  135. /**
  136. */
  137. CMARK_EXPORT int
  138. cmark_node_get_list_start(cmark_node *node);
  139. /**
  140. */
  141. CMARK_EXPORT int
  142. cmark_node_set_list_start(cmark_node *node, int start);
  143. /**
  144. */
  145. CMARK_EXPORT int
  146. cmark_node_get_list_tight(cmark_node *node);
  147. /**
  148. */
  149. CMARK_EXPORT int
  150. cmark_node_set_list_tight(cmark_node *node, int tight);
  151. /**
  152. */
  153. CMARK_EXPORT const char*
  154. cmark_node_get_fence_info(cmark_node *node);
  155. /**
  156. */
  157. CMARK_EXPORT int
  158. cmark_node_set_fence_info(cmark_node *node, const char *info);
  159. /**
  160. */
  161. CMARK_EXPORT const char*
  162. cmark_node_get_url(cmark_node *node);
  163. /**
  164. */
  165. CMARK_EXPORT int
  166. cmark_node_set_url(cmark_node *node, const char *url);
  167. /**
  168. */
  169. CMARK_EXPORT const char*
  170. cmark_node_get_title(cmark_node *node);
  171. /**
  172. */
  173. CMARK_EXPORT int
  174. cmark_node_set_title(cmark_node *node, const char *title);
  175. /**
  176. */
  177. CMARK_EXPORT int
  178. cmark_node_get_start_line(cmark_node *node);
  179. /**
  180. */
  181. CMARK_EXPORT int
  182. cmark_node_get_start_column(cmark_node *node);
  183. /**
  184. */
  185. CMARK_EXPORT int
  186. cmark_node_get_end_line(cmark_node *node);
  187. /**
  188. * .SH TREE MANIPULATION
  189. */
  190. /**
  191. */
  192. CMARK_EXPORT void
  193. cmark_node_unlink(cmark_node *node);
  194. /**
  195. */
  196. CMARK_EXPORT int
  197. cmark_node_insert_before(cmark_node *node, cmark_node *sibling);
  198. /**
  199. */
  200. CMARK_EXPORT int
  201. cmark_node_insert_after(cmark_node *node, cmark_node *sibling);
  202. /**
  203. */
  204. CMARK_EXPORT int
  205. cmark_node_prepend_child(cmark_node *node, cmark_node *child);
  206. /**
  207. */
  208. CMARK_EXPORT int
  209. cmark_node_append_child(cmark_node *node, cmark_node *child);
  210. /**
  211. * .SH PARSING
  212. */
  213. /**
  214. */
  215. CMARK_EXPORT
  216. cmark_parser *cmark_parser_new();
  217. /**
  218. */
  219. CMARK_EXPORT
  220. void cmark_parser_free(cmark_parser *parser);
  221. /**
  222. */
  223. CMARK_EXPORT
  224. cmark_node *cmark_parser_finish(cmark_parser *parser);
  225. /**
  226. */
  227. CMARK_EXPORT
  228. void cmark_parser_feed(cmark_parser *parser, const char *buffer, size_t len);
  229. /**
  230. */
  231. CMARK_EXPORT
  232. cmark_node *cmark_parse_document(const char *buffer, size_t len);
  233. /**
  234. */
  235. CMARK_EXPORT
  236. cmark_node *cmark_parse_file(FILE *f);
  237. /**
  238. * .SH RENDERING
  239. */
  240. /**
  241. */
  242. CMARK_EXPORT
  243. char *cmark_render_ast(cmark_node *root);
  244. /**
  245. */
  246. CMARK_EXPORT
  247. char *cmark_render_html(cmark_node *root);
  248. /** .SH AUTHORS
  249. *
  250. * John MacFarlane, Vicent Marti, Kārlis Gaņģis, Nick Wellnhofer.
  251. */
  252. #ifndef CMARK_NO_SHORT_NAMES
  253. #define NODE_DOCUMENT CMARK_NODE_DOCUMENT
  254. #define NODE_BLOCK_QUOTE CMARK_NODE_BLOCK_QUOTE
  255. #define NODE_LIST CMARK_NODE_LIST
  256. #define NODE_LIST_ITEM CMARK_NODE_LIST_ITEM
  257. #define NODE_CODE_BLOCK CMARK_NODE_CODE_BLOCK
  258. #define NODE_HTML CMARK_NODE_HTML
  259. #define NODE_PARAGRAPH CMARK_NODE_PARAGRAPH
  260. #define NODE_HEADER CMARK_NODE_HEADER
  261. #define NODE_HRULE CMARK_NODE_HRULE
  262. #define NODE_REFERENCE_DEF CMARK_NODE_REFERENCE_DEF
  263. #define NODE_TEXT CMARK_NODE_TEXT
  264. #define NODE_SOFTBREAK CMARK_NODE_SOFTBREAK
  265. #define NODE_LINEBREAK CMARK_NODE_LINEBREAK
  266. #define NODE_INLINE_CODE CMARK_NODE_INLINE_CODE
  267. #define NODE_INLINE_HTML CMARK_NODE_INLINE_HTML
  268. #define NODE_EMPH CMARK_NODE_EMPH
  269. #define NODE_STRONG CMARK_NODE_STRONG
  270. #define NODE_LINK CMARK_NODE_LINK
  271. #define NODE_IMAGE CMARK_NODE_IMAGE
  272. #define NODE_LINK_LABEL CMARK_NODE_LINK_LABEL
  273. #define BULLET_LIST CMARK_BULLET_LIST
  274. #define ORDERED_LIST CMARK_ORDERED_LIST
  275. #define PERIOD_DELIM CMARK_PERIOD_DELIM
  276. #define PAREN_DELIM CMARK_PAREN_DELIM
  277. #endif
  278. #ifdef __cplusplus
  279. }
  280. #endif
  281. #endif