seafoam 0.2

data/spec/seafoam/spec_helpers.rb

@@ -0,0 +1,30 @@
+module Seafoam
+  module SpecHelpers
+    SAMPLE_BGV = [
+      'fib-java.bgv',
+      'fib-js.bgv',
+      'fib-ruby.bgv',
+      'matmult-java.bgv',
+      'matmult-ruby.bgv'
+    ].map { |f| File.expand_path("../../examples/#{f}", __dir__) }
+
+    def self.example_graph(file, graph_index)
+      file = File.expand_path("../../examples/#{file}.bgv", __dir__)
+      parser = Seafoam::BGV::BGVParser.new(File.new(file))
+      parser.read_file_header
+      parser.skip_document_props
+      loop do
+        index, = parser.read_graph_preheader
+        raise unless index
+
+        if index == graph_index
+          parser.read_graph_header
+          break parser.read_graph
+        else
+          parser.skip_graph_header
+          parser.skip_graph
+        end
+      end
+    end
+  end
+end

data/spec/seafoam/spotlight_spec.rb

@@ -0,0 +1,38 @@
+require 'seafoam'
+
+require 'rspec'
+
+describe Seafoam::Spotlight do
+  before :each do
+    file = File.expand_path('../../examples/fib-java.bgv', __dir__)
+    parser = Seafoam::BGV::BGVParser.new(File.new(file))
+    parser.read_file_header
+    parser.skip_document_props
+    parser.read_graph_preheader
+    parser.read_graph_header
+    @graph = parser.read_graph
+  end
+
+  it 'marks individual nodes as lit' do
+    spotlight = Seafoam::Spotlight.new(@graph)
+    spotlight.light @graph.nodes[13]
+    expect(@graph.nodes[13].props[:spotlight]).to eq 'lit'
+  end
+
+  it 'marks surrounding nodes as shaded' do
+    spotlight = Seafoam::Spotlight.new(@graph)
+    spotlight.light @graph.nodes[13]
+    expect(@graph.nodes.values
+      .select { |n| n.props[:spotlight] == 'shaded' }
+      .map(&:id).sort).to eq [6, 12, 14, 18, 19, 20]
+  end
+
+  it 'marks other nodes as hidden' do
+    spotlight = Seafoam::Spotlight.new(@graph)
+    spotlight.light @graph.nodes[13]
+    spotlight.shade
+    expect(@graph.nodes.values
+      .select { |n| n.props[:hidden] }
+      .map(&:id).sort).to eq [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 15, 16, 17, 21]
+  end
+end

data/tools/render-all

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.push File.expand_path('../lib', __dir__)
+require 'seafoam'
+
+config = Seafoam::Config.new
+commands = Seafoam::Commands.new($stdout, config)
+
+extra = {
+  'exampleArrayRead' => [42],
+  'exampleDoubleSynchronized' => [48, 49],
+  'exampleFieldRead' => [42],
+  'exampleFullEscape' => [33],
+  'exampleInstanceOfManyImpls' => [65],
+  'exampleInstanceOfOneImpl' => [65],
+  'exampleInterfaceCallOneImpl' => [9],
+  'exampleInterfaceCallManyImpls' => [9],
+  'exampleLocalSynchronized' => [33],
+  'exampleNoEscape' => [33],
+  'examplePartialEscape' => [33],
+  'exampleUnsafeRead' => [42]
+}
+
+Dir.glob(File.expand_path('../examples/java/*.bgv', __dir__)).each do |bgv|
+  basename = File.basename(bgv, '.bgv')
+  phases = [6]
+  phases.push(*(extra[basename] || []))
+  extra_options = []
+  if basename == 'exampleLocalVariablesState'
+    extra_options.push '--show-frame-state'
+  end
+  phases.each do |phase|
+    commands.run "#{bgv}:#{phase}", 'render', *extra_options, '--out', File.expand_path("../#{basename}@#{phase}.png", __dir__)
+    commands.run "#{bgv}:#{phase}", 'render', *extra_options, '--out', File.expand_path("../#{basename}@#{phase}.svg", __dir__)
+  end
+end

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: seafoam
+version: !ruby/object:Gem::Version
+  version: '0.2'
+platform: ruby
+authors:
+- Chris Seaton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.74'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.74'
+description:
+email:
+executables:
+- seafoam
+- bgv2json
+- bgv2isabelle
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/probots.yml"
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/specs.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".seafoam/config"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- bin/bgv2isabelle
+- bin/bgv2json
+- bin/seafoam
+- docs/annotators.md
+- docs/bgv.md
+- docs/getting-graphs.md
+- docs/images/igv.png
+- docs/images/seafoam.png
+- docs/images/spotlight-igv.png
+- docs/images/spotlight-seafoam.png
+- examples/Fib.java
+- examples/MatMult.java
+- examples/fib-java.bgv
+- examples/fib-js.bgv
+- examples/fib-ruby.bgv
+- examples/fib.js
+- examples/fib.rb
+- examples/identity.bgv
+- examples/identity.rb
+- examples/java/Irreducible.class
+- examples/java/Irreducible.j
+- examples/java/IrreducibleDecompiled.java
+- examples/java/JavaExamples.java
+- examples/java/exampleArithOperator.bgv
+- examples/java/exampleArithOperator.cfg
+- examples/java/exampleArrayAllocation.bgv
+- examples/java/exampleArrayAllocation.cfg
+- examples/java/exampleArrayRead.bgv
+- examples/java/exampleArrayRead.cfg
+- examples/java/exampleArrayWrite.bgv
+- examples/java/exampleArrayWrite.cfg
+- examples/java/exampleCatch.bgv
+- examples/java/exampleCatch.cfg
+- examples/java/exampleCompareOperator.bgv
+- examples/java/exampleCompareOperator.cfg
+- examples/java/exampleDoubleSynchronized.bgv
+- examples/java/exampleDoubleSynchronized.cfg
+- examples/java/exampleExactArith.bgv
+- examples/java/exampleExactArith.cfg
+- examples/java/exampleFieldRead.bgv
+- examples/java/exampleFieldRead.cfg
+- examples/java/exampleFieldWrite.bgv
+- examples/java/exampleFieldWrite.cfg
+- examples/java/exampleFor.bgv
+- examples/java/exampleFor.cfg
+- examples/java/exampleFullEscape.bgv
+- examples/java/exampleFullEscape.cfg
+- examples/java/exampleIf.bgv
+- examples/java/exampleIf.cfg
+- examples/java/exampleIfNeverTaken.bgv
+- examples/java/exampleIfNeverTaken.cfg
+- examples/java/exampleInstanceOfManyImpls.bgv
+- examples/java/exampleInstanceOfManyImpls.cfg
+- examples/java/exampleInstanceOfOneImpl.bgv
+- examples/java/exampleInstanceOfOneImpl.cfg
+- examples/java/exampleIntSwitch.bgv
+- examples/java/exampleIntSwitch.cfg
+- examples/java/exampleInterfaceCallManyImpls.bgv
+- examples/java/exampleInterfaceCallManyImpls.cfg
+- examples/java/exampleInterfaceCallOneImpl.bgv
+- examples/java/exampleInterfaceCallOneImpl.cfg
+- examples/java/exampleLocalInstanceOf.bgv
+- examples/java/exampleLocalInstanceOf.cfg
+- examples/java/exampleLocalSynchronized.bgv
+- examples/java/exampleLocalSynchronized.cfg
+- examples/java/exampleLocalVariables.bgv
+- examples/java/exampleLocalVariables.cfg
+- examples/java/exampleLocalVariablesState.bgv
+- examples/java/exampleLocalVariablesState.cfg
+- examples/java/exampleNestedWhile.bgv
+- examples/java/exampleNestedWhile.cfg
+- examples/java/exampleNestedWhileBreak.bgv
+- examples/java/exampleNestedWhileBreak.cfg
+- examples/java/exampleNoEscape.bgv
+- examples/java/exampleNoEscape.cfg
+- examples/java/exampleObjectAllocation.bgv
+- examples/java/exampleObjectAllocation.cfg
+- examples/java/examplePartialEscape.bgv
+- examples/java/examplePartialEscape.cfg
+- examples/java/examplePhi.bgv
+- examples/java/examplePhi.cfg
+- examples/java/exampleReducible.bgv
+- examples/java/exampleReducible.cfg
+- examples/java/exampleSimpleCall.bgv
+- examples/java/exampleSimpleCall.cfg
+- examples/java/exampleStamp.bgv
+- examples/java/exampleStamp.cfg
+- examples/java/exampleStaticCall.bgv
+- examples/java/exampleStaticCall.cfg
+- examples/java/exampleStringSwitch.bgv
+- examples/java/exampleStringSwitch.cfg
+- examples/java/exampleSynchronized.bgv
+- examples/java/exampleSynchronized.cfg
+- examples/java/exampleThrow.bgv
+- examples/java/exampleThrow.cfg
+- examples/java/exampleThrowCatch.bgv
+- examples/java/exampleThrowCatch.cfg
+- examples/java/exampleUnsafeRead.bgv
+- examples/java/exampleUnsafeRead.cfg
+- examples/java/exampleUnsafeWrite.bgv
+- examples/java/exampleUnsafeWrite.cfg
+- examples/java/exampleWhile.bgv
+- examples/java/exampleWhile.cfg
+- examples/java/exampleWhileBreak.bgv
+- examples/java/exampleWhileBreak.cfg
+- examples/matmult-java.bgv
+- examples/matmult-ruby.bgv
+- examples/matmult.rb
+- examples/overflow.bgv
+- examples/overflow.rb
+- lib/seafoam.rb
+- lib/seafoam/annotators.rb
+- lib/seafoam/annotators/fallback.rb
+- lib/seafoam/annotators/graal.rb
+- lib/seafoam/bgv/bgv_parser.rb
+- lib/seafoam/binary/binary_reader.rb
+- lib/seafoam/binary/io_binary_reader.rb
+- lib/seafoam/colors.rb
+- lib/seafoam/commands.rb
+- lib/seafoam/config.rb
+- lib/seafoam/graph.rb
+- lib/seafoam/graphviz_writer.rb
+- lib/seafoam/spotlight.rb
+- lib/seafoam/version.rb
+- seafoam.gemspec
+- spec/seafoam/annotators/fallback_spec.rb
+- spec/seafoam/annotators/graal_spec.rb
+- spec/seafoam/annotators_spec.rb
+- spec/seafoam/bgv/bgv_parser_spec.rb
+- spec/seafoam/bgv/fixtures/not.bgv
+- spec/seafoam/bgv/fixtures/unsupported.bgv
+- spec/seafoam/binary/io_binary_reader_spec.rb
+- spec/seafoam/command_spec.rb
+- spec/seafoam/graph_spec.rb
+- spec/seafoam/graphviz_writer_spec.rb
+- spec/seafoam/spec_helpers.rb
+- spec/seafoam/spotlight_spec.rb
+- tools/render-all
+homepage: https://github.com/Shopify/seafoam
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
+specification_version: 4
+summary: A tool for working with compiler graphs
+test_files: []