aboutsummaryrefslogtreecommitdiff
path: root/src/cmark.h
blob: a74fe9332e79f12ce14c15e833959b94d91ea19f (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. #define CMARK_VERSION "0.1"
  9. typedef enum {
  10. // Block
  11. CMARK_NODE_DOCUMENT,
  12. CMARK_NODE_BQUOTE,
  13. CMARK_NODE_LIST,
  14. CMARK_NODE_LIST_ITEM,
  15. CMARK_NODE_FENCED_CODE,
  16. CMARK_NODE_INDENTED_CODE,
  17. CMARK_NODE_HTML,
  18. CMARK_NODE_PARAGRAPH,
  19. CMARK_NODE_ATX_HEADER,
  20. CMARK_NODE_SETEXT_HEADER,
  21. CMARK_NODE_HRULE,
  22. CMARK_NODE_REFERENCE_DEF,
  23. CMARK_NODE_FIRST_BLOCK = CMARK_NODE_DOCUMENT,
  24. CMARK_NODE_LAST_BLOCK = CMARK_NODE_REFERENCE_DEF,
  25. // Inline
  26. CMARK_NODE_STRING,
  27. CMARK_NODE_SOFTBREAK,
  28. CMARK_NODE_LINEBREAK,
  29. CMARK_NODE_INLINE_CODE,
  30. CMARK_NODE_INLINE_HTML,
  31. CMARK_NODE_EMPH,
  32. CMARK_NODE_STRONG,
  33. CMARK_NODE_LINK,
  34. CMARK_NODE_IMAGE,
  35. CMARK_NODE_FIRST_INLINE = CMARK_NODE_STRING,
  36. CMARK_NODE_LAST_INLINE = CMARK_NODE_IMAGE,
  37. } cmark_node_type;
  38. typedef enum {
  39. CMARK_NO_LIST,
  40. CMARK_BULLET_LIST,
  41. CMARK_ORDERED_LIST
  42. } cmark_list_type;
  43. typedef enum {
  44. CMARK_PERIOD_DELIM,
  45. CMARK_PAREN_DELIM
  46. } cmark_delim_type;
  47. typedef struct cmark_node cmark_node;
  48. typedef struct cmark_doc_parser cmark_doc_parser;
  49. // Construction and destruction
  50. CMARK_EXPORT cmark_node*
  51. cmark_node_new(cmark_node_type type);
  52. CMARK_EXPORT void
  53. cmark_node_destroy(cmark_node *node);
  54. CMARK_EXPORT void
  55. cmark_free_nodes(cmark_node *e);
  56. // Tree traversal
  57. CMARK_EXPORT cmark_node*
  58. cmark_node_next(cmark_node *node);
  59. CMARK_EXPORT cmark_node*
  60. cmark_node_previous(cmark_node *node);
  61. CMARK_EXPORT cmark_node*
  62. cmark_node_parent(cmark_node *node);
  63. CMARK_EXPORT cmark_node*
  64. cmark_node_first_child(cmark_node *node);
  65. CMARK_EXPORT cmark_node*
  66. cmark_node_last_child(cmark_node *node);
  67. // Accessors
  68. CMARK_EXPORT cmark_node_type
  69. cmark_node_get_type(cmark_node *node);
  70. CMARK_EXPORT const char*
  71. cmark_node_get_string_content(cmark_node *node);
  72. CMARK_EXPORT int
  73. cmark_node_set_string_content(cmark_node *node, const char *content);
  74. CMARK_EXPORT int
  75. cmark_node_get_header_level(cmark_node *node);
  76. CMARK_EXPORT int
  77. cmark_node_set_header_level(cmark_node *node, int level);
  78. CMARK_EXPORT cmark_list_type
  79. cmark_node_get_list_type(cmark_node *node);
  80. CMARK_EXPORT int
  81. cmark_node_set_list_type(cmark_node *node, cmark_list_type type);
  82. CMARK_EXPORT int
  83. cmark_node_get_list_start(cmark_node *node);
  84. CMARK_EXPORT int
  85. cmark_node_set_list_start(cmark_node *node, int start);
  86. CMARK_EXPORT int
  87. cmark_node_get_list_tight(cmark_node *node);
  88. CMARK_EXPORT int
  89. cmark_node_set_list_tight(cmark_node *node, int tight);
  90. CMARK_EXPORT const char*
  91. cmark_node_get_fence_info(cmark_node *node);
  92. CMARK_EXPORT int
  93. cmark_node_set_fence_info(cmark_node *node, const char *info);
  94. CMARK_EXPORT const char*
  95. cmark_node_get_url(cmark_node *node);
  96. CMARK_EXPORT int
  97. cmark_node_set_url(cmark_node *node, const char *url);
  98. CMARK_EXPORT const char*
  99. cmark_node_get_title(cmark_node *node);
  100. CMARK_EXPORT int
  101. cmark_node_set_title(cmark_node *node, const char *title);
  102. CMARK_EXPORT int
  103. cmark_node_get_start_line(cmark_node *node);
  104. CMARK_EXPORT int
  105. cmark_node_get_start_column(cmark_node *node);
  106. CMARK_EXPORT int
  107. cmark_node_get_end_line(cmark_node *node);
  108. // Tree manipulation
  109. CMARK_EXPORT void
  110. cmark_node_unlink(cmark_node *node);
  111. CMARK_EXPORT int
  112. cmark_node_insert_before(cmark_node *node, cmark_node *sibling);
  113. CMARK_EXPORT int
  114. cmark_node_insert_after(cmark_node *node, cmark_node *sibling);
  115. CMARK_EXPORT int
  116. cmark_node_prepend_child(cmark_node *node, cmark_node *child);
  117. CMARK_EXPORT int
  118. cmark_node_append_child(cmark_node *node, cmark_node *child);
  119. // Parser
  120. CMARK_EXPORT
  121. cmark_doc_parser *cmark_new_doc_parser();
  122. CMARK_EXPORT
  123. void cmark_free_doc_parser(cmark_doc_parser *parser);
  124. CMARK_EXPORT
  125. cmark_node *cmark_finish(cmark_doc_parser *parser);
  126. CMARK_EXPORT
  127. void cmark_process_line(cmark_doc_parser *parser, const unsigned char *buffer, size_t bytes);
  128. CMARK_EXPORT
  129. cmark_node *cmark_parse_document(const unsigned char *buffer, size_t len);
  130. CMARK_EXPORT
  131. cmark_node *cmark_parse_file(FILE *f);
  132. // Renderer
  133. CMARK_EXPORT
  134. void cmark_debug_print(cmark_node *root);
  135. CMARK_EXPORT
  136. unsigned char *cmark_render_html(cmark_node *root);
  137. CMARK_EXPORT
  138. unsigned char *cmark_markdown_to_html(unsigned char *text, int len);
  139. #ifndef CMARK_NO_SHORT_NAMES
  140. #define NODE_DOCUMENT CMARK_NODE_DOCUMENT
  141. #define NODE_BQUOTE CMARK_NODE_BQUOTE
  142. #define NODE_LIST CMARK_NODE_LIST
  143. #define NODE_LIST_ITEM CMARK_NODE_LIST_ITEM
  144. #define NODE_FENCED_CODE CMARK_NODE_FENCED_CODE
  145. #define NODE_INDENTED_CODE CMARK_NODE_INDENTED_CODE
  146. #define NODE_HTML CMARK_NODE_HTML
  147. #define NODE_PARAGRAPH CMARK_NODE_PARAGRAPH
  148. #define NODE_ATX_HEADER CMARK_NODE_ATX_HEADER
  149. #define NODE_SETEXT_HEADER CMARK_NODE_SETEXT_HEADER
  150. #define NODE_HRULE CMARK_NODE_HRULE
  151. #define NODE_REFERENCE_DEF CMARK_NODE_REFERENCE_DEF
  152. #define NODE_STRING CMARK_NODE_STRING
  153. #define NODE_SOFTBREAK CMARK_NODE_SOFTBREAK
  154. #define NODE_LINEBREAK CMARK_NODE_LINEBREAK
  155. #define NODE_INLINE_CODE CMARK_NODE_INLINE_CODE
  156. #define NODE_INLINE_HTML CMARK_NODE_INLINE_HTML
  157. #define NODE_EMPH CMARK_NODE_EMPH
  158. #define NODE_STRONG CMARK_NODE_STRONG
  159. #define NODE_LINK CMARK_NODE_LINK
  160. #define NODE_IMAGE CMARK_NODE_IMAGE
  161. #define NODE_LINK_LABEL CMARK_NODE_LINK_LABEL
  162. #define BULLET_LIST CMARK_BULLET_LIST
  163. #define ORDERED_LIST CMARK_ORDERED_LIST
  164. #define PERIOD_DELIM CMARK_PERIOD_DELIM
  165. #define PAREN_DELIM CMARK_PAREN_DELIM
  166. #define free_simple cmark_free_simple
  167. #define free_blocks cmark_free_blocks
  168. #define doc_parser cmark_doc_parser
  169. #define new_doc_parser cmark_new_doc_parser
  170. #define free_doc_parser cmark_free_doc_parser
  171. #define process_line cmark_process_line
  172. #define finish cmark_finish
  173. #define block_next cmark_block_next
  174. #define block_previous cmark_block_previous
  175. #define block_parent cmark_block_parent
  176. #define block_children cmark_block_children
  177. #define block_delete cmark_block_delete
  178. #define block_insert_before cmark_block_insert_before
  179. #define block_insert_after cmark_block_insert_after
  180. #endif
  181. #ifdef __cplusplus
  182. }
  183. #endif
  184. #endif