aboutsummaryrefslogtreecommitdiff
path: root/src/cmark.h
blob: ff0c58f99e6e7fbc7b7bb966dbf557af9fcf8337 (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. /** @file cmark.h
  9. * Functions for parsing CommonMark to an AST, manipulating
  10. * the AST, and rendering the AST to HTML.
  11. */
  12. #define CMARK_VERSION "0.1"
  13. typedef enum {
  14. // Block
  15. CMARK_NODE_DOCUMENT,
  16. CMARK_NODE_BLOCK_QUOTE,
  17. CMARK_NODE_LIST,
  18. CMARK_NODE_LIST_ITEM,
  19. CMARK_NODE_CODE_BLOCK,
  20. CMARK_NODE_HTML,
  21. CMARK_NODE_PARAGRAPH,
  22. CMARK_NODE_HEADER,
  23. CMARK_NODE_HRULE,
  24. CMARK_NODE_REFERENCE_DEF,
  25. CMARK_NODE_FIRST_BLOCK = CMARK_NODE_DOCUMENT,
  26. CMARK_NODE_LAST_BLOCK = CMARK_NODE_REFERENCE_DEF,
  27. // Inline
  28. CMARK_NODE_TEXT,
  29. CMARK_NODE_SOFTBREAK,
  30. CMARK_NODE_LINEBREAK,
  31. CMARK_NODE_INLINE_CODE,
  32. CMARK_NODE_INLINE_HTML,
  33. CMARK_NODE_EMPH,
  34. CMARK_NODE_STRONG,
  35. CMARK_NODE_LINK,
  36. CMARK_NODE_IMAGE,
  37. CMARK_NODE_FIRST_INLINE = CMARK_NODE_TEXT,
  38. CMARK_NODE_LAST_INLINE = CMARK_NODE_IMAGE,
  39. } cmark_node_type;
  40. typedef enum {
  41. CMARK_NO_LIST,
  42. CMARK_BULLET_LIST,
  43. CMARK_ORDERED_LIST
  44. } cmark_list_type;
  45. typedef enum {
  46. CMARK_PERIOD_DELIM,
  47. CMARK_PAREN_DELIM
  48. } cmark_delim_type;
  49. typedef struct cmark_node cmark_node;
  50. typedef struct cmark_parser cmark_parser;
  51. // Construction and destruction
  52. CMARK_EXPORT cmark_node*
  53. cmark_node_new(cmark_node_type type);
  54. CMARK_EXPORT void
  55. cmark_node_free(cmark_node *node);
  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_parser *cmark_parser_new();
  122. CMARK_EXPORT
  123. void cmark_parser_free(cmark_parser *parser);
  124. CMARK_EXPORT
  125. cmark_node *cmark_parser_finish(cmark_parser *parser);
  126. CMARK_EXPORT
  127. void cmark_parser_push(cmark_parser *parser, const char *buffer, size_t len);
  128. CMARK_EXPORT
  129. cmark_node *cmark_parse_document(const char *buffer, size_t len);
  130. CMARK_EXPORT
  131. cmark_node *cmark_parse_file(FILE *f);
  132. // Renderer
  133. CMARK_EXPORT
  134. char *cmark_render_ast(cmark_node *root);
  135. CMARK_EXPORT
  136. char *cmark_render_html(cmark_node *root);
  137. CMARK_EXPORT
  138. char *cmark_markdown_to_html(const char *text, int len);
  139. #ifndef CMARK_NO_SHORT_NAMES
  140. #define NODE_DOCUMENT CMARK_NODE_DOCUMENT
  141. #define NODE_BLOCK_QUOTE CMARK_NODE_BLOCK_QUOTE
  142. #define NODE_LIST CMARK_NODE_LIST
  143. #define NODE_LIST_ITEM CMARK_NODE_LIST_ITEM
  144. #define NODE_CODE_BLOCK CMARK_NODE_CODE_BLOCK
  145. #define NODE_HTML CMARK_NODE_HTML
  146. #define NODE_PARAGRAPH CMARK_NODE_PARAGRAPH
  147. #define NODE_HEADER CMARK_NODE_HEADER
  148. #define NODE_HRULE CMARK_NODE_HRULE
  149. #define NODE_REFERENCE_DEF CMARK_NODE_REFERENCE_DEF
  150. #define NODE_TEXT CMARK_NODE_TEXT
  151. #define NODE_SOFTBREAK CMARK_NODE_SOFTBREAK
  152. #define NODE_LINEBREAK CMARK_NODE_LINEBREAK
  153. #define NODE_INLINE_CODE CMARK_NODE_INLINE_CODE
  154. #define NODE_INLINE_HTML CMARK_NODE_INLINE_HTML
  155. #define NODE_EMPH CMARK_NODE_EMPH
  156. #define NODE_STRONG CMARK_NODE_STRONG
  157. #define NODE_LINK CMARK_NODE_LINK
  158. #define NODE_IMAGE CMARK_NODE_IMAGE
  159. #define NODE_LINK_LABEL CMARK_NODE_LINK_LABEL
  160. #define BULLET_LIST CMARK_BULLET_LIST
  161. #define ORDERED_LIST CMARK_ORDERED_LIST
  162. #define PERIOD_DELIM CMARK_PERIOD_DELIM
  163. #define PAREN_DELIM CMARK_PAREN_DELIM
  164. #endif
  165. #ifdef __cplusplus
  166. }
  167. #endif
  168. #endif