rubyx/lib/sol/send_statement.rb

module Sol
  # Sending in a dynamic language is off course not as simple as just calling.
  # The function that needs to be called depends after all on the receiver,
  # and no guarantees can be made on what that is.
  #
  # It helps to know that usually (>99%) the class of the receiver does not change.
  # Our stategy then is to cache the functions and only dynamically determine it in
  # case of a miss (the 1%, and first invocation)
  #
  # As cache key we must use the type of the object (which is the first word of _every_ object)
  # as that is constant, and function implementations depend on the type (not class)
  class SendStatement < CallStatement

    def block
      return nil if arguments.empty?
      bl = arguments.last
      bl.is_a?(LambdaExpression) ? bl : nil
    end

    def add_block( block )
      @arguments << block
    end

    def each(&block)
      super
      self.block.each(&block) if self.block
    end

    # lazy init this, to keep the dependency (which goes to parfait and booting) at bay
    def dynamic_call
      @dynamic ||= SlotMachine::DynamicCall.new()
    end

    # A Send breaks down to 2 steps:
    # - Setting up the next message, with receiver, arguments, and (importantly) return address
    # - a CachedCall , or a SimpleCall, depending on wether the receiver type can be determined
    #
    # A slight complication occurs for methods defined in superclasses. Since we are
    # type, not class, based, these are not part of our type.
    # So we check, and if find, add the source (sol_method) to the class and start
    # compiling the sol for the receiver_type
    #
    def to_slot( compiler )
      @receiver = SelfExpression.new(compiler.receiver_type) if @receiver.is_a?(SelfExpression)
      if(@receiver.ct_type)
        method = @receiver.ct_type.get_method(@name)
        #puts "Known #{@receiver.ct_type}: method #{method}"
        method = create_method_from_source(compiler) unless( method )
        return simple_call(compiler, method) if method
      end
      cached_call(compiler)
    end

    # If a method is found in the class (not the type)
    # we add it to the class that the receiver type represents, and create a compiler
    # to compile the sol for the specific type (the receiver)
    def create_method_from_source(compiler)
      sol_method = @receiver.ct_type.object_class.resolve_method!(@name)
      return nil unless sol_method
      #puts "#{sol_method.name} , adding to #{@receiver.ct_type.object_class.name}"
      @receiver.ct_type.object_class.add_instance_method(sol_method)
      sol_method.create_callable_method_for(@receiver.ct_type)
      new_compiler = sol_method.compiler_for(@receiver.ct_type)
      compiler.add_method_compiler(new_compiler)
      new_compiler.callable
    end

    def message_setup(compiler,called_method)
      setup  = SlotMachine::MessageSetup.new( called_method )
      slot_receive = @receiver.to_slotted(compiler)
      args = @arguments.collect { |arg|  arg.to_slotted(compiler)}
      setup << SlotMachine::ArgumentTransfer.new(self, slot_receive , args )
    end

    def simple_call(compiler, called_method)
      message_setup(compiler,called_method) << SlotMachine::SimpleCall.new(called_method)
    end

    # this breaks cleanly into two parts:
    # - check the cached type and if neccessary update
    # - call the cached method
    def cached_call(compiler)
      cache_check(compiler) << call_cached_method(compiler)
    end

    # check that current type is the cached type
    # if not, change and find method for the type (simple_call to resolve_method)
    # conceptually easy in ruby, but we have to compile that "easy" ruby
    def cache_check(compiler)
      ok = SlotMachine::Label.new(self,"cache_ok_#{self.object_id}")
      check = build_condition(ok, compiler)      # if cached_type != current_type
      check << SlotMachine::SlotLoad.new(self,[dynamic_call.cache_entry, :cached_type] , receiver_type_definition(compiler))
      check << SlotMachine::ResolveMethod.new(self, @name , dynamic_call.cache_entry )
      check << ok
    end

    # to call the method (that we know now to be in the cache), we move the method
    # to reg1, do the setup (very similar to static) and call
    def call_cached_method(compiler)
      message_setup(compiler,dynamic_call.cache_entry) << dynamic_call
    end

    def to_s(depth = 0)
      sen = "#{receiver}.#{name}(#{@arguments.collect{|a| a.to_s}.join(', ')})"
      at_depth(depth , sen)
    end

    private
    def receiver_type_definition(compiler)
      defi = @receiver.to_slotted(compiler)
      defi.set_next( SlotMachine::Slot.new(:type) )
      defi
    end

    def build_condition(ok_label, compiler)
      cached_type = SlotMachine::Slotted.for(dynamic_call.cache_entry , [:cached_type])
      current_type = receiver_type_definition(compiler)
      SlotMachine::NotSameCheck.new(cached_type , current_type, ok_label)
    end
  end
end