mathematical 0.6.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a9cdeb400a07fdbeb239cbc9a388b6f45b3b927
-  data.tar.gz: d837b73e1fc83fd8c38171904a85262ceaa0d678
+  metadata.gz: 020b6daf960edb5a9e5436aef6fa8c406188896c
+  data.tar.gz: ac15939f237b1086ed76ab8cd36fd55b7cb261e5
 SHA512:
-  metadata.gz: 5223d24628dd767856850b8ceb95fc7a9b37bc70fcd3350cb68566da1a174fa11522a24f34086c2fd81c88944cf59c0e8ac714895e6c3fd33bd5d4b4c77cccdf
-  data.tar.gz: 3e53356aef54d440be7c582bc65b0ab3dbe96edfd69fce06282d925d531a4fa5bd84f189d976f690af17b35eee5d9cc428e770880cdd8e0f270f0af75eecd381
+  metadata.gz: 9f73b02d173514430ff94664fa28e2b2d7cdfd863556796b399c3ee590a97a1904ab9f119b13ea617a677a47bde1351d7c5a4bbcd069d8732ffa097b46a418f9
+  data.tar.gz: 773a25ece459f013a69554c33018f2be6530ffc0e31d6b821a89690d5a652d84286e51697037b69887c09a682c50669927ff0ee4252cbf29fda3dad301a939df

data/README.md

@@ -27,7 +27,7 @@ The simplest way to do this is
 ``` ruby
 require 'mathematical'
 
-Mathematical::Render.new.render(string_with_math)
+Mathematical.new.render(string_with_math)
 ```
 
 `string_with_math` should just be a string of math TeX inline (`$..$`) or display (`$$..$$`) style math.
@@ -45,21 +45,55 @@ The output will be a hash, with keys that depend on the format you want:
 * If you asked for MathML, you'll get:
   * `mathml`: the MathML data
 
+**Note**: If you pass in invalid LaTeX, an error is not raised, but a message *is* printed to STDERR, and the original string is returned (not a hash).
+
+### Array of equations
+
+Rather than just a string, you can also provide an array of math inputs:
+
+``` ruby
+inputs = []
+inputs << '$a$'
+inputs << '$b$'
+inputs << '$c$'
+
+Mathematical.new.render(inputs)
+```
+
+This returns an array of hashes, possessing the same keys as above.
+
+**Note**: With an array, it is possible to receive elements that are not hashes. For example, given the following input:
+
+```
+array = ['$foof$', '$not__thisisnotreal$', '$poof$']
+```
+
+You will receive the following output:
+
+```
+Mathematical.new.render(array)
+[ {:svg => "...", :width => ... }, '$not__thisisnotreal$', {:svg => "...", :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 a single string, a message is also printed to STDERR.
+
 ### Options
 
-`Mathematical::Render.new` takes an optional hash to define a few options:
+`Mathematical.new` takes an optional hash to define a few options:
 
-* `: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`).
+| Name | Description | Default
+|------|-------------|--------
+| `:ppi` | A double determining the pixels per inch of the resulting SVG | `72.0`
+| `:zoom` | A double determining the zoom level of the resulting SVG | `1.0`
+| `: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`
 
 Pass these in like this:
 
 ``` ruby
 opts = { :ppi => 200.0, :zoom => 5.0, :base64 => true }
-renderer = Mathematical::Render.new(opts)
+renderer = Mathematical.new(opts)
 renderer.render('$a \ne b$')
 ```
 
@@ -67,7 +101,7 @@ renderer.render('$a \ne b$')
 
 Check out [SUPPORTED.md on the mtex2MML website](https://github.com/gjtorikian/mtex2MML/blob/master/SUPPORTED.md).
 
-**Note**: This library makes a few assumptions about the strings that you pass in. It assumes that `$..$` is inline math, `$$..$$` is display math, and that your double-slashes (like `\\`) are escaped (`\\\\`).
+**Note**: This library makes a few assumptions about the strings that you pass in. It assumes that `$..$` is inline math and `$$..$$` is display math.
 
 ## Building
 
@@ -122,10 +156,12 @@ On a Windows machine, I have no idea. Pull requests welcome!
 
 ```
 Benchmarking....
-Size: 1175 kilobytes
+Size: 1164 kilobytes
 Iterations: 10
                                                user     system      total        real
-Rendering...                               9.470000   0.750000  10.220000 ( 13.909420)
+Rendering...                             18.070000   0.290000  18.360000 ( 23.003883)
+
+19340 items converted!
 ```
 
 ## Hacking
@@ -217,7 +253,7 @@ With it, you could do something fun like:
 
 ``` ruby
 MathToItex(string).convert do |eq, type|
-  svg_content = Mathematical::Render.new(:base64 => true).render(eq)
+  svg_content = Mathematical.new(:base64 => true).render(eq)
 
   # create image tags of math with base64-encoded SVGs
   %|<img class="#{type.to_s}-math" data-math-type="#{type.to_s}-math" src="#{svg_content}"/>|

data/Rakefile

@@ -40,9 +40,10 @@ task :copy_samples do
 end
 
 task :destroy_copies do
+  safe_files = [/extconf.rb/, /mathematical\.(?:c|h)/, /lasem_overrides/, /cairo_callbacks/]
   ext_dir = File.join(File.dirname(__FILE__), 'ext', 'mathematical')
   Dir.glob("#{ext_dir}/*").select { |f| File.file?(f) }.each do |f|
-    next if f =~ /extconf.rb$/ || f =~ /mathematical.c$/
+    next if safe_files.any? { |s| f =~ s }
     File.delete(f)
   end
   Dir.glob("#{ext_dir}/{lib,src,test,ext,deps,uthash}").select { |d| FileUtils.rm_rf d }
@@ -51,5 +52,5 @@ end
 desc 'Pretty format C code'
 task :format do
   puts `astyle --indent=spaces=2 --style=1tbs --keep-one-line-blocks \
-        $(ack -f --type=cpp --type=cc ext/mathematical/mathematical.c)`
+        $(ack -n -f --type=cpp --type=cc ext/mathematical/)`
 end

data/ext/mathematical/cairo_callbacks.c

@@ -0,0 +1,25 @@
+#include <cairo_callbacks.h>
+
+cairo_status_t cairoSvgSurfaceCallback (void *closure, const unsigned char *data, unsigned int length)
+{
+  VALUE self = (VALUE) closure;
+  if (rb_iv_get(self, "@svg") == Qnil) {
+    rb_iv_set(self, "@svg", rb_str_new2(""));
+  }
+
+  rb_str_cat(rb_iv_get(self, "@svg"), data, length);
+
+  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;
+}

data/ext/mathematical/cairo_callbacks.h

@@ -0,0 +1,7 @@
+#include "ruby.h"
+
+#include <cairo-svg.h>
+
+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);

data/ext/mathematical/extconf.rb

@@ -2,36 +2,36 @@ require 'mkmf'
 require 'rbconfig'
 host_os = RbConfig::CONFIG['host_os']
 
-LASEM_DIR = File.join(File.dirname(__FILE__), "lasem", "src")
-MTEX_DIR = File.join(File.dirname(__FILE__), "mtex2MML", "src")
+LASEM_DIR = File.join(File.dirname(__FILE__), 'lasem', 'src')
+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']}"
 end
 
-have_library("xml2")
-find_header("libxml/tree.h", "/include/libxml2", "/usr/include/libxml2", "/usr/local/include/libxml2")
-find_header("libxml/parser.h", "/include/libxml2", "/usr/include/libxml2", "/usr/local/include/libxml2")
-find_header("libxml/xpath.h", "/include/libxml2", "/usr/include/libxml2", "/usr/local/include/libxml2")
-find_header("libxml/xpathInternals.h", "/include/libxml2", "/usr/include/libxml2", "/usr/local/include/libxml2")
+have_library('xml2')
+find_header('libxml/tree.h', '/include/libxml2', '/usr/include/libxml2', '/usr/local/include/libxml2')
+find_header('libxml/parser.h', '/include/libxml2', '/usr/include/libxml2', '/usr/local/include/libxml2')
+find_header('libxml/xpath.h', '/include/libxml2', '/usr/include/libxml2', '/usr/local/include/libxml2')
+find_header('libxml/xpathInternals.h', '/include/libxml2', '/usr/include/libxml2', '/usr/local/include/libxml2')
 
 # TODO: this is so frakkin' stupid. but I can't seem to get subdirs to compile any other way
 # the `destroy_copies` task, immediately after `compile`, will destroy these files
 FileUtils.cp_r(Dir.glob("#{LASEM_DIR}/*"), File.dirname(__FILE__))
-File.delete(File.join(File.dirname(__FILE__), "lasemrender.c"))
+File.delete(File.join(File.dirname(__FILE__), 'lasemrender.c'))
 
 # build mtex2MML Bison files
 Dir.chdir(MTEX_DIR) do
-  system "make"
+  system 'make'
 end
 
 FileUtils.cp_r(Dir.glob("#{MTEX_DIR}/*.{c,h,cc}"), File.dirname(__FILE__))
 FileUtils.cp_r("#{MTEX_DIR}/deps/.", File.dirname(__FILE__))
 FileUtils.cp_r(Dir.glob("#{MTEX_DIR}/deps/**/*"), File.dirname(__FILE__))
 
-have_library("pangocairo-1.0")
+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#{MTEX_DIR}"
 
-create_makefile("mathematical/mathematical")
+create_makefile('mathematical/mathematical')

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

@@ -36,6 +36,7 @@
 #include <lsmmathmloperatorelement.h>
 #include <lsmmathmlstringelement.h>
 #include <lsmmathmlrowelement.h>
+#include <lsmmathmlencloseelement.h>
 #include <lsmmathmlpaddedelement.h>
 #include <lsmmathmlfencedelement.h>
 #include <lsmmathmlerrorelement.h>
@@ -102,6 +103,8 @@ _create_element (LsmDomDocument *document, const char *tag_name)
 		node = lsm_mathml_operator_element_new ();
 	else if (strcmp (tag_name, "mrow") == 0)
 		node = lsm_mathml_row_element_new ();
+	else if (strcmp (tag_name, "menclose") == 0)
+		node = lsm_mathml_enclose_element_new ();
 	else if (strcmp (tag_name, "mn") == 0)
 		node = lsm_mathml_number_element_new ();
 	else if (strcmp (tag_name, "mi") == 0)

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

@@ -0,0 +1,142 @@
+/* Lasem
+ * 
+ * Copyright © 2007-2008 Emmanuel Pacaud
+ *
+ * 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., 59 Temple Place, Suite 330,
+ * Boston, MA 02111-1307, USA.
+ *
+ * Author:
+ * 	Emmanuel Pacaud <emmanuel@gnome.org>
+ */
+
+#include <lsmmathmlencloseelement.h>
+#include <lsmmathmlview.h>
+
+static GObjectClass *parent_class;
+
+/* LsmDomNode implementation */
+
+static const char *
+_get_node_name (LsmDomNode *node)
+{
+	return "menclose";
+}
+
+/* LsmMathmlElement implementation */
+
+static void
+_update (LsmMathmlElement *self, LsmMathmlStyle *style)
+{
+	LsmMathmlEncloseElement *enclose = LSM_MATHML_ENCLOSE_ELEMENT (self);
+
+	style->math_color = lsm_mathml_color_attribute_inherit (&enclose->math_color, style->math_color);
+	style->math_background = lsm_mathml_color_attribute_inherit (&enclose->math_background, style->math_background);
+}
+
+static const LsmMathmlBbox *
+_measure (LsmMathmlElement *self, LsmMathmlView *view, const LsmMathmlBbox *bbox)
+{
+	LsmMathmlEncloseElement *enclose = LSM_MATHML_ENCLOSE_ELEMENT (self);
+	LsmMathmlBbox stretch_bbox;
+
+	LSM_MATHML_ELEMENT_CLASS (parent_class)->measure (self, view, bbox);
+
+	stretch_bbox = self->bbox;
+
+	lsm_mathml_view_measure_notation (view, &self->style, enclose->notation.value, &stretch_bbox,
+					  &self->bbox, &enclose->x_child_offset);
+
+	return &self->bbox;
+}
+
+static void
+_layout (LsmMathmlElement *self, LsmMathmlView *view,
+	 double x, double y, const LsmMathmlBbox *bbox)
+{
+	LsmMathmlEncloseElement *enclose = LSM_MATHML_ENCLOSE_ELEMENT (self);
+
+	LSM_MATHML_ELEMENT_CLASS (parent_class)->layout (self, view, x + enclose->x_child_offset, y, bbox);
+}
+
+static void
+_render (LsmMathmlElement *self, LsmMathmlView *view)
+{
+	LsmMathmlEncloseElement *enclose = LSM_MATHML_ENCLOSE_ELEMENT (self);
+
+	LSM_MATHML_ELEMENT_CLASS (parent_class)->render (self, view);
+
+	lsm_mathml_view_show_notation (view, &self->style, enclose->notation.value, self->x, self->y, &self->bbox,
+				       enclose->x_child_offset);
+}
+
+/* LsmMathmlEncloseElement implementation */
+
+LsmDomNode *
+lsm_mathml_enclose_element_new (void)
+{
+	return g_object_new (LSM_TYPE_MATHML_ENCLOSE_ELEMENT, NULL);
+}
+
+static const LsmMathmlNotation notation_default = LSM_MATHML_NOTATION_LONGDIV;
+
+static void
+lsm_mathml_enclose_element_init (LsmMathmlEncloseElement *element)
+{
+}
+
+/* LsmMathmlEncloseElement class */
+
+static const LsmAttributeInfos _attribute_infos[] = {
+	{
+		.name = "notation",
+		.attribute_offset = offsetof (LsmMathmlEncloseElement, notation),
+		.trait_class = &lsm_mathml_notation_trait_class,
+		.trait_default = &notation_default
+	},
+	{
+		.name = "mathcolor",
+		.attribute_offset = offsetof (LsmMathmlEncloseElement, math_color),
+		.trait_class = &lsm_mathml_color_trait_class,
+	},
+	{
+		.name = "mathbackground",
+		.attribute_offset = offsetof (LsmMathmlEncloseElement, math_background),
+		.trait_class = &lsm_mathml_color_trait_class,
+	}
+};
+
+static void
+lsm_mathml_enclose_element_class_init (LsmMathmlEncloseElementClass *klass)
+{
+	LsmDomNodeClass *d_node_class = LSM_DOM_NODE_CLASS (klass);
+	LsmMathmlElementClass *m_element_class = LSM_MATHML_ELEMENT_CLASS (klass);
+
+	parent_class = g_type_class_peek_parent (klass);
+
+	d_node_class->get_node_name = _get_node_name;
+
+	m_element_class->update = _update;
+	m_element_class->measure = _measure;
+	m_element_class->layout = _layout;
+	m_element_class->render = _render;
+	m_element_class->attribute_manager = lsm_attribute_manager_duplicate (m_element_class->attribute_manager);
+
+	lsm_attribute_manager_add_attributes (m_element_class->attribute_manager,
+					      G_N_ELEMENTS (_attribute_infos),
+					      _attribute_infos);
+}
+
+G_DEFINE_TYPE (LsmMathmlEncloseElement, lsm_mathml_enclose_element, LSM_TYPE_MATHML_PRESENTATION_CONTAINER)
+

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

@@ -0,0 +1,64 @@
+/* Lasem
+ * 
+ * Copyright © 2007-2011 Emmanuel Pacaud
+ *
+ * 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., 59 Temple Place, Suite 330,
+ * Boston, MA 02111-1307, USA.
+ *
+ * Author:
+ * 	Emmanuel Pacaud <emmanuel@gnome.org>
+ */
+
+#ifndef LSM_MATHML_ENCLOSE_ELEMENT_H
+#define LSM_MATHML_ENCLOSE_ELEMENT_H
+
+#include <lsmmathmltypes.h>
+#include <lsmmathmlpresentationcontainer.h>
+
+G_BEGIN_DECLS
+
+#define LSM_TYPE_MATHML_ENCLOSE_ELEMENT             (lsm_mathml_enclose_element_get_type ())
+#define LSM_MATHML_ENCLOSE_ELEMENT(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), LSM_TYPE_MATHML_ENCLOSE_ELEMENT, LsmMathmlEncloseElement))
+#define LSM_MATHML_ENCLOSE_ELEMENT_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), LSM_TYPE_MATHML_ENCLOSE_ELEMENT, LsmMathmlEncloseElementClass))
+#define LSM_IS_MATHML_ENCLOSE_ELEMENT(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LSM_TYPE_MATHML_ENCLOSE_ELEMENT))
+#define LSM_IS_MATHML_ENCLOSE_ELEMENT_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), LSM_TYPE_MATHML_ENCLOSE_ELEMENT))
+#define LSM_MATHML_ENCLOSE_ELEMENT_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), LSM_TYPE_MATHML_ENCLOSE_ELEMENT, LsmMathmlEncloseElementClass))
+
+typedef struct _LsmMathmlEncloseElementClass LsmMathmlEncloseElementClass;
+
+struct _LsmMathmlEncloseElement {
+	LsmMathmlPresentationContainer presentation_container;
+
+	LsmMathmlEnumAttribute notation;
+	LsmMathmlColorAttribute	math_color;
+	LsmMathmlColorAttribute	math_background;
+
+	/* View data */
+
+	double x_child_offset;
+};
+
+struct _LsmMathmlEncloseElementClass {
+	LsmMathmlPresentationContainerClass parent_class;
+};
+
+GType lsm_mathml_enclose_element_get_type (void);
+
+LsmDomNode *lsm_mathml_enclose_element_new (void);
+
+G_END_DECLS
+
+#endif
+

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

@@ -427,3 +427,38 @@ lsm_mathml_line_from_string (const char *string)
 	return lsm_enum_value_from_string (string, lsm_mathml_line_strings,
 					   G_N_ELEMENTS (lsm_mathml_line_strings));
 }
+
+static const char *lsm_mathml_notation_strings[] = {
+	"longdiv",
+	"actuarial",
+	"radical",
+	"box",
+	"roundedbox",
+	"circle",
+	"left",
+	"right",
+	"top",
+	"bottom",
+	"updiagonalstrike",
+	"downdiagonalstrike",
+	"verticalstrike",
+	"horizontalstrike",
+	"madruwb",
+	"updiagonalarrow"
+};
+
+const char *
+lsm_mathml_notation_to_string (LsmMathmlNotation notation)
+{
+	if (notation < 0 || notation > LSM_MATHML_NOTATION_UP_DIAGONAL_ARROW)
+		return NULL;
+
+	return lsm_mathml_notation_strings [notation];
+}
+
+LsmMathmlNotation
+lsm_mathml_notation_from_string	 (const char *string)
+{
+	return lsm_enum_value_from_string (string, lsm_mathml_notation_strings,
+					   G_N_ELEMENTS (lsm_mathml_notation_strings));
+}