jruby_visualizer 0.1

data/lib/jruby_visualizer/core_ext/ir_scope.rb

@@ -0,0 +1,15 @@
+class Java::org::jruby::ir::IRScope
+  ##
+  # Return a key for storage into the ScopeRegistry.
+  def key
+    "#{get_name}[#{get_file_name}:#{get_line_number}]".to_sym
+  end
+
+  ##
+  # return the CFG and if it is not created yet construct it as
+  # a side-effect
+  def cfg!
+    buildCFG unless get_cfg
+    get_cfg
+  end
+end

data/lib/jruby_visualizer/ir_pretty_printer.rb

@@ -0,0 +1,57 @@
+=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
+
+#
+# Retrieve a nicely formatted string from JRuby's IRScope
+#
+module IRPrettyPrinter
+  
+  def self.pretty_ir(scope, indent='')
+    instrs = if scope.cfg
+      # read instrs from control flow graph
+      scope.cfg.sorted_basic_blocks.reduce([]) do |cfg_instrs, bb|
+        cfg_instrs += bb.instrs
+      end
+    else
+      # if no pass has been executed get them directly without cfg
+      scope.instrs
+    end
+    pretty_str = instrs.map do |instr|
+      f_str = "%s\s\s%s" % [indent, instr]
+      f_str
+    end
+    pretty_str = [indent + scope.to_s] + pretty_str
+    scope.lexical_scopes.each do |lex_scope|
+      pretty_str += pretty_ir(lex_scope, indent + "\s" * 4)
+    end
+    pretty_str
+  end
+
+  def self.print_ir(scope)
+    instrs = pretty_ir(scope)
+    instrs.each do |instr|
+      puts instr
+    end
+  end
+
+  def self.pretty_string(scope)
+    instrs = pretty_ir(scope)
+    instrs.join("\n")
+  end
+
+end
+

data/lib/jruby_visualizer/ir_scope_registry.rb

@@ -0,0 +1,41 @@
+=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_relative 'core_ext/ir_scope'
+
+#
+# Registry for IRScopes, to access them by key without nesting of scopes
+#
+class IRScopeRegistry
+
+  attr_reader :scopes
+
+  def initialize(root_scope)
+    @scopes = {}
+    fill_registry(root_scope)
+  end
+
+  def fill_registry(ir_scope)
+    @scopes[ir_scope.key] = ir_scope
+    ir_scope.lexical_scopes.each { |lex_scope| fill_registry(lex_scope) }
+  end
+
+  def clear
+    @scopes = {}
+  end
+
+end

data/lib/jruby_visualizer/ir_visualizer.rb

@@ -0,0 +1,79 @@
+=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 'diffy'
+require_relative 'ir_pretty_printer'
+require_relative 'jruby_visualizer'
+
+resource_root :images, File.join(File.dirname(__FILE__), 'ui', 'img'), 'ui/img'
+fxml_root File.join(File.dirname(__FILE__), 'ui')
+
+#
+# Visualizer for JRuby's Intermediate Representation (IR)
+# displaying all IR Scopes with its lexical nesting
+# and
+# diffs on the IR, if it has changed (after executing a compiler pass)
+#
+class IRVisualizer < JRubyFX::Application
+
+  def start(stage)
+    compiler_data = JRubyVisualizer.compiler_data
+    with(stage, title: 'Intermediate Representation (IR) Visualizer') do
+      fxml(IRVisualizerController, initialize: [compiler_data])
+      icons.add(Image.new(resource_url(:images, 'jruby-icon-32.png').to_s))
+      show
+    end
+  end
+end
+
+#
+# The controller loads the UI file and takes care of the diffs and
+# updating the UI
+#
+class IRVisualizerController
+  include JRubyFX::Controller
+  fxml 'ir-view.fxml'
+
+  attr_reader :compiler_data
+
+  def initialize(compiler_data)
+    @compiler_data = compiler_data
+    pretty_ir_string = IRPrettyPrinter.pretty_string(@compiler_data.ir_scope)
+    @ir_view.text = @new_ir_string = @previous_ir_string = pretty_ir_string
+
+    @compiler_data.ir_scope_property.add_invalidation_listener do |new_scope_property|
+      @previous_ir_string = @new_ir_string
+      @new_ir_string = IRPrettyPrinter.pretty_string(new_scope_property.get)
+      diff_string = Diffy::Diff.new(@previous_ir_string, @new_ir_string).to_s
+      @ir_view.text =
+      if diff_string.empty?
+        @new_ir_string
+      else
+        diff_string
+      end
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  JRubyVisualizer.compiler_data = CompilerData.new(
+    "a = 1 + 4 + 7;\nc = nil;\nj = 1;\ni = 3 + j;\nputs i")
+  IRVisualizer.launch
+end
+

data/lib/jruby_visualizer/jruby_visualizer.rb

@@ -0,0 +1,103 @@
+=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 'jruby'
+require_relative 'visualizer_compiler_pass_listener'
+require_relative 'visualizer_main_app'
+
+#
+# The Visualizer module enables to launch the visualizer components via
+# an API call or ARGV
+#
+module JRubyVisualizer
+  @@main_app = nil
+  @@compiler_data = nil
+
+  def self.compiler_data
+    @@compiler_data
+  end
+
+  def self.compiler_data=(new_data)
+    @@compiler_data = new_data
+  end
+
+  def self.launched?
+    !!@@main_app
+  end
+
+  def self.launch
+    if launched?
+      return
+    end
+    unless @@compiler_data
+      raise 'Cannot launch Visualizer without a ComiplerData object'
+    end
+    VisualizerMainApp.launch
+    @@main_app = VisualizerMainApp
+  end
+
+  def self.inject_pass_listener
+    # create and add listener
+    vis_pass_listener = VisualizerCompilerPassListener.new
+    ir_manager = JRuby::runtime.ir_manager
+    ir_manager.add_listener(vis_pass_listener)
+
+    # activate visualization listener
+    JRuby::IR.visualize = true
+  end
+
+  def self.pass_listener?
+    JRuby::IR.visualize
+  end
+
+  def self.visualize(ruby_code)
+    unless pass_listener?
+      inject_pass_listener
+    end
+    @@compiler_data = CompilerData.new(ruby_code)
+    # launch App with Ruby code as input
+    launch
+  end
+
+  def self.visualize_with_argv
+    unless ARGV.length == 1
+      usage_message =
+      %#No ruby input for the JRuby Visualizer
+  Usage: 
+    ./lib/jruby_visualizer.rb "def foo; 42; end; foo"
+  or
+    ./lib/jruby_visualizer.rb foo.rb#
+      raise usage_message
+    end
+    ruby_input = ARGV[0]
+    ruby_code =
+    if ruby_input.end_with?('.rb')
+      File.read(ruby_input)
+    else
+      ruby_input
+    end
+    visualize(ruby_code)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  vis = JRubyVisualizer
+  vis.visualize('def foo; 42; end; foo')
+end
+

data/lib/jruby_visualizer/ui/about.fxml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<?import java.lang.*?>
+<?import java.util.*?>
+<?import javafx.scene.control.*?>
+<?import javafx.scene.image.*?>
+<?import javafx.scene.layout.*?>
+<?import javafx.scene.paint.*?>
+<?import javafx.scene.text.*?>
+
+<VBox alignment="CENTER" prefHeight="300.0" prefWidth="500.0" xmlns:fx="http://javafx.com/fxml/1" xmlns="http://javafx.com/javafx/2.2">
+  <children>
+    <HBox alignment="CENTER" prefHeight="-1.0" prefWidth="-1.0">
+      <children>
+        <Label text="JRuby:" />
+        <Hyperlink fx:id="jruby_hyperlink" text="www.jruby.org">
+          <font>
+            <Font name="Monospaced Regular" size="13.0" />
+          </font>
+        </Hyperlink>
+      </children>
+    </HBox>
+    <ImageView fx:id="jruby_logo" fitHeight="150.0" fitWidth="200.0" pickOnBounds="true" preserveRatio="true">
+      <image>
+        <Image url="@img/jruby-logo.png" />
+      </image>
+    </ImageView>
+    <Hyperlink fx:id="visualizer_hyperlink" text="The JRuby Visualizer">
+      <font>
+        <Font name="System Bold" size="20.0" />
+      </font>
+    </Hyperlink>
+    <TextArea editable="false" prefWidth="200.0" text="visualizes JRuby's Compiler and Interpreter artifacts:&#10;- the Abstract Syntax Tree (AST)&#10;- the Intermediate Representation (IR)&#10;- the execution of compiler passes on IR&#10;- a visualization for the Control Flow Graphs (CFGs) on JRuby Scopes" wrapText="true" />
+  </children>
+</VBox>

data/lib/jruby_visualizer/ui/cfg-view.fxml

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<?import java.lang.*?>
+<?import java.util.*?>
+<?import javafx.collections.*?>
+<?import javafx.geometry.*?>
+<?import javafx.scene.control.*?>
+<?import javafx.scene.image.*?>
+<?import javafx.scene.layout.*?>
+<?import javafx.scene.paint.*?>
+
+<BorderPane prefHeight="400.0" prefWidth="600.0" xmlns:fx="http://javafx.com/fxml/1" xmlns="http://javafx.com/javafx/2.2">
+  <center>
+    <TabPane id="ir_scopes" fx:id="cfg_scopes_view" prefHeight="200.0" prefWidth="200.0" tabClosingPolicy="UNAVAILABLE" />
+  </center>
+  <padding>
+    <Insets />
+  </padding>
+  <top>
+    <HBox prefHeight="25.0" prefWidth="600.0" spacing="5.0" BorderPane.alignment="CENTER">
+      <children>
+        <Label text="Scope">
+          <HBox.margin>
+            <Insets bottom="5.0" left="5.0" top="8.0" />
+          </HBox.margin>
+        </Label>
+        <ComboBox fx:id="ir_scope_selector" onAction="#select_scope" prefWidth="201.0">
+          <items>
+            <FXCollections fx:factory="observableArrayList">
+              <String fx:value="Item 1" />
+              <String fx:value="Item 2" />
+              <String fx:value="Item 3" />
+            </FXCollections>
+          </items>
+          <HBox.margin>
+            <Insets bottom="5.0" right="5.0" top="5.0" />
+          </HBox.margin>
+        </ComboBox>
+      </children>
+    </HBox>
+  </top>
+</BorderPane>

data/lib/jruby_visualizer/ui/ir-view.fxml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<?import java.lang.*?>
+<?import java.util.*?>
+<?import javafx.scene.control.*?>
+<?import javafx.scene.layout.*?>
+<?import javafx.scene.paint.*?>
+
+<BorderPane prefHeight="400.0" prefWidth="600.0" xmlns:fx="http://javafx.com/fxml/1" xmlns="http://javafx.com/javafx/2.2">
+  <center>
+    <VBox prefHeight="-1.0" prefWidth="-1.0">
+      <children>
+        <Label text="IR Code:" />
+        <TextArea id="ir" fx:id="ir_view" editable="false" minHeight="-1.0" prefWidth="-1.0" style="-fx-font-family: monospaced" text="Script: file: -ScriptBody -[-:0]&#10;  0  %self = recv_self&#10;  1  %current_scope = scope&lt;-&gt;&#10;  2  %current_module = module&lt;-&gt;&#10;  3  line_num(0)&#10;  4  def_inst_meth(&quot;--unused--&quot;, foo, -)&#10;  5  return(nil)&#10;    Method foo[-:0]&#10;      0  %self = recv_self&#10;      1  %current_scope = scope&lt;-&gt;&#10;      2  %current_module = module&lt;-&gt;&#10;      3  check_arity(0, 0, -1)&#10;      4  %block(0:0) = recv_closure&#10;      5  thread_poll&#10;      6  line_num(0)&#10;      7  %v_2 = &quot;bar&quot;&#10;      8  %v_3 = call(FUNCTIONAL, 'puts', %self, [%v_2])&#10;      9  return(%v_3)&#10;" wrapText="true" VBox.vgrow="ALWAYS" />
+      </children>
+    </VBox>
+  </center>
+</BorderPane>

data/lib/jruby_visualizer/ui/jruby-visualizer.fxml

@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<?import java.lang.*?>
+<?import java.util.*?>
+<?import javafx.collections.*?>
+<?import javafx.scene.control.*?>
+<?import javafx.scene.layout.*?>
+<?import javafx.scene.paint.*?>
+
+<BorderPane maxHeight="-Infinity" maxWidth="-Infinity" minHeight="-Infinity" minWidth="-Infinity" prefHeight="400.0" prefWidth="600.0" xmlns:fx="http://javafx.com/fxml/1" xmlns="http://javafx.com/javafx/2.2">
+  <center>
+    <SplitPane dividerPositions="0.6783625730994152" focusTraversable="true" orientation="VERTICAL" prefHeight="200.0" prefWidth="160.0">
+      <items>
+        <SplitPane dividerPositions="0.5" focusTraversable="true" prefHeight="160.0" prefWidth="200.0">
+          <items>
+            <VBox prefHeight="200.0" prefWidth="100.0">
+              <children>
+                <Label text="Abstract Syntax Tree:" />
+                <TreeView fx:id="ast_view" prefHeight="-1.0" prefWidth="-1.0" VBox.vgrow="ALWAYS" />
+              </children>
+            </VBox>
+            <VBox prefHeight="100.0" prefWidth="414.0">
+              <children>
+                <Label text="Ruby Source:" />
+                <TextArea id="ruby_source" fx:id="ruby_view" editable="false" prefHeight="258.0000999999975" prefWidth="330.0" style="-fx-font-family: monospaced" text="def foo&#10;  puts &quot;bar&quot;&#10;end" wrapText="true" VBox.vgrow="ALWAYS" />
+              </children>
+            </VBox>
+          </items>
+        </SplitPane>
+        <VBox prefHeight="-1.0" prefWidth="-1.0">
+          <children>
+            <Label id="compile_information" text="Information" />
+            <ListView fx:id="compile_information" prefHeight="-1.0" prefWidth="-1.0" VBox.vgrow="ALWAYS" />
+          </children>
+        </VBox>
+      </items>
+    </SplitPane>
+  </center>
+  <top>
+    <VBox prefHeight="-1.0" prefWidth="-1.0">
+      <children>
+        <MenuBar>
+          <menus>
+            <Menu mnemonicParsing="false" text="File">
+              <items>
+                <MenuItem mnemonicParsing="false" onAction="#close_app" text="Close" />
+              </items>
+            </Menu>
+            <Menu mnemonicParsing="false" text="View">
+              <items>
+                <MenuItem mnemonicParsing="false" onAction="#launch_ir_view" text="IR View" />
+                <MenuItem mnemonicParsing="false" onAction="#launch_cfg_view" text="Control Flow Graph" />
+              </items>
+            </Menu>
+            <Menu mnemonicParsing="false" text="Help">
+              <items>
+                <MenuItem mnemonicParsing="false" onAction="#launch_about" text="About" />
+              </items>
+            </Menu>
+          </menus>
+        </MenuBar>
+        <ToolBar>
+          <items>
+            <Label text="IRPasses:" />
+            <ComboBox fx:id="ir_passes_box" onAction="#select_ir_pass">
+              <items>
+                <FXCollections fx:factory="observableArrayList">
+                  <String fx:value="Item 1" />
+                  <String fx:value="Item 2" />
+                  <String fx:value="Item 3" />
+                </FXCollections>
+              </items>
+            </ComboBox>
+            <Button mnemonicParsing="false" onAction="#step_ir_pass" text="Step" />
+            <Button mnemonicParsing="false" onAction="#reset_passes" text="Reset" />
+          </items>
+        </ToolBar>
+      </children>
+    </VBox>
+  </top>
+</BorderPane>