texml 0.4.0

data/bin/texml

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'texml'
+
+xml = ARGF.read
+begin
+  print TeXML.convert(xml)
+rescue XMLParserError
+  puts "#{$0}: #{$!}"
+  exit 1
+end
+

data/lib/texml.rb

@@ -0,0 +1,200 @@
+########################################
+# texml.rb
+# Author: Pierre-Charles David (pcdavid@gmail.com)
+# Version: 0.4
+# Web page: http://github.com/pcdavid/ruby-texml
+# Depends on: xmlparser (available on RAA)
+# License: WTFPL: http://sam.zoy.org/wtfpl/COPYING
+
+# Based of Douglas Lovell's paper:
+#   "TeXML: Typesetting with TeX", Douglas Lovell, IBM Research
+#   in TUGboat, Volume 20 (1999), No. 3
+#
+# Original implementation in Java by D. Lovell, available on IBM
+# alphaWorks: http://www.alphaworks.ibm.com/tech/texml
+#
+# Usage: % texml.rb < input.xml > output.tex
+
+require "xmltreebuilder"
+
+module TeXML
+
+  # Escaping sequences for LaTeX special characters
+  SPECIAL_CHAR_ESCAPES = {
+    '%'[0] => '\%{}',
+    '{'[0] => '\{',
+    '}'[0] => '\}',
+    '|'[0] => '$|${}',
+    '#'[0] => '\#{}',
+    '_'[0] => '\_{}',
+    '^'[0] => '\\char`\\^{}',
+    '~'[0] => '\\char`\\~{}',
+    '&'[0] => '\&{}',
+    '$'[0] => '\${}',		#'
+    '<'[0] => '$<${}',		#'
+    '>'[0] => '$>${}',		#'
+    '\\'[0] => '$\\backslash${}'#'
+  }
+
+  # Converts a TeXML document, passed as a raw XML string, into the
+  # corresponding (La)TeX document.
+  def TeXML.convert(xml)
+    builder = XML::SimpleTreeBuilder.new
+    tree = builder.parse(xml)
+    TeXML::Node.create(tree.documentElement).to_tex
+  end
+
+  # Given a raw string, returns a copy with all (La)TeX special
+  # characters properly quoted.
+  def TeXML.quote(str)
+    tex = ''
+    str.each_byte do |char|
+      tex << (SPECIAL_CHAR_ESCAPES[char] or char)
+    end
+    return tex
+  end
+
+  # Keeps track of which classes can handle which type of nodes
+  NODE_HANDLERS = Hash.new
+  
+  # Common node superclass (also node factory, see Node#create)
+  class Node
+
+    # Creates a node handler object appropriate for the specified XML
+    # node, based on the name of the node (uses information from
+    # NODE_HANDLERS).
+    def Node.create(domNode)
+      handlerClass = NODE_HANDLERS[domNode.nodeName]
+      if !handlerClass.nil?
+	handlerClass.new(domNode)
+      else
+	nil
+      end
+    end
+
+    def initialize(node)
+      @node = node
+    end
+
+    # Aggregates the values of all the children of this Node whose
+    # node name is included in the parameters, in the document order
+    # of the children.
+    def childrenValue(*childTypes)
+      tex = ''
+      @node.childNodes do |kid|
+	if childTypes.include?(kid.nodeName)
+	  node = Node.create(kid)
+	  tex << node.to_tex unless node.nil?
+	end
+      end
+      return tex
+    end
+  end
+
+  class TexmlNode < Node
+    NODE_HANDLERS['TeXML'] = TexmlNode
+
+    def to_tex
+      return childrenValue('cmd', 'env', 'ctrl', 'spec', '#text')
+    end
+  end
+
+  class CmdNode < Node
+    NODE_HANDLERS['cmd'] = CmdNode
+
+    def to_tex
+      name = @node.getAttribute('name')
+      nl_before = (@node.getAttribute('nl1') == '1') ? "\n" : ''
+      nl_after = (@node.getAttribute('nl2') == '1') ? "\n" : ''
+      return nl_before + "\\#{name}" + childrenValue('opt') + childrenValue('parm') + ' ' + nl_after
+    end
+  end
+
+  class EnvNode < Node
+    NODE_HANDLERS['env'] = EnvNode
+
+    def to_tex
+      name = @node.getAttribute('name')
+      start = @node.getAttribute('begin')
+      start = 'begin' if start == ''
+      stop = @node.getAttribute('end')
+      stop = 'end' if stop == ''
+      return "\\#{start}{#{name}}\n" +
+	childrenValue('cmd', 'env', 'ctrl', 'spec', '#text') +
+	"\\#{stop}{#{name}}\n"
+    end
+  end
+
+  class OptNode < Node
+    NODE_HANDLERS['opt'] = OptNode
+
+    def to_tex
+      return "[" + childrenValue('cmd', 'ctrl', 'spec', '#text') + "]"
+    end
+  end
+
+  class ParmNode < Node
+    NODE_HANDLERS['parm'] = ParmNode
+
+    def to_tex
+      return "{" + childrenValue('cmd', 'ctrl', 'spec', '#text') + "}"
+    end
+  end
+
+  class CtrlNode < Node
+    NODE_HANDLERS['ctrl'] = CtrlNode
+
+    def to_tex
+      ch = @node.getAttribute('ch')
+      unless ch.nil?
+	return ch & 0x9F	# Control version of ch
+      else
+	nil
+      end
+    end
+  end
+
+  class GroupNode < Node
+    NODE_HANDLERS['group'] = GroupNode
+    
+    def to_tex
+      return "{" + childrenValue('cmd', 'env', 'ctrl', 'spec', '#text') + "}"
+    end
+  end
+
+  class SpecNode < Node
+    NODE_HANDLERS['spec'] = SpecNode
+
+    SPECIAL_MAP = {
+      'esc'	=> "\\",
+      'bg'	=> '{',
+      'eg'	=> '}',
+      'mshift'	=> '$',		# '
+      'align'	=> '&',
+      'parm'	=> '#',
+      'sup'	=> '^',
+      'sub'	=> '_',
+      'tilde'	=> '~',
+      'comment'	=> '%'
+    }
+
+    def to_tex
+      cat = @node.getAttribute('cat')
+      return (SPECIAL_MAP[cat] or '')
+    end
+  end
+
+  class TextNode < Node
+    NODE_HANDLERS['#text'] = TextNode
+
+    def to_tex
+      parent = @node.parentNode
+      if parent.nodeName == 'env' && parent.getAttribute('name') == 'verbatim'
+	return @node.nodeValue	# TODO: is there /some/ quoting to do?
+      else
+        return TeXML.quote(@node.nodeValue)
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: texml
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
+platform: ruby
+authors: 
+- Pierre-Charles David
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-21 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: "This program converts an XML document conforming to the TeXML syntax into the corresponding (La)TeX document, ready to be typeset. It is based on Douglas Lovell's paper: \"TeXML: Typesetting with TeX\", Douglas Lovell, IBM Research in TUGboat, Volume 20 (1999), No. 3"
+email: pcdavid@gmail.com
+executables: 
+- texml
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/texml.rb
+- bin/texml
+has_rdoc: true
+homepage: http://github.com/pcdavid/ruby-texml
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A TeXML to LaTeX converter.
+test_files: []
+