aboutsummaryrefslogtreecommitdiff
path: root/src/cmark.h
blob: 522e77eb3104c6e1090215645dfc4fcb07873480 (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_content(cmark_node *node);
  71. CMARK_EXPORT int
  72. cmark_node_set_content(cmark_node *node, const char *content);
  73. CMARK_EXPORT const char*
  74. cmark_node_get_url(cmark_node *node);
  75. CMARK_EXPORT int
  76. cmark_node_set_url(cmark_node *node, const char *url);
  77. // Tree manipulation
  78. CMARK_EXPORT void
  79. cmark_node_unlink(cmark_node *node);
  80. CMARK_EXPORT int
  81. cmark_node_insert_before(cmark_node *node, cmark_node *sibling);
  82. CMARK_EXPORT int
  83. cmark_node_insert_before(cmark_node *node, cmark_node *sibling);
  84. CMARK_EXPORT int
  85. cmark_node_prepend_child(cmark_node *node, cmark_node *child);
  86. CMARK_EXPORT int
  87. cmark_node_append_child(cmark_node *node, cmark_node *child);
  88. // Parser
  89. CMARK_EXPORT
  90. cmark_doc_parser *cmark_new_doc_parser();
  91. CMARK_EXPORT
  92. void cmark_free_doc_parser(cmark_doc_parser *parser);
  93. CMARK_EXPORT
  94. cmark_node *cmark_finish(cmark_doc_parser *parser);
  95. CMARK_EXPORT
  96. void cmark_process_line(cmark_doc_parser *parser, const unsigned char *buffer, size_t bytes);
  97. CMARK_EXPORT
  98. cmark_node *cmark_parse_document(const unsigned char *buffer, size_t len);
  99. CMARK_EXPORT
  100. cmark_node *cmark_parse_file(FILE *f);
  101. // Renderer
  102. CMARK_EXPORT
  103. void cmark_debug_print(cmark_node *root);
  104. CMARK_EXPORT
  105. unsigned char *cmark_render_html(cmark_node *root);
  106. CMARK_EXPORT
  107. unsigned char *cmark_markdown_to_html(unsigned char *text, int len);
  108. #ifndef CMARK_NO_SHORT_NAMES
  109. #define NODE_DOCUMENT CMARK_NODE_DOCUMENT
  110. #define NODE_BQUOTE CMARK_NODE_BQUOTE
  111. #define NODE_LIST CMARK_NODE_LIST
  112. #define NODE_LIST_ITEM CMARK_NODE_LIST_ITEM
  113. #define NODE_FENCED_CODE CMARK_NODE_FENCED_CODE
  114. #define NODE_INDENTED_CODE CMARK_NODE_INDENTED_CODE
  115. #define NODE_HTML CMARK_NODE_HTML
  116. #define NODE_PARAGRAPH CMARK_NODE_PARAGRAPH
  117. #define NODE_ATX_HEADER CMARK_NODE_ATX_HEADER
  118. #define NODE_SETEXT_HEADER CMARK_NODE_SETEXT_HEADER
  119. #define NODE_HRULE CMARK_NODE_HRULE
  120. #define NODE_REFERENCE_DEF CMARK_NODE_REFERENCE_DEF
  121. #define NODE_STRING CMARK_NODE_STRING
  122. #define NODE_SOFTBREAK CMARK_NODE_SOFTBREAK
  123. #define NODE_LINEBREAK CMARK_NODE_LINEBREAK
  124. #define NODE_INLINE_CODE CMARK_NODE_INLINE_CODE
  125. #define NODE_INLINE_HTML CMARK_NODE_INLINE_HTML
  126. #define NODE_EMPH CMARK_NODE_EMPH
  127. #define NODE_STRONG CMARK_NODE_STRONG
  128. #define NODE_LINK CMARK_NODE_LINK
  129. #define NODE_IMAGE CMARK_NODE_IMAGE
  130. #define NODE_LINK_LABEL CMARK_NODE_LINK_LABEL
  131. #define BULLET_LIST CMARK_BULLET_LIST
  132. #define ORDERED_LIST CMARK_ORDERED_LIST
  133. #define PERIOD_DELIM CMARK_PERIOD_DELIM
  134. #define PAREN_DELIM CMARK_PAREN_DELIM
  135. #define free_simple cmark_free_simple
  136. #define free_blocks cmark_free_blocks
  137. #define doc_parser cmark_doc_parser
  138. #define new_doc_parser cmark_new_doc_parser
  139. #define free_doc_parser cmark_free_doc_parser
  140. #define process_line cmark_process_line
  141. #define finish cmark_finish
  142. #define block_next cmark_block_next
  143. #define block_previous cmark_block_previous
  144. #define block_parent cmark_block_parent
  145. #define block_children cmark_block_children
  146. #define block_delete cmark_block_delete
  147. #define block_insert_before cmark_block_insert_before
  148. #define block_insert_after cmark_block_insert_after
  149. #endif
  150. #ifdef __cplusplus
  151. }
  152. #endif
  153. #endif