wbrawner/hoedown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
hoedown/src/markdown.h

131 lines
5.5 KiB
C
Raw Normal View History

Initial commit
2011-04-15 08:36:46 +00:00
/* markdown.h - generic markdown parser */
Begin code reorganization
2013-09-20 06:09:52 +00:00
#ifndef HOEDOWN_MARKDOWN_H
#define HOEDOWN_MARKDOWN_H
Initial commit
2011-04-15 08:36:46 +00:00
#include "buffer.h"
autolink: Cleanup API
2011-06-09 00:58:06 +00:00
#include "autolink.h"
Initial commit
2011-04-15 08:36:46 +00:00
add extern C declaration when using c++ compiler
2012-04-04 19:15:29 +00:00
#ifdef __cplusplus
extern "C" {
#endif
Reset version to 0.0.1
2013-09-20 16:46:49 +00:00
#define HOEDOWN_VERSION "0.0.1"
More cleanup and API coalescing
2013-09-24 00:35:54 +00:00
#define HOEDOWN_VERSION_MAJOR 0
#define HOEDOWN_VERSION_MINOR 0
#define HOEDOWN_VERSION_REVISION 1
Add support for versioning
2011-05-11 17:07:28 +00:00
Initial commit
2011-04-15 08:36:46 +00:00
/********************
* TYPE DEFINITIONS *
********************/
BEHOLD! The MKD enums are now HOEDOWN ones.
2013-09-20 19:39:56 +00:00
/* hoedown_autolink - type of autolink */
enum hoedown_autolink {
More cleanup and API coalescing
2013-09-24 00:35:54 +00:00
HOEDOWN_AUTOLINK_NONE, /* used internally when it is not an autolink*/
HOEDOWN_AUTOLINK_NORMAL, /* normal http/http/ftp/mailto/etc link */
HOEDOWN_AUTOLINK_EMAIL /* e-mail link without explit mailto: */
Initial commit
2011-04-15 08:36:46 +00:00
};
BEHOLD! The MKD enums are now HOEDOWN ones.
2013-09-20 19:39:56 +00:00
enum hoedown_tableflags {
HOEDOWN_TABLE_ALIGN_L = 1,
HOEDOWN_TABLE_ALIGN_R = 2,
HOEDOWN_TABLE_ALIGN_CENTER = 3,
HOEDOWN_TABLE_ALIGNMASK = 3,
HOEDOWN_TABLE_HEADER = 4
Cleanup table parsing
2011-08-09 04:11:42 +00:00
};
BEHOLD! The MKD enums are now HOEDOWN ones.
2013-09-20 19:39:56 +00:00
enum hoedown_extensions {
HOEDOWN_EXT_NO_INTRA_EMPHASIS = (1 << 0),
HOEDOWN_EXT_TABLES = (1 << 1),
HOEDOWN_EXT_FENCED_CODE = (1 << 2),
HOEDOWN_EXT_AUTOLINK = (1 << 3),
HOEDOWN_EXT_STRIKETHROUGH = (1 << 4),
HOEDOWN_EXT_UNDERLINE = (1 << 5),
HOEDOWN_EXT_SPACE_HEADERS = (1 << 6),
HOEDOWN_EXT_SUPERSCRIPT = (1 << 7),
HOEDOWN_EXT_LAX_SPACING = (1 << 8),
HOEDOWN_EXT_DISABLE_INDENTED_CODE = (1 << 9),
HOEDOWN_EXT_HIGHLIGHT = (1 << 10),
HOEDOWN_EXT_FOOTNOTES = (1 << 11),
HOEDOWN_EXT_QUOTE = (1 << 12)
Initial commit
2011-04-15 08:36:46 +00:00
};
Begin code reorganization
2013-09-20 06:09:52 +00:00
/* hoedown_callbacks - functions for rendering parsed data */
struct hoedown_callbacks {
Initial commit
2011-04-15 08:36:46 +00:00
/* block level callbacks - NULL skips the block */
Begin code reorganization
2013-09-20 06:09:52 +00:00
void (*blockcode)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, const struct hoedown_buffer *lang, void *opaque);
void (*blockquote)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, void *opaque);
void (*blockhtml)(struct hoedown_buffer *ob,const struct hoedown_buffer *text, void *opaque);
void (*header)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, int level, void *opaque);
void (*hrule)(struct hoedown_buffer *ob, void *opaque);
void (*list)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, int flags, void *opaque);
void (*listitem)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, int flags, void *opaque);
void (*paragraph)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, void *opaque);
void (*table)(struct hoedown_buffer *ob, const struct hoedown_buffer *header, const struct hoedown_buffer *body, void *opaque);
void (*table_row)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, void *opaque);
void (*table_cell)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, int flags, void *opaque);
void (*footnotes)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, void *opaque);
void (*footnote_def)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, unsigned int num, void *opaque);
Initial commit
2011-04-15 08:36:46 +00:00
/* span level callbacks - NULL or return 0 prints the span verbatim */
BEHOLD! The MKD enums are now HOEDOWN ones.
2013-09-20 19:39:56 +00:00
int (*autolink)(struct hoedown_buffer *ob, const struct hoedown_buffer *link, enum hoedown_autolink type, void *opaque);
Begin code reorganization
2013-09-20 06:09:52 +00:00
int (*codespan)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, void *opaque);
int (*double_emphasis)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, void *opaque);
int (*emphasis)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, void *opaque);
int (*underline)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, void *opaque);
int (*highlight)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, void *opaque);
int (*quote)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, void *opaque);
int (*image)(struct hoedown_buffer *ob, const struct hoedown_buffer *link, const struct hoedown_buffer *title, const struct hoedown_buffer *alt, void *opaque);
int (*linebreak)(struct hoedown_buffer *ob, void *opaque);
int (*link)(struct hoedown_buffer *ob, const struct hoedown_buffer *link, const struct hoedown_buffer *title, const struct hoedown_buffer *content, void *opaque);
int (*raw_html_tag)(struct hoedown_buffer *ob, const struct hoedown_buffer *tag, void *opaque);
int (*triple_emphasis)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, void *opaque);
int (*strikethrough)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, void *opaque);
int (*superscript)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, void *opaque);
int (*footnote_ref)(struct hoedown_buffer *ob, unsigned int num, void *opaque);
Initial commit
2011-04-15 08:36:46 +00:00
/* low level callbacks - NULL copies input directly into the output */
Begin code reorganization
2013-09-20 06:09:52 +00:00
void (*entity)(struct hoedown_buffer *ob, const struct hoedown_buffer *entity, void *opaque);
void (*normal_text)(struct hoedown_buffer *ob, const struct hoedown_buffer *text, void *opaque);
Initial commit
2011-04-15 08:36:46 +00:00
/* header and footer */
Begin code reorganization
2013-09-20 06:09:52 +00:00
void (*doc_header)(struct hoedown_buffer *ob, void *opaque);
void (*doc_footer)(struct hoedown_buffer *ob, void *opaque);
Initial commit
2011-04-15 08:36:46 +00:00
};
Begin code reorganization
2013-09-20 06:09:52 +00:00
struct hoedown_markdown;
Create a standalone `markdown` object This was the next logical step on the interface revamp for 2.0. The old API was doing very fishy stuff with allocation: the `rndr` struct was being called once for every `sd_markdown` call, and the amount stack space filled with it was just inappropriate (256 bytes just from the char table and 300 more from pointers in the callback table). By creating the renderer on the heap and reusing it, we save a lot of time on initialization code, at the expense of not being able to change the enabled extensions on each parse (something which is not that common anyway). This will make wrapping Sundown in higher level languages more direct, given that every other language has OO design, which maps better to the concept of a reusable renderer.
2011-09-01 03:02:26 +00:00
Initial commit
2011-04-15 08:36:46 +00:00
/*********
* FLAGS *
*********/
/* list/listitem flags */
BEHOLD! The MKD enums are now HOEDOWN ones.
2013-09-20 19:39:56 +00:00
#define HOEDOWN_LIST_ORDERED 1
More cleanup and API coalescing
2013-09-24 00:35:54 +00:00
#define HOEDOWN_LI_BLOCK 2 /* <li> containing block data */
Initial commit
2011-04-15 08:36:46 +00:00
/**********************
* EXPORTED FUNCTIONS *
**********************/
Begin code reorganization
2013-09-20 06:09:52 +00:00
extern struct hoedown_markdown *
hoedown_markdown_new(
Create a standalone `markdown` object This was the next logical step on the interface revamp for 2.0. The old API was doing very fishy stuff with allocation: the `rndr` struct was being called once for every `sd_markdown` call, and the amount stack space filled with it was just inappropriate (256 bytes just from the char table and 300 more from pointers in the callback table). By creating the renderer on the heap and reusing it, we save a lot of time on initialization code, at the expense of not being able to change the enabled extensions on each parse (something which is not that common anyway). This will make wrapping Sundown in higher level languages more direct, given that every other language has OO design, which maps better to the concept of a reusable renderer.
2011-09-01 03:02:26 +00:00
unsigned int extensions,
size_t max_nesting,
Begin code reorganization
2013-09-20 06:09:52 +00:00
const struct hoedown_callbacks *callbacks,
Enforce const on input document
2011-09-02 19:28:47 +00:00
void *opaque);
Create a standalone `markdown` object This was the next logical step on the interface revamp for 2.0. The old API was doing very fishy stuff with allocation: the `rndr` struct was being called once for every `sd_markdown` call, and the amount stack space filled with it was just inappropriate (256 bytes just from the char table and 300 more from pointers in the callback table). By creating the renderer on the heap and reusing it, we save a lot of time on initialization code, at the expense of not being able to change the enabled extensions on each parse (something which is not that common anyway). This will make wrapping Sundown in higher level languages more direct, given that every other language has OO design, which maps better to the concept of a reusable renderer.
2011-09-01 03:02:26 +00:00
extern void
Begin code reorganization
2013-09-20 06:09:52 +00:00
hoedown_markdown_render(struct hoedown_buffer *ob, const uint8_t *document, size_t doc_size, struct hoedown_markdown *md);
Create a standalone `markdown` object This was the next logical step on the interface revamp for 2.0. The old API was doing very fishy stuff with allocation: the `rndr` struct was being called once for every `sd_markdown` call, and the amount stack space filled with it was just inappropriate (256 bytes just from the char table and 300 more from pointers in the callback table). By creating the renderer on the heap and reusing it, we save a lot of time on initialization code, at the expense of not being able to change the enabled extensions on each parse (something which is not that common anyway). This will make wrapping Sundown in higher level languages more direct, given that every other language has OO design, which maps better to the concept of a reusable renderer.
2011-09-01 03:02:26 +00:00
Initial commit
2011-04-15 08:36:46 +00:00
extern void
Begin code reorganization
2013-09-20 06:09:52 +00:00
hoedown_markdown_free(struct hoedown_markdown *md);
Initial commit
2011-04-15 08:36:46 +00:00
Add support for versioning
2011-05-11 17:07:28 +00:00
extern void
Begin code reorganization
2013-09-20 06:09:52 +00:00
hoedown_version(int *major, int *minor, int *revision);
Add support for versioning
2011-05-11 17:07:28 +00:00
add extern C declaration when using c++ compiler
2012-04-04 19:15:29 +00:00
#ifdef __cplusplus
}
#endif
Make headers consistent (comments, guard names)
2013-09-20 16:04:07 +00:00
#endif /** HOEDOWN_MARKDOWN_H **/
Reference in a new issue Copy permalink