mathematical 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f786243252000f0ce7053c49e288c8024edc860
-  data.tar.gz: 8958c2259c707f27a9cddb5655b8ac1e9dd6d76c
+  metadata.gz: 03f0731bd32ba0f8f1f6f8a3c83ce1ee89ece70d
+  data.tar.gz: e0ca46a7d69b7943645b8bb4bd64c2f6e780b8fa
 SHA512:
-  metadata.gz: 623fa07b26e1693d761561ac91305a50d5e87da002a472e2a7a5b42342eb2ce6c8a69dcc43b0986f0195e8f9038dcd62add881e43407b44d72f7b637f1649a49
-  data.tar.gz: 716e5e0ca88f633957d322dae909b1d5efc23ef2aedb7278d936ad0af6f09f54a646fef3fcf0cc01235c0d69eba938e5902b8a274683f63621fef615e9d49675
+  metadata.gz: 33098207ab043b4b6452b0b35eb332bf731abfedc2fb29ddb14f446e5dab94edc2fefaf51b8f4bc75b3877c69e3fb72c06dbfe3dda4350a3e561ae7516e18ffc
+  data.tar.gz: 2341104e60ea0d51019912c607bf8d81ddd48e46b41aaa2d789e11026eb28d5bde6af0c500754ff9d329431bb11f0d80e4f6a122128b5a8e1e95c42468ae52b4

data/README.md

@@ -1,6 +1,6 @@
 # Mathematical
 
-Quickly convert math equations into beautiful SVGs.
+Quickly convert math equations into beautiful SVGs (or PNGs/MathML).
 
 [![Build Status](https://travis-ci.org/gjtorikian/mathematical.svg?branch=master)](https://travis-ci.org/gjtorikian/mathematical)
 
@@ -25,16 +25,25 @@ Or install it yourself as:
 The simplest way to do this is
 
 ``` ruby
+require 'mathematical'
+
 Mathematical::Render.new.render(string_with_math)
 ```
 
 `string_with_math` should just be a string of itex inline (`$..$`) or display (`$$..$$`) style math.
 
-The output will be a hash, with the following data:
+The output will be a hash, with keys that depend on the format you want:
 
-* `width`: the width of the resulting SVG file
-* `height`: the height of the resulting SVG file
-* `svg`: the actual string of SVG
+* If you asked for an SVG, you'll get:
+  * `width`: the width of the resulting image
+  * `height`: the height of the resulting image
+  * `svg`: the actual string of SVG
+* If you asked for a PNG, you'll get:
+  * `width`: the width of the resulting image
+  * `height`: the height of the resulting image
+  * `png`: the PNG data
+* If you asked for MathML, you'll get:
+  * `mathml`: the MathML data
 
 ### Options
 
@@ -43,6 +52,8 @@ The output will be a hash, with the following data:
 * `:ppi` - A double determining the pixels per inch of the resulting SVG (default: `72.0`).
 * `:zoom` - A double determining the zoom level of the resulting SVG (default: `1.0`).
 * `:base64` - A boolean determining whether Mathematical's output should be a base64-encoded SVG string (default: `false`).
+* `:maxsize` - A numeral indicating the `MAXSIZE` the output string can be. (default: `unsigned long`).
+* `:format` - A string indicating whether you want an "svg", "png", or "mathml" output. (default: `svg`).
 
 Pass these in as an options hash:
 
@@ -56,6 +67,8 @@ renderer.render('$a \ne b$')
 
 Literally everything on the [itex2MML homepage for version 1.5.1](http://golem.ph.utexas.edu/~distler/blog/itex2MMLcommands.html) is supported, because it acts as the interpretation engine for Mathematical.
 
+**Note**: This library makes few assumptions about the strings that you pass in. It assumes that `$..$` is inline math, `$$..$$` is display math, and that slashes like `\\` are escaped (`\\\\`).
+
 ## Dependencies
 
 Before using this gem, you must install the following libraries:
@@ -98,11 +111,9 @@ curl -LO http://mirrors.ctan.org/fonts/cm/ps-type1/bakoma/ttf/cmex10.ttf \
 To install these dependencies on a *nix machine, fetch the packages through your package manager. For example:
 
 ```
-sudo apt-get -qq -y install libxml2-dev libcairo2-dev libpango1.0-dev ttf-lyx
+sudo apt-get -qq -y install libglib2.0-dev libxml2-dev libcairo2-dev libpango1.0-dev ttf-lyx libgdk-pixbuf2.0-dev
 ```
 
-`glib` and `gdk-pixbuf` should be on your machine.
-
 ### Windows install
 
 On a Windows machine, I have no idea. Pull requests welcome!
@@ -121,7 +132,7 @@ Rendering...                               9.470000   0.750000  10.220000 ( 13.9
 
 After cloning the repo:
 
-``` 
+```
 script/bootstrap
 bundle exec rake compile
 ```

data/Rakefile

@@ -28,34 +28,14 @@ Rake::Task[:test].prerequisites << :compile
 
 task :default => [:test]
 
-desc "Generate and publish to gh-pages"
-task :publish do
+desc "Copy samples to gh-pages"
+task :copy_samples do
   Dir.mktmpdir do |tmp|
-    system "cp test/mathematical/fixtures/after/* #{tmp}"
-    titles_to_content = {}
-    Dir.glob("#{tmp}/compliance_*.html") do |item|
-      titles_to_content[File.basename(item)] = File.read(item)
-    end
+    system "cp -r samples #{tmp}"
 
     system "git checkout gh-pages"
 
-    li_listing = titles_to_content.keys.map { |title| "<li><a href='#{title}'>#{File.basename(title, File.extname(title))}</a></li>" }
-    index = File.read("index.html")
-    File.open("index.html", 'w') { |file| file.write(index.sub(/<!-- LIST_GOES_HERE -->/, li_listing.join("\n"))) }
-
-    layout = File.read("layout_shell.text")
-    titles_to_content.each do |title, content|
-      new_layout = layout.sub(/<!-- TITLE_GOES_HERE -->/, title)
-      new_layout = new_layout.sub(/<!-- CONTENT_GOES_HERE -->/, content)
-      File.open("#{title}", 'w') { |file| file.write(new_layout) }
-    end
-
-    message = "Site updated at #{Time.now.utc}"
-    system "git add ."
-    system "git commit -am #{message.shellescape}"
-    system "git push origin gh-pages --force"
-    system "git checkout master"
-    system "echo yolo"
+    system "cp -r #{tmp}/samples ."
   end
 end
 
@@ -65,4 +45,5 @@ task :destroy_copies do
     next if f =~ /extconf.rb/ || f =~ /mathematical.c/
     File.delete(f)
   end
+  Dir.glob("#{ext_dir}/{lib,src,test,ext}").select { |d| FileUtils.rm_rf d }
 end

data/ext/mathematical/extconf.rb

@@ -3,7 +3,7 @@ require 'rbconfig'
 host_os = RbConfig::CONFIG['host_os']
 
 LASEM_DIR = File.join(File.dirname(__FILE__), "lasem", "src")
-ITEX_DIR = File.join(File.dirname(__FILE__), "itexToMML")
+MTEX_DIR = File.join(File.dirname(__FILE__), "mtex2MML", "src")
 
 if host_os =~ /darwin|mac os/
   ENV['PKG_CONFIG_PATH'] = "/opt/X11/lib/pkgconfig:#{ENV['PKG_CONFIG_PATH']}"
@@ -20,11 +20,16 @@ find_header("libxml/xpathInternals.h", "/usr/include/libxml2", "/usr/local/inclu
 FileUtils.cp_r(Dir.glob("#{LASEM_DIR}/*"), File.dirname(__FILE__))
 File.delete(File.join(File.dirname(__FILE__), "lasemrender.c"))
 
-FileUtils.cp_r(Dir.glob("#{ITEX_DIR}/*"), File.dirname(__FILE__))
+# build mtex2MML Bison files
+Dir.chdir(MTEX_DIR) do
+  system "make"
+end
+
+FileUtils.cp_r(Dir.glob("#{MTEX_DIR}/*.{c,h,cc}"), File.dirname(__FILE__))
 
 have_library("pangocairo-1.0")
 
 $LDFLAGS += " #{`pkg-config --static --libs glib-2.0 gdk-pixbuf-2.0 cairo pango`.chomp}"
-$CFLAGS += " #{`pkg-config --cflags glib-2.0 gdk-pixbuf-2.0 cairo pango`.chomp} -I#{LASEM_DIR} -I#{ITEX_DIR}"
+$CFLAGS += " #{`pkg-config --cflags glib-2.0 gdk-pixbuf-2.0 cairo pango`.chomp} -DFLIP_OFFSET_VAL -I#{LASEM_DIR} -I#{MTEX_DIR}"
 
 create_makefile("mathematical/mathematical")

data/ext/mathematical/lasem/src/lsmdomparser.c

@@ -259,7 +259,7 @@ typedef enum {
 
 static LsmDomDocument *
 _parse_memory (LsmDomDocument *document, LsmDomNode *node,
-	       const void *buffer, gsize size, GError **error)
+	       const void *buffer, gssize size, GError **error)
 {
 	static LsmDomSaxParserState state;
 
@@ -269,7 +269,7 @@ _parse_memory (LsmDomDocument *document, LsmDomNode *node,
 	else
 		state.current_node = LSM_DOM_NODE (document);
 
-	if (size < 1)
+	if (size < 0)
 		size = strlen (buffer);
 
 	if (xmlSAXUserParseMemory (&sax_handler, &state, buffer, size) < 0) {
@@ -293,18 +293,18 @@ _parse_memory (LsmDomDocument *document, LsmDomNode *node,
  * @document: a #LsmDomDocument
  * @node: a #LsmDomNode
  * @buffer: a memory buffer holding xml data
- * @size: size of the xml data, in bytes, 0 if unknown
+ * @size: size of the xml data, in bytes, -1 if NULL terminated
  * @error: an error placeholder
  *
  * Append a chunk of xml tree to an existing document. The resulting nodes will be appended to
  * @node, or to @document if @node == NULL.
  *
- * Size set to 0 indicates an unknow xml data size.
+ * Size set to -1 indicates the buffer is NULL terminated.
  */
 
 void
 lsm_dom_document_append_from_memory (LsmDomDocument *document, LsmDomNode *node,
-				     const void *buffer, gsize size, GError **error)
+				     const void *buffer, gssize size, GError **error)
 {
 	g_return_if_fail (LSM_IS_DOM_DOCUMENT (document));
 	g_return_if_fail (LSM_IS_DOM_NODE (node) || node == NULL);
@@ -316,14 +316,14 @@ lsm_dom_document_append_from_memory (LsmDomDocument *document, LsmDomNode *node,
 /**
  * lsm_dom_document_new_from_memory:
  * @buffer: xml data
- * @size: size of the data, in bytes, 0 if unknown
+ * @size: size of the data, in bytes, -1 if NULL terminated
  * @error: an error placeholder
  *
  * Create a new document from a memory data buffer.
  */
 
 LsmDomDocument *
-lsm_dom_document_new_from_memory (const void *buffer, gsize size, GError **error)
+lsm_dom_document_new_from_memory (const void *buffer, gssize size, GError **error)
 {
 	g_return_val_if_fail (buffer != NULL, NULL);
 

data/ext/mathematical/lasem/src/lsmdomparser.h

@@ -30,8 +30,8 @@
 G_BEGIN_DECLS
 
 void 			lsm_dom_document_append_from_memory 	(LsmDomDocument *document, LsmDomNode *node,
-								 const void *buffer, gsize size, GError **error);
-LsmDomDocument * 	lsm_dom_document_new_from_memory 	(const void *buffer, gsize size, GError **error);
+								 const void *buffer, gssize size, GError **error);
+LsmDomDocument * 	lsm_dom_document_new_from_memory 	(const void *buffer, gssize size, GError **error);
 LsmDomDocument * 	lsm_dom_document_new_from_path 		(const char *path, GError **error);
 LsmDomDocument * 	lsm_dom_document_new_from_url 		(const char *url, GError **error);
 

data/ext/mathematical/lasem/src/lsmitex.c

@@ -28,7 +28,7 @@
 /**
  * lsm_itex_to_mathml:
  * @itex: (allow-none): an itex string
- * @size: itex string length, 0 if unknown
+ * @size: itex string length, -1 if NULL terminated
  *
  * Converts an itex string to a Mathml representation.
  *
@@ -36,17 +36,20 @@
  */
 
 char *
-lsm_itex_to_mathml (const char *itex, gsize size)
+lsm_itex_to_mathml (const char *itex, gssize size)
 {
+	gsize usize;
 	char *mathml;
 
 	if (itex == NULL)
 		return NULL;
 
-	if (size < 1)
-		size = strlen (itex);
+	if (size < 0)
+		usize = strlen (itex);
+	else
+		usize = size;
 
-	mathml = itex2MML_parse (itex, size);
+	mathml = itex2MML_parse (itex, usize);
 	if (mathml == NULL)
 		return NULL;
 

data/ext/mathematical/lasem/src/lsmitex.h

@@ -28,7 +28,7 @@
 
 G_BEGIN_DECLS
 
-char *		lsm_itex_to_mathml		(const char *itex, gsize size);
+char *		lsm_itex_to_mathml		(const char *itex, gssize size);
 void		lsm_itex_free_mathml_buffer	(char *mathml);
 
 G_END_DECLS

data/ext/mathematical/lasem/src/lsmmathmldocument.c

@@ -213,7 +213,7 @@ typedef enum {
 } LsmMathmlDocumentError;
 
 LsmMathmlDocument *
-lsm_mathml_document_new_from_itex (const char *itex, gsize size, GError **error)
+lsm_mathml_document_new_from_itex (const char *itex, gssize size, GError **error)
 {
 	LsmDomDocument *document;
 	char *mathml;
@@ -250,7 +250,7 @@ static LsmMathmlDocument *
 lsm_mathml_document_new_from_itex_file (GFile *file, GError **error)
 {
 	LsmMathmlDocument *document;
-	gsize size = 0;
+	gssize size = 0;
 	char *contents = NULL;
 
 	if (!g_file_load_contents (file, NULL, &contents, &size, NULL, error))

data/ext/mathematical/lasem/src/lsmmathmldocument.h

@@ -51,7 +51,7 @@ GType lsm_mathml_document_get_type (void);
 LsmDomDocument *	lsm_mathml_document_new 		(void);
 LsmMathmlMathElement * 	lsm_mathml_document_get_root_element 	(const LsmMathmlDocument *document);
 
-LsmMathmlDocument * 	lsm_mathml_document_new_from_itex	(const char *itex, gsize size, GError **error);
+LsmMathmlDocument * 	lsm_mathml_document_new_from_itex	(const char *itex, gssize size, GError **error);
 LsmMathmlDocument * 	lsm_mathml_document_new_from_itex_path 	(const char *url, GError **error);
 LsmMathmlDocument * 	lsm_mathml_document_new_from_itex_url 	(const char *url, GError **error);
 

data/ext/mathematical/lasem/tests/lsmtest.c

@@ -254,7 +254,7 @@ lasem_test_render (char const *filename, gboolean compare, gboolean dry_run, Sta
 	cairo_t *cairo;
 	cairo_surface_t *surface;
 	char *buffer = NULL;
-	gsize size;
+	gssize size;
 	char *png_filename;
 	char *reference_png_filename;
 	char *test_name;
@@ -300,7 +300,7 @@ lasem_test_render (char const *filename, gboolean compare, gboolean dry_run, Sta
 			xml = buffer;
 		else {
 			xml = itex2MML_parse (buffer, size);
-			size = 0;
+			size = -1;
 		}
 
 		timer = g_timer_new ();

data/ext/mathematical/mathematical.c

@@ -33,7 +33,7 @@
 #include <cairo-pdf.h>
 #include <cairo-svg.h>
 #include <cairo-ps.h>
-#include "itex2MML.h"
+#include "mtex2MML.h"
 
 #define CSTR2SYM(str) ID2SYM(rb_intern(str))
 
@@ -49,6 +49,64 @@ static VALUE rb_eDocumentCreationError;
 // Raised when the SVG document could not be read
 static VALUE rb_eDocumentReadError;
 
+typedef enum {
+  FORMAT_SVG,
+  FORMAT_PNG,
+  FORMAT_MATHML
+} FileFormat;
+
+/**
+ * lsm_mtex_to_mathml:
+ * @mtex: (allow-none): an mtex string
+ * @size: mtex string length, -1 if NULL terminated
+ *
+ * Converts an mtex string to a Mathml representation.
+ *
+ * Return value: a newly allocated string, NULL on parse error. The returned data must be freed using @lsm_mtex_free_mathml_buffer.
+ */
+
+char *
+lsm_mtex_to_mathml (const char *mtex, gssize size)
+{
+  gsize usize;
+  char *mathml;
+
+  if (mtex == NULL)
+    return NULL;
+
+  if (size < 0)
+    usize = strlen (mtex);
+  else
+    usize = size;
+
+  mathml = mtex2MML_parse (mtex, usize);
+  if (mathml == NULL)
+    return NULL;
+
+  if (mathml[0] == '\0') {
+    mtex2MML_free_string (mathml);
+    return NULL;
+  }
+
+  return mathml;
+}
+
+/**
+ * lsm_mtex_free_mathml_buffer:
+ * @mathml: (allow-none): a mathml buffer
+ *
+ * Free the buffer returned by @lsm_mtex_to_mathml.
+ */
+
+void
+lsm_mtex_free_mathml_buffer (char *mathml)
+{
+  if (mathml == NULL)
+    return;
+
+  mtex2MML_free_string (mathml);
+}
+
 cairo_status_t cairoSvgSurfaceCallback (void *closure, const unsigned char *data, unsigned int length) {
   VALUE self = (VALUE) closure;
   if (rb_iv_get(self, "@svg") == Qnil) {
@@ -60,21 +118,37 @@ cairo_status_t cairoSvgSurfaceCallback (void *closure, const unsigned char *data
   return CAIRO_STATUS_SUCCESS;
 }
 
+cairo_status_t cairoPngSurfaceCallback (void *closure, const unsigned char *data, unsigned int length) {
+  VALUE self = (VALUE) closure;
+  if (rb_iv_get(self, "@png") == Qnil) {
+    rb_iv_set(self, "@png", rb_str_new2(""));
+  }
+
+  rb_str_cat(rb_iv_get(self, "@png"), data, length);
+
+  return CAIRO_STATUS_SUCCESS;
+}
+
 static VALUE MATHEMATICAL_init(VALUE self, VALUE rb_Options) {
   Check_Type (rb_Options, T_HASH);
-  VALUE rb_ppi, rb_zoom, rb_maxsize;
+  VALUE rb_ppi, rb_zoom, rb_maxsize, rb_format;
 
   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("format"));
 
   Check_Type(rb_ppi, T_FLOAT);
   Check_Type(rb_zoom, T_FLOAT);
   Check_Type(rb_maxsize, T_FIXNUM);
+  Check_Type(rb_format, T_STRING);
 
   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, "@png", Qnil);
   rb_iv_set(self, "@svg", Qnil);
 
   return self;
@@ -99,20 +173,30 @@ static VALUE MATHEMATICAL_process(VALUE self, VALUE rb_LatexCode) {
   g_type_init ();
 #endif
 
+  VALUE result_hash = rb_hash_new();
+  const char* rb_format = RSTRING_PTR(rb_iv_get(self, "@format"));
+
   // convert the TeX math to MathML
-  char * mathml = lsm_itex_to_mathml(latex_code, latex_size);
-  if (mathml == NULL) rb_raise(rb_eParseError, "Failed to parse itex");
+  char * mathml = mtex2MML_parse(latex_code, latex_size);
+  if (mathml == NULL) rb_raise(rb_eParseError, "Failed to parse mtex");
+
+  if (strncmp(rb_format, "mathml", 6) == 0) {
+    rb_hash_aset (result_hash, rb_tainted_str_new2 ("mathml"),    rb_str_new2(mathml));
+    mtex2MML_free_string(mathml);
+    return result_hash;
+  }
 
   int mathml_size = strlen(mathml);
 
   LsmDomDocument *document;
   document = lsm_dom_document_new_from_memory(mathml, mathml_size, NULL);
 
-  lsm_itex_free_mathml_buffer (mathml);
+  mtex2MML_free_string(mathml);
 
   if (document == NULL) rb_raise(rb_eDocumentCreationError, "Failed to create document");
 
   LsmDomView *view;
+  FileFormat format;
 
   double ppi = NUM2DBL(rb_iv_get(self, "@ppi"));
   double zoom = NUM2DBL(rb_iv_get(self, "@zoom"));
@@ -132,26 +216,51 @@ static VALUE MATHEMATICAL_process(VALUE self, VALUE rb_LatexCode) {
   cairo_t *cairo;
   cairo_surface_t *surface;
 
-  surface = cairo_svg_surface_create_for_stream (cairoSvgSurfaceCallback, self, width_pt, height_pt);
+  if (strncmp(rb_format, "svg", 3) == 0) {
+    format = FORMAT_SVG;
+    surface = cairo_svg_surface_create_for_stream (cairoSvgSurfaceCallback, self, width_pt, height_pt);
+  }
+  else if (strncmp(rb_format, "png", 3) == 0) {
+    format = FORMAT_PNG;
+    surface = cairo_image_surface_create (CAIRO_FORMAT_ARGB32, width, height);
+  }
+
   cairo = cairo_create (surface);
   cairo_surface_destroy (surface);
   cairo_scale (cairo, zoom, zoom);
   lsm_dom_view_render (view, cairo, 0, 0);
 
+  switch (format) {
+    case FORMAT_PNG:
+      cairo_surface_write_to_png_stream (cairo_get_target (cairo), cairoPngSurfaceCallback, self);
+      break;
+    default:
+      break;
+  }
+
   cairo_destroy (cairo);
   g_object_unref (view);
   g_object_unref (document);
 
-  if (rb_iv_get(self, "@svg") == Qnil) rb_raise(rb_eDocumentReadError, "Failed to read SVG contents");
-
-  VALUE result_hash = rb_hash_new();
+  switch (format) {
+    case FORMAT_SVG:
+      if (rb_iv_get(self, "@svg") == Qnil) rb_raise(rb_eDocumentReadError, "Failed to read SVG contents");
+      rb_hash_aset (result_hash, rb_tainted_str_new2 ("svg"),    rb_iv_get(self, "@svg"));
+      break;
+    case FORMAT_PNG:
+      if (rb_iv_get(self, "@png") == Qnil) rb_raise(rb_eDocumentReadError, "Failed to read PNG contents");
+      rb_hash_aset (result_hash, rb_tainted_str_new2 ("png"),    rb_iv_get(self, "@png"));
+      break;
+    default:
+      break;
+  }
 
   rb_hash_aset (result_hash, rb_tainted_str_new2 ("width"),  INT2FIX(width_pt));
   rb_hash_aset (result_hash, rb_tainted_str_new2 ("height"), INT2FIX(height_pt));
-  rb_hash_aset (result_hash, rb_tainted_str_new2 ("svg"),    rb_iv_get(self, "@svg"));
 
   // 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;
 }