mathematical 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dda3e76da788e8839bf017e98c4ede036bb2df68
-  data.tar.gz: 151ecfbed1cacadca2ebeaf3d8302de3e8e520b8
+  metadata.gz: d9cecd3bb1d038dc96a7e15af2d68aa05d414800
+  data.tar.gz: e80c42d9ac225acb937d4158e5ca1664659d734c
 SHA512:
-  metadata.gz: 43e0d0fc23a2ee8996fb87786e3bd28c69ab273334eed9463ce6fc1388f34161d54372c34bb66f0801eda21e87f9a0e841db980d10628e38a2fe888f9a4330d8
-  data.tar.gz: 8de1fc15282fdde83b532fd9de3e23a515ca636840f753d187c4333ea2b1a9d0dc894b1b688cb2e6c3708e010bcdd4e74f2831859d5fcdd42d5695728d5e9801
+  metadata.gz: fc5aaccb3879afc81b320f7fe17af73c430c7c465b48a32108641c85ca690f1f743b46e5b7eb3cc1a2911e52ccfaed739aecbd843e61d36d1604b763980df6e8
+  data.tar.gz: 15ce4f72ce909e0700594a4a47f28421535bb76f957b4793dd2119f4aeaf46d32df612c7676bf504fbd9a9d69ac0a8191d1b6b63560e7d0e429ec5a7798fe06d

data/README.md

@@ -30,7 +30,7 @@ require 'mathematical'
 Mathematical.new.render(string_with_math)
 ```
 
-`string_with_math` should just be a string of math TeX inline (`$..$`) or display (`$$..$$`) style math.
+`string_with_math` should just be a string of TeX math. The default delimiters are `$..$` for inline and `$$..$$` for display. These can be changed by options--see below.
 
 The output will be a hash, with keys that depend on the format you want:
 
@@ -44,11 +44,17 @@ The output will be a hash, with keys that depend on the format you want:
   * `:data`: the PNG data
 * If you asked for MathML, you'll get:
   * `:data`: the MathML data
-* If you pass in invalid LaTeX, you'll get:
-  * `:data`: the original invalid LaTeX
+* If you pass in invalid TeX, you'll get:
+  * `:data`: the original invalid TeX
   * `:exception`: the error class (with message)
 
-**Note**: If you pass in invalid LaTeX, an error is not raised, but a message *is* printed to STDERR. It is the caller's responsibility to check for `:exception` and act on it.
+**Note**: If you pass in invalid TeX, an error is not raised, but a message *is* printed to STDERR. It is the caller's responsibility to check for `:exception` and act on it.
+
+`render` just converts a single equation. There are several other methods you can use:
+
+* `filter`:  Given a string with a mix of TeX math and non-math elements, this returns a single string containing just the converted math elements.
+* `text_filter`: 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.
+* `strict_filter`:  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. HTML tags are removed completely.
 
 ### Array of equations
 
@@ -69,7 +75,7 @@ This returns an array of hashes, rendering the indices. For example, for the abo
 [ {:data => "...", :width => ... }, { :data => '$not__thisisnotreal$', :exception => "...", {:data => "...", :width => ... }]
 ```
 
-That is, while the first and last elements are valid LaTeX math, the middle one is not, so the same string is returned. As with single strings, the error message is printed to STDERR, but not raised.
+That is, while the first and last elements are valid TeX math, the middle one is not, so the same string is returned. As with single strings, the error message is printed to STDERR, but not raised.
 
 ### Options
 
@@ -82,12 +88,13 @@ That is, while the first and last elements are valid LaTeX math, the middle one
 | `:base64` | A boolean determining whether Mathematical's output should be a base64-encoded SVG string | `false`
 | `:maxsize` | A numeral indicating the `MAXSIZE` the output string can be. | `unsigned long`
 | `:format` | A symbol indicating whether you want an `:svg`, `:png`, or `:mathml` output. | `:svg`
+| `:delimiter` | A symbol indicating whether you want an `:dollar` for inline (`$..$`), `:double` for display (`$$..$$`), `:parens` for inline (`\(..\)`), or `:brackets` for display (`[..\]`). You can also pass in an array of symbols to have multiple delimiters considered. | `[:dollar, :double]`
 
 Pass these in like this:
 
 ``` ruby
-opts = { :ppi => 200.0, :zoom => 5.0, :base64 => true }
-renderer = Mathematical.new(opts)
+options = { :ppi => 200.0, :zoom => 5.0, :base64 => true }
+renderer = Mathematical.new(options)
 renderer.render('$a \ne b$')
 ```
 

data/Rakefile

@@ -28,7 +28,7 @@ Rake::Task['clean'].enhance do
   Rake::Task['destroy_copies'].invoke
 end
 
-Rake::Task[:test].prerequisites << :compile
+Rake::Task[:test].prerequisites
 
 task default: [:test]
 
@@ -51,6 +51,9 @@ task :destroy_copies do
     File.delete(f)
   end
   Dir.glob("#{ext_dir}/{lib,src,test,ext,deps,uthash}").select { |d| FileUtils.rm_rf d }
+  FileUtils.rm_rf(File.join(ext_dir, 'mtex2MML', 'build'))
+  FileUtils.rm_rf(File.join(ext_dir, 'lib'))
+  FileUtils.rm_rf(File.join(ext_dir, 'Testing'))
 end
 
 desc 'Pretty format C code'

data/ext/mathematical/cairo_callbacks.h

@@ -1,3 +1,6 @@
+#ifndef CAIRO_OVERRIDES_H
+#define CAIRO_OVERRIDES_H
+
 #include "ruby.h"
 
 #include <cairo-svg.h>
@@ -5,3 +8,5 @@
 extern cairo_status_t cairoSvgSurfaceCallback (void *closure, const unsigned char *data, unsigned int length);
 
 extern cairo_status_t cairoPngSurfaceCallback (void *closure, const unsigned char *data, unsigned int length);
+
+#endif

data/ext/mathematical/extconf.rb

@@ -1,11 +1,24 @@
 require 'mkmf'
 require 'rbconfig'
-host_os = RbConfig::CONFIG['host_os']
 
+HOST_OS = RbConfig::CONFIG['host_os']
+LIBDIR     = RbConfig::CONFIG['libdir']
+INCLUDEDIR = RbConfig::CONFIG['includedir']
+HEADER_DIRS = [INCLUDEDIR]
+
+unless find_executable('cmake')
+  $stderr.puts "\n\n\n[ERROR]: cmake is required and not installed. Get it here: http://www.cmake.org/\n\n"
+  exit 1
+end
+
+ROOT_TMP = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'tmp'))
 LASEM_DIR = File.expand_path(File.join(File.dirname(__FILE__), 'lasem', 'src'))
 MTEX2MML_DIR = File.expand_path(File.join(File.dirname(__FILE__), 'mtex2MML'))
+MTEX2MML_BUILD_DIR = File.join(MTEX2MML_DIR, 'build')
+MTEX2MML_LIB_DIR = File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
+MTEX2MML_SRC_DIR = File.expand_path(File.join(MTEX2MML_DIR, 'src'))
 
-if host_os =~ /darwin|mac os/
+if HOST_OS =~ /darwin|mac os/
   ENV['PKG_CONFIG_PATH'] = "/opt/X11/lib/pkgconfig:#{ENV['PKG_CONFIG_PATH']}"
 end
 
@@ -22,15 +35,28 @@ find_header('libxml/xpathInternals.h', '/include/libxml2', '/usr/include/libxml2
 FileUtils.cp_r(Dir.glob("#{LASEM_DIR}/*"), File.dirname(__FILE__))
 File.delete(File.join(File.dirname(__FILE__), 'lasemrender.c'))
 
+# TODO: we need to clear out the build dir that's erroneously getting packaged
+# this causes problems, as Linux installation is expecting OS X output
+if File.directory?(MTEX2MML_BUILD_DIR) && !File.exist?(ROOT_TMP)
+  FileUtils.rm_rf(MTEX2MML_BUILD_DIR)
+end
+FileUtils.mkdir_p(MTEX2MML_BUILD_DIR)
+
 # build mtex2MML library
-Dir.chdir(MTEX2MML_DIR) do
-  system 'make'
+Dir.chdir(MTEX2MML_BUILD_DIR) do
+  system 'cmake ..'
+  system 'make libmtex2MML_static'
 end
 
-FileUtils.cp_r(Dir.glob(File.join(MTEX2MML_DIR, 'build', '*.{a,h}')), File.dirname(__FILE__))
+FileUtils.mkdir_p(MTEX2MML_LIB_DIR)
+FileUtils.cp_r(File.join(MTEX2MML_BUILD_DIR, 'libmtex2MML.a'), MTEX2MML_LIB_DIR)
+FileUtils.cp_r(File.join(MTEX2MML_SRC_DIR, 'mtex2MML.h'), File.dirname(__FILE__))
+
+LIB_DIRS = [LIBDIR, MTEX2MML_LIB_DIR]
+HEADER_DIRS << MTEX2MML_BUILD_DIR
+dir_config('mathematical', HEADER_DIRS, LIB_DIRS)
 
-$LDFLAGS << " #{`pkg-config --static --libs glib-2.0 gdk-pixbuf-2.0 cairo pango`.chomp}"
-$CFLAGS << " -O2 #{`pkg-config --cflags glib-2.0 gdk-pixbuf-2.0 cairo pango`.chomp} -I#{LASEM_DIR}"
-$LOCAL_LIBS << "#{MTEX2MML_DIR}/build/libmtex2MML.a"
+$LDFLAGS << " #{`pkg-config --static --libs glib-2.0 gdk-pixbuf-2.0 cairo pango`.chomp} -lmtex2MML"
+$CFLAGS << " #{`pkg-config --cflags glib-2.0 gdk-pixbuf-2.0 cairo pango`.chomp} -I#{LASEM_DIR}"
 
 create_makefile('mathematical/mathematical')

data/ext/mathematical/lasem_overrides.c

@@ -1,10 +1,15 @@
+#include "ruby.h"
+
 #include <lasem_overrides.h>
+#include <string.h>
+#include "mtex2MML.h"
 
 char *
-lsm_mtex_to_mathml (const char *mtex, gssize size, int global_start)
+lsm_mtex_to_mathml (const char *mtex, gssize size, int delimiter, int render_type)
 {
   gsize usize;
   char *mathml;
+  int status = 0;
 
   if (mtex == NULL) {
     return NULL;
@@ -16,8 +21,32 @@ lsm_mtex_to_mathml (const char *mtex, gssize size, int global_start)
     usize = size;
   }
 
-  mathml = mtex2MML_global_parse (mtex, usize, global_start);
-  if (mathml == NULL) {
+  switch (render_type) {
+  case PARSE:
+    mathml = mtex2MML_parse(mtex, usize, delimiter);
+    if (mathml == NULL) {
+      status = 1;
+    }
+    break;
+  case FILTER:
+    status = mtex2MML_filter(mtex, usize, delimiter);
+    mathml = mtex2MML_output();
+    break;
+  case TEXT_FILTER:
+    status = mtex2MML_text_filter(mtex, usize, delimiter);
+    mathml = mtex2MML_output();
+    break;
+  case STRICT_FILTER:
+    status = mtex2MML_strict_filter(mtex, usize, delimiter);
+    mathml = mtex2MML_output();
+    break;
+  default:
+    /* should be impossible, Ruby code prevents this */
+    print_and_raise(rb_eTypeError, "not valid render format");
+    break;
+  }
+
+  if (status) {
     return NULL;
   }
 

data/ext/mathematical/lasem_overrides.h

@@ -1,5 +1,12 @@
+#ifndef LASEM_OVERRIDES_H
+#define LASEM_OVERRIDES_H
+
 #include <glib.h>
-#include "mtex2MML.h"
+
+#define PARSE 0
+#define FILTER 1
+#define TEXT_FILTER 2
+#define STRICT_FILTER 3
 
 /**
  * lsm_mtex_to_mathml:
@@ -11,7 +18,7 @@
  * Return value: a newly allocated string, NULL on parse error. The returned data must be freed using @lsm_mtex_free_mathml_buffer.
  */
 
-extern char * lsm_mtex_to_mathml (const char *mtex, gssize size, int global_start);
+extern char * lsm_mtex_to_mathml (const char *mtex, gssize size, int delimiter, int render_type);
 
 /**
  * lsm_mtex_free_mathml_buffer:
@@ -21,3 +28,5 @@ extern char * lsm_mtex_to_mathml (const char *mtex, gssize size, int global_star
  */
 
 extern void lsm_mtex_free_mathml_buffer (char *mathml);
+
+#endif

data/ext/mathematical/mathematical.c

@@ -1,5 +1,5 @@
 /****************************************************************************
-* Mathematical_rb Copyright(c) 2014, Garen J. Torikian, All rights reserved.
+* Mathematical Copyright(c) 2014, Garen J. Torikian, All rights reserved.
 * --------------------------------------------------------------------------
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
@@ -36,28 +36,28 @@ static VALUE rb_eDocumentCreationError;
 // Raised when the SVG document could not be read
 static VALUE rb_eDocumentReadError;
 
-// defines the numeric equation label
-static int global_start = 1;
-
 static VALUE MATHEMATICAL_init(VALUE self, VALUE rb_Options)
 {
   Check_Type (rb_Options, T_HASH);
-  VALUE rb_ppi, rb_zoom, rb_maxsize, rb_format;
+  VALUE rb_ppi, rb_zoom, rb_maxsize, rb_format, rb_delimiter;
 
   rb_ppi = rb_hash_aref(rb_Options, CSTR2SYM("ppi"));
   rb_zoom = rb_hash_aref(rb_Options, CSTR2SYM("zoom"));
   rb_maxsize = rb_hash_aref(rb_Options, CSTR2SYM("maxsize"));
   rb_format = rb_hash_aref(rb_Options, CSTR2SYM("formatInt"));
+  rb_delimiter = rb_hash_aref(rb_Options, CSTR2SYM("delimiter"));
 
   Check_Type(rb_ppi, T_FLOAT);
   Check_Type(rb_zoom, T_FLOAT);
   Check_Type(rb_maxsize, T_FIXNUM);
   Check_Type(rb_format, T_FIXNUM);
+  Check_Type(rb_delimiter, T_FIXNUM);
 
   rb_iv_set(self, "@ppi", rb_ppi);
   rb_iv_set(self, "@zoom", rb_zoom);
   rb_iv_set(self, "@maxsize", rb_maxsize);
   rb_iv_set(self, "@format", rb_format);
+  rb_iv_set(self, "@delimiter", rb_delimiter);
 
   rb_iv_set(self, "@png", Qnil);
   rb_iv_set(self, "@svg", Qnil);
@@ -86,7 +86,7 @@ static VALUE process_rescue(VALUE args, VALUE exception_object)
   return rescue_hash;
 }
 
-VALUE process(VALUE self, unsigned long maxsize, const char *latex_code, unsigned long latex_size)
+VALUE process(VALUE self, unsigned long maxsize, const char *latex_code, unsigned long latex_size, int delimiter, int parse_type)
 {
   if (latex_size > maxsize) {
     print_and_raise(rb_eMaxsizeError, "Size of latex string is greater than the maxsize");
@@ -95,15 +95,10 @@ VALUE process(VALUE self, unsigned long maxsize, const char *latex_code, unsigne
   VALUE result_hash = rb_hash_new();
   FileFormat format = (FileFormat) FIX2INT(rb_iv_get(self, "@format"));
 
-  // convert the LaTeX math to MathML
-  char * mathml = lsm_mtex_to_mathml(latex_code, latex_size, global_start);
+  /* convert the TeX math to MathML */
+  char * mathml = lsm_mtex_to_mathml(latex_code, latex_size, delimiter, parse_type);
   if (mathml == NULL) { print_and_raise(rb_eParseError, "Failed to parse mtex"); }
 
-  // basically, only update the next equation counter if the last math had a numbered equation
-  if (strstr(mathml, "<mlabeledtr>") != NULL) {
-    global_start++;
-  }
-
   if (format == FORMAT_MATHML) {
     rb_hash_aset (result_hash, CSTR2SYM ("data"), rb_str_new2(mathml));
     mtex2MML_free_string(mathml);
@@ -185,28 +180,31 @@ VALUE process(VALUE self, unsigned long maxsize, const char *latex_code, unsigne
   rb_hash_aset (result_hash, CSTR2SYM ("width"),  INT2FIX(width_pt));
   rb_hash_aset (result_hash, CSTR2SYM ("height"), INT2FIX(height_pt));
 
-  // we need to clear out this key when attempting multiple calls. See http://git.io/i1hblQ
+  /* we need to clear out this key when attempting multiple calls. See http://git.io/i1hblQ */
   rb_iv_set(self, "@svg", Qnil);
   rb_iv_set(self, "@png", Qnil);
 
   return result_hash;
 }
 
-// `process` can potentially raise a bunch of exceptions, so we need to wrap
-// the call in a rescue. And `rb_rescue` only takes one argument, so we need
-// to pack everything in an array, and then unpack it in `process_helper`.
+/* `process` can potentially raise a bunch of exceptions, so we need to wrap
+   the call in a rescue. And `rb_rescue` only takes one argument, so we need
+   to pack everything in an array, and then unpack it in `process_helper`. */
 static VALUE process_helper(VALUE data)
 {
   VALUE *args = (VALUE *) data;
 
-  return process(args[0], NUM2ULONG(args[1]), StringValueCStr(args[2]), NUM2ULONG(args[3]));
+  return process(args[0], NUM2ULONG(args[1]), StringValueCStr(args[2]), NUM2ULONG(args[3]), NUM2INT(args[4]), NUM2INT(args[5]));
 }
 
-static VALUE MATHEMATICAL_process(VALUE self, VALUE rb_Input)
+static VALUE MATHEMATICAL_process(VALUE self, VALUE rb_Input, VALUE rb_ParseType)
 {
+  Check_Type(rb_ParseType, T_FIXNUM);
+
   unsigned long maxsize = (unsigned long) FIX2INT(rb_iv_get(self, "@maxsize"));
 
-  // make sure that the passed latex string is not larger than the maximum value of a signed long (or the maxsize option)
+  /* make sure that the passed latex string is not larger than the maximum value of
+    a signed long (or the maxsize option) */
   if (maxsize == 0) {
     maxsize = LONG_MAX;
   }
@@ -225,11 +223,13 @@ static VALUE MATHEMATICAL_process(VALUE self, VALUE rb_Input)
     latex_code = StringValueCStr(rb_Input);
     latex_size = (unsigned long) strlen(latex_code);
 
-    VALUE args[4];
+    VALUE args[6];
     args[0] = self;
     args[1] = ULONG2NUM(maxsize);
     args[2] = rb_Input;
     args[3] = ULONG2NUM(latex_size);
+    args[4] = rb_iv_get(self, "@delimiter");
+    args[5] = rb_ParseType;
 
     output = rb_rescue(process_helper, args, process_rescue, rb_Input);
     break;
@@ -238,21 +238,22 @@ static VALUE MATHEMATICAL_process(VALUE self, VALUE rb_Input)
     int length = RARRAY_LEN(rb_Input), i;
     VALUE hash;
     output = rb_ary_new2(length);
-    global_start = 1;
 
     for (i = 0; i < length; i++) {
-      // grab the ith element
+      /* grab the ith element */
       VALUE math = rb_ary_entry(rb_Input, i);
 
-      // get the string and length
+      /* get the string and length */
       latex_code = StringValueCStr(math);
       latex_size = (unsigned long) strlen(latex_code);
 
-      VALUE args[4];
+      VALUE args[6];
       args[0] = self;
       args[1] = ULONG2NUM(maxsize);
       args[2] = math;
       args[3] = ULONG2NUM(latex_size);
+      args[4] = rb_iv_get(self, "@delimiter");
+      args[5] = rb_ParseType;
 
       hash = rb_rescue(process_helper, args, process_rescue, math);
 
@@ -282,5 +283,5 @@ void Init_mathematical()
   rb_eDocumentReadError = rb_define_class_under(rb_mMathematical, "DocumentReadError", rb_eStandardError);
 
   rb_define_method(rb_cMathematicalProcess, "initialize", MATHEMATICAL_init, 1);
-  rb_define_method(rb_cMathematicalProcess, "process", MATHEMATICAL_process, 1);
+  rb_define_method(rb_cMathematicalProcess, "process", MATHEMATICAL_process, 2);
 }

data/ext/mathematical/mathematical.h

@@ -1,3 +1,6 @@
+#ifndef MATHEMATICAL_H
+#define MATHEMATICAL_H
+
 #include "ruby.h"
 
 #include <string.h>
@@ -13,7 +16,6 @@
 #include <gio/gio.h>
 #include <cairo-svg.h>
 
-#include "mtex2MML.h"
 #include <cairo_callbacks.h>
 #include <lasem_overrides.h>
 
@@ -22,3 +24,5 @@ typedef enum {
   FORMAT_PNG,
   FORMAT_MATHML
 } FileFormat;
+
+#endif

data/ext/mathematical/mtex2MML/deps/strdup/strdup.c

@@ -0,0 +1,24 @@
+
+//
+// strdup.c
+//
+// Copyright (c) 2014 Stephen Mathieson
+// MIT licensed
+//
+
+#ifndef HAVE_STRDUP
+
+#include <stdlib.h>
+#include <string.h>
+#include "strdup.h"
+
+char *
+strdup(const char *str) {
+  if (!str) return NULL;
+  int len = strlen(str) + 1;
+  char *buf = malloc(len);
+  if (buf) memcpy(buf, str, len);
+  return buf;
+}
+
+#endif /* HAVE_STRDUP */

data/ext/mathematical/mtex2MML/deps/strdup/strdup.h

@@ -0,0 +1,24 @@
+
+//
+// strdup.h
+//
+// Copyright (c) 2014 Stephen Mathieson
+// MIT licensed
+//
+
+#ifndef HAVE_STRDUP
+#define HAVE_STRDUP
+
+/**
+ * Drop-in replacement for strdup(3) from libc.
+ *
+ * Creates a copy of `str`.  Free when done.
+ *
+ * Returns a pointer to the newly allocated
+ * copy of `str`, or `NULL` on failure.
+ */
+
+char *
+strdup(const char *str);
+
+#endif /* HAVE_STRDUP */