libjit-sys 0.2.1

Just-In-Time Compilation in Rust using LibJIT bindings
Documentation
require 'jit'

module JIT
  class Value
    module UNINITIALIZED; end

    # Create a new JIT::Value.  If value is specified, the value will be
    # variable, otherwise it will be a constant with the given value.
    #
    # +function+:: The function to which this value will belong.
    # +type+::     The type of the new value.
    # +value+:     The value to use, if this is a constant.
    #
    def self.new(function, type, value=UNINITIALIZED)
      # TODO: Not sure if I like this...
      if value == UNINITIALIZED then
        return function.value(type)
      else
        return function.const(type, value)
      end
    end

    # Assign +value+ to this JIT::Value.
    #
    # +value+:: The value to assign.
    #
    def store(value)
      lhs, rhs = coerce(value)
      self.function.insn_store(lhs, rhs)
    end

    # Return the address of this value.
    def address
      return self.function.insn_address_of(self)
    end

    # Add this value to another and return the result.
    #
    # +rhs+:: The right hand side of the addition operator.
    #
    def +(rhs)
      lhs, rhs = coerce(rhs)
      return self.function.insn_add(lhs, rhs)
    end

    # Subtract another value from this one and return the result.
    #
    # +rhs+:: The right hand side of the subtraction operator.
    #
    def -(rhs)
      lhs, rhs = coerce(rhs)
      return self.function.insn_sub(lhs, rhs)
    end

    # Multiply this value by another and return the result.
    #
    # +rhs+:: The right hand side of the multiplication operator.
    #
    def *(rhs)
      lhs, rhs = coerce(rhs)
      return self.function.insn_mul(lhs, rhs)
    end

    # Divide this value by another and return the quotient.
    #
    # +rhs+:: The right hand side of the division operator.
    #
    def /(rhs)
      lhs, rhs = coerce(rhs)
      return self.function.insn_div(lhs, rhs)
    end

    # Return the additive inverse (negation) of this value.
    def -@()
      rhs, lhs = coerce(0) # inverted, since we are subtracting from 0
      return lhs - rhs
    end

    # Divide this value by another and return the remainder.
    #
    # +rhs+:: The right hand side of the modulus operator.
    #
    def %(rhs)
      lhs, rhs = coerce(rhs)
      return self.function.insn_rem(lhs, rhs)
    end

    # Perform a bitwise and between this value and another.
    #
    # +rhs+:: The right hand side of the operator.
    #
    def &(rhs)
      lhs, rhs = coerce(rhs)
      return self.function.insn_and(lhs, rhs)
    end

    # Perform a bitwise or between this value and another.
    #
    # +rhs+:: The right hand side of the operator.
    #
    def |(rhs)
      lhs, rhs = coerce(rhs)
      return self.function.insn_or(lhs, rhs)
    end

    # Perform a bitwise xor between this value and another.
    #
    # +rhs+:: The right hand side of the operator.
    #
    def ^(rhs)
      lhs, rhs = coerce(rhs)
      return self.function.insn_xor(lhs, rhs)
    end

    # Compare this value to another, returning 1 if the left hand is
    # less than the right hand side or 0 otherwise.
    #
    # +rhs+:: The right hand side of the comparison.
    #
    def <(rhs)
      lhs, rhs = coerce(rhs)
      return self.function.insn_lt(lhs, rhs)
    end

    # Compare this value to another, returning 1 if the left hand is
    # greater than the right hand side or 0 otherwise.
    #
    # +rhs+:: The right hand side of the comparison.
    #
    def >(rhs)
      lhs, rhs = coerce(rhs)
      return self.function.insn_gt(lhs, rhs)
    end

    # Compare this value to another, returning 1 if the left hand is
    # equal to the right hand side or 0 otherwise.
    #
    # +rhs+:: The right hand side of the comparison.
    #
    def ==(rhs)
      lhs, rhs = coerce(rhs)
      return self.function.insn_eq(lhs, rhs)
    end

    # Compare this value to another, returning 1 if the left hand is
    # not equal to the right hand side or 0 otherwise.
    #
    # +rhs+:: The right hand side of the comparison.
    #
    def neq(rhs)
      lhs, rhs = coerce(rhs)
      return self.function.insn_ne(lhs, rhs)
    end

    # Compare this value to another, returning 1 if the left hand is
    # less than or equal to the right hand side or 0 otherwise.
    #
    # +rhs+:: The right hand side of the comparison.
    #
    def <=(rhs)
      lhs, rhs = coerce(rhs)
      return self.function.insn_le(lhs, rhs)
    end

    # Compare this value to another, returning 1 if the left hand is
    # greater than or equal to the right hand side or 0 otherwise.
    #
    # +rhs+:: The right hand side of the comparison.
    #
    def >=(rhs)
      lhs, rhs = coerce(rhs)
      return self.function.insn_ge(lhs, rhs)
    end

    # Shift this value left by the given number of bits.
    #
    # +rhs+:: The number of bits to shift by.
    #
    def <<(rhs)
      lhs, rhs = coerce(rhs)
      return self.function.insn_shl(lhs, rhs)
    end

    # Shift this value right by the given number of bits.
    #
    # +rhs+:: The number of bits to shift by.
    #
    def >>(rhs)
      lhs, rhs = coerce(rhs)
      return self.function.insn_shr(lhs, rhs)
    end

    # Return the logical inverse of this value.
    def ~()
      return self.function.insn_not(self)
    end
  end
end