/itexToMML

#  Ruby module for itex2MML

#

#  Installation

#  ------------

#    1. You need SWIG (>= 1.3) and GNU Make to install

#       the Ruby module.

#    2. Then type:

#            make ruby

#             make test_ruby

#            make install_ruby

#    3. This module can then be invoked like:

#

#            require 'itextomml'

#            

#            itex = Itex2MML::Parser.new

#            itex.html_filter(string)

#

#  Usage

#  -----

#

#      There are four public methods

#

#       itex.html_filter(a_string)

#               converts all itex equations in a_string to MathML, passing the

#               rest of a_string unmodified. Returns the converted string. 

#

#       itex.filter(a_string)

#               converts all itex equations in a_string to MathML. Returns just

#               the MathML equation(s), as a string.

#

#       itex.inline_filter(a_string)

#               treats a_string as an inline equation (automatically supplies

#               the surrounding $...$, so you don't have to) and converts it

#               MathML. Returns the MathML inline equation, as a string.

#

#       itex.block_filter(a_string)

#               treats a_string as a block equation (automatically supplies

#               the surrounding $$...$$, so you don't have to) and converts it

#               MathML. Returns the MathML block equation, as a string.

#

#  Authors: Justin Bonnar <jbonnar@berkeley.edu>

#           Jacques Distler <distler@golem.ph.utexas.edu>

#

#  Placed in the Public Domain

require 'itex2MML'

require 'thread'

module Itex2MML

  class Error < RuntimeError; end

  class Parser

    def self.semaphore

      @semaphore ||= Mutex.new

    end

    def html_filter(string)

      parse(string, :itex2MML_html_filter)

    end

    def filter(string)

      parse(string, :itex2MML_filter)

    end

    def inline_filter(string)

      parse("\$#{string}\$", :itex2MML_filter)

    end

    def block_filter(string)

      parse("\$\$#{string}\$\$", :itex2MML_filter)

    end

  private

    def parse(string, message)

      str = as_bytes(string.to_str)

      self.class.semaphore.synchronize do

        raise Itex2MML::Error unless Itex2MML.send(message, str, str.length) == 0

        as_utf8(Itex2MML.itex2MML_output)

      end

    end

    if "".respond_to?(:force_encoding)

      def as_bytes(string)

        string.force_encoding("ASCII-8BIT")

      end

      def as_utf8(string)

        string.force_encoding("UTF-8")

      end

    else

      def as_bytes(string)

        string

      end

      def as_utf8(string)

        string

      end

    end

  end

end

## Unit Tests ##

if __FILE__ == $0

  require 'test/unit'

  class Itex2MMLTest < Test::Unit::TestCase

    def test_inline_html

      itex = Itex2MML::Parser.new

      assert_equal("Inline: <math xmlns='http://www.w3.org/1998/Math/MathML' display='inline'><mi>sin</mi><mo stretchy=\"false\">(</mo><mi>x</mi><mo stretchy=\"false\">)</mo></math>", itex.html_filter('Inline: $\sin(x)$'))

    end

    def test_inline

      itex = Itex2MML::Parser.new

      assert_equal("<math xmlns='http://www.w3.org/1998/Math/MathML' display='inline'><mi>sin</mi><mo stretchy=\"false\">(</mo><mi>x</mi><mo stretchy=\"false\">)</mo></math>", itex.filter('Inline: $\sin(x)$'))

    end

    def test_inline_inline

      itex = Itex2MML::Parser.new

      assert_equal("<math xmlns='http://www.w3.org/1998/Math/MathML' display='inline'><mi>sin</mi><mo stretchy=\"false\">(</mo><mi>x</mi><mo stretchy=\"false\">)</mo></math>", itex.inline_filter('\sin(x)'))

    end

    def test_block_html

      itex = Itex2MML::Parser.new

      assert_equal("Block: <math xmlns='http://www.w3.org/1998/Math/MathML' display='block'><mi>sin</mi><mo stretchy=\"false\">(</mo><mi>x</mi><mo stretchy=\"false\">)</mo></math>", itex.html_filter('Block: $$\sin(x)$$'))

    end

    def test_block

      itex = Itex2MML::Parser.new

      assert_equal("<math xmlns='http://www.w3.org/1998/Math/MathML' display='block'><mi>sin</mi><mo stretchy=\"false\">(</mo><mi>x</mi><mo stretchy=\"false\">)</mo></math>", itex.filter('Block: $$\sin(x)$$'))

    end

    def test_block_block

      itex = Itex2MML::Parser.new

      assert_equal("<math xmlns='http://www.w3.org/1998/Math/MathML' display='block'><mi>sin</mi><mo stretchy=\"false\">(</mo><mi>x</mi><mo stretchy=\"false\">)</mo></math>", itex.block_filter('\sin(x)'))

    end

    def test_inline_utf8

      itex = Itex2MML::Parser.new

      s = "".respond_to?(:force_encoding) ? "\u00F3" : "\303\263"

      assert_equal("ecuasi"+ s + "n <math xmlns='http://www.w3.org/1998/Math/MathML' display='inline'>" +

             "<mi>sin</mi><mo stretchy=\"false\">(</mo><mi>x</mi><mo stretchy=\"false\">)</mo></math>",

              itex.html_filter("ecuasi\303\263n $\\sin(x)$"))

    end

    def test_inline_utf8_inline

      itex = Itex2MML::Parser.new

      assert_equal("<math xmlns='http://www.w3.org/1998/Math/MathML' display='inline'><mi>sin</mi><mo stretchy=\"false\">(</mo><mi>x</mi><mo stretchy=\"false\">)</mo></math>", itex.filter("ecuasi\303\263n $\\sin(x)$"))

    end

    def test_utf8_in_svg_foreignObject

      itex = Itex2MML::Parser.new

      s = "".respond_to?(:force_encoding) ? "\u2032" : "\342\200\262"

      assert_equal("<math xmlns='http://www.w3.org/1998/Math/MathML' display='inline'><mi>g" +

          "</mi><mo>&prime;</mo><mo>=</mo><semantics><annotation-xml encoding=\"SVG1.1\"><svg w" +

          "idth='40' height='40' xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3." +

          "org/1999/xlink'><foreignObject height='19' width='20' font-size='16' y='0' x='0'><ma" +

          "th display='inline' xmlns='http://www.w3.org/1998/Math/MathML'><mi>g</mi><mo>" +

          s + "</mo></math></foreignObject></svg></annotation-xml></semantics></math>",

        itex.filter("$g' = \\begin{svg}<svg width='40' height='40' xmlns='http://www.w3.org/20" +

          "00/svg' xmlns:xlink='http://www.w3.org/1999/xlink'><foreignObject height='19' width='" +

          "20' font-size='16' y='0' x='0'><math display='inline' xmlns='http://www.w3.org/1998/M" +

          "ath/MathML'><mi>g</mi><mo>\342\200\262</mo></math></foreignObject></svg>\\end{svg}$"))

    end

  end

end