python-pickle 0.1.0

data/lib/python/pickle/instructions/get.rb

@@ -0,0 +1,27 @@
+require 'python/pickle/instruction'
+require 'python/pickle/instructions/has_value'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents the `GET` instruction.
+      #
+      class Get < Instruction
+
+        include HasValue
+
+        #
+        # Initializes the `GET` instruction.
+        #
+        # @param [Integer] value
+        #   The `GET` instruction's value.
+        #
+        def initialize(value)
+          super(:GET,value)
+        end
+
+      end
+    end
+  end
+end

data/lib/python/pickle/instructions/global.rb

@@ -0,0 +1,62 @@
+require 'python/pickle/instruction'
+require 'python/pickle/instructions/has_value'
+
+module Python
+  module Pickle
+    module Instructions
+      class Global < Instruction
+
+        # The global object namespace.
+        #
+        # @return [String]
+        attr_reader :namespace
+
+        # The global object name.
+        #
+        # @return [String]
+        attr_reader :name
+
+        #
+        # Initializes the `GLOBAL` instruction.
+        #
+        # @param [String] namespace
+        #   The namespace name for the global object.
+        #
+        # @param [String] name
+        #   The name of the global object.
+        #
+        def initialize(namespace,name)
+          super(:GLOBAL)
+
+          @namespace = namespace
+          @name      = name
+        end
+
+        #
+        # Compares the `GLOBAL` instruction to another instruction.
+        #
+        # @param [Instruction] other
+        #   The other instruction to compare against.
+        #
+        # @return [Boolean]
+        #   Indicates whether the other instruction matches this one.
+        #
+        def ==(other)
+          super(other) && \
+            (@namespace == other.namespace) && \
+            (@name == other.name)
+        end
+
+        #
+        # Converts the `GLOBAL` instructions to a String.
+        #
+        # @return [String]
+        #
+        def to_s
+          "#{super} #{@namespace}.#{@name}"
+        end
+
+      end
+    end
+  end
+end

data/lib/python/pickle/instructions/has_length_and_value.rb

@@ -0,0 +1,58 @@
+module Python
+  module Pickle
+    module Instructions
+      #
+      # A mixin which adds a length and a value to an instruction class.
+      #
+      module HasLengthAndValue
+        # The length of the value associated with the instruction.
+        #
+        # @return [Integer]
+        attr_reader :length
+
+        # The value associated with the instruction.
+        #
+        # @return [Object]
+        attr_reader :value
+
+        #
+        # Initializes the instruction.
+        #
+        # @param [Symbol] opcode
+        #
+        # @param [Object] value
+        #
+        def initialize(opcode,length,value)
+          super(opcode)
+
+          @value  = value
+          @length = length
+        end
+
+        #
+        # Compares the instruction to another instruction.
+        #
+        # @param [Instruction] other
+        #   The other instruction to compare against.
+        #
+        # @return [Boolean]
+        #   Indicates whether the other instruction matches this one.
+        #
+        def ==(other)
+          super(other) &&
+            other.kind_of?(HasLengthAndValue) &&
+            (@length == other.length && @value == other.value)
+        end
+
+        #
+        # Converts the instruction to a String.
+        #
+        # @return [String]
+        #
+        def to_s
+          "#{super} #{@length.inspect} #{@value.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/python/pickle/instructions/has_value.rb

@@ -0,0 +1,50 @@
+module Python
+  module Pickle
+    module Instructions
+      #
+      # A mixin which adds a value to an instruction class.
+      #
+      module HasValue
+        # The value associated with the instruction.
+        #
+        # @return [Object]
+        attr_reader :value
+
+        #
+        # Initializes the instruction.
+        #
+        # @param [Symbol] opcode
+        #
+        # @param [Object] value
+        #
+        def initialize(opcode,value)
+          super(opcode)
+
+          @value = value
+        end
+
+        #
+        # Compares the instruction to another instruction.
+        #
+        # @param [Instruction] other
+        #   The other instruction to compare against.
+        #
+        # @return [Boolean]
+        #   Indicates whether the other instruction matches this one.
+        #
+        def ==(other)
+          super(other) && other.kind_of?(HasValue) && (@value == other.value)
+        end
+
+        #
+        # Converts the instruction to a String.
+        #
+        # @return [String]
+        #
+        def to_s
+          "#{super} #{@value.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/python/pickle/instructions/int.rb

@@ -0,0 +1,24 @@
+require 'python/pickle/instruction'
+require 'python/pickle/instructions/has_value'
+
+module Python
+  module Pickle
+    module Instructions
+      class Int < Instruction
+
+        include HasValue
+
+        #
+        # Initializes the `INT` instruction.
+        #
+        # @param [Integer] value
+        #   The `INT` instruction's value.
+        #
+        def initialize(value)
+          super(:INT,value)
+        end
+
+      end
+    end
+  end
+end

data/lib/python/pickle/instructions/list.rb

@@ -0,0 +1,24 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `LIST` instruction.
+      #
+      class List < Instruction
+
+        #
+        # Initializes the `LIST` instruction.
+        #
+        def initialize
+          super(:LIST)
+        end
+
+      end
+
+      # The `LIST` instruction.
+      LIST = List.new
+    end
+  end
+end

data/lib/python/pickle/instructions/long.rb

@@ -0,0 +1,24 @@
+require 'python/pickle/instruction'
+require 'python/pickle/instructions/has_value'
+
+module Python
+  module Pickle
+    module Instructions
+      class Long < Instruction
+
+        include HasValue
+
+        #
+        # Initializes the `LONG` instruction.
+        #
+        # @param [Integer] value
+        #   The `LONG` instruction's value.
+        #
+        def initialize(value)
+          super(:LONG,value)
+        end
+
+      end
+    end
+  end
+end

data/lib/python/pickle/instructions/long1.rb

@@ -0,0 +1,32 @@
+require 'python/pickle/instruction'
+require 'python/pickle/instructions/has_length_and_value'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents the `LONG1` instruction.
+      #
+      # @note introduces in protocol 1.
+      #
+      class Long1 < Instruction
+
+        include HasLengthAndValue
+
+        #
+        # Initializes the `LONG1` instruction.
+        #
+        # @param [Integer] length
+        #   The length of the `LONG1` value in bytes.
+        #
+        # @param [Long1] value
+        #   The `LONG1` instruction's value.
+        #
+        def initialize(length,value)
+          super(:LONG1,length,value)
+        end
+
+      end
+    end
+  end
+end

data/lib/python/pickle/instructions/long4.rb

@@ -0,0 +1,32 @@
+require 'python/pickle/instruction'
+require 'python/pickle/instructions/has_length_and_value'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents the `LONG4` instruction.
+      #
+      # @note introduces in protocol 1.
+      #
+      class Long4 < Instruction
+
+        include HasLengthAndValue
+
+        #
+        # Initializes the `LONG4` instruction.
+        #
+        # @param [Integer] length
+        #   The length of the `LONG4` value in bytes.
+        #
+        # @param [Long4] value
+        #   The `LONG4` instruction's value.
+        #
+        def initialize(length,value)
+          super(:LONG4,length,value)
+        end
+
+      end
+    end
+  end
+end

data/lib/python/pickle/instructions/long_bin_get.rb

@@ -0,0 +1,27 @@
+require 'python/pickle/instruction'
+require 'python/pickle/instructions/has_value'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents the `LONG_BINGET` instruction.
+      #
+      class LongBinGet < Instruction
+
+        include HasValue
+
+        #
+        # Initializes the `LONG_BINGET` instruction.
+        #
+        # @param [Integer] value
+        #   The `LONG_BINGET` instruction's value.
+        #
+        def initialize(value)
+          super(:LONG_BINGET,value)
+        end
+
+      end
+    end
+  end
+end

data/lib/python/pickle/instructions/mark.rb

@@ -0,0 +1,24 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `MARK` instruction.
+      #
+      class Mark < Instruction
+
+        #
+        # Initializes the `MARK` instruction.
+        #
+        def initialize
+          super(:MARK)
+        end
+
+      end
+
+      # The `MARK` instruction.
+      MARK = Mark.new
+    end
+  end
+end

data/lib/python/pickle/instructions/memoize.rb

@@ -0,0 +1,26 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `MEMOIZE` instruction.
+      #
+      # @note introduced in protocol 4.
+      #
+      class Memoize < Instruction
+
+        #
+        # Initializes the `MEMOIZE` instruction.
+        #
+        def initialize
+          super(:MEMOIZE)
+        end
+
+      end
+
+      # The `MEMOIZE` instruction.
+      MEMOIZE = Memoize.new
+    end
+  end
+end

data/lib/python/pickle/instructions/new_false.rb

@@ -0,0 +1,24 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `NEWFALSE` instruction.
+      #
+      class NewFalse < Instruction
+
+        #
+        # Initializes the `NEWFALSE` instruction.
+        #
+        def initialize
+          super(:NEWFALSE)
+        end
+
+      end
+
+      # The `NEWFALSE` instruction.
+      NEWFALSE = NewFalse.new
+    end
+  end
+end

data/lib/python/pickle/instructions/new_obj.rb

@@ -0,0 +1,26 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `NEWOBJ` instruction.
+      #
+      # @note introduced in protocol 2.
+      #
+      class NewObj < Instruction
+
+        #
+        # Initializes the `NEWOBJ` instruction.
+        #
+        def initialize
+          super(:NEWOBJ)
+        end
+
+      end
+
+      # The `NEWOBJ` instruction.
+      NEWOBJ = NewObj.new
+    end
+  end
+end

data/lib/python/pickle/instructions/new_obj_ex.rb

@@ -0,0 +1,26 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `NEWOBJ_EX` instruction.
+      #
+      # @note introduced in protocol 3.
+      #
+      class NewObjEx < Instruction
+
+        #
+        # Initializes the `NEWOBJ_EX` instruction.
+        #
+        def initialize
+          super(:NEWOBJ_EX)
+        end
+
+      end
+
+      # The `NEWOBJ_EX` instruction.
+      NEWOBJ_EX = NewObjEx.new
+    end
+  end
+end

data/lib/python/pickle/instructions/new_true.rb

@@ -0,0 +1,24 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `NEWTRUE` instruction.
+      #
+      class NewTrue < Instruction
+
+        #
+        # Initializes the `NEWTRUE` instruction.
+        #
+        def initialize
+          super(:NEWTRUE)
+        end
+
+      end
+
+      # The `NEWTRUE` instruction.
+      NEWTRUE = NewTrue.new
+    end
+  end
+end

data/lib/python/pickle/instructions/next_buffer.rb

@@ -0,0 +1,26 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `NEXT_BUFFER` instruction.
+      #
+      # @note introduced in protocol 4.
+      #
+      class NextBuffer < Instruction
+
+        #
+        # Initializes the `NEXT_BUFFER` instruction.
+        #
+        def initialize
+          super(:NEXT_BUFFER)
+        end
+
+      end
+
+      # The `NEXT_BUFFER` instruction.
+      NEXT_BUFFER = NextBuffer.new
+    end
+  end
+end

data/lib/python/pickle/instructions/none.rb

@@ -0,0 +1,24 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `NONE` instruction.
+      #
+      class None < Instruction
+
+        #
+        # Initializes the `NONE` instruction.
+        #
+        def initialize
+          super(:NONE)
+        end
+
+      end
+
+      # The `NONE` instruction.
+      NONE = None.new
+    end
+  end
+end

data/lib/python/pickle/instructions/pop.rb

@@ -0,0 +1,24 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `POP` instruction.
+      #
+      class Pop < Instruction
+
+        #
+        # Initializes the `POP` instruction.
+        #
+        def initialize
+          super(:POP)
+        end
+
+      end
+
+      # The `POP` instruction.
+      POP = Pop.new
+    end
+  end
+end

data/lib/python/pickle/instructions/pop_mark.rb

@@ -0,0 +1,24 @@
+require 'python/pickle/instruction'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents a pickle `POP_MARK` instruction.
+      #
+      class PopMark < Instruction
+
+        #
+        # Initializes the `POP_MARK` instruction.
+        #
+        def initialize
+          super(:POP_MARK)
+        end
+
+      end
+
+      # The `POP_MARK` instruction.
+      POP_MARK = PopMark.new
+    end
+  end
+end

data/lib/python/pickle/instructions/proto.rb

@@ -0,0 +1,29 @@
+require 'python/pickle/instruction'
+require 'python/pickle/instructions/has_value'
+
+module Python
+  module Pickle
+    module Instructions
+      #
+      # Represents the `PROTO` instruction.
+      #
+      # @note introduces in protocol 2.
+      #
+      class Proto < Instruction
+
+        include HasValue
+
+        #
+        # Initializes the `PROTO` instruction.
+        #
+        # @param [Proto] value
+        #   The `PROTO` instruction's value.
+        #
+        def initialize(value)
+          super(:PROTO,value)
+        end
+
+      end
+    end
+  end
+end

data/lib/python/pickle/instructions/put.rb

@@ -0,0 +1,24 @@
+require 'python/pickle/instruction'
+require 'python/pickle/instructions/has_value'
+
+module Python
+  module Pickle
+    module Instructions
+      class Put < Instruction
+
+        include HasValue
+
+        #
+        # Initializes the `PUT` instruction.
+        #
+        # @param [Integer] value
+        #   The `PUT` instruction's value.
+        #
+        def initialize(value)
+          super(:PUT,value)
+        end
+
+      end
+    end
+  end
+end