rmultimarkdown 4.7.1.1 → 6.2.2.1

data/ext/mmd/html.h

@@ -0,0 +1,81 @@
+/**
+
+	MultiMarkdown 6 -- Lightweight markup processor to produce HTML, LaTeX, and more.
+
+	@file html.h
+
+	@brief Convert token tree to HTML output.
+
+
+	@author	Fletcher T. Penney
+	@bug
+
+**/
+
+/*
+
+	Copyright © 2016 - 2017 Fletcher T. Penney.
+
+
+	The `MultiMarkdown 6` project is released under the MIT License..
+
+	GLibFacade.c and GLibFacade.h are from the MultiMarkdown v4 project:
+
+		https://github.com/fletcher/MultiMarkdown-4/
+
+	MMD 4 is released under both the MIT License and GPL.
+
+
+	CuTest is released under the zlib/libpng license. See CuTest.c for the text
+	of the license.
+
+
+	## The MIT License ##
+
+	Permission is hereby granted, free of charge, to any person obtaining a copy
+	of this software and associated documentation files (the "Software"), to deal
+	in the Software without restriction, including without limitation the rights
+	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+	copies of the Software, and to permit persons to whom the Software is
+	furnished to do so, subject to the following conditions:
+
+	The above copyright notice and this permission notice shall be included in
+	all copies or substantial portions of the Software.
+
+	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+	THE SOFTWARE.
+
+*/
+
+
+#ifndef HTML_MULTIMARKDOWN_H
+#define HTML_MULTIMARKDOWN_H
+
+#include "d_string.h"
+#include "token.h"
+#include "writer.h"
+
+void mmd_export_token_html(DString * out, const char * source, token * t, scratch_pad * scratch);
+void mmd_export_token_tree_html(DString * out, const char * source, token * t, scratch_pad * scratch);
+
+
+void mmd_export_token_html_raw(DString * out, const char * source, token * t, scratch_pad * scratch);
+void mmd_export_token_tree_html_raw(DString * out, const char * source, token * t, scratch_pad * scratch);
+void mmd_export_token_tree_html_math(DString * out, const char * source, token * t, scratch_pad * scratch);
+
+void mmd_export_citation_list_html(DString * out, const char * source, scratch_pad * scratch);
+void mmd_export_footnote_list_html(DString * out, const char * source, scratch_pad * scratch);
+void mmd_export_glossary_list_html(DString * out, const char * source, scratch_pad * scratch);
+
+void mmd_start_complete_html(DString * out, const char * source, scratch_pad * scratch);
+void mmd_end_complete_html(DString * out, const char * source, scratch_pad * scratch);
+
+void mmd_print_string_html(DString * out, const char * str, bool obfuscate);
+
+
+#endif

data/ext/mmd/i18n.h

@@ -0,0 +1,170 @@
+/**
+
+	MultiMarkdown 6 -- MultiMarkdown - lightweight markup processor.
+
+	@file i18n.h
+
+	@brief Provide rudimentary ability to provide translation string functionality.
+	This file enables calculating hash values of built in strings in order to allow
+	swapping out certain strings based on user-specified languages at runtime.
+
+	This does slow down compiling, as multiple hash strings are compiled (seemingly
+	quite slowly).  But, to my understanding and testing, it does not affect the
+	speed when actually running MMD.  This should allow translating an arbitrary
+	number of strings into an arbitrary number of languages without a performance
+	penalty.
+
+
+	@author	Fletcher T. Penney
+	@bug
+
+**/
+
+/*
+
+	Copyright © 2016 - 2017 Fletcher T. Penney.
+
+*/
+
+
+#ifndef I18N_MULTIMARKDOWN_6_H
+#define I18N_MULTIMARKDOWN_6_H
+
+
+#include <string.h>
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+
+
+#define kNumberOfLanguages 7
+#define kNumberOfStrings 4
+#define kLanguage 0
+
+//!< #define this in order to disable translations -- speeds up compiling
+// #define I18N_DISABLED
+
+
+// Hash function from http://lolengine.net/blog/2011/12/20/cpp-constant-string-hash
+// via http://stackoverflow.com/questions/2826559/compile-time-preprocessor-hashing-of-string
+
+
+#ifdef I18N_DISABLED
+	#define LC(x) x
+	#define LANG_FROM_STR(x) 0
+#else
+	#define H1(s,i,x)   (x*65599u+(uint8_t)s[(i)<strlen(s)?strlen(s)-1-(i):strlen(s)])
+	#define H4(s,i,x)   H1(s,i,H1(s,i+1,H1(s,i+2,H1(s,i+3,x))))
+	#define H16(s,i,x)  H4(s,i,H4(s,i+4,H4(s,i+8,H4(s,i+12,x))))
+	#define H64(s,i,x)  H16(s,i,H16(s,i+16,H16(s,i+32,H16(s,i+48,x))))
+	#define H256(s,i,x) H64(s,i,H64(s,i+64,H64(s,i+128,H64(s,i+192,x))))
+
+	#define HASH(s)    ((uint32_t)(H256(s,0,0)^(H256(s,0,0)>>16)))
+
+	#define LC(x) Translate(HASH(x), scratch->language)
+
+	//#define LC(x) TranslateTest(__COUNTER__, __FILE__, __LINE__, __FUNCTION__ , x)
+
+	#define LANG_FROM_STR(x) i18n_language_from_string(x)
+
+
+// Create the dictionary array
+static const char * lc_lookup[kNumberOfLanguages * kNumberOfStrings] = {
+	"return to body",				// English
+	"Regresar al texto",			// Español
+	"Zum Haupttext",				// Deutsch
+	"Retour au texte principal",	// Français
+	"Ga terug naar tekstlichaam",	// Nederlands
+	"Återgå till textkroppen",		// Svenska
+	"חזור/י לגוף הטקסט",				// Hebrew - עברית
+
+	"see footnote",					// English
+	"Ver nota a pie de página",		// Español
+	"Siehe Fußnote",				// Deutsch
+	"Voir note de bas de page",		// Français
+	"Zie vootnot",					// Nederlands
+	"Se fotnot",					// Svenska
+	"ראה/י הערה",					// Hebrew - עברית
+
+	"see citation",					// English
+	"Ver referencia",				// Español
+	"Siehe Zitat",					// Deutsch
+	"Voir citation",				// Français
+	"Zie citaat",					// Nederlands
+	"Se citat",						// Svenska
+	"ראה/י ציטוט",					// Hebrew - עברית
+
+	"see glossary",					// English
+	"Ver glosario",					// Español
+	"Siehe Glossar",				// Deutsch
+	"Voir glossaire",				// Français
+	"Zie woordenlijst",				// Nederlands
+	"Se ordlista",					// Svenska
+	"ראה/י מילון מונחים",				// Hebrew - עברית
+};
+
+
+// Used for development when a new string is added to the dictionary and
+// we need to know the hash
+static inline const char * TranslateTest(int c, char * file, int line, const char func[], char * x) {
+	fprintf(stderr, "%s: %d (%s) -> %d\n", file, line, func, c);
+	unsigned long h = HASH(x);
+	fprintf(stderr, "hash '%s' -> %lu\n", x, h);
+
+	return lc_lookup[(c * kNumberOfLanguages) + kLanguage];
+}
+
+
+// Given a hash and language, return the proper string
+static inline const char * Translate(unsigned long x, int l) {
+	switch (x) {
+		case 3219553713:
+			return lc_lookup[0 * kNumberOfLanguages + l];
+		case 657226305:
+			return lc_lookup[1 * kNumberOfLanguages + l];
+		case 2977473004:
+			return lc_lookup[2 * kNumberOfLanguages + l];
+		case 3851221863:
+			return lc_lookup[3 * kNumberOfLanguages + l];
+		default:
+			return "localization error";
+	}
+}
+
+
+#endif
+
+
+// Based on ISO 639-1 names
+// https://en.wikipedia.org/wiki/ISO_639-1
+enum lc_languages {
+	LC_EN = 0,			//!< English is default
+	LC_ES,				//!< Español
+	LC_DE,				//!< Deutsch
+	LC_FR,				//!< Français
+	LC_NL,				//!< Nederlands
+	LC_SV,				//!< Svenska
+	LC_HE,				//!< Hebrew - עברית
+};
+
+
+// MMD expects a lower case 2 letter code in the metadata or command-line arguments
+static inline short i18n_language_from_string(const char * l) {
+	if (strcmp(l, "es") == 0) {
+		return LC_ES;
+	} else if (strcmp(l, "de") == 0) {
+		return LC_DE;
+	} else if (strcmp(l, "fr") == 0) {
+		return LC_FR;
+	} else if (strcmp(l, "he") == 0) {
+		return LC_HE;
+	} else if (strcmp(l, "nl") == 0) {
+		return LC_NL;
+	} else if (strcmp(l, "sv") == 0) {
+		return LC_SV;
+	}
+
+	return 0;
+}
+
+#endif

data/ext/mmd/include/d_string.h

@@ -0,0 +1,182 @@
+/**
+
+	MultiMarkdown 6 -- Lightweight markup processor to produce HTML, LaTeX, and more.
+
+	@file d_string.h
+
+	@brief Dynamic string -- refactoring of old GLibFacade.  Provides a string
+	"object" that can grow to accomodate any size content that is appended.
+
+
+	@author	Daniel Jalkut, modified by Fletcher T. Penney and Dan Lowe
+
+	@bug	
+
+**/
+
+/*
+
+	Copyright © 2011 Daniel Jalkut.
+	Modifications by Fletcher T. Penney, Copyright © 2011-2017 Fletcher T. Penney.
+	Modifications by Dan Lowe, Copyright © 2011 Dan Lowe.
+
+
+	The `MultiMarkdown 6` project is released under the MIT License..
+	
+	GLibFacade.c and GLibFacade.h are from the MultiMarkdown v4 project:
+	
+		https://github.com/fletcher/MultiMarkdown-4/
+	
+	MMD 4 is released under both the MIT License and GPL.
+	
+	
+	CuTest is released under the zlib/libpng license. See CuTest.c for the text
+	of the license.
+	
+	
+	## The MIT License ##
+	
+	Permission is hereby granted, free of charge, to any person obtaining a copy
+	of this software and associated documentation files (the "Software"), to deal
+	in the Software without restriction, including without limitation the rights
+	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+	copies of the Software, and to permit persons to whom the Software is
+	furnished to do so, subject to the following conditions:
+	
+	The above copyright notice and this permission notice shall be included in
+	all copies or substantial portions of the Software.
+	
+	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+	THE SOFTWARE.
+
+*/
+
+
+#ifndef D_STRING_SMART_STRING_H
+#define D_STRING_SMART_STRING_H
+
+#include <stdbool.h>
+#include <stdlib.h>
+
+/* WE implement minimal mirror implementations of GLib's GString  
+ * sufficient to cover the functionality required by MultiMarkdown.
+ *
+ * NOTE: THese are 100% clean, from-scratch implementations using only the 
+ * GLib function prototype as guide for behavior.
+ */
+
+
+/// Structure for dynamic string
+typedef struct 
+{	
+	char * str;								//!< Pointer to UTF-8 byte stream for string
+	unsigned long currentStringBufferSize;	//!< Size of buffer currently allocated
+	unsigned long currentStringLength;		//!< Size of current string
+} DString;
+
+
+/// Create a new dynamic string
+DString * d_string_new(
+	const char * startingString				//!< Initial contents for string		
+);
+
+
+/// Free dynamic string
+char * d_string_free(
+	DString * ripString,					//!< DString to be freed
+	bool freeCharacterData					//!< Should the underlying str be freed as well?
+);
+
+
+/// Append null-terminated string to end of dynamic string
+void d_string_append(
+	DString * baseString,					//!< DString to be appended
+	const char * appendedString				//!< String to be appended
+);
+
+
+/// Append single character to end of dynamic string
+void d_string_append_c(
+	DString * baseString,					//!< DString to be appended
+	char appendedCharacter					//!< Character to append
+);
+
+
+/// Append array of characters to end of dynamic string
+void d_string_append_c_array(
+	DString * baseString,					//!< DString to be appended
+	const char * appendedChars,				//!< String to be appended
+	size_t bytes							//!< Number of bytes to append
+);
+
+
+/// Append to end of dynamic string using format specifier
+void d_string_append_printf(
+	DString * baseString,					//!< DString to be appended
+	const char * format,					//!< Format specifier for appending
+	...										//!< Arguments for format specifier
+);
+
+
+/// Prepend null-terminated string to end of dynamic string
+void d_string_prepend(
+	DString * baseString,					//!< DString to be appended
+	const char * prependedString			//!< String to be prepended
+);
+
+
+/// Insert null-terminated string inside dynamic string
+void d_string_insert(
+	DString * baseString,					//!< DString to be appended
+	size_t pos,								//!< Offset at which to insert string
+	const char * insertedString				//!< String to be inserted
+);
+
+
+/// Insert single character inside dynamic string
+void d_string_insert_c(
+	DString * baseString,					//!< DString to be appended
+	size_t pos,								//!< Offset at which to insert string
+	char insertedCharacter					//!< Character to insert
+);
+
+
+/// Insert inside dynamic string using format specifier
+void d_string_insert_printf(
+	DString * baseString,					//!< DString to be appended
+	size_t pos,								//!< Offset at which to insert string
+	const char * format,					//!< Format specifier for appending
+	...										//!< Arguments for format specifier
+);
+
+
+/// Erase portion of dynamic string
+void d_string_erase(
+	DString * baseString,					//!< DString to be appended
+	size_t pos,								//!< Offset at which to erase portion of string
+	size_t len								//!< Character to append
+);
+
+/// Copy a portion of dynamic string
+char * d_string_copy_substring(
+	DString * d,							//!< DString to copy
+	size_t start,							//!< Start position for copy
+	size_t len								//!< How many characters(bytes) to copy
+);
+
+/// Replace occurences of "original" with "replace" inside the specified range
+/// Returns the change in overall length
+long d_string_replace_text_in_range(
+	DString * d,
+	size_t pos,
+	size_t len,
+	const char * original,
+	const char * replace
+);
+
+#endif

data/ext/mmd/include/libMultiMarkdown.h

@@ -0,0 +1,548 @@
+/**
+
+	MultiMarkdown 6 -- Lightweight markup processor to produce HTML, LaTeX, and more.
+
+	@file mmd.h
+
+	@brief Header file for libMultiMarkdown.
+
+
+	@author	Fletcher T. Penney
+	@bug	
+
+
+	******IMPORTANT******
+
+	If you are using libMultiMarkdown in your own project, you need to either:
+
+	1. Disable kUseObjectPool in `token.h`
+
+	2. Properly manage the `token_pool_init` and `token_pool_free` functions.
+
+
+	I recommend option #1, unless you absolutely need the best performance for 
+	long documents.  Doing #2 properly is tricky in any program that can handle
+	multiple MMD text strings at overlapping times.
+
+**/
+
+/*
+
+	Copyright © 2016 - 2017 Fletcher T. Penney.
+
+
+	The `MultiMarkdown 6` project is released under the MIT License..
+	
+	GLibFacade.c and GLibFacade.h are from the MultiMarkdown v4 project:
+	
+		https://github.com/fletcher/MultiMarkdown-4/
+	
+	MMD 4 is released under both the MIT License and GPL.
+	
+	
+	CuTest is released under the zlib/libpng license. See CuTest.c for the text
+	of the license.
+	
+	
+	## The MIT License ##
+	
+	Permission is hereby granted, free of charge, to any person obtaining a copy
+	of this software and associated documentation files (the "Software"), to deal
+	in the Software without restriction, including without limitation the rights
+	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+	copies of the Software, and to permit persons to whom the Software is
+	furnished to do so, subject to the following conditions:
+	
+	The above copyright notice and this permission notice shall be included in
+	all copies or substantial portions of the Software.
+	
+	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+	THE SOFTWARE.
+
+*/
+
+
+#ifndef MMD6_H
+#define MMD6_H
+
+#include <stdbool.h>
+#include <stdlib.h>
+
+
+#include "d_string.h"
+#include "token.h"
+
+
+/// There are 3 main versions of the primary functions:
+///
+///	* `mmd_string...` -- start from source text in c string
+/// * `mmd_d_string...` -- start from a DString (Useful if you already use DString's for your text)
+/// * `mmd_engine...` -- useful when you are processing the same source multiple times
+
+
+/*
+	C string variants
+*/
+
+/// Convert MMD text to specified format, with specified extensions, and language
+/// Returned char * must be freed
+char * mmd_string_convert(const char * source, unsigned long extensions, short format, short language);
+
+
+/// Convert MMD text to specified format using DString as a container for block of data
+/// and length of that block.  Must be used for "complex" output formats such as EPUB.
+/// Returned DString * must be freed
+DString * mmd_string_convert_to_data(const char * source, unsigned long extensions, short format, short language, const char * directory);
+
+
+/// Convert MMD text and write results to specified file -- used for "complex" output formats requiring
+/// multiple documents (e.g. EPUB)
+void mmd_string_convert_to_file(const char * source, unsigned long extensions, short format, short language, const char * directory, const char * filepath);
+
+
+/// Does the text have metadata?
+bool mmd_string_has_metadata(char * source, size_t * end);
+
+
+/// Return metadata keys, one per line
+/// Returned char * must be freed
+char * mmd_string_metadata_keys(char * source);
+
+
+/// Extract desired metadata as string value
+/// Returned char * must be freed
+char * mmd_string_metavalue_for_key(char * source, const char * key);
+
+
+/// Insert/replace metadata in string, returning new string
+char * mmd_string_update_metavalue_for_key(const char * source, const char * key, const char * value);
+
+
+/// Grab list of all transcluded files, but we need to know directory to search,
+/// as well as the path to the file
+/// Returned stack needs to be freed
+struct stack * mmd_string_transclusion_manifest(const char * source, const char * search_path, const char * source_path);
+
+
+
+
+/*
+	DString variants - DString ("dynamic string") is a mutable string implementation used in this project
+*/
+
+/// Convert MMD text to specified format, with specified extensions, and language
+/// Returned char * must be freed
+char * mmd_d_string_convert(DString * source, unsigned long extensions, short format, short language);
+
+
+/// Convert MMD text to specified format using DString as a container for block of data
+/// and length of that block.  Must be used for "complex" output formats such as EPUB.
+/// Returned DString * must be freed
+DString * mmd_d_string_convert_to_data(DString * source, unsigned long extensions, short format, short language, const char * directory);
+
+
+/// Convert MMD text and write results to specified file -- used for "complex" output formats requiring
+/// multiple documents (e.g. EPUB)
+void mmd_d_string_convert_to_file(DString * source, unsigned long extensions, short format, short language, const char * directory, const char * filepath);
+
+
+/// Does the text have metadata?
+bool mmd_d_string_has_metadata(DString * source, size_t * end);
+
+
+/// Return metadata keys, one per line
+/// Returned char * must be freed
+char * mmd_d_string_metadata_keys(DString * source);
+
+
+/// Extract desired metadata as string value
+/// Returned char * must be freed
+char * mmd_d_string_metavalue_for_key(DString * source, const char * key);
+
+
+/// Insert/replace metadata value in DString
+void mmd_d_string_update_metavalue_for_key(DString * source, const char * key, const char * value);
+
+
+/// Grab list of all transcluded files, but we need to know directory to search,
+/// as well as the path to the file
+/// Returned stack needs to be freed
+struct stack * mmd_d_string_transclusion_manifest(DString * source, const char * search_path, const char * source_path);
+
+
+
+
+/*
+	MMD Engine variants
+*/
+
+/// MMD Engine is used for storing configuration information for MMD parser
+typedef struct mmd_engine mmd_engine;
+
+
+/// Create MMD Engine using an existing DString (A new copy is *not* made)
+mmd_engine * mmd_engine_create_with_dstring(
+	DString *		d,
+	unsigned long	extensions
+);
+
+
+/// Create MMD Engine using a C string (A private copy of the string will be
+/// made.  The one passed here can be freed by the calling function)
+mmd_engine * mmd_engine_create_with_string(
+	const char *	str,
+	unsigned long	extensions
+);
+
+
+/// Reset engine when finished parsing. (Usually not necessary to use this.)
+void mmd_engine_reset(mmd_engine * e);
+
+
+/// Free an existing MMD Engine
+void mmd_engine_free(
+	mmd_engine * e,
+	bool freeDString
+);
+
+
+/// Set language and smart quotes language
+void mmd_engine_set_language(mmd_engine * e, short language);
+
+
+/// Parse part of the string into a token tree
+token * mmd_engine_parse_substring(mmd_engine * e, size_t byte_start, size_t byte_len);
+
+
+/// Parse the entire string into a token tree
+void mmd_engine_parse_string(mmd_engine * e);
+
+
+/// Export parsed token tree to output format
+void mmd_engine_export_token_tree(DString * out, mmd_engine * e, short format);
+
+
+/// Convert MMD text to specified format, with specified extensions, and language
+/// Returned char * must be freed
+char * mmd_engine_convert(mmd_engine * e, short format);
+
+
+/// Convert MMD text and write results to specified file -- used for "complex" output formats requiring
+/// multiple documents (e.g. EPUB)
+void mmd_engine_convert_to_file(mmd_engine * e, short format, const char * directory, const char * filepath);
+
+
+/// Convert MMD text to specified format using DString as a container for block of data
+/// and length of that block.  Must be used for "complex" output formats such as EPUB.
+/// Returned DString * must be freed
+DString * mmd_engine_convert_to_data(mmd_engine * e, short format, const char * directory);
+
+
+/// Does the text have metadata?
+bool mmd_engine_has_metadata(mmd_engine * e, size_t * end);
+
+
+/// Return metadata keys, one per line
+/// Returned char * must be freed
+char * mmd_engine_metadata_keys(mmd_engine * e);
+
+
+/// Extract desired metadata as string value
+char * mmd_engine_metavalue_for_key(mmd_engine * e, const char * key);
+
+
+/// Insert/replace metadata value in mmd_engine
+void mmd_engine_update_metavalue_for_key(mmd_engine * e, const char * key, const char * value);
+
+
+/// Grab list of all transcluded files, but we need to know directory to search,
+/// as well as the path to the file
+/// Returned stack needs to be freed
+struct stack * mmd_engine_transclusion_manifest(mmd_engine * e, const char * search_path, const char * source_path);
+
+
+
+
+/*
+	Utility functions
+*/
+
+/// Return the version string for this build of libMultiMarkdown
+/// The returned `char *` will need to be freed after it is no longer needed.
+char * mmd_version(void);
+
+
+// Read file into memory
+DString * scan_file(const char * fname);
+
+
+/// MMD Engine is used for storing configuration information for MMD parser
+typedef struct stack stack;
+
+
+/// Recursively transclude source text, given a search directory.
+/// Track files to prevent infinite recursive loops
+void mmd_transclude_source(DString * source, const char * search_path, const char * source_path, short format, struct stack * parsed, struct stack * manifest);
+
+
+/// If MMD Header metadata used, insert it into appropriate place
+void mmd_prepend_mmd_header(DString * source);
+
+
+/// If MMD Footer metadata used, insert it into appropriate place
+void mmd_append_mmd_footer(DString * source);
+
+
+/// Accept all CriticMarkup changes in the source string
+void mmd_critic_markup_accept(DString * d);
+
+
+/// Reject all CriticMarkup changes in the source string
+void mmd_critic_markup_reject(DString * d);
+
+
+/// Token types for parse tree
+enum token_types {
+	DOC_START_TOKEN = 0,	//!< DOC_START_TOKEN must be type 0
+
+	BLOCK_BLOCKQUOTE = 50,		//!< This must start *after* the largest number in parser.h
+	BLOCK_CODE_FENCED,
+	BLOCK_CODE_INDENTED,
+	BLOCK_DEFLIST,
+	BLOCK_DEFINITION,
+	BLOCK_DEF_ABBREVIATION,
+	BLOCK_DEF_CITATION,
+	BLOCK_DEF_GLOSSARY,
+	BLOCK_DEF_FOOTNOTE,
+	BLOCK_DEF_LINK,
+	BLOCK_EMPTY,
+	BLOCK_HEADING,				//!< Placeholder for theme cascading
+	BLOCK_H1,					//!< Leave H1, H2, etc. in order
+	BLOCK_H2,
+	BLOCK_H3,
+	BLOCK_H4,
+	BLOCK_H5,
+	BLOCK_H6,
+	BLOCK_HR,
+	BLOCK_HTML,
+	BLOCK_LIST_BULLETED,
+	BLOCK_LIST_BULLETED_LOOSE,
+	BLOCK_LIST_ENUMERATED,
+	BLOCK_LIST_ENUMERATED_LOOSE,
+	BLOCK_LIST_ITEM,
+	BLOCK_LIST_ITEM_TIGHT,
+	BLOCK_META,
+	BLOCK_PARA,
+	BLOCK_SETEXT_1,
+	BLOCK_SETEXT_2,
+	BLOCK_TABLE,
+	BLOCK_TABLE_HEADER,
+	BLOCK_TABLE_SECTION,
+	BLOCK_TERM,
+	BLOCK_TOC,
+
+	CRITIC_ADD_OPEN,
+	CRITIC_ADD_CLOSE,
+	CRITIC_DEL_OPEN,
+	CRITIC_DEL_CLOSE,
+	CRITIC_COM_OPEN,
+	CRITIC_COM_CLOSE,
+	CRITIC_SUB_OPEN,
+	CRITIC_SUB_DIV,
+	CRITIC_SUB_DIV_A,
+	CRITIC_SUB_DIV_B,
+	CRITIC_SUB_CLOSE,
+	CRITIC_HI_OPEN,
+	CRITIC_HI_CLOSE,
+
+	PAIR_CRITIC_ADD,
+	PAIR_CRITIC_DEL,
+	PAIR_CRITIC_COM,
+	PAIR_CRITIC_SUB_ADD,
+	PAIR_CRITIC_SUB_DEL,
+	PAIR_CRITIC_HI,
+
+	PAIRS,			//!< Placeholder for theme cascading
+	PAIR_ANGLE,
+	PAIR_BACKTICK,
+	PAIR_BRACKET,
+	PAIR_BRACKET_ABBREVIATION,
+	PAIR_BRACKET_FOOTNOTE,
+	PAIR_BRACKET_GLOSSARY,
+	PAIR_BRACKET_CITATION,
+	PAIR_BRACKET_IMAGE,
+	PAIR_BRACKET_VARIABLE,
+	PAIR_BRACE,
+	PAIR_EMPH,
+	PAIR_MATH,
+	PAIR_PAREN,
+	PAIR_QUOTE_SINGLE,
+	PAIR_QUOTE_DOUBLE,
+	PAIR_QUOTE_ALT,
+	PAIR_RAW_FILTER,
+	PAIR_SUBSCRIPT,
+	PAIR_SUPERSCRIPT,
+	PAIR_STAR,
+	PAIR_STRONG,
+	PAIR_UL,
+	PAIR_BRACES,
+
+	STAR,
+	UL,
+	EMPH_START,
+	EMPH_STOP,
+	STRONG_START,
+	STRONG_STOP,
+
+	BRACKET_LEFT,
+	BRACKET_RIGHT,
+	BRACKET_ABBREVIATION_LEFT,
+	BRACKET_FOOTNOTE_LEFT,
+	BRACKET_GLOSSARY_LEFT,
+	BRACKET_CITATION_LEFT,
+	BRACKET_IMAGE_LEFT,
+	BRACKET_VARIABLE_LEFT,
+
+	PAREN_LEFT,
+	PAREN_RIGHT,
+
+	ANGLE_LEFT,
+	ANGLE_RIGHT,
+
+	BRACE_DOUBLE_LEFT,
+	BRACE_DOUBLE_RIGHT,
+
+	AMPERSAND,
+	AMPERSAND_LONG,
+	APOSTROPHE,
+	BACKTICK,
+	CODE_FENCE,
+	COLON,
+	DASH_M,
+	DASH_N,
+	ELLIPSIS,
+	QUOTE_SINGLE,
+	QUOTE_DOUBLE,
+	QUOTE_LEFT_SINGLE,
+	QUOTE_RIGHT_SINGLE,
+	QUOTE_LEFT_DOUBLE,
+	QUOTE_RIGHT_DOUBLE,
+	QUOTE_RIGHT_ALT,
+
+	ESCAPED_CHARACTER,
+
+	HTML_ENTITY,
+	HTML_COMMENT_START,
+	HTML_COMMENT_STOP,
+	PAIR_HTML_COMMENT,
+	
+	MATH_PAREN_OPEN,
+	MATH_PAREN_CLOSE,
+	MATH_BRACKET_OPEN,
+	MATH_BRACKET_CLOSE,
+	MATH_DOLLAR_SINGLE,
+	MATH_DOLLAR_DOUBLE,
+
+	EQUAL,
+	PIPE,
+	PLUS,
+	SLASH,
+	
+	SUPERSCRIPT,
+	SUBSCRIPT,
+
+	INDENT_TAB,
+	INDENT_SPACE,
+	NON_INDENT_SPACE,
+
+	HASH1,							//!< Leave HASH1, HASH2, etc. in order
+	HASH2,
+	HASH3,
+	HASH4,
+	HASH5,
+	HASH6,
+	MARKER_BLOCKQUOTE,
+	MARKER_H1,						//!< Leave MARKER_H1, MARKER_H2, etc. in order
+	MARKER_H2,
+	MARKER_H3,
+	MARKER_H4,
+	MARKER_H5,
+	MARKER_H6,
+	MARKER_LIST_BULLET,
+	MARKER_LIST_ENUMERATOR,
+
+	TABLE_ROW,
+	TABLE_CELL,
+	TABLE_DIVIDER,
+
+	TOC,
+	
+	TEXT_BACKSLASH,
+	RAW_FILTER_LEFT,
+	TEXT_BRACE_LEFT,
+	TEXT_BRACE_RIGHT,
+	TEXT_EMPTY,
+	TEXT_HASH,
+	TEXT_LINEBREAK,
+	TEXT_LINEBREAK_SP,
+	TEXT_NL,
+	TEXT_NL_SP,
+	TEXT_NUMBER_POSS_LIST,
+	TEXT_PERCENT,
+	TEXT_PERIOD,
+	TEXT_PLAIN,
+
+	MANUAL_LABEL,
+};
+
+
+/// Define smart typography languages -- first in list is default
+enum smart_quotes_language {
+	ENGLISH = 0,
+	DUTCH,
+	FRENCH,
+	GERMAN,
+	GERMANGUILL,
+	SWEDISH,
+};
+
+
+enum output_format {
+	FORMAT_HTML,
+	FORMAT_EPUB,
+	FORMAT_LATEX,
+	FORMAT_BEAMER,
+	FORMAT_MEMOIR,
+	FORMAT_FODT,
+	FORMAT_ODT,
+	FORMAT_TEXTBUNDLE,
+	FORMAT_TEXTBUNDLE_COMPRESSED,
+	FORMAT_MMD,
+};
+
+
+enum parser_extensions {
+	EXT_COMPATIBILITY       = 1 << 0,    //!< Markdown compatibility mode
+	EXT_COMPLETE            = 1 << 1,    //!< Create complete document
+	EXT_SNIPPET             = 1 << 2,    //!< Create snippet only
+	EXT_SMART               = 1 << 3,    //!< Enable Smart quotes
+	EXT_NOTES               = 1 << 4,    //!< Enable Footnotes
+	EXT_NO_LABELS           = 1 << 5,    //!< Don't add anchors to headers, etc.
+	EXT_PROCESS_HTML        = 1 << 6,    //!< Process Markdown inside HTML
+	EXT_NO_METADATA         = 1 << 7,    //!< Don't parse Metadata
+	EXT_OBFUSCATE           = 1 << 8,    //!< Mask email addresses
+	EXT_CRITIC              = 1 << 9,    //!< Critic Markup Support
+	EXT_CRITIC_ACCEPT       = 1 << 10,   //!< Accept all proposed changes
+	EXT_CRITIC_REJECT       = 1 << 11,   //!< Reject all proposed changes
+	EXT_RANDOM_FOOT         = 1 << 12,   //!< Use random numbers for footnote links
+	EXT_TRANSCLUDE          = 1 << 13,   //!< Perform transclusion(s)
+	EXT_FAKE                = 1 << 31,   //!< 31 is highest number allowed
+};
+
+
+#endif