virtualbox 0.5.4 → 0.6.0

data/lib/virtualbox/com/implementer/mscom.rb

@@ -0,0 +1,165 @@
+module VirtualBox
+  module COM
+    module Implementer
+      class MSCOM < Base
+        attr_reader :lib
+        attr_reader :object
+
+        # Initializes the MSCOM implementer.
+        #
+        # @param [AbstractInterface] inteface
+        # @param [FFI::Pointer] pointer
+        def initialize(interface, lib_base, object)
+          super(interface)
+
+          @lib = lib_base
+          @object = object
+        end
+
+        # Reads a property from the interface with the given name.
+        def read_property(name, opts)
+          # First get the basic value from the COM object
+          value = @object[COM::FFI::Util.camelize(name.to_s)]
+
+          # Then depending on the value type, we either return as-is or
+          # must wrap it up in another interface class
+          returnable_value(value, opts[:value_type])
+        end
+
+        # Writes a property from the interface with the given name and
+        # value.
+        def write_property(name, value, opts)
+          # Set the property with a prepared value
+          @object[COM::FFI::Util.camelize(name.to_s)] = spec_to_args([opts[:value_type]], [value]).first
+        end
+
+        # Calls a function from the interface with the given name
+        def call_function(name, args, opts)
+          # Convert args to proper values to send and send em!
+          args = spec_to_args(opts[:spec], args)
+          value = @object.send(COM::FFI::Util.camelize(name.to_s), *args)
+
+          # TODO: Multiple return values
+          returnable_value(value, opts[:value_type])
+        end
+
+        #############################################################
+        # Internal Methods, a.k.a. unless you're hacking on the code of this
+        # library, you should do well to leave these alone =]
+        #############################################################
+
+        # Takes a function spec and an argument list. This handles properly converting
+        # enums to ints and {AbstractInterface}s to proper MSCOM interfaces.
+        def spec_to_args(spec, args)
+          args = args.dup
+
+          # First remove all :out parameters from the spec, since those are of no
+          # concern for MSCOM at this point
+          spec = spec.collect do |item|
+            if item.is_a?(Array) && item[0] == :out
+              nil
+            else
+              item
+            end
+          end.compact
+
+          spec = spec.collect do |item|
+            if item == T_BOOL
+              args.shift ? 1 : 0
+            elsif item.to_s[0,1] == item.to_s[0,1].upcase
+              # Try to get the class from the interfaces
+              interface = interface_klass(item.to_sym)
+
+              if interface.superclass == COM::AbstractInterface
+                # For interfaces, get the instance, then dig deep to get the pointer
+                # to the VtblParent, which is what the API expects
+                instance = args.shift
+
+                if !instance.nil?
+                  # Get the actual MSCOM object, rather than the AbstractInterface
+                  instance.implementer.object
+                else
+                  # If the argument was nil, just pass a nil pointer as the argument
+                  nil
+                end
+              elsif interface.superclass == COM::AbstractEnum
+                # For enums, we need the value of the enum
+                interface.index(args.shift.to_sym)
+              end
+            else
+              # Simply replace spec item with next item in args
+              # list
+              args.shift
+            end
+          end
+        end
+
+        # Takes a value (returned from a WIN32OLE object) and a type and converts
+        # to a proper ruby return value type.
+        def returnable_value(value, type)
+          # Types which are void or nil just return
+          return nil if type.nil? || type == :void
+
+          klass = type.is_a?(Array) ? type.first : type
+          ignore, inferred_type = infer_type(klass)
+
+          array_of = type.is_a?(Array) ? "array_of_" : ""
+          send("read_#{array_of}#{inferred_type}", value, type)
+        end
+
+        def read_unicode_string(value, type)
+          # Return as-is
+          value
+        end
+
+        def read_char(value, type)
+          # Convert to a boolean
+          !(value.to_s == "0")
+        end
+
+        def read_ushort(value, type)
+          value.to_i
+        end
+
+        def read_uint(value, type)
+          value.to_i
+        end
+
+        def read_ulong(value, type)
+          value.to_i
+        end
+
+        def read_int(value, type)
+          value.to_i
+        end
+
+        def read_long(value, type)
+          value.to_i
+        end
+
+        def read_enum(value, type)
+          interface_klass(type)[value]
+        end
+
+        def read_interface(value, type)
+          return nil if value.nil?
+          interface_klass(type).new(self.class, lib, value)
+        end
+
+        def read_array_of_unicode_string(value, type)
+          # Return as-is, since MSCOM returns ruby strings!
+          value
+        end
+
+        def read_array_of_interface(value, type)
+          klass = interface_klass(type.first)
+          value.collect do |item|
+            if !item.nil?
+              klass.new(self.class, lib, item)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/virtualbox/com/implementer/nil.rb

@@ -0,0 +1,10 @@
+module VirtualBox
+  module COM
+    module Implementer
+      # A "nil" implementer which doesn't actually do anything. This is used in
+      # tests.
+      class Nil < AbstractImplementer
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/appliance.rb

@@ -0,0 +1,20 @@
+module VirtualBox
+  module COM
+    module Interface
+      class Appliance < AbstractInterface
+        IID = "e3ba9ab9-ac2c-4266-8bd2-91c4bf721ceb"
+
+        property :path, WSTRING, :readonly => true
+        property :disks, [WSTRING], :readonly => true
+        property :virtual_system_descriptions, [:VirtualSystemDescription], :readonly => true
+
+        function :read, :Progress, [WSTRING]
+        function :interpret, nil, []
+        function :import_machines, :Progress, []
+        function :create_vfs_explorer, :VFSExplorer, [WSTRING]
+        function :write, :Progress, [WSTRING, WSTRING]
+        function :get_warnings, [WSTRING], []
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/audio_adapter.rb

@@ -0,0 +1,13 @@
+module VirtualBox
+  module COM
+    module Interface
+      class AudioAdapter < AbstractInterface
+        IID = "921873db-5f3f-4b69-91f9-7be9e535a2cb"
+
+        property :enabled, T_BOOL
+        property :audio_controller, :AudioControllerType
+        property :audio_driver, :AudioDriverType
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/audio_controller_type.rb

@@ -0,0 +1,9 @@
+module VirtualBox
+  module COM
+    module Interface
+      class AudioControllerType < AbstractEnum
+        map [:ac97, :sb16]
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/audio_driver_type.rb

@@ -0,0 +1,9 @@
+module VirtualBox
+  module COM
+    module Interface
+      class AudioDriverType < AbstractEnum
+        map [:null, :winmm, :oss, :alsa, :direct_sound, :core_audio, :mmpm, :pulse, :sol_audio]
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/bios_boot_menu_mode.rb

@@ -0,0 +1,9 @@
+module VirtualBox
+  module COM
+    module Interface
+      class BIOSBootMenuMode < AbstractEnum
+        map [:disabled, :menu_only, :message_and_menu]
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/bios_settings.rb

@@ -0,0 +1,19 @@
+module VirtualBox
+  module COM
+    module Interface
+      class BIOSSettings < AbstractInterface
+        IID = "38b54279-dc35-4f5e-a431-835b867c6b5e"
+
+        property :logo_fade_in, T_BOOL
+        property :logo_fade_out, T_BOOL
+        property :logo_display_time, T_UINT32
+        property :logo_image_path, WSTRING
+        property :boot_menu_mode, :BIOSBootMenuMode
+        property :acpi_enabled, T_BOOL
+        property :io_apic_enabled, T_BOOL
+        property :time_offset, T_INT64
+        property :pxe_debug_enabled, T_BOOL
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/clipboard_mode.rb

@@ -0,0 +1,9 @@
+module VirtualBox
+  module COM
+    module Interface
+      class ClipboardMode < AbstractEnum
+        map [:disabled, :host_to_guest, :guest_to_host, :bidirectional]
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/console.rb

@@ -0,0 +1,48 @@
+module VirtualBox
+  module COM
+    module Interface
+      class Console < AbstractInterface
+        IID = "6375231a-c17c-464b-92cb-ae9e128d71c3"
+
+        property :machine, :Machine, :readonly => true
+        property :state, :MachineState, :readonly => true
+        property :guest, :Guest, :readonly => true
+        property :keyboard, :Keyboard, :readonly => true
+        property :mouse, :Mouse, :readonly => true
+        property :display, :Display, :readonly => true
+        property :debugger, :MachineDebugger, :readonly => true
+        property :usb_devices, [:USBDevice], :readonly => true
+        property :remote_usb_devices, [:HostUSBDevice], :readonly => true
+        property :shared_folders, [:SharedFolder], :readonly => true
+        property :remote_display_info, :RemoteDisplayInfo, :readonly => true
+
+        function :power_up, :Progress, []
+        function :power_up_paused, :Progress, []
+        function :power_down, :Progress, []
+        function :reset, nil, []
+        function :pause, nil, []
+        function :resume, nil, []
+        function :power_button, nil, []
+        function :sleep_button, nil, []
+        function :get_power_button_handled, T_BOOL, []
+        function :get_guest_entered_acpi_mode, T_BOOL, []
+        function :save_state, :Progress, []
+        function :adopt_saved_state, nil, [WSTRING]
+        function :forget_saved_state, nil, [T_BOOL]
+        function :get_device_activity, :DeviceActivity, [:DeviceType]
+        function :attach_usb_device, nil, [WSTRING]
+        function :detach_usb_device, :USBDevice, [WSTRING]
+        function :find_usb_device_by_address, :USBDevice, [WSTRING]
+        function :find_usb_device_by_id, :USBDevice, [WSTRING]
+        function :create_shared_folder, nil, [WSTRING, WSTRING, T_BOOL]
+        function :remove_shared_folder, nil, [WSTRING]
+        function :take_snapshot, :Progress, [WSTRING, WSTRING]
+        function :delete_snapshot, :Progress, [WSTRING]
+        function :restore_snapshot, :Progress, [:Snapshot]
+        function :teleport, :Progress, [WSTRING, T_UINT32, WSTRING, T_UINT32]
+        function :register_callback, nil, [:ConsoleCallback]
+        function :unregister_callback, nil, [:ConsoleCallback]
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/cpu_property_type.rb

@@ -0,0 +1,9 @@
+module VirtualBox
+  module COM
+    module Interface
+      class CpuPropertyType < AbstractEnum
+        map [:null, :pae, :synthetic]
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/device_type.rb

@@ -0,0 +1,9 @@
+module VirtualBox
+  module COM
+    module Interface
+      class DeviceType < AbstractEnum
+        map [:null, :floppy, :dvd, :hard_disk, :network, :usb, :shared_folder]
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/dhcp_server.rb

@@ -0,0 +1,20 @@
+module VirtualBox
+  module COM
+    module Interface
+      class DHCPServer < AbstractInterface
+        IID = "6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
+
+        property :enabled, T_BOOL
+        property :ip_address, WSTRING, :readonly => true
+        property :network_mask, WSTRING, :readonly => true
+        property :network_name, WSTRING, :readonly => true
+        property :lower_ip, WSTRING, :readonly => true
+        property :upper_ip, WSTRING, :readonly => true
+
+        function :set_configuration, nil, [WSTRING, WSTRING, WSTRING, WSTRING]
+        function :start, nil, [WSTRING, WSTRING, WSTRING]
+        function :stop, nil, []
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/firmware_type.rb

@@ -0,0 +1,9 @@
+module VirtualBox
+  module COM
+    module Interface
+      class FirmwareType < AbstractEnum
+        map [:bios, :efi, :efi32, :efi64, :efidual]
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/guest_os_type.rb

@@ -0,0 +1,21 @@
+module VirtualBox
+  module COM
+    module Interface
+      class GuestOSType < AbstractInterface
+        IID = "cfe9e64c-4430-435b-9e7c-e3d8e417bd58"
+
+        property :family_id, WSTRING, :readonly => true
+        property :family_description, WSTRING, :readonly => true
+        property :id, WSTRING, :readonly => true
+        property :description, WSTRING, :readonly => true
+        property :is_64_bit, T_BOOL, :readonly => true
+        property :recommended_io_apic, T_BOOL, :readonly => true
+        property :recommended_virt_ex, T_BOOL, :readonly => true
+        property :recommended_ram, T_UINT32, :readonly => true
+        property :recommended_vram, T_UINT32, :readonly => true
+        property :recommended_hdd, T_UINT32, :readonly => true
+        property :adapter_type, :NetworkAdapterType, :readonly => true
+      end
+    end
+  end
+end

data/lib/virtualbox/com/interface/host.rb

@@ -0,0 +1,40 @@
+module VirtualBox
+  module COM
+    module Interface
+      class Host < AbstractInterface
+        IID_STR = "e380cbfc-ae65-4fa6-899e-45ded6b3132a"
+
+        property :dvd_drives, [:Medium], :readonly => true
+        property :floppy_drives, [:Medium], :readonly => true
+        property :usb_devices, [:HostUSBDevice], :readonly => true
+        property :usb_device_filters, [:HostUSBDeviceFilter], :readonly => true
+        property :network_interfaces, [:HostNetworkInterface], :readonly => true
+        property :processor_count, T_ULONG, :readonly => true
+        property :processor_online_count, T_ULONG, :readonly => true
+        property :memory_size, T_ULONG, :readonly => true
+        property :memory_available, T_ULONG, :readonly => true
+        property :operating_system, WSTRING, :readonly => true
+        property :os_version, WSTRING, :readonly => true
+        property :utc_time, T_INT64, :readonly => true
+        property :acceleration_3d_available, T_BOOL, :readonly => true
+
+        function :get_processor_speed, T_ULONG, [T_UINT32]
+        function :get_processor_feature, T_BOOL, [T_UINT32] # TODO ENUM
+        function :get_processor_description, WSTRING, [T_UINT32]
+        function :get_processor_cpu_id_leaf, nil, [T_UINT32, T_UINT32, T_UINT32, [:out, T_UINT32], [:out, T_UINT32], [:out, T_UINT32], [:out, T_UINT32]]
+        function :create_host_only_network_interface, :Progress, [[:out, :HostNetworkInterface]]
+        function :remove_host_only_network_interface, :Progress, [WSTRING]
+        function :create_usb_device_filter, :HostUSBDeviceFilter, [WSTRING]
+        function :insert_usb_device_filter, nil, [T_UINT32, :HostUSBDeviceFilter]
+        function :remove_usb_device_filter, nil, [T_UINT32]
+        function :find_host_dvd_drive, :Medium, [WSTRING]
+        function :find_host_floppy_drive, :Medium, [WSTRING]
+        function :find_host_network_interface_by_name, :HostNetworkInterface, [WSTRING]
+        function :find_host_network_interface_by_id, :HostNetworkInterface, [WSTRING]
+        function :find_host_network_interfaces_of_type, [:HostNetworkInterface], [:HostNetworkInterfaceType]
+        function :find_usb_device_by_id, :HostUSBDevice, [WSTRING]
+        function :find_usb_device_by_address, :HostUSBDevice, [WSTRING]
+      end
+    end
+  end
+end