ruby-dbus 0.8.0 → 0.9.0

data/lib/dbus/bus.rb

@@ -3,7 +3,7 @@
 # This file is part of the ruby-dbus project
 # Copyright (C) 2007 Arnaud Cornet and Paul van Tilburg
 #
-# This library is free software; you can redistribute it and/or
+# This library is free software; you caan redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
 # License, version 2.1 as published by the Free Software Foundation.
 # See the file "COPYING" for the exact licensing terms.
@@ -49,7 +49,8 @@ module DBus
       self
     end
 
-    # Retrieves an object (ProxyObject) at the given _path_.
+    # Retrieves an object at the given _path_.
+    # @return [ProxyObject]
     def object(path)
       node = get_node(path, true)
       if node.object.nil?
@@ -95,7 +96,7 @@ module DBus
         n = n[elem]
       end
       if n.nil?
-        puts "Warning, unknown object #{path}" if $DEBUG
+        DBus.logger.debug "Warning, unknown object #{path}"
       end
       n
     end
@@ -248,7 +249,7 @@ module DBus
           @is_tcp = true
         rescue
           puts "Error: Could not establish connection to: #{@path}, will now exit."
-          exit(0) #a little harsh
+          exit(1) #a little harsh
         end
       else
         #Danger, Will Robinson: the specified "path" is not usable
@@ -469,6 +470,7 @@ module DBus
     #
     # FIXME, NameRequestError cannot really be rescued as it will be raised
     # when dispatching a later call. Rework the API to better match the spec.
+    # @return [Service]
     def request_service(name)
       # Use RequestName, but asynchronously!
       # A synchronous call would not work with service activation, where
@@ -598,10 +600,10 @@ module DBus
     def add_match(mr, &slot)
       # check this is a signal.
       mrs = mr.to_s
-      puts "#{@signal_matchrules.size} rules, adding #{mrs.inspect}" if $DEBUG
+      DBus.logger.debug "#{@signal_matchrules.size} rules, adding #{mrs.inspect}"
       # don't ask for the same match if we override it
       unless @signal_matchrules.key?(mrs)
-        puts "Asked for a new match" if $DEBUG
+        DBus.logger.debug "Asked for a new match"
         proxy.AddMatch(mrs)
       end
       @signal_matchrules[mrs] = slot
@@ -625,7 +627,7 @@ module DBus
         raise InvalidPacketException if m.reply_serial == nil
         mcs = @method_call_replies[m.reply_serial]
         if not mcs
-          puts "DEBUG: no return code for mcs: #{mcs.inspect} m: #{m.inspect}" if $DEBUG
+          DBus.logger.debug "no return code for mcs: #{mcs.inspect} m: #{m.inspect}"
         else
           if m.message_type == Message::ERROR
             mcs.call(Error.new(m))
@@ -637,7 +639,7 @@ module DBus
         end
       when DBus::Message::METHOD_CALL
         if m.path == "/org/freedesktop/DBus"
-          puts "DEBUG: Got method call on /org/freedesktop/DBus" if $DEBUG
+          DBus.logger.debug "Got method call on /org/freedesktop/DBus"
         end
         node = @service.get_node(m.path)
         if not node
@@ -664,11 +666,12 @@ module DBus
           end
         end
       else
-        puts "DEBUG: Unknown message type: #{m.message_type}" if $DEBUG
+        DBus.logger.debug "Unknown message type: #{m.message_type}"
       end
     end
 
     # Retrieves the Service with the given _name_.
+    # @return [Service]
     def service(name)
       # The service might not exist at this time so we cannot really check
       # anything
@@ -704,7 +707,7 @@ module DBus
       m.member = "Hello"
       send_sync(m) do |rmsg|
         @unique_name = rmsg.destination
-        puts "Got hello reply. Our unique_name is #{@unique_name}" if $DEBUG
+        DBus.logger.debug "Got hello reply. Our unique_name is #{@unique_name}"
       end
       @service = Service.new(@unique_name, self)
     end
@@ -794,12 +797,14 @@ module DBus
     include Singleton
   end
 
-  # Shortcut for the SystemBus instance
+  # Shortcut for the {SystemBus} instance
+  # @return [Connection]
   def DBus.system_bus
     SystemBus.instance
   end
 
-  # Shortcut for the SessionBus instance
+  # Shortcut for the {SessionBus} instance
+  # @return [Connection]
   def DBus.session_bus
     SessionBus.instance
   end

data/lib/dbus/introspect.rb

@@ -247,50 +247,34 @@ module DBus
       (class << self ; self ; end)
     end
 
-    # FIXME
-    def check_for_eval(s)
-      raise RuntimeError, "invalid internal data '#{s}'" if not s.to_s =~ /^[A-Za-z0-9_]*$/
-    end
-
-    # FIXME
-    def check_for_quoted_eval(s)
-      raise RuntimeError, "invalid internal data '#{s}'" if not s.to_s =~ /^[^"]+$/
-    end
-
     # Defines a method on the interface from the Method descriptor _m_.
     def define_method_from_descriptor(m)
-      check_for_eval(m.name)
-      check_for_quoted_eval(@name)
-      methdef = "def #{m.name}("
-      methdef += (0..(m.params.size - 1)).to_a.collect { |n|
-        "arg#{n}"
-      }.push("&reply_handler").join(", ")
-      methdef += %{)
-              msg = Message.new(Message::METHOD_CALL)
-              msg.path = @object.path
-              msg.interface = "#{@name}"
-              msg.destination = @object.destination
-              msg.member = "#{m.name}"
-              msg.sender = @object.bus.unique_name
-            }
-      idx = 0
       m.params.each do |fpar|
         par = fpar.type
-        check_for_quoted_eval(par)
-
         # This is the signature validity check
         Type::Parser.new(par).parse
-
-        methdef += %{
-          msg.add_param("#{par}", arg#{idx})
-        }
-        idx += 1
       end
-      methdef += "
-        @object.bus.send_sync_or_async(msg, &reply_handler)
+
+      singleton_class.class_eval do
+        define_method m.name do |*args, &reply_handler|
+          if m.params.size != args.size
+            raise ArgumentError, "wrong number of arguments (#{args.size} for #{m.params.size})"
+          end
+
+          msg = Message.new(Message::METHOD_CALL)
+          msg.path = @object.path
+          msg.interface = @name
+          msg.destination = @object.destination
+          msg.member = m.name
+          msg.sender = @object.bus.unique_name
+          m.params.each do |fpar|
+            par = fpar.type
+            msg.add_param(par, args.shift)
+          end
+          @object.bus.send_sync_or_async(msg, &reply_handler)
+        end
       end
-      "
-      singleton_class.class_eval(methdef)
+
       @methods[m.name] = m
     end
 
@@ -315,9 +299,25 @@ module DBus
       define(m)
     end
 
+    # @overload on_signal(name, &block)
+    # @overload on_signal(bus, name, &block)
     # Registers a handler (code block) for a signal with _name_ arriving
     # over the given _bus_. If no block is given, the signal is unregistered.
-    def on_signal(bus, name, &block)
+    # Note that specifying _bus_ is discouraged and the option is kept only for
+    # backward compatibility.
+    # @return [void]
+    def on_signal(*args, &block)
+      # Since we must function under ruby 1.8.7, it isn't possible to define the
+      # function as on_signal(bus = nil, name, &block)
+      bus = case args.size
+              when 1
+                @object.bus
+              when 2
+                args.shift
+              else
+                raise ArgumentError, "wrong number of arguments (#{args.size} for 1-2)"
+            end
+      name = args.shift
       mr = DBus::MatchRule.new.from_signal(self, name)
       if block.nil?
         bus.remove_match(mr)
@@ -339,6 +339,7 @@ module DBus
     end
 
     # Read all properties at once, as a hash.
+    # @return [Hash{String}]
     def all_properties
       self.object[PROPERTY_INTERFACE].GetAll(self.name)[0]
     end
@@ -361,7 +362,7 @@ module DBus
     attr_reader :path
     # The bus the object is reachable via.
     attr_reader :bus
-    # The default interface of the object, as String.
+    # @return [String] The name of the default interface of the object.
     attr_accessor :default_iface
 
     # Creates a new proxy object living on the given _bus_ at destination _dest_
@@ -377,25 +378,69 @@ module DBus
       @interfaces.keys
     end
 
-    # Retrieves an interface of the proxy object (ProxyObjectInterface instance).
+    # Retrieves an interface of the proxy object
+    # @param [String] intfname
+    # @return [ProxyObjectInterface]
     def [](intfname)
       @interfaces[intfname]
     end
 
     # Maps the given interface name _intfname_ to the given interface _intf.
+    # @param [String] intfname
+    # @param [ProxyObjectInterface] intf
+    # @return [ProxyObjectInterface]
     def []=(intfname, intf)
       @interfaces[intfname] = intf
     end
 
-    # Introspects the remote object.  Allows you to find and select
+    # Introspects the remote object. Allows you to find and select
     # interfaces on the object.
     def introspect
       # Synchronous call here.
       xml = @bus.introspect_data(@destination, @path)
       ProxyObjectFactory.introspect_into(self, xml)
+      define_shortcut_methods()
       xml
     end
 
+    # For each non duplicated method name in any interface present on the
+    # caller, defines a shortcut method dynamically.
+    # This function is automatically called when a {ProxyObject} is
+    # introspected.
+    def define_shortcut_methods
+      # builds a list of duplicated methods
+      dup_meths, univocal_meths = [],{}
+      @interfaces.each_value do |intf|
+        intf.methods.each_value do |meth|
+          # Module#instance_methods give us an array of symbols or strings,
+          # depending on which version
+          name = if RUBY_VERSION >= "1.9"
+                   meth.name.to_sym
+                 else
+                   meth.name
+                 end
+          # don't overwrite instance methods!
+          if dup_meths.include? name or self.class.instance_methods.include? name
+            next
+          elsif univocal_meths.include? name
+            univocal_meths.delete name
+            dup_meths << name
+          else
+            univocal_meths[name] = intf
+          end
+        end
+      end
+      univocal_meths.each do |name, intf|
+        # creates a shortcut function that forwards each call to the method on
+        # the appropriate intf
+        singleton_class.class_eval do
+          define_method name do |*args, &reply_handler|
+            intf.method(name).call(*args, &reply_handler)
+          end
+        end
+      end
+    end
+
     # Returns whether the object has an interface with the given _name_.
     def has_iface?(name)
       raise "Cannot call has_iface? if not introspected" if not @introspected
@@ -404,9 +449,10 @@ module DBus
 
     # Registers a handler, the code block, for a signal with the given _name_.
     # It uses _default_iface_ which must have been set.
+    # @return [void]
     def on_signal(name, &block)
       if @default_iface and has_iface?(@default_iface)
-        @interfaces[@default_iface].on_signal(@bus, name, &block)
+        @interfaces[@default_iface].on_signal(name, &block)
       else
         # TODO improve
         raise NoMethodError
@@ -437,6 +483,11 @@ module DBus
         raise NoMethodError, "undefined method `#{name}' for DBus interface `#{@default_iface}' on object `#{@path}'"
       end
     end
+
+    # Returns the singleton class of the object.
+    def singleton_class
+      (class << self ; self ; end)
+    end
   end # class ProxyObject
 
   # = D-Bus proxy object factory class

data/lib/dbus/logger.rb

@@ -0,0 +1,31 @@
+# dbus/logger.rb - debug logging
+#
+# This file is part of the ruby-dbus project
+# Copyright (C) 2012 Martin Vidner
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License, version 2.1 as published by the Free Software Foundation.
+# See the file "COPYING" for the exact licensing terms.
+
+require 'logger'
+
+module DBus
+  # Get the logger for the DBus module.
+  # The default one logs to STDERR,
+  # with DEBUG if $DEBUG is set, otherwise INFO.
+  def logger
+    unless defined? @logger
+      @logger = Logger.new(STDERR)
+      @logger.level = $DEBUG ? Logger::DEBUG : Logger::INFO
+    end
+    @logger
+  end
+  module_function :logger
+
+  # Set the logger for the DBus module
+  def logger=(logger)
+    @logger = logger
+  end
+  module_function :logger=
+end

data/lib/dbus/message.rb

@@ -101,6 +101,10 @@ module DBus
       end
     end
 
+    def to_s
+      "#{message_type} sender=#{sender} -> dest=#{destination} serial=#{serial} reply_serial=#{reply_serial} path=#{path}; interface=#{interface}; member=#{member} error_name=#{error_name}"
+    end
+
     # Create a regular reply to a message _m_.
     def self.method_return(m)
       MethodReturnMessage.new.reply_to(m)
@@ -161,64 +165,18 @@ module DBus
       marshaller.append(Type::BYTE, @protocol)
       marshaller.append(Type::UINT32, @body_length)
       marshaller.append(Type::UINT32, @serial)
-      marshaller.array(Type::Parser.new("y").parse[0]) do
-        if @path
-          marshaller.struct do
-            marshaller.append(Type::BYTE, PATH)
-            marshaller.append(Type::BYTE, 1)
-            marshaller.append_simple_string("o")
-            marshaller.append(Type::OBJECT_PATH, @path)
-          end
-        end
-        if @interface
-          marshaller.struct do
-            marshaller.append(Type::BYTE, INTERFACE)
-            marshaller.append(Type::BYTE, 1)
-            marshaller.append_simple_string("s")
-            marshaller.append(Type::STRING, @interface)
-          end
-        end
-        if @member
-          marshaller.struct do
-            marshaller.append(Type::BYTE, MEMBER)
-            marshaller.append(Type::BYTE, 1)
-            marshaller.append_simple_string("s")
-            marshaller.append(Type::STRING, @member)
-          end
-        end
-        if @error_name
-          marshaller.struct do
-            marshaller.append(Type::BYTE, ERROR_NAME)
-            marshaller.append(Type::BYTE, 1)
-            marshaller.append_simple_string("s")
-            marshaller.append(Type::STRING, @error_name)
-          end
-        end
-        if @reply_serial
-          marshaller.struct do
-            marshaller.append(Type::BYTE, REPLY_SERIAL)
-            marshaller.append(Type::BYTE, 1)
-            marshaller.append_simple_string("u")
-            marshaller.append(Type::UINT32, @reply_serial)
-          end
-        end
-        if @destination
-          marshaller.struct do
-            marshaller.append(Type::BYTE, DESTINATION)
-            marshaller.append(Type::BYTE, 1)
-            marshaller.append_simple_string("s")
-            marshaller.append(Type::STRING, @destination)
-          end
-        end
-        if @signature != ""
-          marshaller.struct do
-            marshaller.append(Type::BYTE, SIGNATURE)
-            marshaller.append(Type::BYTE, 1)
-            marshaller.append_simple_string("g")
-            marshaller.append(Type::SIGNATURE, @signature)
-          end
-        end
-      end
+
+      headers = []
+      headers << [PATH,         ["o", @path]]         if @path
+      headers << [INTERFACE,    ["s", @interface]]    if @interface
+      headers << [MEMBER,       ["s", @member]]       if @member
+      headers << [ERROR_NAME,   ["s", @error_name]]   if @error_name
+      headers << [REPLY_SERIAL, ["u", @reply_serial]] if @reply_serial
+      headers << [DESTINATION,  ["s", @destination]]  if @destination
+      #           SENDER is not sent, the message bus fills it in instead
+      headers << [SIGNATURE,    ["g", @signature]]    if @signature != ""
+      marshaller.append("a(yv)", headers)
+
       marshaller.align(8)
       @params.each do |param|
         marshaller.append(param[0], param[1])

data/lib/dbus/type.rb

@@ -15,47 +15,31 @@ module DBus
 # This module containts the constants of the types specified in the D-Bus
 # protocol.
 module Type
-  # The types.
-  INVALID = 0
-  BYTE = ?y
-  BOOLEAN = ?b
-  INT16 = ?n
-  UINT16 = ?q
-  INT32 = ?i
-  UINT32 = ?u
-  INT64 = ?x
-  UINT64 = ?t
-  DOUBLE = ?d
-  STRUCT = ?r
-  ARRAY = ?a
-  VARIANT = ?v
-  OBJECT_PATH = ?o
-  STRING = ?s
-  SIGNATURE = ?g
-  DICT_ENTRY = ?e
-  UNIX_FD = ?h
-
-  # Mapping from type number to name.
-  TypeName = {
-    INVALID => "INVALID",
-    BYTE => "BYTE",
-    BOOLEAN => "BOOLEAN",
-    INT16 => "INT16",
-    UINT16 => "UINT16",
-    INT32 => "INT32",
-    UINT32 => "UINT32",
-    INT64 => "INT64",
-    UINT64 => "UINT64",
-    DOUBLE => "DOUBLE",
-    STRUCT => "STRUCT",
-    ARRAY => "ARRAY",
-    VARIANT => "VARIANT",
-    OBJECT_PATH => "OBJECT_PATH",
-    STRING => "STRING",
-    SIGNATURE => "SIGNATURE",
-    DICT_ENTRY => "DICT_ENTRY",
-    UNIX_FD => "UNIX_FD"
+  # Mapping from type number to name and alignment.
+  TypeMapping = {
+    0 => ["INVALID", nil],
+    ?y => ["BYTE", 1],
+    ?b => ["BOOLEAN", 4],
+    ?n => ["INT16", 2],
+    ?q => ["UINT16", 2],
+    ?i => ["INT32", 4],
+    ?u => ["UINT32", 4],
+    ?x => ["INT64", 8],
+    ?t => ["UINT64", 8],
+    ?d => ["DOUBLE", 8],
+    ?r => ["STRUCT", 8],
+    ?a => ["ARRAY", 4],
+    ?v => ["VARIANT", 1],
+    ?o => ["OBJECT_PATH", 4],
+    ?s => ["STRING", 4],
+    ?g => ["SIGNATURE", 1],
+    ?e => ["DICT_ENTRY", 8],
+    ?h => ["UNIX_FD", 4],
   }
+  # Defines the set of constants
+  TypeMapping.each_pair do |key, value|
+    Type.const_set(value.first, key)
+  end
 
   # Exception raised when an unknown/incorrect type is encountered.
   class SignatureException < Exception
@@ -72,7 +56,7 @@ module Type
 
     # Create a new type instance for type number _sigtype_.
     def initialize(sigtype)
-      if not TypeName.keys.member?(sigtype)
+      if not TypeMapping.keys.member?(sigtype)
         raise SignatureException, "Unknown key in signature: #{sigtype.chr}"
       end
       @sigtype = sigtype
@@ -81,25 +65,7 @@ module Type
 
     # Return the required alignment for the type.
     def alignment
-      {
-        BYTE => 1,
-        BOOLEAN => 4,
-        INT16 => 2,
-        UINT16 => 2,
-        INT32 => 4,
-        UINT32 => 4,
-        INT64 => 8,
-        UINT64 => 8,
-        STRUCT => 8,
-        DICT_ENTRY => 8,
-        DOUBLE => 8,
-        ARRAY => 4,
-        VARIANT => 1,
-        OBJECT_PATH => 4,
-        STRING => 4,
-        SIGNATURE => 1,
-        UNIX_FD => 4,
-      }[@sigtype]
+      TypeMapping[@sigtype].last
     end
 
     # Return a string representation of the type according to the
@@ -113,7 +79,7 @@ module Type
       when DICT_ENTRY
         "{" + @members.collect { |t| t.to_s }.join + "}"
       else
-        if not TypeName.keys.member?(@sigtype)
+        if not TypeMapping.keys.member?(@sigtype)
           raise NotImplementedError
         end
         @sigtype.chr
@@ -123,7 +89,7 @@ module Type
     # Add a new member type _a_.
     def <<(a)
       if not [STRUCT, ARRAY, DICT_ENTRY].member?(@sigtype)
-        raise SignatureException 
+        raise SignatureException
       end
       raise SignatureException if @sigtype == ARRAY and @members.size > 0
       if @sigtype == DICT_ENTRY
@@ -145,7 +111,7 @@ module Type
     end
 
     def inspect
-      s = TypeName[@sigtype]
+      s = TypeMapping[@sigtype].first
       if [STRUCT, ARRAY].member?(@sigtype)
         s += ": " + @members.inspect
       end
@@ -176,7 +142,9 @@ module Type
       case c
       when ?a
         res = Type.new(ARRAY)
-        child = parse_one(nextchar)
+        c = nextchar
+        raise SignatureException, "Parse error in #{@signature}" if c == nil
+        child = parse_one(c)
         res << child
       when ?(
         res = Type.new(STRUCT)