include/dbus-c++/interface.h

   1 /*
   2  *
   3  *  D-Bus++ - C++ bindings for D-Bus
   4  *
   5  *  Copyright (C) 2005-2009  Paolo Durante <shackan@gmail.com>
   6  *
   7  *
   8  *  This library is free software; you can redistribute it and/or
   9  *  modify it under the terms of the GNU Lesser General Public
  10  *  License as published by the Free Software Foundation; either
  11  *  version 2.1 of the License, or (at your option) any later version.
  12  *
  13  *  This library is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  *  Lesser General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU Lesser General Public
  19  *  License along with this library; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23
  24
  25 #ifndef __DBUSXX_INTERFACE_H
  26 #define __DBUSXX_INTERFACE_H
  27
  28 #include <string>
  29 #include <map>
  30 #include "api.h"
  31 #include "util.h"
  32 #include "types.h"
  33
  34 #include "message.h"
  35 #include "pendingcall.h"
  36
  37 namespace DBus {
  38
  39 //todo: this should belong to to properties.h
  40 struct DBUSXXAPI PropertyData
  41 {
  42         bool            read;
  43         bool            write;
  44         std::string     sig;
  45         Variant         value;
  46 };
  47
  48 typedef std::map<std::string, PropertyData>     PropertyTable;
  49
  50 class IntrospectedInterface;
  51
  52 class ObjectAdaptor;
  53 class InterfaceAdaptor;
  54 class SignalMessage;
  55
  56 typedef std::map<std::string, InterfaceAdaptor *> InterfaceAdaptorTable;
  57
  58 class DBUSXXAPI AdaptorBase
  59 {
  60 public:
  61
  62         virtual ObjectAdaptor &object() = 0 ;
  63
  64 protected:
  65
  66         InterfaceAdaptor *find_interface(const std::string &name);
  67         InterfaceAdaptor *find_interface_with_method(const std::string &method);
  68
  69         virtual ~AdaptorBase()
  70         {}
  71
  72         virtual void _emit_signal(SignalMessage &) = 0;
  73
  74         InterfaceAdaptorTable _interfaces;
  75 };
  76
  77 /*
  78 */
  79
  80 class ObjectProxy;
  81 class InterfaceProxy;
  82 class CallMessage;
  83
  84 typedef std::map<std::string, InterfaceProxy *> InterfaceProxyTable;
  85
  86 class DBUSXXAPI ProxyBase
  87 {
  88 public:
  89
  90         virtual ObjectProxy &object() = 0 ;
  91
  92 protected:
  93
  94         InterfaceProxy *find_interface(const std::string &name);
  95
  96         virtual ~ProxyBase()
  97         {}
  98
  99         virtual Message _invoke_method(CallMessage &, int timeout) = 0;
 100
 101         virtual PendingCall _invoke_method_async(CallMessage &, const PendingCallSlot &, void* p, int timeout) = 0;
 102
 103         InterfaceProxyTable _interfaces;
 104 };
 105
 106 class DBUSXXAPI Interface
 107 {
 108 public:
 109
 110         Interface(const std::string &name);
 111
 112         virtual ~Interface();
 113
 114         const std::string &name() const { return _name; }
 115
 116 private:
 117
 118         std::string     _name;
 119 };
 120
 121 /*
 122 */
 123
 124 typedef std::map< std::string, Slot<Message, const CallMessage &> > MethodTable;
 125 typedef std::map< std::string, Slot<void, const CallMessage &> > AsyncTable;
 126
 127 class DBUSXXAPI InterfaceAdaptor : public Interface, public virtual AdaptorBase
 128 {
 129 public:
 130
 131         InterfaceAdaptor(const std::string &name);
 132
 133         void dispatch_method(const CallMessage &, Message **);
 134
 135         void emit_signal(const SignalMessage &);
 136
 137         Variant *get_property(const std::string &name);
 138
 139         void set_property(const std::string &name, Variant &value);
 140
 141         bool has_method(const std::string &name) const;
 142
 143         virtual IntrospectedInterface *const introspect() const { return NULL; }
 144
 145 protected:
 146
 147         MethodTable     _methods;
 148         AsyncTable _asyncs;
 149         PropertyTable _properties;
 150 };
 151
 152 /*
 153 */
 154
 155 typedef std::map< std::string, Slot<void, const SignalMessage &> > SignalTable;
 156
 157 class DBUSXXAPI InterfaceProxy : public Interface, public virtual ProxyBase
 158 {
 159 public:
 160
 161         InterfaceProxy(const std::string &name);
 162
 163         Message invoke_method(const CallMessage &, int timeout = -1);
 164
 165         PendingCall invoke_method_async(const CallMessage &, const PendingCallSlot &, void*, int timeout = -1);
 166
 167         bool dispatch_signal(const SignalMessage &);
 168
 169 protected:
 170
 171         SignalTable     _signals;
 172 };
 173
 174 # define register_method(interface, method, callback) \
 175         InterfaceAdaptor::_methods[ #method ] = \
 176                 new ::DBus::Callback< interface, ::DBus::Message, const ::DBus::CallMessage &>(this, & interface :: callback, ::DBus::CallMessage());
 177
 178 # define register_async(interface, method, callback) \
 179         InterfaceAdaptor::_asyncs[ #method ] = \
 180                 new ::DBus::CallbackNoReturn< interface, const ::DBus::CallMessage &>(this, & interface :: callback);
 181
 182 # define bind_property(variable, type, can_read, can_write) \
 183         InterfaceAdaptor::_properties[ #variable ].read = can_read; \
 184         InterfaceAdaptor::_properties[ #variable ].write = can_write; \
 185         InterfaceAdaptor::_properties[ #variable ].sig = type; \
 186         variable.bind(InterfaceAdaptor::_properties[ #variable ]);
 187
 188 # define connect_signal(interface, signal, callback) \
 189         InterfaceProxy::_signals[ #signal ] = \
 190                 new ::DBus::CallbackNoReturn< interface, const ::DBus::SignalMessage &>(this, & interface :: callback);
 191
 192 } /* namespace DBus */
 193
 194 #endif//__DBUSXX_INTERFACE_H