aboutsummaryrefslogtreecommitdiff
path: root/src/cmark.h
blob: a23b5879374894a4b0951c50d700c48de2824e8c (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_BULLET_LIST,
  40. CMARK_ORDERED_LIST
  41. } cmark_list_type;
  42. typedef enum {
  43. CMARK_PERIOD_DELIM,
  44. CMARK_PAREN_DELIM
  45. } cmark_delim_type;
  46. typedef struct cmark_node cmark_node;
  47. typedef struct cmark_doc_parser cmark_doc_parser;
  48. // Construction and destruction
  49. CMARK_EXPORT cmark_node*
  50. cmark_node_new(cmark_node_type type);
  51. CMARK_EXPORT void
  52. cmark_node_destroy(cmark_node *node);
  53. CMARK_EXPORT void
  54. cmark_free_nodes(cmark_node *e);
  55. // Tree traversal
  56. CMARK_EXPORT cmark_node*
  57. cmark_node_next(cmark_node *node);
  58. CMARK_EXPORT cmark_node*
  59. cmark_node_previous(cmark_node *node);
  60. CMARK_EXPORT cmark_node*
  61. cmark_node_parent(cmark_node *node);
  62. CMARK_EXPORT cmark_node*
  63. cmark_node_first_child(cmark_node *node);
  64. CMARK_EXPORT cmark_node*
  65. cmark_node_last_child(cmark_node *node);
  66. // Accessors
  67. CMARK_EXPORT cmark_node_type
  68. cmark_node_get_type(cmark_node *node);
  69. CMARK_EXPORT const char*
  70. cmark_node_get_string_content(cmark_node *node);
  71. CMARK_EXPORT int
  72. cmark_node_set_string_content(cmark_node *node, const char *content);
  73. CMARK_EXPORT int
  74. cmark_node_get_header_level(cmark_node *node);
  75. CMARK_EXPORT int
  76. cmark_node_set_header_level(cmark_node *node, int level);
  77. CMARK_EXPORT const char*
  78. cmark_node_get_url(cmark_node *node);
  79. CMARK_EXPORT int
  80. cmark_node_set_url(cmark_node *node, const char *url);
  81. // Tree manipulation
  82. CMARK_EXPORT void
  83. cmark_node_unlink(cmark_node *node);
  84. CMARK_EXPORT int
  85. cmark_node_insert_before(cmark_node *node, cmark_node *sibling);
  86. CMARK_EXPORT int
  87. cmark_node_insert_after(cmark_node *node, cmark_node *sibling);
  88. CMARK_EXPORT int
  89. cmark_node_prepend_child(cmark_node *node, cmark_node *child);
  90. CMARK_EXPORT int
  91. cmark_node_append_child(cmark_node *node, cmark_node *child);
  92. // Parser
  93. CMARK_EXPORT
  94. cmark_doc_parser *cmark_new_doc_parser();
  95. CMARK_EXPORT
  96. void cmark_free_doc_parser(cmark_doc_parser *parser);
  97. CMARK_EXPORT
  98. cmark_node *cmark_finish(cmark_doc_parser *parser);
  99. CMARK_EXPORT
  100. void cmark_process_line(cmark_doc_parser *parser, const unsigned char *buffer, size_t bytes);
  101. CMARK_EXPORT
  102. cmark_node *cmark_parse_document(const unsigned char *buffer, size_t len);
  103. CMARK_EXPORT
  104. cmark_node *cmark_parse_file(FILE *f);
  105. // Renderer
  106. CMARK_EXPORT
  107. void cmark_debug_print(cmark_node *root);
  108. CMARK_EXPORT
  109. unsigned char *cmark_render_html(cmark_node *root);
  110. CMARK_EXPORT
  111. unsigned char *cmark_markdown_to_html(unsigned char *text, int len);
  112. #ifndef CMARK_NO_SHORT_NAMES
  113. #define NODE_DOCUMENT CMARK_NODE_DOCUMENT
  114. #define NODE_BQUOTE CMARK_NODE_BQUOTE
  115. #define NODE_LIST CMARK_NODE_LIST
  116. #define NODE_LIST_ITEM CMARK_NODE_LIST_ITEM
  117. #define NODE_FENCED_CODE CMARK_NODE_FENCED_CODE
  118. #define NODE_INDENTED_CODE CMARK_NODE_INDENTED_CODE
  119. #define NODE_HTML CMARK_NODE_HTML
  120. #define NODE_PARAGRAPH CMARK_NODE_PARAGRAPH
  121. #define NODE_ATX_HEADER CMARK_NODE_ATX_HEADER
  122. #define NODE_SETEXT_HEADER CMARK_NODE_SETEXT_HEADER
  123. #define NODE_HRULE CMARK_NODE_HRULE
  124. #define NODE_REFERENCE_DEF CMARK_NODE_REFERENCE_DEF
  125. #define NODE_STRING CMARK_NODE_STRING
  126. #define NODE_SOFTBREAK CMARK_NODE_SOFTBREAK
  127. #define NODE_LINEBREAK CMARK_NODE_LINEBREAK
  128. #define NODE_INLINE_CODE CMARK_NODE_INLINE_CODE
  129. #define NODE_INLINE_HTML CMARK_NODE_INLINE_HTML
  130. #define NODE_EMPH CMARK_NODE_EMPH
  131. #define NODE_STRONG CMARK_NODE_STRONG
  132. #define NODE_LINK CMARK_NODE_LINK
  133. #define NODE_IMAGE CMARK_NODE_IMAGE
  134. #define NODE_LINK_LABEL CMARK_NODE_LINK_LABEL
  135. #define BULLET_LIST CMARK_BULLET_LIST
  136. #define ORDERED_LIST CMARK_ORDERED_LIST
  137. #define PERIOD_DELIM CMARK_PERIOD_DELIM
  138. #define PAREN_DELIM CMARK_PAREN_DELIM
  139. #define free_simple cmark_free_simple
  140. #define free_blocks cmark_free_blocks
  141. #define doc_parser cmark_doc_parser
  142. #define new_doc_parser cmark_new_doc_parser
  143. #define free_doc_parser cmark_free_doc_parser
  144. #define process_line cmark_process_line
  145. #define finish cmark_finish
  146. #define block_next cmark_block_next
  147. #define block_previous cmark_block_previous
  148. #define block_parent cmark_block_parent
  149. #define block_children cmark_block_children
  150. #define block_delete cmark_block_delete
  151. #define block_insert_before cmark_block_insert_before
  152. #define block_insert_after cmark_block_insert_after
  153. #endif
  154. #ifdef __cplusplus
  155. }
  156. #endif
  157. #endif