rsyntaxtree 0.5.0

data/.gitignore

@@ -0,0 +1,11 @@
+pkg/
+tmp/
+doc/
+.DS_Store
+Gemfile.lock
+
+*.bak
+*.~
+
+
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rsyntaxtree.gemspec
+gemspec

data/README.md

@@ -0,0 +1,51 @@
+# RSyntaxTree: yet another syntax tree generator in Ruby
+
+RSyntaxTree is a graphical syntax tree generator written in the Ruby programming language. It is basically a port of  [phpSyntaxTree](http://ironcreek.net/phpsyntaxtree/) created by André Eisenbach.
+
+While phpSyntaxTree does not accept **multi-byte characters** as those in Chinese, Japanese, and Korean, RSyntaxTree handles text of any language as long as encoded in UTF-8 and fonts have been installed. Additionally, RSyntaxTree can output **symmetrized** tree diagrams, a functionality that is not implemented in phpSyntaxTree.
+
+RSyntaxTree consists of an easy-to-use command-line app and a web-based interfaces made with  [Sinatra](http://www.sinatrarb.com) web framework.
+
+### Web Interface
+
+Working web interface of a previous version of RSyntaxTree is available at http://yohasebe.com/rsyntaxtree .  New version will be deployed soon.
+
+### Installation
+
+`# gem install rsyntaxtree`
+
+### Usage
+
+For the web interface, see Usage section in http://yohasebe.com/rsyntaxtree .
+
+For the command-line interface, type `$rsyntaxtree -h` after installation. Here's what you get:
+    
+    RSyntaxTree, (linguistic) syntax tree generator written in Ruby.
+    
+    Usage:
+           rsyntaxtree [options] "[NP [N bracket] [NP notation]]]"
+    where [options] are:
+          --outdir, -o <s>:   Output directory (default: present working directory) (default: ./)
+          --format, -f <s>:   Output format: png or svg (default: png)
+       --leafstyle, -l <s>:   visual style of tree leaves: triangle, bar, or nothing (default: triangle)
+       --fontstyle, -n <s>:   Font style: sans-serif, serif, jp-gothic, jp-mincho, cjk (default: cjk)
+            --font, -t <s>:   Path to a ttf font used to generate tree
+        --fontsize, -s <i>:   Font size: 8-20 (default: 16)
+           --color, -c <s>:   Color text and bars: on or off (default: on)
+      --symmetrize, -y <s>:   Generate symmetrical, balanced tree: on or off (default: on)
+         --autosub, -a <s>:   Put subscript numbers to nodes: on or off (default: off)
+             --version, -v:   Print version and exit
+                --help, -h:   Show this message
+
+### Development
+
+For the latest updates and downloads please visit http://github.com/yohasebe/rsyntaxtree
+
+### Author
+
+Yoichiro Hasebe yohasebe@gmail.com
+
+### License
+
+RSyntaxTree is distributed under the [MIT License](http://www.opensource.org/licenses/mit-license.php).
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require 'sinatra'
+require 'haml'
+require 'base64'
+require './helpers/helpers'
+require './lib/rsyntaxtree'
+
+include Helpers
+
+configure do
+  enable :sessions
+end
+
+get '/' do #
+  haml :index
+end
+
+post '/check' do                        
+  data = params["data"]
+  result = RSGenerator.check_data(data)
+  return result ? "true" : "false"
+end
+
+get '/draw_png' do
+  rs_generator = RSGenerator.new(params)
+  content_type "image/png"
+  rs_generator.draw_tree
+end
+
+post '/draw_png' do  
+  basename = "syntree.png"
+  rs_generator = RSGenerator.new(params)
+  png_blob = rs_generator.draw_png
+  response.headers['content_type'] = "image/png"
+  response.headers['content_length'] = png_blob.size.to_s
+  response.headers['content_disposition'] = "inline" + %(; filename="#{basename}")
+  Base64.encode64(png_blob)
+end
+
+post '/download_svg' do
+  content_type 'image/svg+xml'
+  attachment 'syntree.svg'
+  rs_generator = RSGenerator.new(params)
+  rs_generator.draw_svg
+end  
+
+post '/download_pdf' do
+  content_type 'applcation/pdf'
+  attachment 'syntree.pdf'
+  rs_generator = RSGenerator.new(params)
+  rs_generator.draw_pdf
+end  
+

data/bin/rsyntaxtree

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+$LOAD_PATH << File.join( File.dirname(__FILE__), '../lib')
+
+require 'rsyntaxtree'
+require 'trollop'
+
+opts = Trollop::options do
+  version "RSyntaxTree #{RSyntaxTree::VERSION} (c) 2012 Yoichiro Hasebe"
+  banner <<-EOS
+RSyntaxTree, (linguistic) syntax tree generator written in Ruby.
+
+Usage:
+       rsyntaxtree [options] "[NP [N bracket] [NP notation]]]"
+where [options] are:
+EOS
+
+  opt :outdir, "Output directory (default: present working directory)",
+      :default => "./"
+  opt :format, "Output format: png, pdf, or svg",
+      :default => "png"
+  opt :leafstyle, "visual style of tree leaves: triangle, bar, or nothing", 
+      :default => "triangle"
+  opt :fontstyle, "Font style: sans-serif, serif, jp-gothic, jp-mincho, cjk",
+      :default => "cjk"
+  opt :font, "Path to a ttf font used to generate tree", :type => String
+  opt :fontsize, "Font size: 8-20",
+      :default => 16
+  opt :color, "Color text and bars: on or off",
+      :default => "on" 
+  opt :symmetrize, "Generate symmetrical, balanced tree: on or off",
+      :default => "on" 
+  opt :autosub, "Put subscript numbers to nodes: on or off",
+      :default => "off"       
+end
+
+Trollop::die :outdir, "must be an exsting directory path" unless FileTest::directory?(opts[:outdir])
+Trollop::die :format, "must be png or svg" unless /\A(png|pdf|svg)\z/ =~ opts[:format]
+Trollop::die :leafstyle, "must be triangle, bar, or nothing" unless /\A(triangle|bar|nothing)\z/ =~ opts[:leafstyle]
+Trollop::die :fontstyle, "must be sans-serif, serif, jp-gothic, jp-mincho, or cjk" unless /\A(sans\-serif|serif|jp\-gothic|jp\-mincho|cjk)\z/ =~ opts[:fontstyle]
+Trollop::die :font, "must be path to an existing ttf font" if opts[:font] && !File::exists?(opts[:font])
+Trollop::die :fontsize, "must be in the range 8-20" unless opts[:fontsize] >= 8 && opts[:fontsize] <= 20
+Trollop::die :color, "must be either on or off" unless /\A(on|off)\z/ =~ opts[:color]
+Trollop::die :symmetrize, "must be either on or off" unless /\A(on|off)\z/ =~ opts[:symmetrize]
+Trollop::die :autosub, "must be either on or off" unless /\A(on|off)\z/ =~ opts[:autosub]
+
+string_opts = {}
+opts.each do |key, value|
+  string_opts[key.to_s] = value unless key == :font && !value
+end
+
+data = ARGV[0]
+
+unless data && RSGenerator.check_data(data)
+  puts "bracket notation given is invalid"
+  exit
+end
+
+string_opts["data"] = data
+
+rsg = RSGenerator.new(string_opts)
+ext = string_opts["format"]
+outfile = File.new(File.expand_path(string_opts["outdir"]) + "/syntree." + ext, "wb")
+case ext
+when "png"
+  outfile.write rsg.draw_png
+when "pdf"
+  outfile.write rsg.draw_pdf
+when "svg"
+  outfile.write rsg.draw_svg
+end
+outfile.close

data/config.ru

@@ -0,0 +1,7 @@
+path = File.expand_path("../", __FILE__)
+
+require 'rubygems'
+require 'sinatra'
+require "#{path}/app"
+
+run Sinatra::Application

data/helpers/helpers.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+module Helpers
+  def link_to(name, location, alternative = false)
+    if alternative and alternative[:condition]
+      "<a href=#{alternative[:location]}>#{alternative[:name]}</a>"
+    else
+      "<a href=#{location}>#{name}</a>"
+    end
+  end
+  
+  def multibyte?(text)
+    result = false
+    text.strip.split(//).each do |chr|
+      unless /([!-~]|\s)/ =~ chr
+        result = true; break
+      end
+    end
+    return result
+  end  
+end

data/lib/rsyntaxtree.rb

@@ -0,0 +1,134 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#==========================
+# rsyntaxtree.rb
+#==========================
+#
+# Facade of rsyntaxtree library.  When loaded by a driver script, it does all
+# the necessary 'require' to use the library.
+#
+# This file is part of RSyntaxTree, which is a ruby port of Andre Eisenbach's
+# excellent program phpSyntaxTree.
+# Copyright (c) 2007-2009 Yoichiro Hasebe <yohasebe@gmail.com>
+# Copyright (c) 2003-2004 Andre Eisenbach <andre@ironcreek.net>
+# 
+# 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 of the License, 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+$LOAD_PATH << File.join( File.dirname(__FILE__), 'rsyntaxtree')
+$LOAD_PATH << File.join( File.dirname(__FILE__), '../helpers')
+
+require 'uri'
+require 'imgutils'
+require 'element'
+require 'elementlist'
+require 'string_parser'
+require 'tree_graph'
+require 'svg_graph'
+require 'error_message'
+require 'helpers'
+require 'version'
+
+FONT_DIR = File.expand_path(File.dirname(__FILE__) + "/../fonts")
+
+class RSGenerator 
+  include Helpers
+  def initialize(params = {})
+    new_params = {}
+    params.each do |key, value|
+      case key
+      when "data"
+        data = URI.unescape(value)
+        data  = data.gsub('-AMP-', '&').gsub('-PRIME-', "'").gsub('-SCOLON-', ';')
+        new_params[key] = data
+      when "symmetrize", "color", "autosub"
+        new_params[key] = value == "on"? true : false
+      when "fontsize"
+        new_params[key] = value.to_i
+      when "fontstyle"
+        if value == "sans-serif"
+          new_params["font"] = FONT_DIR + "/DroidSans.ttf"
+        elsif value == "serif"
+          new_params["font"] = FONT_DIR + "/DroidSerif-Regular.ttf"
+        elsif value == "jp-gothic"
+          new_params["font"] = FONT_DIR + "/ipagp.ttf"
+        elsif value == "jp-mincho"
+          new_params["font"] = FONT_DIR + "/ipamp.ttf"
+        elsif value == "cjk"
+          new_params["font"] = FONT_DIR + "/wqy-zenhei.ttf"
+        end
+      else
+        new_params[key] = value
+      end
+    end
+    
+    
+    @params = {
+      "symmetrize" => true,
+      "color"      => true,
+      "autosub"    => false,
+      "fontsize"   => 18,
+      "format"     => "png",
+      "leafstyle"   => "triangle",
+      "font"        => FONT_DIR + "/ipagp.ttf",
+      "filename"   => "syntree",
+      "data"       => "",
+    }
+    
+    @params.merge! new_params
+   end
+
+  def self.check_data(text)
+     # StringParser.validate_text(text)     
+     sp = StringParser.new(text)
+     sp.valid?
+  end
+  
+  def draw_png
+    @params["format"] = "png"
+    draw_tree
+  end
+
+  def draw_pdf
+    @params["format"] = "pdf"
+    draw_tree
+  end
+  
+  def draw_svg
+    @params["format"] = "svg"
+    draw_svg
+  end
+  
+  def draw_tree
+    sp = StringParser.new(@params["data"])
+    sp.parse
+    sp.auto_subscript if @params["autosub"]
+    elist = sp.get_elementlist
+    graph = TreeGraph.new(elist, 
+      @params["symmetrize"], @params["color"], @params["leafstyle"], @params["font"], @params["fontsize"], @params["format"])
+    graph.to_blob(@params["format"])
+  end
+  
+  def draw_svg
+    sp = StringParser.new(@params["data"].gsub('&', '&amp;'))
+    sp.parse
+    sp.auto_subscript if @params["autosub"]
+    elist = sp.get_elementlist
+    graph = SVGGraph.new(elist, 
+      @params["symmetrize"], @params["color"], @params["leafstyle"], @params["font"], @params["fontsize"])
+    graph.svg_data
+  end
+end
+

data/lib/rsyntaxtree/element.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#==========================
+# element.rb
+#==========================
+#
+# Aa class that represents a basic tree element, either node or leaf.
+#
+# This file is part of RSyntaxTree, which is a ruby port of Andre Eisenbach's
+# excellent program phpSyntaxTree.
+#
+# Copyright (c) 2007-2009 Yoichiro Hasebe <yohasebe@gmail.com>
+# Copyright (c) 2003-2004 Andre Eisenbach <andre@ironcreek.net>
+# 
+# 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 of the License, 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+ETYPE_UNDEFINED = 0
+ETYPE_NODE = 1
+ETYPE_LEAF = 2
+
+class Element
+
+    attr_accessor :id, :parent, :type, :content, :level, :width, :indent
+    def initialize(id = 0, parent = 0, content = NULL, level = 0, type = ETYPE_LEAF)
+      @id = id                 # Unique element id
+      @parent = parent         # Parent element id
+      @type = type             # Element type
+      @content = content.strip # The actual element content
+      @level = level           # Element level in the tree (0=top etc...)
+      @width = 0               # Width of the element in pixels
+      @indent = 0              # Drawing offset
+    end
+    
+    # Debug helper function
+    def dump
+      printf( "ID      : %d\n", @id );
+      printf( "Parent  : %d\n", @parent );
+      printf( "Level   : %d\n", @level );
+      printf( "Type    : %d\n", @type );
+      printf( "Width   : %d\n", @width );
+      printf( "Indent  : %d\n", @indent );
+      printf( "Content : %s\n\n", @content );
+    end
+
+end

data/lib/rsyntaxtree/elementlist.rb

@@ -0,0 +1,137 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#==========================
+# elementlist.rb
+#==========================
+#
+# Contains a list of unordered tree elements with a defined parent
+#
+# This file is part of RSyntaxTree, which is a ruby port of Andre Eisenbach's
+# excellent program phpSyntaxTree.
+#
+# Copyright (c) 2007-2009 Yoichiro Hasebe <yohasebe@gmail.com>
+# Copyright (c) 2003-2004 Andre Eisenbach <andre@ironcreek.net>
+# 
+# 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 of the License, 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+require 'element'
+
+class ElementList
+
+    attr_accessor :elements, :iterator
+    def initialize
+      @elements = Array.new # The element array
+      @iterator = -1 # Iterator index (used for get_first / get_next)
+    end
+    
+    def add(element)
+      @elements << element
+      if(element.parent != 0)
+        parent = get_id(element.parent)
+        parent.type = ETYPE_NODE
+      end
+    end
+
+    def get_first
+      if(@elements.length == 0)
+        return nil
+      else
+        @iterator = 0
+        return @elements[@iterator]
+      end
+    end
+
+    def get_next
+        @iterator += 1
+        if @elements[@iterator]
+          return @elements[@iterator]
+        else
+          return nil
+        end
+    end
+
+    def get_id(id)
+      @elements.each do |element|
+        if(element.id == id)
+          return element 
+        end
+      end  
+      return nil;
+    end
+
+    def get_elements
+      @elements
+    end
+
+    def get_child_count(id)
+      get_children(id).length
+    end
+
+    def get_children(id)
+      children = Array.new
+      @elements.each do |element|
+        if(element.parent == id)
+          children << element.id
+        end
+      end
+      children
+    end
+
+    def get_element_width(id)
+      element = get_id(id)
+      if element
+        return element.width
+      else
+        return -1;
+      end
+    end
+
+    def set_element_width(id, width)
+      element = get_id(id)
+      if element
+        element.width = width
+      end
+    end
+
+    def get_indent(id)
+      element = get_id(id)
+      if element
+        return element.indent
+      else
+        return -1
+      end  
+    end
+
+    def set_indent(id, indent)
+      element = get_id(id)
+      if element
+        element.indent = indent
+      end
+    end
+
+    def get_level_height
+      maxlevel = 0
+      @elements.each do |element|
+        level = element.level
+        if(level > maxlevel)
+          maxlevel = level
+        end
+      end
+      return maxlevel + 1;
+    end
+    
+end
+