rsyntaxtree 0.7.1 → 0.7.7

data/lib/rsyntaxtree/tree_graph.rb

@@ -10,84 +10,39 @@
 # This file is part of RSyntaxTree, which is a ruby port of Andre Eisenbach's
 # excellent program phpSyntaxTree.
 #
-# Copyright (c) 2007-2018 Yoichiro Hasebe <yohasebe@gmail.com>
+# Copyright (c) 2007-2021 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 'imgutils'
-require 'elementlist'
-# require 'rubygems'
+
+require 'graph'
 require 'rmagick'
 include Magick
 
-# Double to make image retina ready
-E_WIDTH   = 60 * 2 # Element width
-E_PADD    = 7  * 2 # Element height padding
-V_SPACE   = 20 * 2
-H_SPACE   = 10 * 2
-B_SIDE   =   5 * 2
-B_TOPBOT =   5 * 2
-
-class TreeGraph
-
-  def initialize(e_list, symmetrize = true, color = true, terminal = "auto",
-                 font = "Helvetica", font_size = 10, simple = false, margin = 0)
-
-    # Store parameters (double font size and margin to make image retina ready)
-    @e_list     = e_list
-    @font       = font
-    @terminal = terminal
-    @symmetrize = symmetrize
-    @simple = simple
-    @font_size = font_size * 2
-    @margin = margin * 2
-
-    # Element dimensions
-    @e_width   = E_WIDTH
-    
-    # Calculate image dimensions
-    @e_height = @font_size + E_PADD * 2
-    h = @e_list.get_level_height
-    w = calc_level_width(0)
-    w_px = w + B_SIDE * 2
-    h_px = h * @e_height + (h-1) * (V_SPACE + @font_size) + B_TOPBOT * 2
-    @height    = h_px
-    @width     = w_px
+class TreeGraph < Graph
+
+  def initialize(e_list, metrics, symmetrize, color, leafstyle, multibyte,
+                 fontstyle, font, font_it, font_bd, font_itbd, font_cjk, font_size,
+                 margin)
+
+    # Store class-specific parameters
+    @fontstyle  = fontstyle
+    @font       = multibyte ? font_cjk : font
+    @font_size  = font_size
+    @font_it    = font_it
+    @font_bd    = font_bd
+    @font_itbd  = font_itbd
+    @font_cjk   = font_cjk
+    @margin     = margin
+
+    super(e_list, metrics, symmetrize, color, leafstyle, multibyte, @font, @font_size)
 
     # Initialize the image and colors
-    @im = Image.new(w_px, h_px)
-    @gc = Draw.new
-    @gc.font = @font
+    @im           = Image.new(@width, @height)
+    @im.interlace = PlaneInterlace
+    @gc           = Draw.new
+    @gc.font      = @font
     @gc.pointsize(@font_size)
-
-    @col_bg   = "none"
-    @col_fg   = "black"
-    @col_line = "black"
-    
-    if color
-      @col_node  = "blue"
-      @col_leaf  = "green"
-      @col_trace = "red"
-    else
-      @col_node  = "black"
-      @col_leaf  = "black"
-      @col_trace = "black"
-    end
   end
-  
+
   def destroy
     @im.destroy!
   end
@@ -108,44 +63,112 @@ class TreeGraph
     draw
     @im.border!(@margin, @margin, "white")
     return @im.to_blob do
-       self.format = fileformat
+      self.format = fileformat
+      self.interlace = PlaneInterlace
     end
-  end  
-  
+  end
+
   :private
- 
+
   # Add the element into the tree (draw it)
   def draw_element(x, y, w, string, type)
-    string = string.sub(/\^\z/){""} 
+    string = string.sub(/\^\z/){""}
     # Calculate element dimensions and position
-    if (type == ETYPE_LEAF) and @terminal == "nothing"
+    if (type == ETYPE_LEAF) and @leafstyle == "nothing"
       top = row2px(y - 1) + (@font_size * 1.5)
-    else 
+    else
       top   = row2px(y)
     end
-    left   = x + B_SIDE
+    left   = x + @m[:b_side]
     bottom = top  + @e_height
     right  = left + w
 
-    # Split the string into the main part and the 
+    # Split the string into the main part and the
     # subscript part of the element (if any)
-    main = string
-    sub  = ""
-
-    sub_size = (@font_size * 0.7 )
     parts = string.split("_", 2)
-  
     if(parts.length > 1 )
-      main = parts[0]
-      sub  = parts[1].gsub(/_/, " ")
+      main = parts[0].strip
+      sub  = parts[1].gsub(/_/, " ").strip
+    else
+      main = parts[0].strip
+      sub  = ""
     end
-        
-    # Calculate text size for the main and the 
+
+    if /\A\+(.+)\+\z/ =~ main
+      main = $1
+      main_decoration = OverlineDecoration
+    elsif /\A\-(.+)\-\z/ =~ main
+      main = $1
+      main_decoration = UnderlineDecoration
+    elsif /\A\=(.+)\=\z/ =~ main
+      main = $1
+      main_decoration = LineThroughDecoration
+    else
+      main_decoration = NoDecoration
+    end
+
+    if /\A\*\*\*(.+)\*\*\*\z/ =~ main
+      main = $1
+      if !@multibyte
+        main_font = @font_itbd
+      end
+    elsif /\A\*\*(.+)\*\*\z/ =~ main
+      main = $1
+      if !@multibyte
+        main_font = @font_bd
+      end
+    elsif /\A\*(.+)\*\z/ =~ main
+      main = $1
+      if !@multibyte
+        main_font = @font_it
+      end
+    else
+      main_font = @font
+    end
+
+    # Calculate text size for the main and the
     # subscript part of the element
-    main_width = img_get_txt_width(main, @font, @font_size)
+    # symbols for underline/overline removed temporarily
+
+    main_width = img_get_txt_width(main, main_font, @font_size)
+
+    if /\A\+(.+)\+\z/ =~ sub
+      sub = $1
+      sub_decoration = OverlineDecoration
+    elsif /\A\-(.+)\-\z/ =~ sub
+      sub = $1
+      @gc.decorate(UnderlineDecoration)
+      sub_decoration = UnderlineDecoration
+    elsif /\A\=(.+)\=\z/ =~ sub
+      sub = $1
+      sub_decoration = LineThroughDecoration
+    else
+      sub_decoration = NoDecoration
+    end
+
+    sub_font = @font
+
+    if /\A\*\*\*(.+)\*\*\*\z/ =~ sub
+      sub = $1
+      if !@multibyte
+        sub_font = @font_itbd
+      end
+    elsif /\A\*\*(.+)\*\*\z/ =~ sub
+      sub = $1
+      if !@multibyte
+        sub_font = @font_bd
+      end
+    elsif /\A\*(.+)\*\z/ =~ sub
+      sub = $1
+      if !@multibyte
+        sub_font = @font_it
+      end
+    else
+      sub_font = @font
+    end
 
     if sub != ""
-      sub_width  = img_get_txt_width(sub.to_s,  @font, sub_size)
+      sub_width  = img_get_txt_width(sub.to_s, sub_font, @sub_size)
     else
       sub_width = 0
     end
@@ -154,14 +177,14 @@ class TreeGraph
     txt_width = main_width + sub_width
 
     txt_pos   = left + (right - left) / 2 - txt_width / 2
-  
+
     # Select apropriate color
     if(type == ETYPE_LEAF)
       col = @col_leaf
     else
-      col = @col_node      
+      col = @col_node
     end
-    
+
     if(main[0].chr == "<" && main[-1].chr == ">")
       col = @col_trace
     end
@@ -172,17 +195,22 @@ class TreeGraph
     # Draw main text
     @gc.pointsize(@font_size)
     main_x = txt_pos
-    main_y = top + @e_height - E_PADD
+    main_y = top + @e_height - @m[:e_padd]
+
+    @gc.interline_spacing = -(@main_height / 3)
+    @gc.font(main_font)
+    @gc.decorate(main_decoration)
     @gc.text(main_x.ceil, main_y.ceil, main)
-        
+
     # Draw subscript text
     if (sub.length > 0 )
-      @gc.pointsize(sub_size)
-      sub_x = txt_pos + main_width + (sub_size/8)
-      sub_y = top + (@e_height - E_PADD + sub_size / 2)
+      @gc.pointsize(@sub_size)
+      sub_x = txt_pos + main_width + @sub_space_width
+      sub_y = top + (@e_height - @m[:e_padd] + @sub_size / 2)
+      @gc.font(sub_font)
+      @gc.decorate(sub_decoration)
       @gc.text(sub_x.ceil, sub_y.ceil, sub)
     end
-     
   end
 
   # Draw a line between child/parent elements
@@ -191,11 +219,11 @@ class TreeGraph
     if (fromY == 0 )
       return
     end
-            
+
     fromTop  = row2px(fromY)
-    fromLeft = (fromX + fromW / 2 + B_SIDE)
+    fromLeft = (fromX + fromW / 2 + @m[:b_side])
     toBot    = (row2px(fromY - 1 ) + @e_height)
-    toLeft  = (toX + toW / 2 + B_SIDE)
+    toLeft  = (toX + toW / 2 + @m[:b_side])
 
     @gc.fill("none")
     @gc.stroke @col_line
@@ -204,27 +232,27 @@ class TreeGraph
   end
 
   # Draw a triangle between child/parent elements
-  def triangle_to_parent(fromX, fromY, fromW, toX, textW, symmetrize = true)
+  def triangle_to_parent(fromX, fromY, fromW, textW, symmetrize = true)
     if (fromY == 0)
       return
     end
-      
+
     toX = fromX
-    fromCenter = (fromX + fromW / 2 + B_SIDE)
-    
+    fromCenter = (fromX + fromW / 2 + @m[:b_side])
+
     fromTop  = row2px(fromY).ceil
     fromLeft1 = (fromCenter + textW / 2).ceil
     fromLeft2 = (fromCenter - textW / 2).ceil
     toBot    = (row2px(fromY - 1) + @e_height)
     if symmetrize
-      toLeft   = (toX + textW / 2 + B_SIDE)
+      toLeft   = (toX + textW / 2 + @m[:b_side])
     else
-      toLeft   = (toX + textW / 2 + B_SIDE * 3)
+      toLeft   = (toX + textW / 2 + @m[:b_side] * 3)
     end
-        
+
     @gc.fill("none")
     @gc.stroke @col_line
-    @gc.stroke_width 1    
+    @gc.stroke_width 1
     @gc.line(fromLeft1, fromTop, toLeft, toBot)
     @gc.line(fromLeft2, fromTop, toLeft, toBot)
     @gc.line(fromLeft1, fromTop, fromLeft2, fromTop)
@@ -239,9 +267,9 @@ class TreeGraph
     children = @e_list.get_children(id)
     @e_list.set_element_width(id, target)
 
-    if(children.length > 0 ) 
+    if(children.length > 0 )
       delta = target - current
-      target_delta = delta / children.length 
+      target_delta = delta / children.length
 
       children.each do |child|
         child_width = @e_list.get_element_width(child)
@@ -250,212 +278,17 @@ class TreeGraph
     end
   end
 
-  # Calculate the width of the element. If the element is
-  #   a node, the calculation will be performed recursively
-  #   for all child elements.
-  def calc_element_width(e)
-    w = 0
-        
-    children = @e_list.get_children(e.id)
-
-    if(children.length == 0)
-      w = img_get_txt_width(e.content, @font, @font_size) + @font_size
-    else
-      children.each do |child|
-        child_e = @e_list.get_id(child)
-        w += calc_element_width(child_e)
-      end
-
-      tw = img_get_txt_width(e.content, @font, @font_size) + @font_size
-      if(tw > w)
-        fix_child_size(e.id, w, tw)
-        w = tw
-      end
-    end
-
-    @e_list.set_element_width(e.id, w)
-    return w
-  end
-
-  # Calculate the width of all elements in a certain level
-  def calc_level_width(l)
-    w = 0
-    e = @e_list.get_first
-    while e
-      if(e.level == l)
-        w += calc_element_width(e)
-      end
-        e = @e_list.get_next
-    end
-
-    return w
-  end
-
-  def calc_children_width(id)
-    left = 0
-    right = 0
-    c_list = @e_list.get_children(id)
-    return nil if c_list.empty?
-    
-    c_list.each do |c|
-      left =  c.indent if indent == 0 or left > c.indent
+  def img_get_txt_width(text, font, font_size, multiline = false)
+    parts = text.split("_", 2)
+    main_before = parts[0].strip
+    sub = parts[1]
+    main = get_txt_only(main_before)
+    main_metrics = img_get_txt_metrics(main, font, font_size, multiline)
+    width = main_metrics.width
+    if sub
+      sub_metrics = img_get_txt_metrics(sub.strip, font, font_size * SUBSCRIPT_CONST, multiline)
+      width += sub_metrics.width
     end
-    c_list.each do |c|
-      right = c.indent + e.width if c.indent + c.width > right
-    end
-    return [left, right]
-  end
-
-  def get_children_indent(id)
-    calc_children_width(id)[0]
-  end
-  
-  def get_children_width(id)
-    calc_children_width(id)[1] - get_children_indent(id)
-  end
-
-  # Parse the elements in the list top to bottom and
-  #   draw the elements into the image.
-  #   As we it iterate through the levels, the element
-  #   indentation is calculated.
-  def parse_list
-
-    # Calc element list recursively....
-    e_arr = @e_list.get_elements
-     
-    h = @e_list.get_level_height
-    h.times do |i|
-      x = 0
-      e_arr.each do |j|
-
-        if (j.level == i)
-          cw = @e_list.get_element_width(j.id)
-          parent_indent = @e_list.get_indent(j.parent)
-          if (x <  parent_indent)
-            x = parent_indent
-          end
-          @e_list.set_indent(j.id, x)
-
-          if !@symmetrize
-            draw_element(x, i, cw, j.content, j.type)
-            if(j.parent != 0 )
-              words = j.content.split(" ")
-              unless @terminal == "nothing" && ETYPE_LEAF == j.type
-                if (@terminal == "triangle" && ETYPE_LEAF == j.type && x == parent_indent && words.length > 0)
-                  txt_width = img_get_txt_width(j.content, @font, @font_size)
-                  triangle_to_parent(x, i, cw, @e_list.get_element_width(j.parent), txt_width)
-                elsif (@terminal == "auto" && ETYPE_LEAF == j.type && x == parent_indent)
-                   if words.length > 1 || j.triangle
-                     txt_width = img_get_txt_width(j.content, @font, @font_size)
-                     triangle_to_parent(x, i, cw, @e_list.get_element_width(j.parent), txt_width, @symmetrize)
-                   else
-                     line_to_parent(x, i, cw, @e_list.get_indent(j.parent), @e_list.get_element_width(j.parent))
-                   end
-                else
-                  line_to_parent(x, i, cw, @e_list.get_indent(j.parent), @e_list.get_element_width(j.parent))
-                end
-              end
-            end
-          end          
-
-          x += cw
-        end
-      end
-    end
-    return true if !@symmetrize
-    h.times do |i|
-      curlevel = h - i - 1
-      indent = 0
-      e_arr.each_with_index do |j, idx|
-        if (j.level == curlevel)
-          # Draw a line to the parent element
-          children = @e_list.get_children(j.id)
-
-          tw = img_get_txt_width(j.content, @font, @font_size)
-          if children.length > 1
-            left, right = -1, -1
-            children.each do |child|          
-              k = @e_list.get_id(child)
-              kw = img_get_txt_width(k.content, @font, @font_size)              
-              left = k.indent + kw / 2 if k.indent + kw / 2 < left or left == -1
-              right = k.indent + kw / 2 if k.indent + kw / 2 > right
-            end
-            draw_element(left, curlevel, right - left, j.content, j.type)
-            @e_list.set_indent(j.id, left + (right - left) / 2 -  tw / 2)
-
-            children.each do |child|
-              k = @e_list.get_id(child)
-              words = k.content.split(" ")
-              dw = img_get_txt_width(k.content, @font, @font_size)
-              unless @terminal == "nothing" && ETYPE_LEAF == k.type
-                if (@terminal == "triangle" && ETYPE_LEAF == k.type && k.indent == j.indent && words.length > 0)
-                  txt_width = img_get_txt_width(k.content, @font, @font_size)
-                  triangle_to_parent(k.indent, curlevel + 1, dw, tw, txt_width)
-                elsif (@terminal == "auto" && ETYPE_LEAF == k.type && k.indent == j.indent)
-                  if words.length > 1 || k.triangle
-                    txt_width = img_get_txt_width(k.content, @font, @font_size)
-                    triangle_to_parent(k.indent, curlevel + 1, dw, tw, txt_width)
-                  else
-                    line_to_parent(k.indent, curlevel + 1, dw, j.indent, tw)
-                  end
-                else
-                  line_to_parent(k.indent, curlevel + 1, dw, j.indent, tw)
-                end
-              end
-            end
-            
-          else
-            unless children.empty?
-              k = @e_list.get_id(children[0])
-              kw = img_get_txt_width(k.content, @font, @font_size)              
-              left = k.indent
-              right = k.indent + kw
-              draw_element(left, curlevel, right - left, j.content, j.type)
-              @e_list.set_indent(j.id, left + (right - left) / 2 -  tw / 2)
-            else
-             parent = @e_list.get_id(j.parent)
-             pw = img_get_txt_width(parent.content, @font, @font_size)
-             pleft = parent.indent
-             pright = pleft + pw
-             left = j.indent
-             right = left + tw
-             if pw > tw
-               left = pleft
-               right = pright
-             end
-             draw_element(left, curlevel, right - left, j.content, j.type) 
-             @e_list.set_indent(j.id, left + (right - left) / 2 -  tw / 2)             
-            end
-
-            unless children.empty?
-              k = @e_list.get_id(children[0])
-              words = k.content.split(" ")
-              dw = img_get_txt_width(k.content, @font, @font_size)
-              unless @terminal == "nothing" && ETYPE_LEAF == k.type
-                if (@terminal == "triangle" && ETYPE_LEAF == k.type && words.length > 0)
-                  txt_width = img_get_txt_width(k.content, @font, @font_size)
-                  triangle_to_parent(k.indent, curlevel + 1, dw, 
-                                     @e_list.get_element_width(k.parent), txt_width)
-                elsif (@terminal == "auto" && ETYPE_LEAF == k.type)
-                  if words.length > 1 || k.triangle
-                    txt_width = img_get_txt_width(k.content, @font, @font_size)
-                    triangle_to_parent(k.indent, curlevel + 1, dw, @e_list.get_element_width(k.parent), txt_width)
-                  else
-                    line_to_parent(k.indent, curlevel + 1, dw, j.indent, tw)
-                  end
-                else
-                  line_to_parent(k.indent, curlevel + 1, dw, j.indent, tw)
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-
-  def row2px(row)
-   B_TOPBOT + @e_height * row + (V_SPACE + @font_size) * row
+    return width
   end
-  
 end