dcopclient.h

/*
Copyright (c) 1999 Preston Brown <pbrown@kde.org>
Copyright (c) 1999, 2000 Matthias Ettrich <ettrich@kde.org>
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
 
#ifndef _DCOPCLIENT_H
#define _DCOPCLIENT_H
 
#include <tqobject.h>
#include <tqcstring.h>
#include <tqvaluelist.h>
#include <tqstring.h>
#include <kdatastream.h> // needed for proper bool marshalling
#include <tdelibs_export.h>
 
class DCOPObjectProxy;
class DCOPClientPrivate;
class DCOPClientTransaction;
 
typedef TQValueList<TQCString> QCStringList;

class DCOP_EXPORT DCOPClient : public TQObject
{
  TQ_OBJECT
  
 
 public:
  DCOPClient();

  virtual ~DCOPClient();

  static void setServerAddress(const TQCString &addr);

  bool attach();

  void bindToApp();

  bool detach();

  bool isAttached() const;

  bool isAttachedToForeignServer() const;

  bool acceptCalls() const;

  void setAcceptCalls(bool b);

  bool qtBridgeEnabled(); // ### KDE 4.0: make const

  void setQtBridgeEnabled(bool b);

  TQCString registerAs( const TQCString &appId, bool addPID = true );

  bool isRegistered() const;

  TQCString appId() const;

  int socket() const;

  void suspend();

  void resume();

  bool isSuspended() const;

  bool send(const TQCString &remApp, const TQCString &remObj,
        const TQCString &remFun, const TQByteArray &data);

  bool send(const TQCString &remApp, const TQCString &remObj,
        const TQCString &remFun, const TQString &data);

 
  bool call(const TQCString &remApp, const TQCString &remObj,
        const TQCString &remFun, const TQByteArray &data,
        TQCString& replyType, TQByteArray &replyData,
        bool useEventLoop/*=false*/, int timeout/*=-1*/,
        bool forceRemote/*=false*/);

  // KDE4 merge with above
  bool call(const TQCString &remApp, const TQCString &remObj,
        const TQCString &remFun, const TQByteArray &data,
        TQCString& replyType, TQByteArray &replyData,
        bool useEventLoop/*=false*/, int timeout/*=-1*/);
  // KDE4 merge with above
  bool call(const TQCString &remApp, const TQCString &remObj,
        const TQCString &remFun, const TQByteArray &data,
        TQCString& replyType, TQByteArray &replyData,
        bool useEventLoop=false);

  int callAsync(const TQCString &remApp, const TQCString &remObj,
                const TQCString &remFun, const TQByteArray &data,
                TQObject *callBackObj, const char *callBackSlot);

  bool findObject(const TQCString &remApp, const TQCString &remObj,
        const TQCString &remFun, const TQByteArray &data,
        TQCString &foundApp, TQCString &foundObj,
        bool useEventLoop/*=false*/, int timeout/*=-1*/);

  // KDE4 merge with above
  bool findObject(const TQCString &remApp, const TQCString &remObj,
        const TQCString &remFun, const TQByteArray &data,
        TQCString &foundApp, TQCString &foundObj,
        bool useEventLoop=false);
 

  void emitDCOPSignal( const TQCString &object, const TQCString &signal,
                       const TQByteArray &data);
 
  /* For backwards compatibility */
  void emitDCOPSignal( const TQCString &signal, const TQByteArray &data);

  bool connectDCOPSignal( const TQCString &sender, const TQCString &senderObj,
                          const TQCString &signal,
                          const TQCString &receiverObj, const TQCString &slot,
                          bool Volatile);

  bool connectDCOPSignal( const TQCString &sender, const TQCString &signal,
                          const TQCString &receiverObj, const TQCString &slot,
                          bool Volatile) TDE_DEPRECATED;

  bool disconnectDCOPSignal( const TQCString &sender, const TQCString &senderObj,
                          const TQCString &signal,
                          const TQCString &receiverObj, const TQCString &slot);

  bool disconnectDCOPSignal( const TQCString &sender, const TQCString &signal,
                          const TQCString &receiverObj, const TQCString &slot) TDE_DEPRECATED;

  virtual bool process(const TQCString &fun, const TQByteArray &data,
               TQCString& replyType, TQByteArray &replyData);

  DCOPClientTransaction *beginTransaction( );

  void endTransaction( DCOPClientTransaction *t, TQCString& replyType, TQByteArray &replyData);

  TQ_INT32 transactionId() const;

  bool isApplicationRegistered( const TQCString& remApp);

  QCStringList registeredApplications();

  QCStringList remoteObjects( const TQCString& remApp, bool *ok = 0 );

  QCStringList remoteInterfaces( const TQCString& remApp, const TQCString& remObj , bool *ok = 0 );

  QCStringList remoteFunctions( const TQCString& remApp, const TQCString& remObj , bool *ok = 0 );

  bool receive(const TQCString &app, const TQCString &obj,
           const TQCString &fun, const TQByteArray& data,
           TQCString& replyType, TQByteArray &replyData);

  bool find(const TQCString &app, const TQCString &obj,
        const TQCString &fun, const TQByteArray& data,
        TQCString& replyType, TQByteArray &replyData);

  static TQCString normalizeFunctionSignature( const TQCString& fun );
 

  TQCString senderId() const;
 

  void setDefaultObject( const TQCString& objId );

  TQCString defaultObject() const;

  void setNotifications( bool enabled );

  void setDaemonMode( bool daemonMode );

  void setPriorityCall(bool);

  static DCOPClient* mainClient();

  static void setMainClient( DCOPClient* mainClient);

  static DCOPClient* findLocalClient( const TQCString &_appId );

  static void emergencyClose();

  static const char *postMortemSender();
  static const char *postMortemObject();
  static const char *postMortemFunction();

  static TQCString dcopServerFile(const TQCString &hostname=0);

  static TQCString dcopServerFileOld(const TQCString &hostname=0) TDE_DEPRECATED;

  static TQCString iceauthPath();
 
signals:
  void applicationRegistered( const TQCString& appId );
  void applicationRemoved( const TQCString& appId );

  void attachFailed(const TQString &msg);

  void blockUserInput( bool block );

  void callBack(int, const TQCString&, const TQByteArray &);
 
public slots:
  void processSocketData(int socknum);
 
protected slots:
 
private slots:
  void processPostedMessagesInternal();
  void asyncReplyReady();
  void eventLoopTimeout();
 
public:
  class ReplyStruct;

  void handleAsyncReply(ReplyStruct *replyStruct);
 
private:
 
  bool isLocalTransactionFinished(TQ_INT32 id, TQCString &replyType, TQByteArray &replyData);
 
  bool attachInternal( bool registerAsAnonymous = true );
 
  bool callInternal(const TQCString &remApp, const TQCString &remObj,
        const TQCString &remFun, const TQByteArray &data,
        TQCString& replyType, TQByteArray &replyData,
        bool useEventLoop, int timeout, int minor_opcode);
 
 
  bool callInternal(const TQCString &remApp, const TQCString &remObjId,
            const TQCString &remFun, const TQByteArray &data,
            ReplyStruct *replyStruct,
            bool useEventLoop, int timeout, int minor_opcode);
 
protected:
  virtual void virtual_hook( int id, void* data );
private:
  DCOPClientPrivate *d;
};
 
#endif