seafoam 0.11 → 0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc92671f5ea437e5afccf98c5874434251e6df05fde08e325e0b8b4a60d5d2b0
-  data.tar.gz: 77a8f71d631be2c02674784598a97d7da4b83c4556f2fc21c5d66496678b3792
+  metadata.gz: 44f9af9b54052ddbfc03bc99833eb0af6e2e5f2bd0a5612a77ea10e3d30b3fca
+  data.tar.gz: 7d1613577c3e033c69149eb51845540b88adc0c05bda3327c59a41c700647181
 SHA512:
-  metadata.gz: 2c9d7b5ccea117d2b1b686d66fffbeebe4282dde52f5c9880125f57911f4da4ed2e7660f1957597931e5bf714258b0c1a08e6c9fc0bfbc822915b2ae22c08964
-  data.tar.gz: 2c991ed3d87e80ccdb92630dfc3d2283b01ed2125c70883eec7b5e0cd6031d55acbb8930feb7cf6ef6e029b0e58ff2b01b2d2c81c0a2a0bca266070a2c28ba2c
+  metadata.gz: f35b3f93409e92be806e793817461900f66d7d1a8e91e6ae95fc52f66fa61955d7c48f0de1899ad15b35e88fa2b6b4cbb70fed976accb9f20ee7725f201828fe
+  data.tar.gz: 03d4b654e6f2001128aa711ccddb4cccf09aed480d65578e0e49edb3d59c2acb5b594e3ef4f32b972e9821862aa24b9daa12c4fb7f1cef838a46c43c2c3b4fa9

data/bin/bgv2isabelle

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'seafoam'
+require "seafoam"
 
 # This is the 'bgv2isabelle' command line entry point.
 
@@ -15,6 +16,6 @@ rescue StandardError => e
     raise e
   else
     # Otherwise, just print the message.
-    warn "seafoam: #{e.message}"
+    warn("seafoam: #{e.message}")
   end
 end

data/bin/bgv2json

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'seafoam'
+require "seafoam"
 
 # This is the 'bgv2json' command line entry point.
 
@@ -15,6 +16,6 @@ rescue StandardError => e
     raise e
   else
     # Otherwise, just print the message.
-    warn "seafoam: #{e.message}"
+    warn("seafoam: #{e.message}")
   end
 end

data/bin/seafoam

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'seafoam'
+require "seafoam"
 
 # This is the 'seafoam' command line entry point.
 
@@ -15,6 +16,6 @@ rescue StandardError => e
     raise e
   else
     # Otherwise, just print the message.
-    warn "seafoam: #{e.message}"
+    warn("seafoam: #{e.message}")
   end
 end

data/lib/seafoam/bgv/bgv_parser.rb

@@ -1,5 +1,7 @@
-require 'stringio'
-require 'zlib'
+# frozen_string_literal: true
+
+require "stringio"
+require "zlib"
 
 module Seafoam
   module BGV
@@ -21,7 +23,7 @@ module Seafoam
 
       # Read the file header and return the version.
       def read_file_header(version_check: true)
-        raise EncodingError, 'does not appear to be a BGV file - missing header' unless @reader.read_bytes(4) == MAGIC
+        raise EncodingError, "does not appear to be a BGV file - missing header" unless @reader.read_bytes(4) == MAGIC
 
         @major = @reader.read_sint8
         @minor = @reader.read_sint8
@@ -90,7 +92,7 @@ module Seafoam
           group: @group_stack.dup,
           format: format,
           args: args,
-          props: props
+          props: props,
         }
       end
 
@@ -115,15 +117,17 @@ module Seafoam
           node = edge[:node]
           props = edge[:edge]
           inputs = edge[:inputs]
-          others = edge[:ids].reject(&:nil?).map { |id| graph.nodes[id] || raise(EncodingError, "BGV edge with unknown node #{id}") }
+          others = edge[:ids].reject(&:nil?).map do |id|
+            graph.nodes[id] || raise(EncodingError, "BGV edge with unknown node #{id}")
+          end
           others.each_with_index do |other, index|
             # We need to give each edge their own property as they're annotated separately.
             props = props.dup
             props[:index] = index
             if inputs
-              graph.create_edge other, node, props
+              graph.create_edge(other, node, props)
             else
-              graph.create_edge node, other, props
+              graph.create_edge(node, other, props)
             end
           end
         end
@@ -134,7 +138,7 @@ module Seafoam
           block_nodes = @reader.read_sint32.times.map { @reader.read_sint32 }
           # Followers aren't used but could be.
           @reader.read_sint32.times.map { @reader.read_sint32 }
-          graph.create_block block_id, block_nodes
+          graph.create_block(block_id, block_nodes)
         end
         graph
       end
@@ -147,8 +151,8 @@ module Seafoam
           node_class = read_pool_object
           skip_bool
           skip_props
-          skip_edges node_class, true
-          skip_edges node_class, false
+          skip_edges(node_class, true)
+          skip_edges(node_class, false)
         end
         skip_blocks
       end
@@ -200,9 +204,9 @@ module Seafoam
           short_name: short_name,
           method: method,
           bci: bci,
-          props: props
+          props: props,
         }
-        @group_stack.push group
+        @group_stack.push(group)
       end
 
       # Read the closing of a group.
@@ -228,16 +232,16 @@ module Seafoam
       # Skip over edges.
       def skip_edges(node_class, inputs)
         edges = if inputs
-                  node_class[:inputs]
-                else
-                  node_class[:outputs]
-                end
+          node_class[:inputs]
+        else
+          node_class[:outputs]
+        end
         edges.each do |edge|
           count = if edge[:direct]
-                    1
-                  else
-                    @reader.read_sint16
-                  end
+            1
+          else
+            @reader.read_sint16
+          end
           count.times do
             @reader.skip_int32
           end
@@ -247,16 +251,16 @@ module Seafoam
       # Read edges, producing an array of edge hashes.
       def read_edges(node, node_class, inputs)
         edges = if inputs
-                  node_class[:inputs]
-                else
-                  node_class[:outputs]
-                end
+          node_class[:inputs]
+        else
+          node_class[:outputs]
+        end
         edges.map do |edge|
           count = if edge[:direct]
-                    1
-                  else
-                    @reader.read_sint16
-                  end
+            1
+          else
+            @reader.read_sint16
+          end
           ids = count.times.map do
             id = @reader.read_sint32
             raise if id < -1
@@ -268,7 +272,7 @@ module Seafoam
             node: node,
             edge: edge,
             ids: ids,
-            inputs: inputs
+            inputs: inputs,
           }
         end
       end
@@ -277,8 +281,8 @@ module Seafoam
       def skip_blocks
         @reader.read_sint32.times do
           @reader.skip_int32
-          @reader.skip_int32 @reader.read_sint32
-          @reader.skip_int32 @reader.read_sint32
+          @reader.skip_int32(@reader.read_sint32)
+          @reader.skip_int32(@reader.read_sint32)
         end
       end
 
@@ -323,9 +327,9 @@ module Seafoam
               skip_pool_object
             end
           when PROPERTY_INT
-            @reader.skip_int32 @reader.read_sint32
+            @reader.skip_int32(@reader.read_sint32)
           when PROPERTY_DOUBLE
-            @reader.skip_float64 @reader.read_sint32
+            @reader.skip_float64(@reader.read_sint32)
           else
             raise EncodingError, "unknown BGV property array type 0x#{type.to_s(16)}"
           end
@@ -388,7 +392,8 @@ module Seafoam
         when POOL_NULL
         when POOL_NEW
           read_pool_entry
-        when POOL_STRING, POOL_ENUM, POOL_CLASS, POOL_METHOD, POOL_NODE_CLASS, POOL_FIELD, POOL_SIGNATURE, POOL_NODE_SOURCE_POSITION, POOL_NODE
+        when POOL_STRING, POOL_ENUM, POOL_CLASS, POOL_METHOD, POOL_NODE_CLASS,
+            POOL_FIELD, POOL_SIGNATURE, POOL_NODE_SOURCE_POSITION, POOL_NODE
           @reader.skip_int16
         else
           raise EncodingError, "unknown token 0x#{token.to_s(16)} in BGV pool object"
@@ -403,7 +408,8 @@ module Seafoam
           nil
         when POOL_NEW
           read_pool_entry
-        when POOL_STRING, POOL_ENUM, POOL_CLASS, POOL_METHOD, POOL_NODE_CLASS, POOL_FIELD, POOL_SIGNATURE, POOL_NODE_SOURCE_POSITION, POOL_NODE
+        when POOL_STRING, POOL_ENUM, POOL_CLASS, POOL_METHOD, POOL_NODE_CLASS,
+            POOL_FIELD, POOL_SIGNATURE, POOL_NODE_SOURCE_POSITION, POOL_NODE
           id = @reader.read_uint16
           object = @pool[id]
           raise EncodingError, "unknown BGV pool object #{token}" unless object
@@ -425,7 +431,9 @@ module Seafoam
         when POOL_ENUM
           enum_class = read_pool_object
           enum_ordinal = @reader.read_sint32
-          raise EncodingError, "unknown BGV eum ordinal #{enum_ordinal} in #{enum_class}" if enum_ordinal.negative? || enum_ordinal >= enum_class.size
+          if enum_ordinal.negative? || enum_ordinal >= enum_class.size
+            raise EncodingError, "unknown BGV eum ordinal #{enum_ordinal} in #{enum_class}"
+          end
 
           object = enum_class[enum_ordinal]
         when POOL_CLASS
@@ -448,12 +456,12 @@ module Seafoam
           signature = read_pool_object
           modifiers = @reader.read_sint32
           bytes_length = @reader.read_sint32
-          @reader.skip bytes_length if bytes_length != -1
+          @reader.skip(bytes_length) if bytes_length != -1
           object = {
             declaring_class: declaring_class,
             method_name: method_name,
             signature: signature,
-            modifiers: modifiers
+            modifiers: modifiers,
           }
         when POOL_NODE_CLASS
           node_class = read_pool_object
@@ -464,7 +472,7 @@ module Seafoam
             node_class: node_class,
             name_template: name_template,
             inputs: inputs,
-            outputs: outputs
+            outputs: outputs,
           }
         when POOL_FIELD
           field_class = read_pool_object
@@ -475,7 +483,7 @@ module Seafoam
             field_class: field_class,
             name: name,
             type_name: type_name,
-            modifiers: modifiers
+            modifiers: modifiers,
           }
         when POOL_SIGNATURE
           args = @reader.read_sint16.times.map do
@@ -484,7 +492,7 @@ module Seafoam
           ret = read_pool_object
           object = {
             args: args,
-            ret: ret
+            ret: ret,
           }
         when POOL_NODE_SOURCE_POSITION
           method = read_pool_object
@@ -498,26 +506,26 @@ module Seafoam
             loc_line = @reader.read_sint32
             loc_start = @reader.read_sint32
             loc_end = @reader.read_sint32
-            locs.push [location, loc_line, loc_start, loc_end]
+            locs.push([location, loc_line, loc_start, loc_end])
           end
           caller = read_pool_object
           object = {
             method: method,
             bci: bci,
             locs: locs,
-            caller: caller
+            caller: caller,
           }
         when POOL_NODE
           node_id = @reader.read_sint32
           node_class = read_pool_object
           object = {
             node_id: node_id,
-            node_class: node_class
+            node_class: node_class,
           }
         else
           raise EncodingError, "unknown BGV pool type 0x#{type.to_s(16)}"
         end
-        set_pool_entry id, object
+        set_pool_entry(id, object)
       end
 
       # Hook method that can be overidden for debugging.
@@ -534,7 +542,7 @@ module Seafoam
           {
             direct: !indirect,
             name: name,
-            type: type
+            type: type,
           }
         end
       end
@@ -542,7 +550,7 @@ module Seafoam
       # Skip over a UTF-8 string.
       def skip_string
         length = @reader.read_sint32
-        @reader.skip length if length != -1
+        @reader.skip(length) if length != -1
       end
 
       # Read a UTF-8 string.
@@ -552,7 +560,7 @@ module Seafoam
           nil
         else
           string = @reader.read_utf8(length)
-          raise EncodingError, 'null byte in BGV string' if string.include?("\0")
+          raise EncodingError, "null byte in BGV string" if string.include?("\0")
 
           string
         end
@@ -578,11 +586,11 @@ module Seafoam
 
       # File format constants.
 
-      MAGIC = 'BIGV'
+      MAGIC = "BIGV"
 
       SUPPORTED_VERSIONS = [
         [6, 1],
-        [7, 0]
+        [7, 0],
       ]
 
       BEGIN_GROUP = 0x00

data/lib/seafoam/binary/io_binary_reader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Seafoam
   module Binary
     # An adapter to read binary values from an IO stream.
@@ -7,7 +9,7 @@ module Seafoam
       end
 
       def read_utf8(length)
-        read_bytes(length).force_encoding Encoding::UTF_8
+        read_bytes(length).force_encoding(Encoding::UTF_8)
       end
 
       def read_bytes(length)
@@ -15,31 +17,31 @@ module Seafoam
       end
 
       def read_float64
-        @io.read(8).unpack1('G')
+        @io.read(8).unpack1("G")
       end
 
       def read_float32
-        @io.read(4).unpack1('g')
+        @io.read(4).unpack1("g")
       end
 
       def read_sint64
-        @io.read(8).unpack1('q>')
+        @io.read(8).unpack1("q>")
       end
 
       def read_sint32
-        @io.read(4).unpack1('l>')
+        @io.read(4).unpack1("l>")
       end
 
       def read_sint16
-        @io.read(2).unpack1('s>')
+        @io.read(2).unpack1("s>")
       end
 
       def read_uint16
-        @io.read(2).unpack1('S>')
+        @io.read(2).unpack1("S>")
       end
 
       def read_sint8
-        @io.read(1).unpack1('c')
+        @io.read(1).unpack1("c")
       end
 
       def read_uint8
@@ -47,37 +49,37 @@ module Seafoam
       end
 
       def peek_sint8
-        byte = @io.read(1).unpack1('c')
-        @io.ungetbyte byte
+        byte = @io.read(1).unpack1("c")
+        @io.ungetbyte(byte)
         byte
       end
 
       def skip_float64(count = 1)
-        skip count * 8
+        skip(count * 8)
       end
 
       def skip_float32(count = 1)
-        skip count * 4
+        skip(count * 4)
       end
 
       def skip_int64(count = 1)
-        skip count * 8
+        skip(count * 8)
       end
 
       def skip_int32(count = 1)
-        skip count * 4
+        skip(count * 4)
       end
 
       def skip_int16(count = 1)
-        skip count * 2
+        skip(count * 2)
       end
 
       def skip_int8(count = 1)
-        skip count
+        skip(count)
       end
 
       def skip(count)
-        @io.seek count, IO::SEEK_CUR
+        @io.seek(count, IO::SEEK_CUR)
       end
 
       def eof?

data/lib/seafoam/colors.rb

@@ -1,18 +1,24 @@
+# frozen_string_literal: true
+
 module Seafoam
   # Colors from and derived from the TruffleRuby logo.
 
   # TruffleRuby logo Copyright (C) 2017 Talkdesk, Inc.
   # Licensed under CC BY 4.0: https://creativecommons.org/licenses/by/4.0/
 
-  WHITE_ICE = '#d7ede7'
-  CRUISE = '#b8ddd1'
-  KEPPEL = '#3cb4a4'
-  CARISSMA = '#e98693'
-  AMARANTH = '#da2d4f'
-  BLACK = '#1a1919'
-  WHITE = '#ffffff'
-  DUST = '#f9f9f9'
-  BIG_STONE = '#343d46'
-  ICE_STONE = '#b3bbc3'
-  ORANGE = '#ffa500'
+  WHITE_ICE = "#d7ede7"
+  CRUISE = "#b8ddd1"
+  KEPPEL = "#3cb4a4"
+  CARISSMA = "#e98693"
+  AMARANTH = "#da2d4f"
+  BLACK = "#1a1919"
+  WHITE = "#ffffff"
+  DUST = "#f9f9f9"
+  BIG_STONE = "#343d46"
+  ICE_STONE = "#b3bbc3"
+  ORANGE = "#ffa500"
+  LIGHT_BLUE = "#ccccff"
+  LIGHT_PURPLE = "#c39bd3"
+  LIGHT_YELLOW = "#ffffde"
+  DARK_YELLOW = "#aaaa33"
 end