maruku 0.4.2.1 → 0.5.0

data/lib/maruku/ext/math.rb

@@ -0,0 +1,11 @@
+
+
+require 'maruku/ext/math/elements'
+require 'maruku/ext/math/parsing'
+require 'maruku/ext/math/to_latex'
+require 'maruku/ext/math/to_html'
+
+require 'maruku/ext/math/mathml_engines/none'
+require 'maruku/ext/math/mathml_engines/ritex'
+require 'maruku/ext/math/mathml_engines/itex2mml'
+require 'maruku/ext/math/mathml_engines/blahtex'

data/lib/maruku/ext/math/elements.rb

@@ -0,0 +1,26 @@
+module MaRuKu; class MDElement
+	
+	def md_inline_math(math)
+		self.md_el(:inline_math, [], meta={:math=>math})
+	end
+
+	def md_equation(math, label=nil)
+		reglabel= /\\label\{(\w+)\}/
+		if math =~ reglabel
+			label = $1
+			math.gsub!(reglabel,'')
+		end
+#		puts "Found label = #{label} math #{math.inspect} "
+		num = nil
+		if label && @doc #take number
+			@doc.eqid2eq ||= {}	
+			num = @doc.eqid2eq.size + 1
+		end
+		e = self.md_el(:equation, [], meta={:math=>math, :label=>label,:num=>num})
+		if label && @doc #take number
+			@doc.eqid2eq[label] = e
+		end
+		e
+	end
+
+end end

data/lib/maruku/ext/math/mathml_engines/blahtex.rb

@@ -0,0 +1,108 @@
+
+require 'tempfile'
+require 'fileutils'
+require 'digest/md5'
+require 'pstore'
+
+module MaRuKu; module Out; module HTML
+	
+	PNG = Struct.new(:src,:depth,:height)
+	
+	def convert_to_png_blahtex(kind, tex)
+		begin
+			FileUtils::mkdir_p MaRuKu::Globals[:html_png_dir]
+
+			# first, we check whether this image has already been processed
+			md5sum = Digest::MD5.hexdigest(tex+" params: ")
+			result_file = File.join(MaRuKu::Globals[:html_png_dir], md5sum+".txt")
+			
+			if not File.exists?(result_file) 
+				tmp_in = Tempfile.new('maruku_blahtex')
+				f = tmp_in.open
+				f.write tex
+				f.close
+				
+				resolution = get_setting(:html_png_resolution)
+			
+				options = "--png --use-preview-package --shell-dvipng 'dvipng -D #{resolution}' "
+				options += ("--png-directory '%s'" % MaRuKu::Globals[:html_png_dir])
+			
+				cmd = "blahtex #{options} < #{tmp_in.path} > #{result_file}"
+				$stderr.puts "$ #{cmd}"
+				system cmd
+				tmp_in.delete
+				
+			end
+			
+			result = nil
+			f = File.open(result_file)
+			result = f.read
+			f.close
+			
+			
+			doc = Document.new(result, {:respect_whitespace =>:all})
+			png = doc.root.elements[1]
+			if png.name != 'png'
+				maruku_error "Blahtex error: \n#{doc}"
+				return nil
+			end
+			depth = png.elements['depth'] || (raise "No depth element in:\n #{doc}")
+			height = png.elements['height'] || (raise "No height element in:\n #{doc}")
+			md5 = png.elements['md5'] || (raise "No md5 element in:\n #{doc}")
+			
+			depth = depth.text.to_f
+			height = height.text.to_f # XXX check != 0
+			md5 = md5.text
+			
+			dir_url = MaRuKu::Globals[:html_png_url]
+			return PNG.new("#{dir_url}#{md5}.png", depth, height)
+			
+		rescue Exception => e
+			maruku_error "Error: #{e}"
+		end
+		nil
+	end
+
+	BlahtexCache = PStore.new("blahtex_cache.pstore")
+
+	def convert_to_mathml_blahtex(kind, tex)
+		begin
+			BlahtexCache.transaction do 
+				if BlahtexCache[tex].nil?
+					tmp_in = Tempfile.new('maruku_blahtex')
+						f = tmp_in.open
+						f.write tex
+						f.close
+					tmp_out = Tempfile.new('maruku_blahtex')
+	
+					options = "--mathml"
+					cmd = "blahtex #{options} < #{tmp_in.path} > #{tmp_out.path}"
+					$stderr.puts "$ #{cmd}"
+					system cmd
+					tmp_in.delete
+					
+					result = nil
+					File.open(tmp_out.path) do |f| result=f.read end
+						puts result
+					
+					BlahtexCache[tex] = result
+				end
+			
+				blahtex = BlahtexCache[tex]
+				doc = Document.new(blahtex, {:respect_whitespace =>:all})
+				mathml = doc.root.elements['mathml']
+				if not mathml
+					maruku_error "Blahtex error: \n#{doc}"
+					return nil
+				else
+					return mathml
+				end
+			end
+			
+		rescue Exception => e
+			maruku_error "Error: #{e}"
+		end
+		nil
+	end
+
+end end end

data/lib/maruku/ext/math/mathml_engines/itex2mml.rb

@@ -0,0 +1,29 @@
+
+module MaRuKu; module Out; module HTML
+
+	def convert_to_mathml_itex2mml(kind, tex)
+		begin
+			if not $itex2mml_parser
+				require 'itextomml'
+				$itex2mml_parser =  Itex2MML::Parser.new
+			end
+			
+			itex_method = {:equation=>:block_filter,:inline=>:inline_filter}
+			
+			mathml =  $itex2mml_parser.send(itex_method[kind], tex)
+			doc = Document.new(mathml, {:respect_whitespace =>:all}).root
+			return doc
+		rescue LoadError => e
+			maruku_error "Could not load package 'itex2mml'.\n"+
+			"Please install it."
+		rescue REXML::ParseException => e
+			maruku_error "Invalid MathML TeX: \n#{add_tabs(tex,1,'tex>')}"+
+				"\n\n #{e.inspect}"
+		rescue 
+			maruku_error "Could not produce MathML TeX: \n#{tex}"+
+				"\n\n #{e.inspect}"
+		end
+		nil
+	end
+
+end end end

data/lib/maruku/ext/math/mathml_engines/none.rb

@@ -0,0 +1,20 @@
+module MaRuKu; module Out; module HTML
+
+	def convert_to_mathml_none(kind, tex)
+		# You can: either return a REXML::Element
+		#    return Element.new 'div'    
+		# or return an empty array on error
+		#    return []  
+		# or have a string parsed by REXML:
+		tex = tex.gsub('&','&')
+		mathml = "<code>#{tex}</code>"
+		return Document.new(mathml).root
+	end
+
+	def convert_to_png_none(kind, tex)
+		return nil
+	end
+
+
+end end end
+

data/lib/maruku/ext/math/mathml_engines/ritex.rb

@@ -0,0 +1,24 @@
+module MaRuKu; module Out; module HTML
+
+	def convert_to_mathml_ritex(kind, tex)
+		begin
+			if not $ritex_parser
+				require 'ritex'
+			 	$ritex_parser = Ritex::Parser.new
+			end
+			
+			mathml =  $ritex_parser.parse(tex.strip)
+			doc = Document.new(mathml, {:respect_whitespace =>:all}).root
+			return doc
+		rescue LoadError => e
+			maruku_error "Could not load package 'ritex'.\n"+
+			"Please install it using:\n"+
+			"   $ gem install ritex\n\n"+e.inspect
+		rescue Racc::ParseError => e
+			maruku_error "Could not parse TeX: \n#{tex}"+
+				"\n\n #{e.inspect}"
+		end
+		nil
+	end
+	
+end end end

data/lib/maruku/ext/math/parsing.rb

@@ -0,0 +1,82 @@
+module MaRuKu
+	class MDDocument
+		# Hash equation id (String) to equation element (MDElement)
+		attr_accessor :eqid2eq
+	end
+end
+
+
+	# At least one slash inside
+	#RegInlineMath1 = /\$([^\$]*[\\][^\$]*)\$/
+	# No spaces around the delimiters
+	#RegInlineMath2 = /\$([^\s\$](?:[^\$]*[^\s\$])?)\$/
+	#RegInlineMath = Regexp::union(RegInlineMath1,RegInlineMath2)
+
+	# Everything goes; takes care of escaping the "\$" inside the expression
+	RegInlineMath = /\${1}((?:[^\$]|\\\$)+)\$/
+	
+	MaRuKu::In::Markdown::
+	register_span_extension(:chars => ?$, :regexp => RegInlineMath) do 
+		|doc, src, con|
+		if m = src.read_regexp(RegInlineMath)
+			math = m.captures.compact.first
+			con.push doc.md_inline_math(math)
+			true
+		else
+			#puts "not math: #{src.cur_chars 10}"
+			false
+		end
+	end
+	
+	EquationStart = /^[ ]{0,3}(?:\\\[|\$\$)(.*)$/
+	
+	EqLabel = /(?:\((\w+)\))/
+	OneLineEquation = /^[ ]{0,3}(?:\\\[|\$\$)(.*)(?:\\\]|\$\$)\s*#{EqLabel}?\s*$/
+	EquationEnd = /^(.*)(?:\\\]|\$\$)\s*#{EqLabel}?\s*$/
+
+	MaRuKu::In::Markdown::
+	register_block_extension(:regexp  => EquationStart) do |doc, src, con|
+#		puts "Equation :#{self}"
+		first = src.shift_line
+		if first =~ OneLineEquation
+			math = $1
+			label = $2 
+			con.push doc.md_equation($1, $2)
+		else
+			first =~ EquationStart
+			math = $1
+			label = nil
+			while true
+				if not src.cur_line
+					maruku_error "Stream finished while reading equation\n\n"+
+					add_tabs(math,1,'$> '), src, con
+					break
+				end
+				line = src.shift_line
+				if line =~ EquationEnd
+					math += $1 + "\n"
+					label = $2 if $2
+					break
+				else
+					math += line + "\n"
+				end
+			end
+			con.push doc.md_equation(math, label)
+		end
+		true
+	end
+		
+		
+	# This adds support for \eqref
+	RegEqrefLatex = /\\eqref\{(\w+)\}/
+	RegEqPar = /\(eq:(\w+)\)/
+	RegEqref = Regexp::union(RegEqrefLatex, RegEqPar)
+	
+	MaRuKu::In::Markdown::
+	register_span_extension(:chars => [?\\, ?(], :regexp => RegEqref) do 
+		|doc, src, con|
+		eqid = src.read_regexp(RegEqref).captures.compact.first
+		r = doc.md_el(:eqref, [], meta={:eqid=>eqid})
+		con.push r
+	 	true 
+	end

data/lib/maruku/ext/math/to_html.rb

@@ -0,0 +1,178 @@
+
+=begin maruku_doc
+Extension: math
+Attribute: html_math_engine
+Scope: document, element
+Output: html
+Summary: Select the rendering engine for MathML.
+Default: <?mrk Globals[:html_math_engine].to_s ?>
+
+Select the rendering engine for math.
+
+If you want to use your custom engine `foo`, then set:
+
+	HTML math engine: foo
+{:lang=markdown}
+
+and then implement two functions:
+
+	def convert_to_mathml_foo(kind, tex)
+		...
+	end
+=end
+
+=begin maruku_doc
+Extension: math
+Attribute: html_png_engine
+Scope: document, element
+Output: html
+Summary: Select the rendering engine for math.
+Default: <?mrk Globals[:html_math_engine].to_s ?>
+
+Same thing as `html_math_engine`, only for PNG output.
+
+	def convert_to_png_foo(kind, tex)
+		# same thing
+		...
+	end
+{:lang=ruby}
+
+=end
+
+module MaRuKu; module Out; module HTML
+
+
+	def add_class_to(el, cl)
+		el.attributes['class'] = 
+		if already = el.attributes['class']
+			already + " " + cl
+		else
+			cl
+		end
+	end
+	
+	# Creates an xml Mathml document of self.math
+	def render_mathml(kind, tex)
+		engine = get_setting(:html_math_engine)
+		method = "convert_to_mathml_#{engine}".to_sym
+		if self.respond_to? method
+			mathml = self.send(method, kind, tex) 
+			return mathml || convert_to_mathml_none(kind, tex)
+		else 
+			puts "A method called #{method} should be defined."
+			return convert_to_mathml_none(kind, tex)
+		end
+	end
+
+	# Creates an xml Mathml document of self.math
+	def render_png(kind, tex)
+		engine = get_setting(:html_png_engine)
+		method = "convert_to_png_#{engine}".to_sym
+		if self.respond_to? method
+			return self.send(method, kind, tex) 
+		else 
+			puts "A method called #{method} should be defined."
+			return nil
+		end
+	end
+	
+	def pixels_per_ex
+		if not $pixels_per_ex 
+			x = render_png(:inline, "x")
+			$pixels_per_ex  = x.height # + x.depth
+		end
+		$pixels_per_ex
+	end
+		
+	def adjust_png(png, use_depth)
+		src = png.src
+		
+		height_in_px = png.height
+		depth_in_px = png.depth
+		height_in_ex = height_in_px / pixels_per_ex
+		depth_in_ex = depth_in_px / pixels_per_ex
+		total_height_in_ex = height_in_ex + depth_in_ex
+		style = "" 
+		style += "vertical-align: -#{depth_in_ex}ex;" if use_depth
+		style += "height: #{total_height_in_ex}ex;"
+		img = Element.new 'img'
+		img.attributes['src'] = src
+		img.attributes['style'] = style
+		img.attributes['alt'] = "equation"
+		img
+	end
+	
+	def to_html_inline_math
+		mathml  = render_mathml(:inline, self.math)
+		png = render_png(:inline, self.math)
+
+		span = create_html_element 'span'
+		add_class_to(span, 'maruku-inline')
+			
+			if mathml
+				add_class_to(mathml, 'maruku-mathml')
+				span << mathml 
+			end
+	
+			if png
+				img = adjust_png(png, use_depth=true)
+				add_class_to(img, 'maruku-png')
+				span << img
+			end
+		span
+		
+	end
+
+	def to_html_equation
+		mathml  = render_mathml(:equation, self.math)
+		png = render_png(:equation, self.math)
+		
+		div = create_html_element 'div'
+		add_class_to(div, 'maruku-equation')
+			if self.label # then numerate
+				span = Element.new 'span'
+				span.attributes['class'] = 'maruku-eq-number'
+				num = self.num
+				span << Text.new("(#{num})")
+				div << span
+				div.attributes['id'] = "eq:#{self.label}"
+			end
+			
+			if mathml
+				add_class_to(mathml, 'maruku-mathml')
+				div << mathml 
+			end
+			
+			if png
+				img = adjust_png(png, use_depth=false)
+				add_class_to(img, 'maruku-png')
+				div << img
+			end
+			
+			source_div = Element.new 'div'
+				add_class_to(source_div, 'maruku-eq-tex')
+				code = convert_to_mathml_none(:equation, self.math)	
+				code.attributes['style'] = 'display: none'
+			source_div << code
+			div << source_div
+		div
+	end
+	
+	def to_html_eqref
+		if eq = self.doc.eqid2eq[self.eqid]
+			num = eq.num
+			a = Element.new 'a'
+			a.attributes['class'] = 'maruku-eqref'
+			a.attributes['href'] = "#eq:#{self.eqid}"
+			a << Text.new("(#{num})")
+			a
+		else
+			maruku_error "Cannot find equation #{self.eqid.inspect}"
+			Text.new "(eq:#{self.eqid})"
+		end
+	end
+
+	
+end end end
+
+