class MIPSUnit::MSpec::TestFactory

# File lib/mipsunit/mspec/test_factory.rb, line 164
def assert_register_not_at(register)
  if (register == :at || register == :r1)
    name = TestFactoryHelper.register_to_string(register)
    message = "Cannot verify value of #{name} because MSpec uses it as a temporary."
    message += "\nTo verify the value of this register, you must first move it to a different, unused register "
    message += "and verify the value of that register."
    raise InvalidSpecException.new(message)
  end
end

# File lib/mipsunit/mspec/test_factory.rb, line 157
def call(p1=nil, p2=nil, p3=nil, p4=nil)
  name = self.class.metadata.subject
  call_by_name(name, p1, p2, p3, p4)
end

# File lib/mipsunit/mspec/test_factory.rb, line 143
def call_by_name(name, p1=nil, p2=nil, p3=nil, p4=nil)
  if name.nil?
    raise InvalidSpecException.new("Must specify a method when using call_by_name.")
  end
  name = name.to_s

  # remove unused parameters
  params = {:a0 => p1, :a1 => p2, :a2 => p3, :a3 => p4}.reject { |k, v| v.nil? }
  set(params)

  @output.puts "jal #{name}"
end

# File lib/mipsunit/mspec/test_factory.rb, line 106
def data(hash)
  MIPSUnit::MSpec.global.print_single_warning(:data_in_before)
  data!(hash)
end

# File lib/mipsunit/mspec/test_factory.rb, line 115
def data!(hash)
  TestFactoryHelper.data(hash) do |dl|
    self.class.metadata.assert_label_not_defined_in_object_scope(dl)
    @local_labels << dl
  end
end

# File lib/mipsunit/mspec/test_factory.rb, line 133
def set(hash)
  labels_in_scope = self.class.metadata.data_labels + @local_labels
  # we iterate the hash in sorted order so that the output is predictable for
  # testing purposes
  hash.keys.sort { |a, b| a.to_s <=> b.to_s }.each do |key|
    TestFactoryHelper.set_register(key, hash[key], @output, labels_in_scope)
  end
end

# File lib/mipsunit/mspec/test_factory.rb, line 202
def verify(hash)
  # We sort the keys before iterating only so that the
  # output is consistent for testing purposes.
  hash.keys.sort { |a, b| a.to_s <=> b.to_s }.each do |key|
    verify_register(key, hash[key])
  end
end

# File lib/mipsunit/mspec/test_factory.rb, line 217
def verify_memory(observed, expected, length = nil)
  assert_register_not_at(observed) if observed.is_a?(Symbol)

  raise InvalidSpecException.new("Feature not yet supported") unless (observed.is_a?(String) || observed.is_a?(Symbol))
  raise InvalidSpecException.new("Feature not yet supported") unless expected.is_a?(Array)

  if (expected.is_a?(Array))
    labels_in_scope = self.class.metadata.data_labels + @local_labels
    test_name_string = "#{self.class.metadata.cumulative_description} #{@description}"
    TestFactoryHelper.verify_memory_array(observed, expected, self, test_name_string, labels_in_scope, @output)
  end
end

# File lib/mipsunit/mspec/test_factory.rb, line 176
def verify_register(register, expected_value)
  assert_register_not_at(register)

  unless expected_value.is_a?(Integer) || expected_value.is_a?(Symbol) ||
      expected_value.is_a?(TrueClass) || expected_value.is_a?(FalseClass)
    raise InvalidSpecException.new("Cannot compare a register (#{register.to_s}) to type #{expected_value.class}")
  end

  TestFactoryHelper.validate_register(register)

  # Generate a single string containing the complete name of this test
  test_name_string = "#{self.class.metadata.cumulative_description} #{@description}"

  # put desired value in $at  (Since the mips beq instruction only compares registers, this happens anyway.
  # There is no harm in making it explicit here.)
  set(:at => expected_value)

  register_name = TestFactoryHelper.register_to_string(register)
  TestFactoryHelper.fail_unless("beq $at, #{register_name}", test_name_string, "Register #{register.to_s}",
                                expected_value, self, @output) do
    @output.puts "move $a3, #{register_name}"
  end
end

# File lib/mipsunit/mspec/test_factory.rb, line 92
def self.before(&block)
  @metadata.before << block
end

# File lib/mipsunit/mspec/test_factory.rb, line 98
def self.data(hash)
  TestFactoryHelper.data(hash) { |dl| @metadata.add_data_label(dl) }
end

# File lib/mipsunit/mspec/test_factory.rb, line 46
def self.describe(description, &block)
  # save metadata in a local variable so we can pass it to the
  # new TestDefinitionGroup while in a block
  my_metadata = @metadata

  # Define a new descendant of TestFactory (this is what Class.new(self) does)
  # Every class is described by an instance of Class.  The block below
  # adds the instance variable @metadata to the newly defined Class object.
  group = Class.new(self) do
    @metadata = TestDefinitionGroup.new(description, my_metadata)
    # A define block looks like this:
    # define "some function" do
    #   THE BLOCK
    # end
    #
    # The class_eval statement below runs the code in the define
    # block (i.e, "THE BLOCK") in the context of defining a new class.  In other
    # words, it is as if we had written the code like this:
    #
    # class NewTestFactory < TestFactory
    #  THE BLOCK
    # end
    #
    # Thus, any definitions in the block become instance methods for this
    # descendant of TestFactory.  Calls to "it" or "before" are calls to the
    # class methods "it" and "before" defined below.
    class_eval(&block)
  end

  # Add the metadata for the newly processed describe block (i.e., group.metadata) to the
  # current list of nested groups.  Notice that @metadata in the  line below is not the same
  # object as @metadata in the block above.  @metadata in the block above is an instance variable in the
  # newly created Class object.
  @metadata.nested_groups << group.metadata unless @metadata.nil?
  group.metadata
end

# File lib/mipsunit/mspec/test_factory.rb, line 85
def self.it(description, &block)
  definition = TestDefinition.new(self, description, block)
  @metadata.definitions << definition
  description
end

# File lib/mipsunit/mspec/test_factory.rb, line 41
def self.metadata
  @metadata
end

# File lib/mipsunit/mspec/test_factory.rb, line 122
def initialize(output, description)
  @output = output
  @description = description
  @local_labels = []
end