mathematical 0.4.2 → 0.5.0

data/ext/mathematical/mtex2MML/src/y.tab.h

@@ -0,0 +1,393 @@
+/* A Bison parser, made by GNU Bison 2.3.  */
+
+/* Skeleton interface for Bison's Yacc-like parsers in C
+
+   Copyright (C) 1984, 1989, 1990, 2000, 2001, 2002, 2003, 2004, 2005, 2006
+   Free Software Foundation, Inc.
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2, or (at your option)
+   any later version.
+
+   This program 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 General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 51 Franklin Street, Fifth Floor,
+   Boston, MA 02110-1301, USA.  */
+
+/* As a special exception, you may create a larger work that contains
+   part or all of the Bison parser skeleton and distribute that work
+   under terms of your choice, so long as that work isn't itself a
+   parser generator using the skeleton or a modified version thereof
+   as a parser skeleton.  Alternatively, if you modify or redistribute
+   the parser skeleton itself, you may (at your option) remove this
+   special exception, which will cause the skeleton and the resulting
+   Bison output files to be licensed under the GNU General Public
+   License without this special exception.
+
+   This special exception was added by the Free Software Foundation in
+   version 2.2 of Bison.  */
+
+/* Tokens.  */
+#ifndef YYTOKENTYPE
+# define YYTOKENTYPE
+   /* Put the tokens into the symbol table, so that GDB and other debuggers
+      know about them.  */
+   enum yytokentype {
+     TEXATOP = 258,
+     TEXOVER = 259,
+     CHAR = 260,
+     STARTMATH = 261,
+     STARTDMATH = 262,
+     ENDMATH = 263,
+     MI = 264,
+     MIB = 265,
+     MN = 266,
+     MO = 267,
+     SUP = 268,
+     SUB = 269,
+     MROWOPEN = 270,
+     MROWCLOSE = 271,
+     LEFT = 272,
+     RIGHT = 273,
+     BIG = 274,
+     BBIG = 275,
+     BIGG = 276,
+     BBIGG = 277,
+     BIGL = 278,
+     BBIGL = 279,
+     BIGGL = 280,
+     BBIGGL = 281,
+     FRAC = 282,
+     TFRAC = 283,
+     OPERATORNAME = 284,
+     MATHOP = 285,
+     MATHBIN = 286,
+     MATHREL = 287,
+     MOP = 288,
+     MOL = 289,
+     MOLL = 290,
+     MOF = 291,
+     MOR = 292,
+     PERIODDELIM = 293,
+     OTHERDELIM = 294,
+     LEFTDELIM = 295,
+     RIGHTDELIM = 296,
+     MOS = 297,
+     MOB = 298,
+     SQRT = 299,
+     ROOT = 300,
+     BINOM = 301,
+     TBINOM = 302,
+     UNDER = 303,
+     OVER = 304,
+     OVERBRACE = 305,
+     UNDERLINE = 306,
+     UNDERBRACE = 307,
+     UNDEROVER = 308,
+     TENSOR = 309,
+     MULTI = 310,
+     ARRAYALIGN = 311,
+     ROWSPACINGDEF = 312,
+     ROWLINESDEF = 313,
+     COLUMNALIGN = 314,
+     ARRAY = 315,
+     COLSEP = 316,
+     ROWSEP = 317,
+     ARRAYOPTS = 318,
+     COLLAYOUT = 319,
+     COLALIGN = 320,
+     ROWALIGN = 321,
+     ALIGN = 322,
+     EQROWS = 323,
+     EQCOLS = 324,
+     ROWLINES = 325,
+     COLLINES = 326,
+     FRAME = 327,
+     PADDING = 328,
+     ATTRLIST = 329,
+     ITALICS = 330,
+     SANS = 331,
+     TT = 332,
+     BOLD = 333,
+     BOXED = 334,
+     SLASHED = 335,
+     RM = 336,
+     BB = 337,
+     ST = 338,
+     END = 339,
+     BBLOWERCHAR = 340,
+     BBUPPERCHAR = 341,
+     BBDIGIT = 342,
+     CALCHAR = 343,
+     FRAKCHAR = 344,
+     CAL = 345,
+     FRAK = 346,
+     CLAP = 347,
+     LLAP = 348,
+     RLAP = 349,
+     ROWOPTS = 350,
+     TEXTSIZE = 351,
+     SCSIZE = 352,
+     SCSCSIZE = 353,
+     DISPLAY = 354,
+     TEXTSTY = 355,
+     TEXTBOX = 356,
+     TEXTSTRING = 357,
+     XMLSTRING = 358,
+     CELLOPTS = 359,
+     ROWSPAN = 360,
+     COLSPAN = 361,
+     THINSPACE = 362,
+     MEDSPACE = 363,
+     THICKSPACE = 364,
+     QUAD = 365,
+     QQUAD = 366,
+     NEGSPACE = 367,
+     NEGMEDSPACE = 368,
+     NEGTHICKSPACE = 369,
+     PHANTOM = 370,
+     HREF = 371,
+     UNKNOWNCHAR = 372,
+     EMPTYMROW = 373,
+     STATLINE = 374,
+     TOOLTIP = 375,
+     TOGGLE = 376,
+     TOGGLESTART = 377,
+     TOGGLEEND = 378,
+     FGHIGHLIGHT = 379,
+     BGHIGHLIGHT = 380,
+     SPACE = 381,
+     INTONE = 382,
+     INTTWO = 383,
+     INTTHREE = 384,
+     BAR = 385,
+     WIDEBAR = 386,
+     VEC = 387,
+     WIDEVEC = 388,
+     HAT = 389,
+     WIDEHAT = 390,
+     CHECK = 391,
+     WIDECHECK = 392,
+     TILDE = 393,
+     WIDETILDE = 394,
+     DOT = 395,
+     DDOT = 396,
+     DDDOT = 397,
+     DDDDOT = 398,
+     UNARYMINUS = 399,
+     UNARYPLUS = 400,
+     BEGINENV = 401,
+     ENDENV = 402,
+     MATRIX = 403,
+     PMATRIX = 404,
+     BMATRIX = 405,
+     BBMATRIX = 406,
+     VMATRIX = 407,
+     VVMATRIX = 408,
+     SVG = 409,
+     ENDSVG = 410,
+     SMALLMATRIX = 411,
+     CASES = 412,
+     ALIGNED = 413,
+     GATHERED = 414,
+     SUBSTACK = 415,
+     PMOD = 416,
+     RMCHAR = 417,
+     COLOR = 418,
+     BGCOLOR = 419,
+     XARROW = 420,
+     OPTARGOPEN = 421,
+     OPTARGCLOSE = 422,
+     MTEXNUM = 423,
+     RAISEBOX = 424,
+     NEG = 425
+   };
+#endif
+/* Tokens.  */
+#define TEXATOP 258
+#define TEXOVER 259
+#define CHAR 260
+#define STARTMATH 261
+#define STARTDMATH 262
+#define ENDMATH 263
+#define MI 264
+#define MIB 265
+#define MN 266
+#define MO 267
+#define SUP 268
+#define SUB 269
+#define MROWOPEN 270
+#define MROWCLOSE 271
+#define LEFT 272
+#define RIGHT 273
+#define BIG 274
+#define BBIG 275
+#define BIGG 276
+#define BBIGG 277
+#define BIGL 278
+#define BBIGL 279
+#define BIGGL 280
+#define BBIGGL 281
+#define FRAC 282
+#define TFRAC 283
+#define OPERATORNAME 284
+#define MATHOP 285
+#define MATHBIN 286
+#define MATHREL 287
+#define MOP 288
+#define MOL 289
+#define MOLL 290
+#define MOF 291
+#define MOR 292
+#define PERIODDELIM 293
+#define OTHERDELIM 294
+#define LEFTDELIM 295
+#define RIGHTDELIM 296
+#define MOS 297
+#define MOB 298
+#define SQRT 299
+#define ROOT 300
+#define BINOM 301
+#define TBINOM 302
+#define UNDER 303
+#define OVER 304
+#define OVERBRACE 305
+#define UNDERLINE 306
+#define UNDERBRACE 307
+#define UNDEROVER 308
+#define TENSOR 309
+#define MULTI 310
+#define ARRAYALIGN 311
+#define ROWSPACINGDEF 312
+#define ROWLINESDEF 313
+#define COLUMNALIGN 314
+#define ARRAY 315
+#define COLSEP 316
+#define ROWSEP 317
+#define ARRAYOPTS 318
+#define COLLAYOUT 319
+#define COLALIGN 320
+#define ROWALIGN 321
+#define ALIGN 322
+#define EQROWS 323
+#define EQCOLS 324
+#define ROWLINES 325
+#define COLLINES 326
+#define FRAME 327
+#define PADDING 328
+#define ATTRLIST 329
+#define ITALICS 330
+#define SANS 331
+#define TT 332
+#define BOLD 333
+#define BOXED 334
+#define SLASHED 335
+#define RM 336
+#define BB 337
+#define ST 338
+#define END 339
+#define BBLOWERCHAR 340
+#define BBUPPERCHAR 341
+#define BBDIGIT 342
+#define CALCHAR 343
+#define FRAKCHAR 344
+#define CAL 345
+#define FRAK 346
+#define CLAP 347
+#define LLAP 348
+#define RLAP 349
+#define ROWOPTS 350
+#define TEXTSIZE 351
+#define SCSIZE 352
+#define SCSCSIZE 353
+#define DISPLAY 354
+#define TEXTSTY 355
+#define TEXTBOX 356
+#define TEXTSTRING 357
+#define XMLSTRING 358
+#define CELLOPTS 359
+#define ROWSPAN 360
+#define COLSPAN 361
+#define THINSPACE 362
+#define MEDSPACE 363
+#define THICKSPACE 364
+#define QUAD 365
+#define QQUAD 366
+#define NEGSPACE 367
+#define NEGMEDSPACE 368
+#define NEGTHICKSPACE 369
+#define PHANTOM 370
+#define HREF 371
+#define UNKNOWNCHAR 372
+#define EMPTYMROW 373
+#define STATLINE 374
+#define TOOLTIP 375
+#define TOGGLE 376
+#define TOGGLESTART 377
+#define TOGGLEEND 378
+#define FGHIGHLIGHT 379
+#define BGHIGHLIGHT 380
+#define SPACE 381
+#define INTONE 382
+#define INTTWO 383
+#define INTTHREE 384
+#define BAR 385
+#define WIDEBAR 386
+#define VEC 387
+#define WIDEVEC 388
+#define HAT 389
+#define WIDEHAT 390
+#define CHECK 391
+#define WIDECHECK 392
+#define TILDE 393
+#define WIDETILDE 394
+#define DOT 395
+#define DDOT 396
+#define DDDOT 397
+#define DDDDOT 398
+#define UNARYMINUS 399
+#define UNARYPLUS 400
+#define BEGINENV 401
+#define ENDENV 402
+#define MATRIX 403
+#define PMATRIX 404
+#define BMATRIX 405
+#define BBMATRIX 406
+#define VMATRIX 407
+#define VVMATRIX 408
+#define SVG 409
+#define ENDSVG 410
+#define SMALLMATRIX 411
+#define CASES 412
+#define ALIGNED 413
+#define GATHERED 414
+#define SUBSTACK 415
+#define PMOD 416
+#define RMCHAR 417
+#define COLOR 418
+#define BGCOLOR 419
+#define XARROW 420
+#define OPTARGOPEN 421
+#define OPTARGCLOSE 422
+#define MTEXNUM 423
+#define RAISEBOX 424
+#define NEG 425
+
+
+
+
+#if ! defined YYSTYPE && ! defined YYSTYPE_IS_DECLARED
+typedef int YYSTYPE;
+# define yystype YYSTYPE /* obsolescent; will be withdrawn */
+# define YYSTYPE_IS_DECLARED 1
+# define YYSTYPE_IS_TRIVIAL 1
+#endif
+
+extern YYSTYPE mtex2MML_yylval;
+

data/lib/mathematical.rb

@@ -1,5 +1,6 @@
 require "mathematical/mathematical"
 
+require "mathematical/corrections"
 require "mathematical/render"
 require "mathematical/version"
 

data/lib/mathematical/corrections.rb

@@ -0,0 +1,34 @@
+module Mathematical
+  module Corrections
+
+    def apply_corrections(maths)
+      maths = adjust_alignment(maths)
+      maths = adjust_frac(maths)
+      maths = adjust_lt_gt(maths)
+      maths = adjust_limits(maths)
+    end
+
+    # `{align}` *should* be valid, according to AMS-Latex, but it seems itex@1.5.1 does not like it.
+    def adjust_alignment(maths)
+      maths = maths.gsub(/\\begin\{align\}/, "\\begin{aligned}")
+      maths.gsub(/\\end\{align\}/, "\\end{aligned}")
+    end
+
+    # seems like KaTeX/MathJax supports \frac\d\d, but itex does not
+    def adjust_frac(maths)
+      maths.gsub(/\\frac(\d)(\d)/, '\frac{\1}{\2}')
+    end
+
+    # from the itex website:
+    # It is possible (though probably not recommended) to insert MathML markup
+    # inside itex equations. So "<" and ">" are significant.
+    # To obtain a less-than or greater-than sign, you should use \lt or \gt, respectively.
+    def adjust_lt_gt(maths)
+      maths.gsub(/</, '\lt').gsub(/>/, '\gt')
+    end
+
+    def adjust_limits(maths)
+      maths.gsub(/\\int\\limits_/, '\int_')
+    end
+  end
+end

data/lib/mathematical/render.rb

@@ -4,37 +4,46 @@ require 'tempfile'
 
 module Mathematical
   class Render
+    include Corrections
+
+    FORMAT_TYPES = %w(svg png mathml)
+
     DEFAULT_OPTS = {
       :ppi => 72.0,
       :zoom => 1.0,
       :base64 => false,
-      :maxsize => 0
+      :maxsize => 0,
+      :format => "svg"
     }
 
     def initialize(opts = {})
       @config = DEFAULT_OPTS.merge(opts)
+
       raise(TypeError, "maxsize must be an integer!") unless @config[:maxsize].is_a? Fixnum
       raise(TypeError, "maxsize cannot be less than 0!") if @config[:maxsize] < 0
+      raise(TypeError, "format must be a string!") unless @config[:format].is_a? String
+      raise(TypeError, "format type must be one of the following formats: #{FORMAT_TYPES.join(', ')}") unless FORMAT_TYPES.include?(@config[:format])
+
       @processer = Mathematical::Process.new(@config)
     end
 
     def render(maths)
       raise(TypeError, "text must be a string!") unless maths.is_a? String
+      maths = maths.strip
       raise(ArgumentError, "text must be in itex format (`$...$` or `$$...$$`)!") unless maths =~ /\A\${1,2}/
 
-      # seems to be a bug in itex@1.5.1 where the "Vertical spacing and page breaks in multiline display" (\\)
-      # do not work, and yield an "unknown character" error
-      maths.gsub!(/\\\\/, "\\\\\\\\")
-
-      # `{align}` *should* be valid, according to AMS-Latex, but it seems itex@1.5.1 does not like it.
-      maths.gsub!(/\\begin\{align\}/, "\\begin{aligned}")
-      maths.gsub!(/\\end\{align\}/, "\\end{aligned}")
+      maths = apply_corrections(maths)
 
       begin
-        raise RuntimeError unless svg_hash = @processer.process(maths)
-        svg_hash["svg"] = svg_hash["svg"][xml_header.length..-1] # remove starting <?xml...> tag
-        svg_hash["svg"] = svg_to_base64(svg_hash["svg"]) if @config[:base64]
-        svg_hash
+        raise RuntimeError unless data_hash = @processer.process(maths)
+        case @config[:format]
+        when "svg"
+          data_hash["svg"] = data_hash["svg"][xml_header.length..-1] # remove starting <?xml...> tag
+          data_hash["svg"] = svg_to_base64(data_hash["svg"]) if @config[:base64]
+          data_hash
+        when "png", "mathml"
+          data_hash
+        end
       rescue ParseError, DocumentCreationError, DocumentReadError => e # an error in the C code, probably a bad TeX parse
         $stderr.puts "#{e.message}: #{maths}"
         maths