jruby_visualizer 0.1

data/bin/jruby_visualizer

@@ -0,0 +1,5 @@
+#!/usr/bin/env jruby
+
+require 'jruby_visualizer'
+
+JRubyVisualizer.visualize_with_argv

data/lib/jruby_visualizer.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env jruby
+
+require 'java'
+
+require_relative 'jruby_visualizer/jruby_visualizer'
+
+if __FILE__ == $PROGRAM_NAME
+  JRubyVisualizer.visualize_with_argv
+end

data/lib/jruby_visualizer/about_page.rb

@@ -0,0 +1,64 @@
+=begin
+JRuby Visualizer
+Copyright (C) 2013 The JRuby Team
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+require 'jrubyfx'
+
+resource_root :images, File.join(File.dirname(__FILE__), 'ui', 'img'), 'ui/img'
+fxml_root File.join(File.dirname(__FILE__), 'ui')
+
+#
+# JRubyFX Application showing information about the Visualizer
+#
+class AboutPage < JRubyFX::Application
+
+  def start(stage)
+    with(stage, title: 'About the JRuby Visualizer') do
+      fxml(AboutPageController)
+      icons.add(Image.new(resource_url(:images, 'jruby-icon-32.png').to_s))
+    end
+  
+    stage['#jruby_logo'].set_on_mouse_clicked do |e|
+        open_browser_with('http://jruby.org')
+    end
+    stage['#jruby_hyperlink'].set_on_action do |e|
+        open_browser_with('http://jruby.org')
+    end
+    stage['#visualizer_hyperlink'].set_on_action do |e|
+      open_browser_with('https://github.com/jruby/jruby-visualizer')
+    end
+    stage.show
+  end
+
+  def open_browser_with(url)
+    get_host_services.show_document(url)
+  end
+
+end
+
+#
+# Controller loads the fxml file for the About Page
+#
+class AboutPageController
+  include JRubyFX::Controller
+  fxml 'about.fxml'
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  AboutPage.launch
+end
+

data/lib/jruby_visualizer/ast_tree_view_builder.rb

@@ -0,0 +1,77 @@
+=begin
+JRuby Visualizer
+Copyright (C) 2013 The JRuby Team
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+require 'java'
+require 'jrubyfx'
+
+#
+# Custom TreeItem, to store the JRuby's AST Node within the item
+#
+class ASTTreeItem < Java::javafx.scene.control.TreeItem
+  include JRubyFX
+
+  attr_reader :node
+
+  def initialize(node)
+    @node = node
+    super(node_string)
+    set_expanded(true)
+  end
+
+  def node_string
+    node_information = @node.respond_to?(:name) ? ":#{@node.name}" : ''
+    "#{@node.node_name}#{node_information} #{@node.position.start_line}"
+  end
+
+end
+
+
+#
+# Builder for the custom TreeItem from an usual JRuby AST
+#
+class ASTTreeViewBuilder
+  include JRubyFX
+
+  attr_accessor :tree_view
+
+  def initialize(tree_view)
+    @tree_view = tree_view
+  end
+
+  def build_tree_item(node)
+    ASTTreeItem.new(node)
+  end
+
+  def build_view(root)
+    @tree_view.root = build_tree_item(root)
+    root.child_nodes.each { |child| build_view_inner(child, @tree_view.root) }
+  end
+
+  def build_view_inner(node, parent_item)
+    tree_item = build_tree_item(node)
+    parent_item.children << tree_item
+    node.child_nodes.each { |child| build_view_inner(child, tree_item) }
+  end
+  private :build_view_inner
+end
+
+if __FILE__ == $PROGRAM_NAME
+  require 'jruby'
+  root = JRuby.parse('def foo; 42; end; foo')
+  builder = ASTTreeViewBuilder.new(nil)
+  builder.build_view(root)
+end

data/lib/jruby_visualizer/cfg_visualizer.rb

@@ -0,0 +1,122 @@
+=begin
+JRuby Visualizer
+Copyright (C) 2013 The JRuby Team
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+require 'jrubyfx'
+require_relative 'jruby_visualizer'
+require_relative 'ir_scope_registry'
+require_relative 'control_flow_graph_view'
+
+resource_root :images, File.join(File.dirname(__FILE__), 'ui', 'img'), 'ui/img'
+fxml_root File.join(File.dirname(__FILE__), 'ui')
+
+#
+# UI to visualize the IR's Control Flow Graph (CFG)
+# Currently as a list view with live links between the basic blocks
+#
+class CFGVisualizer < JRubyFX::Application
+  def start(stage)
+    compiler_data = JRubyVisualizer.compiler_data
+    with(stage, title: 'Visualization of Control Flow Graphs (CFG)') do
+      fxml(CFGVisualizerController, initialize: [compiler_data])
+      icons.add(Image.new(resource_url(:images, 'jruby-icon-32.png').to_s))
+      show
+    end
+  end
+end
+
+#
+# This controller connects the CompilerData to the CFG View and
+# handles opening/updating tabs for CFGs
+#
+class CFGVisualizerController
+  include JRubyFX::Controller
+  fxml 'cfg-view.fxml'
+
+  attr_reader :compiler_data, :ir_registry
+
+  def initialize(compiler_data)
+    @compiler_data = compiler_data
+  
+    # read scopes into the registry
+    @ir_registry = IRScopeRegistry.new(@compiler_data.ir_scope)
+    read_registry_into_selector
+    # listen to changes of the ir_scope property
+    @compiler_data.ir_scope_property.add_invalidation_listener do |new_scope_property|
+      root_scope = new_scope_property.get
+      @ir_registry.clear
+      @ir_registry.fill_registry(root_scope)
+      read_registry_into_selector
+      update_tabs
+    end
+  end
+
+  def read_registry_into_selector
+    scopes_keys = @ir_registry.scopes.keys.map do |key|
+      key.to_s
+    end
+    scopes_keys.sort!
+    @ir_scope_selector.items = FXCollections.observable_array_list(scopes_keys)
+    @ir_scope_selector.value = @selected_scope = scopes_keys[0]
+  end
+
+  def select_scope
+    @selected_scope = @ir_scope_selector.value
+    open_cfg_tab
+  end
+
+  def open_cfg_tab
+    if @selected_scope.nil?
+      return
+    end
+  
+    tabs = @cfg_scopes_view.tabs
+    is_tab_opened = tabs.find do |tab|
+      # get string value from StringProperty name
+      tab.text == @selected_scope
+    end
+
+    unless is_tab_opened
+      tab = Tab.new(@selected_scope)
+      cfg = get_selected_scope.cfg!
+      tab.set_content(ControlFlowGraphView.new(cfg))
+      tabs << tab
+      # set focus on selected tab
+      @cfg_scopes_view.selection_model.select(tab)
+    end
+  end
+
+  def get_selected_scope
+    @ir_registry.scopes[@selected_scope.to_sym]
+  end
+
+  def update_tabs
+    @cfg_scopes_view.tabs.each do |tab|
+      scope_name = tab.text
+      # TODO read and diff on custom cfg objects
+      cfg = @ir_registry.scopes[scope_name.to_sym].cfg!
+      # TODO listen to events if the ir scope changes
+      tab.set_content(ControlFlowGraphView.new(cfg))
+    end
+  end
+  
+end
+
+if __FILE__ == $PROGRAM_NAME
+  JRubyVisualizer.compiler_data = CompilerData.new(
+    "\nclass Foo\n\ndef bar; 42; end; end;\nFoo.new.bar")
+  CFGVisualizer.launch
+end

data/lib/jruby_visualizer/compiler_data.rb

@@ -0,0 +1,133 @@
+=begin
+JRuby Visualizer
+Copyright (C) 2013 The JRuby Team
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+require 'jrubyfx'
+
+#
+# JavaFX Property that fires always when the set method is called
+#
+class FireChangeObjectProperty < Java::javafx.beans.property.SimpleObjectProperty
+  def initialize(*args)
+    raise ArgumentError.new "wrong number of arguments (#{args.length} for 3)" if args.length > 3
+    super
+  end
+
+  def set(new_val)
+    super(new_val)
+    fire_value_changed_event
+  end
+end
+
+#
+# Data container for
+#  * Abstract Syntax Tree (AST),
+#  * Intermediate Code (IR)
+#  * Ruby Code
+# It models and handles the dependencies between those compiler artifacts with
+# JRubyFX properties
+#
+class CompilerData
+  include JRubyFX
+
+  @@ir_builder = nil
+
+  property_accessor :ruby_code, :ast_root, :ir_scope
+  attr_accessor :current_pass, :next_pass
+
+  def self.parse(code)
+    JRuby.parse(code)
+  end
+  
+  def self.create_ir_builder
+    ir_manager = JRuby::runtime.ir_manager
+    ir_manager.dry_run = true
+
+    org.jruby.ir.IRBuilder::createIRBuilder(JRuby::runtime, ir_manager)
+  end
+
+  def self.build_ir(root_node)
+    unless @@ir_builder
+      @@ir_builder = create_ir_builder
+    end
+    @@ir_builder.build_root(root_node)
+  end
+
+  def self.pass_to_s(pass)
+    pass.class.to_s.split("::").last
+  end
+
+  def self.compiler_passes_names
+    scheduler = JRuby::runtime.ir_manager.schedule_passes
+    scheduler.map do |pass|
+      pass_to_s(pass)
+    end
+  end
+
+  def reset_scheduler
+    ir_manager = JRuby::runtime.ir_manager
+    @scheduler = ir_manager.schedule_passes.iterator
+    if @scheduler.has_next
+      @current_pass = nil
+      @next_pass = @scheduler.next
+    else
+      @current_pass = @next_pass = nil
+    end
+    # trigger to re build the old ir scope
+    @ir_scope.set(self.class.build_ir(@ast_root.get))
+  end
+
+  def initialize(ruby_code='')
+    @ruby_code = SimpleStringProperty.new(ruby_code)
+    @ast_root = SimpleObjectProperty.new(self, 'ast_root', self.class.parse(ruby_code))
+    @ir_scope = FireChangeObjectProperty.new(self, 'ir_scope', self.class.build_ir(@ast_root.get))
+    # bind change of Ruby code to reparsing an AST and set the property
+    @ruby_code.add_invalidation_listener do |new_code_property|
+      @ast_root.set(self.class.parse(new_code_property.get))
+    end
+    # bind change of AST to rebuilding IR and set the property
+    @ast_root.add_invalidation_listener do |new_ast_property|
+      @ir_scope.set(self.class.build_ir(new_ast_property.get))
+    end
+
+    # initialize scheduler
+    reset_scheduler
+  end
+
+  def self.run_pass_on_all_scopes(pass, scope)
+    pass.run(scope)
+    scope.lexical_scopes.each do |lex_scope|
+      run_pass_on_all_scopes(pass, lex_scope)
+    end
+  end
+
+  def step_ir_passes
+    if @next_pass
+      @current_pass = @next_pass
+      @next_pass =
+        if @scheduler.has_next
+          @scheduler.next
+        else
+          nil
+        end
+      scope = @ir_scope.get
+      self.class.run_pass_on_all_scopes(@current_pass, scope)
+      @ir_scope.set(scope)
+    end
+  end
+
+end
+

data/lib/jruby_visualizer/control_flow_graph_view.rb

@@ -0,0 +1,96 @@
+=begin
+JRuby Visualizer
+Copyright (C) 2013 The JRuby Team
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+require 'jrubyfx'
+
+#
+# A custom JRubyFX control for a basic block of a CFG. This view is a composite
+# with a TextArea for the basic blocks and live links to basic blocks that
+# can succeed after this one
+#
+class BasicBlockBox < Java::javafx.scene.layout.VBox
+  include JRubyFX
+
+  attr_reader :basic_block, :instrs_box, :successors, :successor_buttons
+
+  def initialize(basic_block, cfg, cfg_list_view)
+    super(5)
+    @basic_block = basic_block
+    instructions = instrs
+    @instrs_box = TextArea.new(instructions)
+    line_no = instructions.lines.count
+    @instrs_box.set_pref_row_count(line_no)
+    @instrs_box.set_style('-fx-font-family: monospaced')
+    @instrs_box.set_editable(false)
+    @successors = cfg.get_outgoing_destinations(@basic_block).to_a
+    if @successors.empty?
+      get_children << @instrs_box
+    else
+      @successor_buttons = @successors.map do |bb|
+        button = Button.new(bb.to_s)
+        button.set_on_action do
+          # TODO rewrite this ugly code
+          i = button.get_text.scan(/.*\[(\d+):.*\]/)[0][0]
+          index = i.to_i - 1
+          cfg_list_view.selection_model.select(index)
+          cfg_list_view.focus_model.focus(index)
+          cfg_list_view.scroll_to(index)
+        end
+        button
+      end
+
+      successors_layout = HBox.new(5)
+      successors_layout.get_children << Label.new('Successors: ')
+      successors_layout.get_children.add_all(@successor_buttons)
+
+      get_children.add_all(@instrs_box, successors_layout)
+    end
+  end
+
+  def instrs
+    instrs_string = @basic_block.to_string_instrs
+    if instrs_string.end_with?("\n")
+      instrs_string[0...-1]
+    else
+      instrs_string
+    end
+  end
+
+end
+
+#
+# The UI for the CFG as a wrapper for a ListView that is directly built
+# from JRuby's CFG. In order to get a resizable UI element, a BorderPane is
+# used
+#
+class ControlFlowGraphView < Java::javafx.scene.layout.BorderPane
+  include JRubyFX
+
+  def initialize(cfg)
+    super()
+    @cfg = cfg
+    @cfg_list_view = ListView.new
+    @bb_cells = FXCollections.observable_array_list([])
+    @cfg.sorted_basic_blocks.each do |bb|
+      bb_cell = BasicBlockBox.new(bb, cfg, @cfg_list_view)
+      @bb_cells << bb_cell
+    end
+    @cfg_list_view.set_items(@bb_cells)
+    set_center(@cfg_list_view)
+  end
+
+end