dcopref.h

/*
Copyright (c) 2002 Matthias Ettrich <ettrich@kde.org>
Copyright (c) 1999 Preston Brown <pbrown@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 _DCOPREF_H
#define _DCOPREF_H
 
#include <tqcstring.h>
#include <dcoptypes.h>
#include <kdatastream.h> // needed for proper bool marshalling
#include "tdelibs_export.h"
 
class TQDataStream;
class DCOPObject;
class DCOPClient;

class DCOP_EXPORT DCOPReply
{
public:
    template<class T>
    operator T() {
    T t;
    dcopTypeInit(t);
    if ( typeCheck( dcopTypeName(t), true ) ) {
        TQDataStream reply( data, IO_ReadOnly );
        reply >> t;
    }
    return t;
    }

    template <class T> bool get(  T& t, const char* tname ) {
    if ( typeCheck( tname, false ) ) {
        TQDataStream reply( data, IO_ReadOnly );
        reply >> t;
        return true;
    }
    return false;
    }

    template <class T> bool get(  T& t ) {
    if ( typeCheck( dcopTypeName(t), false ) ) {
        TQDataStream reply( data, IO_ReadOnly );
        reply >> t;
        return true;
    }
    return false;
    }

    inline bool isValid() const { return !type.isNull(); }

    TQByteArray data;
    TQCString type;
private:
    bool typeCheck( const char* t );
    bool typeCheck( const char* t, bool warn );
};

class DCOP_EXPORT DCOPArg  {
public:
    template <class T> DCOPArg( const T& t, const char* tname_arg )
    : tname(tname_arg)
    {
        TQDataStream ds( data, IO_WriteOnly );
        ds << t;
    }

    template <class T> DCOPArg( const T& t )
    : tname( dcopTypeName(t) )
    {
        TQDataStream ds( data, IO_WriteOnly );
        ds << t;
    }

    TQByteArray data;
    const char* tname;
};
 
inline const char* dcopTypeName( const DCOPArg &arg )  { return arg.tname; }
inline TQDataStream & operator << (TQDataStream & str, const DCOPArg& arg )
   { str.writeRawBytes( arg.data.data(), arg.data.size() ); return str; }
 
 

 
class DCOP_EXPORT DCOPRef
{
public:
    DCOPRef();

    DCOPRef( const DCOPRef& ref );
    DCOPRef( const TQCString& app, const TQCString& obj = "" );

    DCOPRef( DCOPObject *object );

    DCOPRef( const TQCString& app, const TQCString& obj, const TQCString& type );

    bool isNull() const;

    TQCString app() const;

    TQCString obj() const;

    TQCString object() const;

    TQCString type() const;
 

    DCOPRef& operator=( const DCOPRef& );

    void setRef( const TQCString& app, const TQCString& obj = "" );

    void setRef( const TQCString& app, const TQCString& obj, const TQCString& type );
 

    void clear();
 

    DCOPClient* dcopClient() const;

    void setDCOPClient( DCOPClient *client );

    enum EventLoopFlag { NoEventLoop, UseEventLoop };
    DCOPReply call( const TQCString& fun ) {
    TQByteArray data;
    return callInternal( fun, "()", data );
    }

    DCOPReply callExt( const TQCString& fun, EventLoopFlag useEventLoop=NoEventLoop,
            int timeout=-1 ) {
    TQByteArray data;
    return callInternal( fun, "()", data, useEventLoop, timeout );
    }

    template <class T1>
    DCOPReply call( const TQCString& fun, const T1& t1 ) {
    TQCString args;
    args.sprintf( "(%s)",
             dcopTypeName(t1) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1;
    return callInternal( fun, args, data );
    }

    template <class T1>
    DCOPReply callExt( const TQCString& fun,
            EventLoopFlag useEventLoop, int timeout,
            const T1& t1) {
    TQCString args;
    args.sprintf( "(%s)",
             dcopTypeName(t1) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1;
    return callInternal( fun, args, data, useEventLoop, timeout );
    }

    template <class T1, class T2>
    DCOPReply call( const TQCString& fun,
            const T1& t1,
            const T2& t2 ) {
    TQCString args;
    args.sprintf( "(%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2;
    return callInternal( fun, args, data );
    }

    template <class T1, class T2>
    DCOPReply callExt( const TQCString& fun,
            EventLoopFlag useEventLoop, int timeout,
            const T1& t1,
            const T2& t2) {
    TQCString args;
    args.sprintf( "(%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2;
    return callInternal( fun, args, data, useEventLoop, timeout );
    }

    template <class T1, class T2, class T3>
    DCOPReply call( const TQCString& fun,
            const T1& t1,
            const T2& t2,
            const T3& t3 ) {
    TQCString args;
    args.sprintf( "(%s,%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2),
             dcopTypeName(t3) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2 << t3;
    return callInternal( fun, args, data );
    }

    template <class T1, class T2, class T3>
    DCOPReply callExt( const TQCString& fun,
            EventLoopFlag useEventLoop, int timeout,
            const T1& t1,
            const T2& t2,
            const T3& t3) {
    TQCString args;
    args.sprintf( "(%s,%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2),
             dcopTypeName(t3) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2 << t3;
    return callInternal( fun, args, data, useEventLoop, timeout );
    }

    template <class T1,class T2,class T3,class T4>
    DCOPReply call( const TQCString& fun,
            const T1& t1,
            const T2& t2,
            const T3& t3,
            const T4& t4 ) {
    TQCString args;
    args.sprintf( "(%s,%s,%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2),
             dcopTypeName(t3),
             dcopTypeName(t4) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2 << t3 << t4;
    return callInternal( fun, args, data );
    }

    template <class T1,class T2,class T3,class T4>
    DCOPReply callExt( const TQCString& fun,
            EventLoopFlag useEventLoop, int timeout,
            const T1& t1,
            const T2& t2,
            const T3& t3,
            const T4& t4) {
    TQCString args;
    args.sprintf( "(%s,%s,%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2),
             dcopTypeName(t3),
             dcopTypeName(t4) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2 << t3 << t4;
    return callInternal( fun, args, data, useEventLoop, timeout );
    }

    template <class T1,class T2,class T3,class T4,class T5>
    DCOPReply call( const TQCString& fun,
            const T1& t1,
            const T2& t2,
            const T3& t3,
            const T4& t4,
            const T5& t5 ) {
    TQCString args;
    args.sprintf( "(%s,%s,%s,%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2),
             dcopTypeName(t3),
             dcopTypeName(t4),
             dcopTypeName(t5) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2 << t3 << t4 << t5;
    return callInternal( fun, args, data );
    }

    template <class T1,class T2,class T3,class T4,class T5>
    DCOPReply callExt( const TQCString& fun,
            EventLoopFlag useEventLoop, int timeout,
            const T1& t1,
            const T2& t2,
            const T3& t3,
            const T4& t4,
            const T5& t5 ) {
    TQCString args;
    args.sprintf( "(%s,%s,%s,%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2),
             dcopTypeName(t3),
             dcopTypeName(t4),
             dcopTypeName(t5) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2 << t3 << t4 << t5;
    return callInternal( fun, args, data, useEventLoop, timeout );
    }

    template <class T1,class T2,class T3,class T4,class T5,class T6>
    DCOPReply call( const TQCString& fun,
            const T1& t1,
            const T2& t2,
            const T3& t3,
            const T4& t4,
            const T5& t5,
            const T6& t6 ) {
    TQCString args;
    args.sprintf( "(%s,%s,%s,%s,%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2),
             dcopTypeName(t3),
             dcopTypeName(t4),
             dcopTypeName(t5),
             dcopTypeName(t6) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2 << t3 << t4 << t5 << t6;
    return callInternal( fun, args, data );
    }

    template <class T1,class T2,class T3,class T4,class T5,class T6>
    DCOPReply callExt( const TQCString& fun,
            EventLoopFlag useEventLoop, int timeout,
            const T1& t1,
            const T2& t2,
            const T3& t3,
            const T4& t4,
            const T5& t5,
            const T6& t6) {
    TQCString args;
    args.sprintf( "(%s,%s,%s,%s,%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2),
             dcopTypeName(t3),
             dcopTypeName(t4),
             dcopTypeName(t5),
             dcopTypeName(t6) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2 << t3 << t4 << t5 << t6;
    return callInternal( fun, args, data, useEventLoop, timeout );
    }

    template <class T1,class T2,class T3,class T4,class T5,class T6,class T7>
    DCOPReply call( const TQCString& fun,
            const T1& t1,
            const T2& t2,
            const T3& t3,
            const T4& t4,
            const T5& t5,
            const T6& t6,
            const T7& t7 ) {
    TQCString args;
    args.sprintf( "(%s,%s,%s,%s,%s,%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2),
             dcopTypeName(t3),
             dcopTypeName(t4),
             dcopTypeName(t5),
             dcopTypeName(t6),
             dcopTypeName(t7) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2 << t3 << t4 << t5 << t6 << t7;
    return callInternal( fun, args, data );
    }

    template <class T1,class T2,class T3,class T4,class T5,class T6,class T7>
    DCOPReply callExt( const TQCString& fun,
            EventLoopFlag useEventLoop, int timeout,
            const T1& t1,
            const T2& t2,
            const T3& t3,
            const T4& t4,
            const T5& t5,
            const T6& t6,
            const T7& t7) {
    TQCString args;
    args.sprintf( "(%s,%s,%s,%s,%s,%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2),
             dcopTypeName(t3),
             dcopTypeName(t4),
             dcopTypeName(t5),
             dcopTypeName(t6),
             dcopTypeName(t7) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2 << t3 << t4 << t5 << t6 << t7;
    return callInternal( fun, args, data, useEventLoop, timeout );
    }

    template <class T1,class T2,class T3,class T4,class T5,class T6,class T7,class T8>
    DCOPReply call( const TQCString& fun,
            const T1& t1,
            const T2& t2,
            const T3& t3,
            const T4& t4,
            const T5& t5,
            const T6& t6,
            const T7& t7,
            const T8& t8 ) {
    TQCString args;
    args.sprintf( "(%s,%s,%s,%s,%s,%s,%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2),
             dcopTypeName(t3),
             dcopTypeName(t4),
             dcopTypeName(t5),
             dcopTypeName(t6),
             dcopTypeName(t7),
             dcopTypeName(t8) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2 << t3 << t4 << t5 << t6 << t7 << t8;
    return callInternal( fun, args, data );
    }

    template <class T1,class T2,class T3,class T4,class T5,class T6,class T7,class T8>
    DCOPReply callExt( const TQCString& fun,
            EventLoopFlag useEventLoop, int timeout,
            const T1& t1,
            const T2& t2,
            const T3& t3,
            const T4& t4,
            const T5& t5,
            const T6& t6,
            const T7& t7,
            const T8& t8) {
    TQCString args;
    args.sprintf( "(%s,%s,%s,%s,%s,%s,%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2),
             dcopTypeName(t3),
             dcopTypeName(t4),
             dcopTypeName(t5),
             dcopTypeName(t6),
             dcopTypeName(t7),
             dcopTypeName(t8) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2 << t3 << t4 << t5 << t6 << t7 << t8;
    return callInternal( fun, args, data, useEventLoop, timeout );
    }

    bool send( const TQCString& fun ) {
    TQByteArray data;
    return sendInternal( fun, "()", data );
    }

    template <class T1>
    bool send( const TQCString& fun, const T1& t1 ) {
    TQCString args;
    args.sprintf( "(%s)",
             dcopTypeName(t1) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1;
    return sendInternal( fun, args, data );
    }

    template <class T1, class T2>
    bool send( const TQCString& fun,
            const T1& t1,
            const T2& t2 ) {
    TQCString args;
    args.sprintf( "(%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2;
    return sendInternal( fun, args, data );
    }

    template <class T1, class T2, class T3>
    bool send( const TQCString& fun,
            const T1& t1,
            const T2& t2,
            const T3& t3 ) {
    TQCString args;
    args.sprintf( "(%s,%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2),
             dcopTypeName(t3) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2 << t3;
    return sendInternal( fun, args, data );
    }

    template <class T1,class T2,class T3,class T4>
    bool send( const TQCString& fun,
            const T1& t1,
            const T2& t2,
            const T3& t3,
            const T4& t4 ) {
    TQCString args;
    args.sprintf( "(%s,%s,%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2),
             dcopTypeName(t3),
             dcopTypeName(t4) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2 << t3 << t4;
    return sendInternal( fun, args, data );
    }

    template <class T1,class T2,class T3,class T4,class T5>
    bool send( const TQCString& fun,
            const T1& t1,
            const T2& t2,
            const T3& t3,
            const T4& t4,
            const T5& t5 ) {
    TQCString args;
    args.sprintf( "(%s,%s,%s,%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2),
             dcopTypeName(t3),
             dcopTypeName(t4),
             dcopTypeName(t5) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2 << t3 << t4 << t5;
    return sendInternal( fun, args, data );
    }

    template <class T1,class T2,class T3,class T4,class T5,class T6>
    bool send( const TQCString& fun,
            const T1& t1,
            const T2& t2,
            const T3& t3,
            const T4& t4,
            const T5& t5,
            const T6& t6 ) {
    TQCString args;
    args.sprintf( "(%s,%s,%s,%s,%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2),
             dcopTypeName(t3),
             dcopTypeName(t4),
             dcopTypeName(t5),
             dcopTypeName(t6) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2 << t3 << t4 << t5 << t6;
    return sendInternal( fun, args, data );
    }

    template <class T1,class T2,class T3,class T4,class T5,class T6,class T7>
    bool send( const TQCString& fun,
            const T1& t1,
            const T2& t2,
            const T3& t3,
            const T4& t4,
            const T5& t5,
            const T6& t6,
            const T7& t7 ) {
    TQCString args;
    args.sprintf( "(%s,%s,%s,%s,%s,%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2),
             dcopTypeName(t3),
             dcopTypeName(t4),
             dcopTypeName(t5),
             dcopTypeName(t6),
             dcopTypeName(t7) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2 << t3 << t4 << t5 << t6 << t7;
    return sendInternal( fun, args, data );
    }

    template <class T1,class T2,class T3,class T4,class T5,class T6,class T7,class T8>
    bool send( const TQCString& fun,
            const T1& t1,
            const T2& t2,
            const T3& t3,
            const T4& t4,
            const T5& t5,
            const T6& t6,
            const T7& t7,
            const T8& t8 ) {
    TQCString args;
    args.sprintf( "(%s,%s,%s,%s,%s,%s,%s,%s)",
             dcopTypeName(t1),
             dcopTypeName(t2),
             dcopTypeName(t3),
             dcopTypeName(t4),
             dcopTypeName(t5),
             dcopTypeName(t6),
             dcopTypeName(t7),
             dcopTypeName(t8) );
    TQByteArray data;
    TQDataStream ds( data, IO_WriteOnly );
    ds << t1 << t2 << t3 << t4 << t5 << t6 << t7 << t8;
    return sendInternal( fun, args, data );
    }
 
 
 
private:
    DCOPReply callInternal( const TQCString& fun, const TQCString& args, const TQByteArray& data,
                EventLoopFlag useEventLoop, int timeout );
    DCOPReply callInternal( const TQCString& fun, const TQCString& args, const TQByteArray& data );
    bool sendInternal( const TQCString& fun, const TQCString& args, const TQByteArray& data );
 
    TQCString m_app;
    TQCString m_obj;
    TQCString m_type;
 
    class DCOPRefPrivate;
    DCOPRefPrivate *d;
};

DCOP_EXPORT TQDataStream& operator<<( TQDataStream&, const DCOPRef& ref );
DCOP_EXPORT TQDataStream& operator>>( TQDataStream&, DCOPRef& ref );
 
#endif