mathematical 1.6.17 → 1.6.18

data/ext/mathematical/lasem/viewer/meson.build

@@ -0,0 +1,17 @@
+if get_option('viewer').enabled()
+
+demo_dependencies = [
+  lasem_dependencies,
+  dependency('gtk4', version : '>=4.9')
+]
+
+lasemdemo = executable(
+  'lsm-viewer',
+  'viewer.c',
+  dependencies : demo_dependencies,
+  link_with : lasem_library,
+  include_directories : [library_inc],
+  install : true
+)
+
+endif

data/ext/mathematical/lasem/viewer/viewer.c

@@ -0,0 +1,248 @@
+/* Lasem - SVG and Mathml library
+ *
+ * Copyright © 2010 Emmanuel Pacaud
+ * Copyright © 2023 Matthew Jakeman
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General
+ * Public License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1335, USA.
+ *
+ * Author:
+ * 	Matthew Jakeman <mattjakemandev@gmail.com>
+ */
+
+#include <gtk/gtk.h>
+
+#include <lsm.h>
+#include <lsmdom.h>
+#include <cairo.h>
+
+#define VIEWER_TYPE_WINDOW (viewer_window_get_type())
+G_DECLARE_FINAL_TYPE (ViewerWindow, viewer_window, VIEWER, WINDOW, GtkApplicationWindow)
+
+struct _ViewerWindow
+{
+    GtkApplicationWindow parent_instance;
+
+    GtkWidget *lasem_view;
+
+    LsmDomDocument *document;
+    LsmDomView *view;
+    GError *error;
+};
+
+G_DEFINE_FINAL_TYPE (ViewerWindow, viewer_window, GTK_TYPE_APPLICATION_WINDOW)
+
+static GtkWidget *
+viewer_window_new (GtkApplication *app)
+{
+    return GTK_WIDGET (g_object_new (VIEWER_TYPE_WINDOW,
+                                     "application", app,
+                                     NULL));
+}
+
+static void
+viewer_window_finalize (GObject *object)
+{
+    ViewerWindow *self = (ViewerWindow *)object;
+
+    g_clear_pointer (&self->view, g_object_unref);
+    g_clear_pointer (&self->document, g_object_unref);
+
+    G_OBJECT_CLASS (viewer_window_parent_class)->finalize (object);
+}
+
+static void
+viewer_window_class_init (ViewerWindowClass *klass)
+{
+    GObjectClass *object_class = G_OBJECT_CLASS (klass);
+
+    object_class->finalize = viewer_window_finalize;
+}
+
+static void
+display_error (ViewerWindow *window, GError *error, const char *error_text)
+{
+    char *message;
+
+    message = (error != NULL)
+        ? error->message
+        : "Undetermined Error";
+
+    GtkAlertDialog *dlg = gtk_alert_dialog_new ("%s: %s\n",
+						error_text,
+						message);
+
+    gtk_window_set_modal (GTK_WINDOW (dlg), TRUE);
+    g_signal_connect (dlg, "response", G_CALLBACK (gtk_window_destroy), NULL);
+
+    gtk_window_present (GTK_WINDOW (dlg));
+}
+
+static void
+viewer_window_load_from_file (ViewerWindow *window, const char *path)
+{
+    GError *error = NULL;
+
+    gchar *contents;
+    gsize length;
+
+    if (!g_file_get_contents (path, &contents, &length, &error))
+    {
+        display_error (window, error, "Could not read file");
+
+        if (error != NULL)
+            g_error_free (error);
+
+        return;
+    }
+
+    if (window->view)
+    {
+        g_clear_pointer (&window->view, g_object_unref);
+        g_clear_pointer (&window->document, g_object_unref);
+        g_clear_pointer (&window->error, g_object_unref);
+    }
+
+    window->document = lsm_dom_document_new_from_memory (contents, length, &error);
+
+    if (!LSM_IS_DOM_DOCUMENT (window->document))
+    {
+        display_error (window, error, "Could not read MathML/SVG");
+
+        if (error != NULL)
+            g_error_free (error);
+
+        return;
+    }
+
+    window->view = lsm_dom_document_create_view (window->document);
+    gtk_widget_queue_draw (window->lasem_view);
+}
+
+static void
+lasem_view_draw (GtkDrawingArea *drawing_area,
+                 cairo_t        *cr,
+                 int             width,
+                 int             height,
+                 ViewerWindow     *window)
+{
+    if (window->view == NULL)
+        return;
+
+    int margin = 25;
+
+    guint content_width = 0;
+    guint content_height = 0;
+    guint baseline = 0;
+    lsm_dom_view_get_size_pixels (window->view, &content_width, &content_height, &baseline);
+
+    float multiplier = ((float)width - (2 * margin)) / content_width;
+    lsm_dom_view_set_resolution (window->view, multiplier * LSM_DOM_VIEW_DEFAULT_RESOLUTION);
+
+    lsm_dom_view_render (window->view, cr, margin, margin);
+}
+
+static void
+viewer_on_file_open (GtkFileDialog *dialog,
+                     GAsyncResult  *result,
+                     ViewerWindow  *self)
+{
+    GFile *file;
+    GError *error = NULL;
+
+    file = gtk_file_dialog_open_finish (dialog, result, &error);
+
+    if (G_IS_FILE (file))
+    {
+        char *path;
+
+        path = g_file_get_path (file);
+        viewer_window_load_from_file (self, path);
+        g_free (path);
+    }
+    else
+    {
+        display_error (self, error, "File Chooser error");
+
+        if (error != NULL)
+            g_error_free (error);
+    }
+}
+
+static void
+viewer_show_file_chooser (ViewerWindow *self)
+{
+    GtkFileDialog *dialog;
+    GtkFileFilter *filter;
+
+    filter = gtk_file_filter_new ();
+    gtk_file_filter_add_mime_type (filter, "text/mathml");
+    gtk_file_filter_add_mime_type (filter, "image/svg+xml");
+    gtk_file_filter_set_name (filter, "MathML/SVG Files");
+
+    dialog = gtk_file_dialog_new ();
+    gtk_file_dialog_set_modal (dialog, TRUE);
+    gtk_file_dialog_set_default_filter (dialog, filter);
+
+    gtk_file_dialog_open (dialog, GTK_WINDOW (self),
+                          NULL, (GAsyncReadyCallback) viewer_on_file_open,
+                          self);
+}
+
+static void
+viewer_window_init (ViewerWindow *self)
+{
+    gtk_window_set_title (GTK_WINDOW (self), "Lasem Viewer");
+    gtk_window_set_default_size (GTK_WINDOW (self), 800, 600);
+    gtk_window_set_resizable (GTK_WINDOW (self), FALSE);
+
+    GtkWidget *header_bar = gtk_header_bar_new ();
+    gtk_window_set_titlebar (GTK_WINDOW (self), header_bar);
+
+    GtkWidget *open_btn = gtk_button_new_with_label ("Open");
+    gtk_widget_add_css_class (open_btn, "suggested-action");
+    g_signal_connect_swapped (open_btn, "clicked", G_CALLBACK (viewer_show_file_chooser), self);
+    gtk_header_bar_pack_start (GTK_HEADER_BAR (header_bar), open_btn);
+
+    GtkWidget *lasem_view = gtk_drawing_area_new ();
+    gtk_window_set_child (GTK_WINDOW (self), lasem_view);
+    gtk_drawing_area_set_draw_func (GTK_DRAWING_AREA (lasem_view),
+                                    (GtkDrawingAreaDrawFunc) lasem_view_draw,
+                                    self, NULL);
+    self->lasem_view = lasem_view;
+}
+
+static void
+activate (GtkApplication* app,
+          gpointer        user_data)
+{
+    GtkWidget *window = viewer_window_new(app);
+    gtk_widget_set_visible (window, TRUE);
+}
+
+int
+main (int    argc,
+      char **argv)
+{
+    GtkApplication *app;
+    int status;
+
+    app = gtk_application_new ("org.lasem.Viewer", G_APPLICATION_DEFAULT_FLAGS);
+    g_signal_connect (app, "activate", G_CALLBACK (activate), NULL);
+    status = g_application_run (G_APPLICATION (app), argc, argv);
+    g_object_unref (app);
+
+    return status;
+}

data/ext/mathematical/mtex2MML/CMakeLists.txt

@@ -0,0 +1,255 @@
+# Building (out of source build):
+# > mkdir build && cd build
+# > cmake ..
+# > cmake --build .
+#
+# Testing:
+# > ctest -V
+#
+# Install:
+# > cmake --build . --target install
+
+#
+#
+#   General project setup
+#
+#
+project(mtex2MML)
+enable_language(C)
+cmake_minimum_required(VERSION 2.8.7 FATAL_ERROR)
+cmake_policy(SET CMP0015 NEW)
+
+include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules/astyle.cmake")
+
+include(CheckLibraryExists)
+include(GenerateExportHeader)
+
+set(PROJECT_NAME "mtex2MML")
+set(LIBRARY "libmtex2MML")
+set(STATICLIBRARY "libmtex2MML_static")
+
+file(STRINGS "${CMAKE_CURRENT_SOURCE_DIR}/src/mtex2MML.h" MTEX2MML_HEADER REGEX "^#define MTEX2MML_VERSION \"[^\"]*\"$")
+
+string(REGEX REPLACE "^.*MTEX2MML_VERSION \"([0-9]+).*$" "\\1" MTEX2MML_VERSION_MAJOR "${MTEX2MML_HEADER}")
+string(REGEX REPLACE "^.*MTEX2MML_VERSION \"[0-9]+\\.([0-9]+).*$" "\\1" MTEX2MML_VERSION_MINOR  "${MTEX2MML_HEADER}")
+string(REGEX REPLACE "^.*MTEX2MML_VERSION \"[0-9]+\\.[0-9]+\\.([0-9]+).*$" "\\1" MTEX2MML_VERSION_REV "${MTEX2MML_HEADER}")
+set(MTEX2MML_VERSION_STRING "${MTEX2MML_VERSION_MAJOR}.${MTEX2MML_VERSION_MINOR}.${MTEX2MML_VERSION_REV}")
+
+#
+#
+#   Installation paths
+#
+#
+set(BIN_INSTALL_DIR bin CACHE PATH "Where to install binaries to.")
+set(LIB_INSTALL_DIR lib CACHE PATH "Where to install libraries to.")
+set(INCLUDE_INSTALL_DIR include/${PROJECT_NAME} CACHE PATH "Where to install headers to.")
+
+#
+#
+#   Build options
+#
+#
+option(BUILD_CLAR      "Build Tests using the Clar suite"    ON)
+
+#
+#
+#   Find required dependencies
+#
+#
+include_directories(src deps ${CMAKE_CURRENT_BINARY_DIR})
+
+find_package(BISON REQUIRED)
+find_package(FLEX REQUIRED)
+find_library(M_LIB m) # only necessary for true *nix systems
+
+#
+#
+#   Configure Bison/Flex
+#
+#
+set(YYPREFIX mtex2MML_yy)
+
+bison_target(MTEX2MMLPARSER ${CMAKE_CURRENT_SOURCE_DIR}/src/parser.y ${CMAKE_CURRENT_BINARY_DIR}/parser.c COMPILE_FLAGS "-y -v -p ${YYPREFIX}")
+flex_target(MTEX2MMLSCANNER ${CMAKE_CURRENT_SOURCE_DIR}/src/lexer.l  ${CMAKE_CURRENT_BINARY_DIR}/lexer.c COMPILE_FLAGS "-P ${YYPREFIX}")
+add_flex_bison_dependency(MTEX2MMLSCANNER MTEX2MMLPARSER)
+
+#
+#
+#   Define targets
+#
+#
+
+# Collect sourcefiles, exclude main.c from libraries
+file(GLOB SRC_H ${CMAKE_CURRENT_SOURCE_DIR}/src/*.h deps/uthash/*.h)
+file(GLOB SRC_MTEX2MML ${CMAKE_CURRENT_SOURCE_DIR}/src/*.c)
+list(REMOVE_ITEM SRC_MTEX2MML "${CMAKE_CURRENT_SOURCE_DIR}/src/main.c")
+
+set(PROGRAM "mtex2MML")
+set(PROGRAM_SOURCES
+  ${SRC_MTEX2MML}
+  ${CMAKE_CURRENT_SOURCE_DIR}/src/main.c
+  ${BISON_MTEX2MMLPARSER_OUTPUTS}
+  ${FLEX_MTEX2MMLSCANNER_OUTPUTS}
+)
+
+add_executable(${PROGRAM} ${PROGRAM_SOURCES})
+add_library(${LIBRARY} SHARED
+            ${SRC_H}
+            ${SRC_MTEX2MML}
+            ${BISON_MTEX2MMLPARSER_OUTPUTS}
+            ${FLEX_MTEX2MMLSCANNER_OUTPUTS}
+)
+add_library(${STATICLIBRARY} STATIC
+            ${SRC_H}
+            ${SRC_MTEX2MML}
+            ${BISON_MTEX2MMLPARSER_OUTPUTS}
+            ${FLEX_MTEX2MMLSCANNER_OUTPUTS}
+)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/src/libmtex2MML.pc.in
+${CMAKE_CURRENT_BINARY_DIR}/libmtex2MML.pc @ONLY)
+
+install(TARGETS ${PROJECT_NAME} RUNTIME DESTINATION ${BIN_INSTALL_DIR})
+install(TARGETS ${LIBRARY} LIBRARY DESTINATION ${LIB_INSTALL_DIR})
+install(TARGETS ${STATICLIBRARY} ARCHIVE DESTINATION ${LIB_INSTALL_DIR})
+install(FILES ${SRC_H} DESTINATION ${INCLUDE_INSTALL_DIR})
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/libmtex2MML.pc
+  DESTINATION lib/pkgconfig)
+
+if(UNIX AND NOT APPLE AND NOT CYGWIN)
+  target_link_libraries(${PROGRAM} ${M_LIB})
+  target_link_libraries(${STATICLIBRARY} ${M_LIB})
+  target_link_libraries(${LIBRARY} ${M_LIB})
+endif()
+
+# Always compile with warnings
+if(MSVC)
+  # Force to always compile with W4
+  if(CMAKE_CXX_FLAGS MATCHES "/W[0-4]")
+    string(REGEX REPLACE "/W[0-4]" "/W4" CMAKE_C_FLAGS "${CMAKE_C_FLAGS}")
+  else()
+    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /W4")
+  endif()
+  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /wd4127 /wd4244 /wd4267 /wd4706 /wd4800 /D_CRT_SECURE_NO_WARNINGS")
+
+  if(DEFINED ENV{APPVEYOR})
+    set(CMAKE_GENERATOR_PLATFORM "Visual Studio 12 2013")
+  endif()
+
+  include_directories(${CMAKE_CURRENT_SOURCE_DIR}/src/win32-shims)
+elseif(CMAKE_COMPILER_IS_GNUCC OR "${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
+  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -std=c99 -pedantic-errors -fextended-identifiers ")
+endif()
+
+set_target_properties(${LIBRARY} PROPERTIES
+  OUTPUT_NAME "mtex2MML"
+  SOVERSION ${MTEX2MML_VERSION_STRING}
+  VERSION ${MTEX2MML_VERSION_STRING}
+)
+
+#
+#
+#   Rename outputs
+#
+#
+if (MSVC)
+  set_target_properties(${STATICLIBRARY} PROPERTIES
+    OUTPUT_NAME "mtex2MML_static"
+    VERSION ${MTEX2MML_VERSION_STRING}
+  )
+else()
+  set_target_properties(${STATICLIBRARY} PROPERTIES
+    OUTPUT_NAME "mtex2MML"
+    VERSION ${MTEX2MML_VERSION_STRING}
+  )
+  # -fPIC, basically
+  if (UNIX AND (CMAKE_COMPILER_IS_GNUCC OR CMAKE_COMPILER_IS_GNUCXX))
+    if ("${CMAKE_VERSION}" VERSION_LESS "2.8.9")
+      set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fPIC")
+    else()
+      set_target_properties(${STATICLIBRARY} PROPERTIES
+        POSITION_INDEPENDENT_CODE TRUE
+      )
+    endif()
+  endif()
+endif(MSVC)
+
+set_property(TARGET ${LIBRARY}
+  APPEND PROPERTY MACOSX_RPATH true
+)
+
+generate_export_header(${LIBRARY}
+    BASE_NAME ${PROJECT_NAME})
+
+if (MSVC)
+  set_property(TARGET ${PROGRAM}
+    APPEND PROPERTY LINK_FLAGS /INCREMENTAL:NO
+  )
+endif(MSVC)
+
+#
+#
+#   Tests
+#
+#
+if (BUILD_CLAR)
+  include (CTest)
+  enable_testing()
+  find_package(PythonInterp REQUIRED)
+
+  set(CLAR_FIXTURES "${CMAKE_CURRENT_SOURCE_DIR}/tests/fixtures/")
+  set(CLAR_PATH "${CMAKE_CURRENT_SOURCE_DIR}/tests")
+  add_definitions(-DCLAR_FIXTURE_PATH=\"${CLAR_FIXTURES}\")
+	add_definitions(-DCLAR_TMPDIR=\"libmtex2MML_tests\")
+
+  include_directories(${CLAR_PATH})
+  file(GLOB_RECURSE SRC_TEST ${CLAR_PATH}/*/*.c ${CLAR_PATH}/*/*.h)
+  set(SRC_CLAR "${CLAR_PATH}/main.c" "${CLAR_PATH}/clar.c"
+    "${CLAR_PATH}/array.c"
+    "${CLAR_PATH}/basic.c"
+    "${CLAR_PATH}/cornercases.c"
+    "${CLAR_PATH}/delimiters.c"
+    "${CLAR_PATH}/env.c"
+    "${CLAR_PATH}/functions.c"
+    "${CLAR_PATH}/helpers.c"
+    "${CLAR_PATH}/maliciousness.c"
+    "${CLAR_PATH}/mathjax.c"
+    "${CLAR_PATH}/numbered_equations.c"
+    "${CLAR_PATH}/performance.c"
+    "${CLAR_PATH}/symbols.c"
+  )
+
+  add_custom_command(
+    OUTPUT ${CLAR_PATH}/clar.suite
+    COMMAND ${PYTHON_EXECUTABLE} generate.py
+    DEPENDS ${SRC_TEST}
+    WORKING_DIRECTORY ${CLAR_PATH}
+  )
+
+  set_source_files_properties(
+    ${CLAR_PATH}/clar.c
+    PROPERTIES OBJECT_DEPENDS ${CLAR_PATH}/clar.suite
+  )
+
+  add_executable(mtex2MML_clar ${SRC_H} ${SRC_MTEX2MML} ${SRC_CLAR} ${SRC_TEST}
+                ${BISON_MTEX2MMLPARSER_OUTPUTS}
+                ${FLEX_MTEX2MMLSCANNER_OUTPUTS}
+  )
+  if(UNIX AND NOT APPLE AND NOT CYGWIN)
+    target_link_libraries(mtex2MML_clar ${M_LIB})
+  endif()
+
+  add_custom_command(TARGET mtex2MML_clar
+    POST_BUILD
+    COMMAND ${PYTHON_EXECUTABLE} mathjax_generate.py
+    WORKING_DIRECTORY ${CLAR_PATH}
+  )
+
+  add_test(mtex2MML_clar mtex2MML_clar -v)
+
+  if(UNIX)
+    # setup valgrind
+    add_custom_target(memcheck
+      valgrind --leak-check=full --dsymutil=yes --error-exitcode=1 ./mtex2MML_clar  >/dev/null
+    )
+  endif()
+endif ()

data/ext/mathematical/mtex2MML/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+## Bug fixes
+
+If you're interested in fixing a bug, there are two files you'll likely need to change:
+
+* *lexer.l*, which contains the grammar rules for the TeX characters.
+* *parser.y*, which acts on the grammar states and converts the data into MathML.
+
+If you submit a PR for something new, you should also add tests. You may need to update [SUPPORTED.md](SUPPORTED.md), too.
+
+## Feature requests
+
+Want something added, but don't want to code? That's cool! Please provide a clear example of the math TeX and a reason why you think it should be added. For example:
+
+> I'd like to be able to use `\douglas` in my equations, like this:
+>
+>     $$
+>     \douglas - 2 = 40
+>     $$
+>
+> This shorthand notation is very popular among British mathematicians.
+
+Simply stating "Please add this syntax" without a reason might not get a reply.

data/ext/mathematical/mtex2MML/README.md

@@ -0,0 +1,143 @@
+# mtex2MML
+
+[![Build Status](https://travis-ci.org/gjtorikian/mtex2MML.svg?branch=master)](https://travis-ci.org/gjtorikian/mtex2MML) [![Build status](https://ci.appveyor.com/api/projects/status/0ynwxikxqp5rseu3?svg=true)](https://ci.appveyor.com/project/gjtorikian/mtex2mml)
+
+This is a Bison grammar to convert TeX math into MathML. It can be used as a standalone program or as a static library. It is written in standard C99. It's been tested on OS X, Ubuntu, and Windows.
+
+The goal of this project is to implement as much of AMS-TeX math as possible.
+
+This code is a fork of [the itex2MML project](https://golem.ph.utexas.edu/~distler/blog/itex2MML.html), originally written by Jacques Distler and Paul Gartside. It has vastly more support for AMS-TeX math than the original, with a much larger test suite.
+
+### Why MathML?!
+
+It's true, MathML is not well supported in browsers. (Kudos to the Firefox team for sticking with it!)
+
+However, you can consider MathML as an intermediate format onto greater things, like conversion to SVG via [mathematical](https://github.com/gjtorikian/mathematical).
+
+## What's supported?
+
+Please refer to [SUPPORTED.md](SUPPORTED.md) for more information on what this lib can do. Right now it has a ~93% compatibility with everything MathJax can do.
+
+The most obvious gap in this library is the inability to define new commands (via `\mathop`, `\def`, `\mathchoice`, etc.). Everything else in standard TeX math should be fine.
+
+## Usage
+
+By default, inline equations are demarcated by `$...$`. Display equations are demarcated by `$$...$$`. You can change these to `\(..\)` and `\[..\]` respectively; see below for configuration.
+
+You cannot nest equations; for example, `$$...\text{foo $...$ bar}...$$` is not allowed.
+
+### Heuristics
+
+Since `$` signs appear quite often in plaintext, a basic heuristic is applied to calculate whether `$` should be interpreted as math or not:
+
+> Basic heuristic is: opening $ can't be followed by whitespace, closing $ can't be followed by a digit or preceded by whitespace." -- @jgm, http://bit.ly/1HVtemx
+
+Of course, if you type `\$`, no math is applied as the `$` is considered skipped.
+
+### As a library
+
+Both a static and dynamic library are created as part of the `cmake` build process. Include one of them during the compilation of your program.
+
+#### Methods available
+
+The library exposes the following methods:
+
+* `char * mtex2MML_parse(const char * str, unsigned long strlen, const int options)`: Converts a single TeX equation in `str` to MathML. Returns just the MathML equation, as a string.
+
+* `char * mtex2MML_global_parse(const char * str, unsigned long strlen, const int options, int global_start)`: The same as `mtex2MML_parse`, but allows you to provide a starting integer for equation numbering. Returns just the MathML equation, as a string.
+
+* `int mtex2MML_filter(const char * str, unsigned long strlen, const int options)`: Given a string with a mix of TeX math and non-math elements, this returns a single string containing just the converted math elements. Equations are automatically numbered. Returns a `status` indicating success (`0`) or failure. You must access the resulting string with `mtex2MML_output`.
+
+* `int mtex2MML_text_filter(const char * str, unsigned long strlen, const int options)`: Given a string with a mix of TeX math and non-math elements, this converts all the math and leaves the rest of the string unmodified. Equations are automatically numbered. Returns a `status` indicating success (`0`) or failure. You must access the resulting string with `mtex2MML_output`. HTML within a math equation are normalized (eg. `<` becomes `&lt;`).
+
+* `int mtex2MML_strict_filter(const char * str, unsigned long strlen, const int options)`: Given a string with a mix of TeX math and non-math elements, this converts all the math and leaves the rest of the string unmodified. Equations are automatically numbered. Returns a `status` indicating success (`0`) or failure. You must access the resulting string with `mtex2MML_output`. HTML tags are removed completely.
+
+The `options` argument determines which types of delimiters are to be used:
+
+* `MTEX2MML_DELIMITER_DEFAULT` is the default, using `$..$` for inline and `$$..$$` for display.
+* `MTEX2MML_DELIMITER_DOLLAR` uses single dollar signs: `$..$` for inline.
+* `MTEX2MML_DELIMITER_DOUBLE` uses double dollar signs: `$$..$$` for display.
+* `MTEX2MML_DELIMITER_PARENS` uses parenthesis: `\(..\)` for inline.
+* `MTEX2MML_DELIMITER_BRACKETS` uses brackets: `\[..\]` for display.
+* `MTEX2MML_DELIMITER_ENVIRONMENTS` supports bare `\\begin..\\end` environments.
+
+[The *tests/basic.c*](tests/basic.c) and [the *tests/delimiters.c*](tests/delimiters.c) suites provides a demonstrate of how these methods can be used.
+
+### As a command
+
+Like any good Unix program, the mtex2MML binary operates on pipes. That is to say, it works like this:
+
+```
+echo '\sin y' | mtex2MML --inline > math.txt
+```
+
+Use `mtex2MML -h` to get documentation on the options.
+
+## Error handling
+
+A `0` status indicates a success, while anything else indicates a failure, [as per the Bison documentation](http://www.gnu.org/software/bison/manual/html_node/Parser-Function.html). If a token cannot be parsed, or if the tokenization is nested too deep, the library will bail with a non-zero status code. An error message is also printed to STDERR.
+
+[The *tests/maliciousness.c* suite](tests/maliciousness.c) has a demonstration on how to perform error handling.
+
+## Building
+
+To build mtex2MML, you need:
+
+* [CMake](http://www.cmake.org/download/) (at least version 2.8.7)
+* [Bison](https://www.gnu.org/software/bison/)
+* [Flex](http://flex.sourceforge.net/)
+* [Python3](https://www.python.org/) (just for the tests)
+
+### OS X (brew or macports), Ubuntu and Arch Linux
+
+To fetch dependencies, build, and run the library, call:
+
+```
+script/bootstrap
+cd build
+cmake ..
+make
+```
+
+### Windows
+
+With [Chocolatey](https://chocolatey.org/), you can run:
+
+```
+choco install cmake winflexbison python3
+```
+
+Then, with Powershell, simply run `build.ps1`.
+
+## Testing
+
+Assuming you've built the programs, to run the test suite:
+
+```
+cd build
+ctest -V
+```
+
+mtex2MML has a test suite that mimics the one found in [MathJax](https://github.com/mathjax/MathJax-test), with a few exceptions:
+
+* Files marked as `.xtex` have features that are not implemented, but probably should be in the future.
+* Files marked as `.no_tex` have features that probably won't be implemented.
+
+During the test run, the suite will list the percentage of features that still need coverage.
+
+## Installing
+
+To install the mtex2MML binary, you can run:
+
+```
+cd build
+make install
+```
+
+## Contributing
+
+Found a bug or want to request a feature? Great! Check out [CONTRIBUTING.md](CONTRIBUTING.md) for more information!
+
+## License
+
+As with the original version(s), this is Open Source software, released under a triple license: [GPL](http://choosealicense.com/licenses/gpl-2.0/), [MPL](http://choosealicense.com/licenses/mpl-2.0/), and [LGPL](http://choosealicense.com/licenses/lgpl-2.1/).