From 08da449f9620e7fcb5898e9a5a048467b6d99bff Mon Sep 17 00:00:00 2001 From: Manuel Nickschas Date: Mon, 27 Aug 2007 17:50:49 +0000 Subject: [PATCH] Last Quassel version to use the soon-to-be-obsolete static signal proxy. Most of the new, QxtRPCPeer-based SignalProxy has been implemented, and after this commit, I'm gonna rip out the guts out of both client and core to make them use dynamic signals-over-net. --- Quassel.kdevelop.filelist | 11 + src/CMakeLists.txt | 3 +- src/common/CMakeLists.txt | 5 +- src/common/signalproxy.cpp | 81 ++++++ src/common/signalproxy.h | 86 ++++++ src/contrib/qxt/AUTHORS | 15 + src/contrib/qxt/CMakeLists.txt | 6 + src/contrib/qxt/LGPL | 504 ++++++++++++++++++++++++++++++++ src/contrib/qxt/LICENSE | 83 ++++++ src/contrib/qxt/README | 4 + src/contrib/qxt/qxtglobal.h | 192 ++++++++++++ src/contrib/qxt/qxtpimpl.h | 192 ++++++++++++ src/contrib/qxt/qxtrpcpeer.cpp | 517 +++++++++++++++++++++++++++++++++ src/contrib/qxt/qxtrpcpeer.h | 289 ++++++++++++++++++ 14 files changed, 1985 insertions(+), 3 deletions(-) create mode 100644 src/common/signalproxy.cpp create mode 100644 src/common/signalproxy.h create mode 100644 src/contrib/qxt/AUTHORS create mode 100644 src/contrib/qxt/CMakeLists.txt create mode 100644 src/contrib/qxt/LGPL create mode 100644 src/contrib/qxt/LICENSE create mode 100644 src/contrib/qxt/README create mode 100644 src/contrib/qxt/qxtglobal.h create mode 100644 src/contrib/qxt/qxtpimpl.h create mode 100644 src/contrib/qxt/qxtrpcpeer.cpp create mode 100644 src/contrib/qxt/qxtrpcpeer.h diff --git a/Quassel.kdevelop.filelist b/Quassel.kdevelop.filelist index 4d05c530..51259503 100644 --- a/Quassel.kdevelop.filelist +++ b/Quassel.kdevelop.filelist @@ -101,3 +101,14 @@ src/qtgui/guisettings.cpp src/common/ircuser.h src/common/ircuser.cpp src/qtgui/settingspage.h +src/contrib +src/contrib/qxt +src/contrib/qxt/qxtglobal.h +src/contrib/qxt/qxtpimpl.h +src/contrib/qxt/qxtrpcpeer.cpp +src/contrib/qxt/qxtrpcpeer.h +src/core/serverinfo.cpp +src/core/serverinfo.h +src/contrib/qxt/CMakeLists.txt +src/common/signalproxy.cpp +src/common/signalproxy.h diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 07d2f2ff..19de1c4a 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -43,7 +43,7 @@ SET(SDIRS "") FOREACH(dir ${quassel_DIRS}) SET(SDIRS ${SDIRS} "${CMAKE_CURRENT_SOURCE_DIR}/${dir}") ENDFOREACH(dir) -INCLUDE_DIRECTORIES(${SDIRS} plugins) +INCLUDE_DIRECTORIES(${SDIRS} plugins contrib/qxt) INCLUDE_DIRECTORIES(${CMAKE_CURRENT_BINARY_DIR}/qtgui) # so that ui files are found # We need Qt4 support. @@ -63,6 +63,7 @@ ADD_DEFINITIONS(${GCC_WARN}) # Define subdirs. CMake complains if a directory is added twice, so make sure this # does not happen in any combination of the requested targets. +ADD_SUBDIRECTORY(contrib/qxt) ADD_SUBDIRECTORY(common) IF(BUILD_CORE) ADD_SUBDIRECTORY(core) diff --git a/src/common/CMakeLists.txt b/src/common/CMakeLists.txt index c05d7c57..517a3d4f 100644 --- a/src/common/CMakeLists.txt +++ b/src/common/CMakeLists.txt @@ -1,6 +1,7 @@ -SET(common_SRCS global.cpp logger.cpp message.cpp settings.cpp util.cpp ircuser.cpp) +SET(common_SRCS global.cpp logger.cpp message.cpp settings.cpp signalproxy.cpp util.cpp ircuser.cpp) SET(common_HDRS global.h message.h util.h) -SET(common_MOCS logger.h ircuser.h quasselui.h settings.h) +SET(common_MOCS logger.h ircuser.h quasselui.h settings.h signalproxy.h) QT4_WRAP_CPP(_MOC ${common_MOCS}) ADD_LIBRARY(common ${common_SRCS} ${_MOC}) +TARGET_LINK_LIBRARIES(common qxt) diff --git a/src/common/signalproxy.cpp b/src/common/signalproxy.cpp new file mode 100644 index 00000000..bd12b15f --- /dev/null +++ b/src/common/signalproxy.cpp @@ -0,0 +1,81 @@ +/*************************************************************************** + * Copyright (C) 2005-07 by The Quassel IRC Development Team * + * devel@quassel-irc.org * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + +#include "signalproxy.h" + +SignalProxy::SignalProxy(ProxyType _type, QIODevice *dev, QObject *parent) : QObject(parent), type(_type) { + if(dev) { + if(type != Client) { + qWarning() << tr("Device given for ProxyType == Server, ignoring...").toAscii(); + } else { + addPeer(dev); + } + } +} + +SignalProxy::~SignalProxy() { + foreach(Connection conn, peers) { + conn.peer->deleteLater(); conn.device->deleteLater(); + } +} + +void SignalProxy::addPeer(QIODevice *dev) { + if(type == Client && peers.count()) { + qWarning() << tr("Cannot add more than one peer to a SignalProxy in client mode!").toAscii(); + return; + } + Connection conn; + conn.device = dev; + conn.peer = new QxtRPCPeer(dev, QxtRPCPeer::Peer, this); + + foreach(SlotDesc slot, attachedSlots) { + conn.peer->attachSlot(slot.rpcFunction, slot.recv, slot.slot); + } + foreach(SignalDesc sig, attachedSignals) { + conn.peer->attachSignal(sig.sender, sig.signal, sig.rpcFunction); + } + peers.append(conn); + +} + +void SignalProxy::attachSignal(QObject* sender, const char* signal, const QByteArray& rpcFunction) { + foreach(Connection conn, peers) { + conn.peer->attachSignal(sender, signal, rpcFunction); + } + attachedSignals.append(SignalDesc(sender, signal, rpcFunction)); + +} + +void SignalProxy::attachSlot(const QByteArray& rpcFunction, QObject* recv, const char* slot) { + foreach(Connection conn, peers) { + conn.peer->attachSlot(rpcFunction, recv, slot); + } + attachedSlots.append(SlotDesc(rpcFunction, recv, slot)); +} + +void SignalProxy::detachObject(QObject* obj) { + Q_ASSERT(false); // not done yet + foreach(Connection conn, peers) { + conn.peer->detachObject(obj); + } + // FIXME: delete attached signal/slot info + +} + diff --git a/src/common/signalproxy.h b/src/common/signalproxy.h new file mode 100644 index 00000000..90daddeb --- /dev/null +++ b/src/common/signalproxy.h @@ -0,0 +1,86 @@ +/*************************************************************************** + * Copyright (C) 2005-07 by The Quassel IRC Development Team * + * devel@quassel-irc.org * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + +#ifndef _RPCPEER_H_ +#define _RPCPEER_H_ + +#include "qxtrpcpeer.h" +#include + +class SignalProxy : public QObject { + Q_OBJECT + + public: + + enum ProxyType { Client, Server }; + + SignalProxy(ProxyType type, QIODevice *device = 0, QObject *parent = 0); + ~SignalProxy(); + + void attachSignal(QObject* sender, const char* signal, const QByteArray& rpcFunction = QByteArray()); + void attachSlot(const QByteArray& rpcFunction, QObject* recv, const char* slot); + + void detachObject(QObject* obj); + + public slots: + void addPeer(QIODevice *device); + + void sendSignal(const char *signal, QVariant p1 = QVariant(), QVariant p2 = QVariant(), QVariant p3 = QVariant(), QVariant p4 = QVariant(), + QVariant p5 = QVariant(), QVariant p6 = QVariant(), QVariant p7 = QVariant(), QVariant p8 = QVariant(), QVariant p9 = QVariant()); + + void detachSender(); + + signals: + //void peerDisconnected(); + + private slots: + + private: + struct Connection { + QPointer peer; + QPointer device; + }; + + struct SignalDesc { + QObject *sender; + const char *signal; + QByteArray rpcFunction; + + SignalDesc(QObject *sndr, const char *sig, const QByteArray &func) : sender(sndr), signal(sig), rpcFunction(func) {} + }; + + struct SlotDesc { + QByteArray rpcFunction; + QObject *recv; + const char *slot; + + SlotDesc(const QByteArray& func, QObject* r, const char* s) : rpcFunction(func), recv(r), slot(s) {} + }; + + ProxyType type; + QList peers; + QList attachedSignals; + QList attachedSlots; + +}; + + + +#endif diff --git a/src/contrib/qxt/AUTHORS b/src/contrib/qxt/AUTHORS new file mode 100644 index 00000000..4e4a445b --- /dev/null +++ b/src/contrib/qxt/AUTHORS @@ -0,0 +1,15 @@ +==Main Contributers (aka Project-Members)== + +Adam Higerd +J-P Nurmi +Arvid Picciani + +==Project Management== + +Arvid Picciani +Adam Higerd + +==Minor Contributions== + +Igor Ulyanov +Bjoern Erik Nilsen diff --git a/src/contrib/qxt/CMakeLists.txt b/src/contrib/qxt/CMakeLists.txt new file mode 100644 index 00000000..9f3c2f2d --- /dev/null +++ b/src/contrib/qxt/CMakeLists.txt @@ -0,0 +1,6 @@ +SET(qxt_SRCS qxtrpcpeer.cpp) +SET(qxt_HDRS qxtglobal.h qxtpimpl.h) +SET(qxt_MOCS qxtrpcpeer.h) + +QT4_WRAP_CPP(_MOC ${qxt_MOCS}) +ADD_LIBRARY(qxt ${qxt_SRCS} ${_MOC}) diff --git a/src/contrib/qxt/LGPL b/src/contrib/qxt/LGPL new file mode 100644 index 00000000..5ab7695a --- /dev/null +++ b/src/contrib/qxt/LGPL @@ -0,0 +1,504 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! + + diff --git a/src/contrib/qxt/LICENSE b/src/contrib/qxt/LICENSE new file mode 100644 index 00000000..e853fa78 --- /dev/null +++ b/src/contrib/qxt/LICENSE @@ -0,0 +1,83 @@ +Qt Extended Library +Copyright (C) 2007 Qxt Foundation + +------------------- Disclaimer ------------------------------------------------ + +Until the Qxt Foundation is legally established, copyright for the +source code falls back to the original contributor. For information about the +status of the Qxt Foundation, or about the copyright status of any part of Qxt, +contact the Qxt project maintainers at . + +Once the Qxt Foundation has been legally established, all contributors must +transfer all copyright interest to the Qxt Foundation before their submissions +will be added to the project. + +------------------- License --------------------------------------------------- + +This library is free software; you can redistribute it and/or modify it under +the terms of the GNU Lesser General Public License as published by the Free +Software Foundation; version 2.1. + +Future versions of the source code of this library may be redistributed and/or +modified under the terms of the Common Public License; version 1.0. + +This library is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more +details about the LGPL (see the included file entitled LGPL) or the Common +Public License for more information about the CPM (see the included file +entitled cpl1.0.txt). + +Parts of Qxt depend on Qt 4 and/or other libraries that have their own +licenses. Qxt is independent of these licenses; however, use of these other +libraries is subject to their respective license agreements. + +------------------- Intent ---------------------------------------------------- + +The following section describes the opinions and intent of the Qxt Foundation +with regards to the licensing and use of the Qxt source code and library. In +the event that the CPL is found to be illegal or invalid, or if any application +or clause of the license is subjected to question or abuse, this section is a +general statement of the desired interpretation. + +This section has no legal standing and the statements made here are strictly +subject to the text of the CPL; that is, if this section and the CPL are in +disagreement, the text of the CPL takes precedence. In no way does this +intent grant you any additional rights or impose any additional restrictions. + +If you have questions about licensing, contact the maintainers. + +Qxt is built and supported by open-source enthusiasts. +- Please respect the open-source background of the contributors. The code is + provided for everyone's use; you may not restrict the rights of anyone to + use it. + - No individual may claim ownership of any part of the code. It belongs + to the community. + - You may modify the source code to suit your needs, but these changes + must be made free. If you distribute a modified form of Qxt, you must + also distribute the entire source code of the modified form. + - Digital Rights Management (DRM) puts unfair, unfree restrictions on + users and developers. It is the opposite of Free Software. We can't + stop you from using it, but please don't use the Qxt name for software + restricted by DRM. +- Please respect the time and effort put into the project by the developers. + - If you find Qxt useful, it would be appreciated if you would include + text in your application (for instance, in the About dialog) giving + acknowledgement to Qxt. + - If you make modifications to the source code, you must not call the + modified version "Qxt." It's okay to include "Qxt" in the name, but + anyone who receives the modified version needs to know that it's not + the same as the version distributed by the Qxt Foundation. +- We want everyone to be able to use Qxt without restrictions. + - If you distribute Qxt in compiled binary form, please ensure that + everyone who receives it can get the source code used to create it. + - You are free to use Qxt in closed-source applications as long as you + distribute Qxt in an open-source fashion. This does not require you + to make your entire application open-source. +- The Qxt Foundation is a non-profit, non-political organization. + - Please don't use the Qxt name in any political or semi-political + propaganda or publication. We don't like it. +- Qxt is distributed "as-is," with no warranty. + - If it makes your program crash, your computer blow up, or tiny demons + fly out of your nose, please don't sue us. + diff --git a/src/contrib/qxt/README b/src/contrib/qxt/README new file mode 100644 index 00000000..47fcd5af --- /dev/null +++ b/src/contrib/qxt/README @@ -0,0 +1,4 @@ +This directory contains some files from the Qt Extension Library Project, +which can be found at . We have taken the liberty +of not copying the whole Qxt source into the Quassel tree, but only the parts +we need, specifically we are using QxtRPCPeer within Quassel IRC. diff --git a/src/contrib/qxt/qxtglobal.h b/src/contrib/qxt/qxtglobal.h new file mode 100644 index 00000000..4a2e6b77 --- /dev/null +++ b/src/contrib/qxt/qxtglobal.h @@ -0,0 +1,192 @@ +/**************************************************************************** +** +** Copyright (C) Qxt Foundation. Some rights reserved. +** +** This file is part of the QxtCore module of the Qt eXTension library +** +** This library is free software; you can redistribute it and/or modify it +** under the terms of th Common Public License, version 1.0, as published by +** IBM. +** +** This file is provided "AS IS", without WARRANTIES OR CONDITIONS OF ANY +** KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY +** WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR +** FITNESS FOR A PARTICULAR PURPOSE. +** +** You should have received a copy of the CPL along with this file. +** See the LICENSE file and the cpl1.0.txt file included with the source +** distribution for more information. If you did not receive a copy of the +** license, contact the Qxt Foundation. +** +** +** +****************************************************************************/ + + +/** \defgroup core Core + The Core contains naturaly the most important parts of Qxt everything is based one. it has no QT depencies and is licenced under pure lgpl +*/ + +/** \defgroup kit Kit + the kit module contains the base parts of Qxt that depend on QtCore +*/ + +/** \defgroup sql Sql + parts that depend on QtSql (and at least QtCore) +*/ + +/** \defgroup network Network + parts that depend on QtNetwork (and at least QtCore) +*/ + +/** \defgroup gui Gui + parts that depend on QtGui (and at least QtCore) +*/ + + +/** \defgroup curses Curses + Qt like ncurses Frontend +*/ + +/** \defgroup web Web + Qt like Web Developement tools +*/ + +/** \defgroup crypto Crypto + Tools for encryption and hashing +*/ + + + +/** + +*/ +/*! \mainpage Qt extension librarys + * + * + * Qxt Provides Classes for extended needs based on the Qt Library by Trolltech + * + * Checkout the classes list + +\image html logo.png + * + */ + + +#ifndef QXTDEFINES_HEADER_GUARDD +#define QXTDEFINES_HEADER_GUARDD + + + + + +#define QXT_VERSION ( (2<<16) + (2<<8) + 3 ) + + + +//--------------------------global macros------------------------------ + +#ifndef QXT_NO_MACROS + +#endif + +//--------------------------export macros------------------------------ + + + + +# define QXT_DLLEXPORT DO_NOT_USE_THIS_ANYMORE + + + + + + + +#if defined(QXT_WINDOWS) + +# if defined(BUILD_QXT_CORE) +# define QXT_CORE_EXPORT __declspec(dllexport) +# else +# define QXT_CORE_EXPORT __declspec(dllimport) +# endif + +# if defined(BUILD_QXT_GUI) +# define QXT_GUI_EXPORT __declspec(dllexport) +# else +# define QXT_GUI_EXPORT __declspec(dllimport) +# endif + +# if defined(BUILD_QXT_MEDIA) +# define QXT_MEDIA_EXPORT __declspec(dllexport) +# else +# define QXT_MEDIA_EXPORT __declspec(dllimport) +# endif + + +# if defined(BUILD_QXT_NETWORK) +# define QXT_NETWORK_EXPORT __declspec(dllexport) +# else +# define QXT_NETWORK_EXPORT __declspec(dllimport) +# endif + + +# if defined(BUILD_QXT_SQL) +# define QXT_SQL_EXPORT __declspec(dllexport) +# else +# define QXT_SQL_EXPORT __declspec(dllimport) +# endif + +# if defined(BUILD_QXT_WEB) +# define QXT_WEB_EXPORT __declspec(dllexport) +# else +# define QXT_WEB_EXPORT __declspec(dllimport) +# endif + +# if defined(BUILD_QXT_CRYPTO) +# define QXT_CRYPTO_EXPORT __declspec(dllexport) +# else +# define QXT_CRYPTO_EXPORT __declspec(dllimport) +# endif + + +#else + +# define QXT_CORE_EXPORT +# define QXT_GUI_EXPORT +# define QXT_MEDIA_EXPORT +# define QXT_NETWORK_EXPORT +# define QXT_SQL_EXPORT +# define QXT_WEB_EXPORT +# define QXT_CRYPTO_EXPORT + + + + +#endif + + + + + + + + + + +#if defined BUILD_QXT_CORE || defined BUILD_QXT_GUI || defined BUILD_QXT_MEDIA || defined BUILD_QXT_SQL || defined BUILD_QXT_NETWORK || defined BUILD_QXT_KIT || defined BUILD_QXT_WEB || defined BUILD_QXT_CRYPTO +#define BUILD_QXT +#endif + + + + + + + + + + + +#endif //guards + diff --git a/src/contrib/qxt/qxtpimpl.h b/src/contrib/qxt/qxtpimpl.h new file mode 100644 index 00000000..e1aeaa40 --- /dev/null +++ b/src/contrib/qxt/qxtpimpl.h @@ -0,0 +1,192 @@ +/**************************************************************************** +** +** Copyright (C) Qxt Foundation. Some rights reserved. +** +** This file is part of the QxtCore module of the Qt eXTension library +** +** This library is free software; you can redistribute it and/or modify it +** under the terms of th Common Public License, version 1.0, as published by +** IBM. +** +** This file is provided "AS IS", without WARRANTIES OR CONDITIONS OF ANY +** KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY +** WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR +** FITNESS FOR A PARTICULAR PURPOSE. +** +** You should have received a copy of the CPL along with this file. +** See the LICENSE file and the cpl1.0.txt file included with the source +** distribution for more information. If you did not receive a copy of the +** license, contact the Qxt Foundation. +** +** +** +****************************************************************************/ +/** +\class QxtPimpl QxtPimpl +\ingroup core +\brief Hide private details of a class + +Application code generally doesn't have to be concerned about hiding its +implementation details, but when writing library code it is important to +maintain a constant interface, both source and binary. Maintaining a constant +source interface is easy enough, but keeping the binary interface constant +means moving implementation details into a private class. The PIMPL, or +d-pointer, idiom is a common method of implementing this separation. QxtPimpl +offers a convenient way to connect the public and private sides of your class. + +\section start Getting Started +Before you declare the public class, you need to make a forward declaration +of the private class. The private class must have the same name as the public +class, followed by the word Private. For example, a class named MyTest would +declare the private class with: +\code +class MyTestPrivate; +\endcode + +\subsection pub The Public Class +Generally, you shouldn't keep any data members in the public class without a +good reason. Functions that are part of the public interface should be declared +in the public class, and functions that need to be available to subclasses (for +calling or overriding) should be in the protected section of the public class. +To connect the private class to the public class, include the +QXT_DECLARE_PRIVATE macro in the private section of the public class. In the +example above, the private class is connected as follows: +\code +private: + QXT_DECLARE_PRIVATE(MyTest); +\endcode + +Additionally, you must include the QXT_INIT_PRIVATE macro in the public class's +constructor. Continuing with the MyTest example, your constructor might look +like this: +\code +MyTest::MyTest() { + // initialization + QXT_INIT_PRIVATE(MyTest); +} +\endcode + +\subsection priv The Private Class +As mentioned above, data members should usually be kept in the private class. +This allows the memory layout of the private class to change without breaking +binary compatibility for the public class. Functions that exist only as +implementation details, or functions that need access to private data members, +should be implemented here. + +To define the private class, inherit from the template QxtPrivate class, and +include the QXT_DECLARE_PUBLIC macro in its public section. The template +parameter should be the name of the public class. For example: +\code +class MyTestPrivate : public QxtPrivate { +public: + MyTestPrivate(); + QXT_DECLARE_PUBLIC(MyTest); +}; +\endcode + +\section cross Accessing Private Members +Use the qxt_d() function (actually a function-like object) from functions in +the public class to access the private class. Similarly, functions in the +private class can invoke functions in the public class by using the qxt_p() +function (this one's actually a function). + +For example, assume that MyTest has methods named getFoobar and doBaz(), +and MyTestPrivate has a member named foobar and a method named doQuux(). +The code might resemble this example: +\code +int MyTest::getFoobar() { + return qxt_d().foobar; +} + +void MyTestPrivate::doQuux() { + qxt_p().doBaz(foobar); +} +\endcode +*/ + +#ifndef QXTPIMPL_H +#define QXTPIMPL_H + +/*! \relates QxtPimpl + * Declares that a public class has a related private class. + * + * This shuold be put in the private section of the public class. The parameter is the name of the public class. + */ +#define QXT_DECLARE_PRIVATE(PUB) friend class PUB##Private; QxtPrivateInterface qxt_d; +/*! \relates QxtPimpl + * Declares that a private class has a related public class. + * + * This may be put anywhere in the declaration of the private class. The parameter is the name of the public class. + */ +#define QXT_DECLARE_PUBLIC(PUB) friend class PUB; +/*! \relates QxtPimpl + * Initializes resources owned by the private class. + * + * This should be called from the public class's constructor, + * before qxt_d() is used for the first time. The parameter is the name of the public class. + */ +#define QXT_INIT_PRIVATE(PUB) qxt_d.setPublic(this); + +#ifdef QXT_DOXYGEN_RUN +/*! \relates QxtPimpl + * Returns a reference to the private class. + * + * This function is only available in a class using \a QXT_DECLARE_PRIVATE. + */ +QxtPrivate& qxt_d(); + +/*! \relates QxtPimpl + * Returns a const reference to the private class. + * + * This function is only available in a class using \a QXT_DECLARE_PRIVATE. + * This overload will be automatically used in const functions. + */ +const QxtPrivate& qxt_d(); + +/*! \relates QxtPimpl + * Returns a reference to the public class. + * + * This function is only available in a class using \a QXT_DECLARE_PUBLIC. + */ +PUB& qxt_p(); + +/*! \relates QxtPimpl + * Returns a const reference to the public class. + * + * This function is only available in a class using \a QXT_DECLARE_PUBLIC. + * This overload will be automatically used in const functions. + */ +const PUB& qxt_p(); +#endif + +#ifndef QXT_DOXYGEN_RUN +template +class QxtPrivate { +public: + virtual ~QxtPrivate() {} + inline void QXT_setPublic(PUB* pub) { qxt_p_ptr = pub; } + +protected: + inline PUB& qxt_p() { return *qxt_p_ptr; } + inline const PUB& qxt_p() const { return *qxt_p_ptr; } + +private: + PUB* qxt_p_ptr; +}; + +template +class QxtPrivateInterface { +friend class QxtPrivate; +public: + QxtPrivateInterface() { pvt = new PVT; } + ~QxtPrivateInterface() { delete pvt; } + + inline void setPublic(PUB* pub) { pvt->QXT_setPublic(pub); } + inline PVT& operator()() { return *static_cast(pvt); } + inline const PVT& operator()() const { return *static_cast(pvt); } +private: + QxtPrivate* pvt; +}; +#endif + +#endif diff --git a/src/contrib/qxt/qxtrpcpeer.cpp b/src/contrib/qxt/qxtrpcpeer.cpp new file mode 100644 index 00000000..f9766057 --- /dev/null +++ b/src/contrib/qxt/qxtrpcpeer.cpp @@ -0,0 +1,517 @@ +/**************************************************************************** +** +** Copyright (C) Qxt Foundation. Some rights reserved. +** +** This file is part of the QxtNetwork module of the Qt eXTension library +** +** This library is free software; you can redistribute it and/or modify it +** under the terms of th Common Public License, version 1.0, as published by +** IBM. +** +** This file is provided "AS IS", without WARRANTIES OR CONDITIONS OF ANY +** KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY +** WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR +** FITNESS FOR A PARTICULAR PURPOSE. +** +** You should have received a copy of the CPL along with this file. +** See the LICENSE file and the cpl1.0.txt file included with the source +** distribution for more information. If you did not receive a copy of the +** license, contact the Qxt Foundation. +** +** +** +****************************************************************************/ + +#include "qxtrpcpeer.h" +#include +#include +#include +#include +#include +#include +#include + +class QxtIntrospector: public QObject { + // This class MANUALLY implements the necessary parts of QObject. + // Do NOT add the Q_OBJECT macro. As this class isn't intended + // for direct use, it doesn't offer any sort of useful meta-object. +public: + QxtIntrospector(QxtRPCPeer* parent, QObject* source, const char* signal); + + int qt_metacall(QMetaObject::Call _c, int _id, void **_a); + + QString rpcFunction; + +private: + QxtRPCPeer* peer; + QList argTypes; +}; + +struct QxtRPCConnection { + QTcpSocket* socket; + QByteArray buffer; + QString lastMethod; +}; + +class QxtRPCPeerPrivate : public QxtPrivate { +public: + QXT_DECLARE_PUBLIC(QxtRPCPeer); + + void receivePeerSignal(QString fn, QVariant p0 = QVariant(), QVariant p1 = QVariant(), QVariant p2 = QVariant(), QVariant p3 = QVariant(), + QVariant p4 = QVariant(), QVariant p5 = QVariant(), QVariant p6 = QVariant(), QVariant p7 = QVariant(), QVariant p8 = QVariant()) const; + void receiveClientSignal(quint64 id, QString fn, QVariant p0 = QVariant(), QVariant p1 = QVariant(), QVariant p2 = QVariant(), QVariant p3 = QVariant(), + QVariant p4 = QVariant(), QVariant p5 = QVariant(), QVariant p6 = QVariant(), QVariant p7 = QVariant()) const; + + void processInput(QIODevice* socket, QByteArray& buffer); + + // Object -> introspector for each signal + QMultiHash attachedSignals; + // RPC function -> (object, slot ID) + typedef QPair MethodID; + QHash > attachedSlots; + + typedef QHash ConnHash; + ConnHash m_clients; + QTcpServer* m_server; + QIODevice* m_peer; ///aep: doom + + QByteArray m_buffer; + int m_rpctype; +}; + +QxtRPCPeer::QxtRPCPeer(QObject* parent) : QObject(parent) { + QXT_INIT_PRIVATE(QxtRPCPeer); + qxt_d().m_rpctype = Peer; + qxt_d().m_server = new QTcpServer(this); + qxt_d().m_peer = new QTcpSocket(this); + QObject::connect(qxt_d().m_peer, SIGNAL(connected()), this, SIGNAL(peerConnected())); + QObject::connect(qxt_d().m_peer, SIGNAL(disconnected()), this, SIGNAL(peerDisconnected())); + QObject::connect(qxt_d().m_peer, SIGNAL(disconnected()), this, SLOT(disconnectSender())); + QObject::connect(qxt_d().m_peer, SIGNAL(readyRead()), this, SLOT(dataAvailable())); + QObject::connect(qxt_d().m_peer, SIGNAL(error(QAbstractSocket::SocketError)), this, SIGNAL(peerError(QAbstractSocket::SocketError))); + QObject::connect(qxt_d().m_server, SIGNAL(newConnection()), this, SLOT(newConnection())); +} + +QxtRPCPeer::QxtRPCPeer(RPCTypes type, QObject* parent) : QObject(parent) { + QXT_INIT_PRIVATE(QxtRPCPeer); + qxt_d().m_rpctype = type; + qxt_d().m_server = new QTcpServer(this); + qxt_d().m_peer = new QTcpSocket(this); + QObject::connect(qxt_d().m_peer, SIGNAL(connected()), this, SIGNAL(peerConnected())); + QObject::connect(qxt_d().m_peer, SIGNAL(disconnected()), this, SIGNAL(peerDisconnected())); + QObject::connect(qxt_d().m_peer, SIGNAL(disconnected()), this, SLOT(disconnectSender())); + QObject::connect(qxt_d().m_peer, SIGNAL(readyRead()), this, SLOT(dataAvailable())); + QObject::connect(qxt_d().m_peer, SIGNAL(error(QAbstractSocket::SocketError)), this, SIGNAL(peerError(QAbstractSocket::SocketError))); + QObject::connect(qxt_d().m_server, SIGNAL(newConnection()), this, SLOT(newConnection())); +} + +QxtRPCPeer::QxtRPCPeer(QIODevice* device, RPCTypes type, QObject* parent) : QObject(parent) { + if (!device->isOpen()) + { + qWarning("QxtRPCPeer::the device you passed is not open!"); + } + + QXT_INIT_PRIVATE(QxtRPCPeer); + qxt_d().m_rpctype = type; + qxt_d().m_server = new QTcpServer(this); + qxt_d().m_peer = device; + + if (qobject_cast(device)!=0) + { + QObject::connect(qxt_d().m_peer, SIGNAL(connected()), this, SIGNAL(peerConnected())); + QObject::connect(qxt_d().m_peer, SIGNAL(disconnected()), this, SIGNAL(peerDisconnected())); + QObject::connect(qxt_d().m_peer, SIGNAL(disconnected()), this, SLOT(disconnectSender())); + QObject::connect(qxt_d().m_peer, SIGNAL(error(QAbstractSocket::SocketError)), this, SIGNAL(peerError(QAbstractSocket::SocketError))); + } + QObject::connect(qxt_d().m_peer, SIGNAL(readyRead()), this, SLOT(dataAvailable())); + QObject::connect(qxt_d().m_server, SIGNAL(newConnection()), this, SLOT(newConnection())); +} + +void QxtRPCPeer::setRPCType(RPCTypes type) { + if(qxt_d().m_peer->isOpen () || qxt_d().m_server->isListening()) { + qWarning() << "QxtRPCPeer: Cannot change RPC types while connected or listening"; + return; + } + qxt_d().m_rpctype = type; +} + +QxtRPCPeer::RPCTypes QxtRPCPeer::rpcType() const { + return (RPCTypes)(qxt_d().m_rpctype); +} + +void QxtRPCPeer::connect(QHostAddress addr, int port) { + if(qxt_d().m_rpctype == Server) { + qWarning() << "QxtRPCPeer: Cannot connect outward in Server mode"; + return; + } else if(qxt_d().m_peer->isOpen ()) { + qWarning() << "QxtRPCPeer: Already connected"; + return; + } + QTcpSocket * sock = qobject_cast(qxt_d().m_peer); + assert(sock); + sock->connectToHost(addr, port); +} + +bool QxtRPCPeer::listen(QHostAddress iface, int port) { + if(qxt_d().m_rpctype == Client) { + qWarning() << "QxtRPCPeer: Cannot listen in Client mode"; + return false; + } else if(qxt_d().m_rpctype == Peer && qxt_d().m_peer->isOpen ()) { + qWarning() << "QxtRPCPeer: Cannot listen while connected to a peer"; + return false; + } else if(qxt_d().m_server->isListening()) { + qWarning() << "QxtRPCPeer: Already listening"; + return false; + } + return qxt_d().m_server->listen(iface, port); +} + +void QxtRPCPeer::disconnectPeer(quint64 id) { + if(qxt_d().m_rpctype == Server && id==0) { + qWarning() << "QxtRPCPeer: Server mode does not have a peer"; + return; + } else if(qxt_d().m_rpctype!= Server && id!=0) { + qWarning() << "QxtRPCPeer: Must specify a client ID to disconnect"; + return; + } + QxtRPCConnection* conn; + if(id==0) { + qxt_d().m_peer->close(); + } else if((conn = qxt_d().m_clients.take((QObject*)(id)))!= 0) { + conn->socket->disconnectFromHost(); + conn->socket->deleteLater(); + delete conn; + } else { + qWarning() << "QxtRPCPeer: no client with id " << id; + } +} + +void QxtRPCPeer::disconnectAll() { + if(qxt_d().m_rpctype!= Server) + disconnectPeer(); + else { + for(QxtRPCPeerPrivate::ConnHash::const_iterator i = qxt_d().m_clients.constBegin(); i!= qxt_d().m_clients.constEnd(); i++) { + (*i)->socket->deleteLater(); + delete *i; + } + qxt_d().m_clients.clear(); + } +} + +void QxtRPCPeer::stopListening() { + if(!qxt_d().m_server->isListening()) { + qWarning() << "QxtRPCPeer: Not listening"; + return; + } + qxt_d().m_server->close(); +} + +bool QxtRPCPeer::attachSignal(QObject* sender, const char* signal, const QByteArray& rpcFunction) { + const QMetaObject* meta = sender->metaObject(); + QByteArray sig(meta->normalizedSignature(signal).mid(1)); + int methodID = meta->indexOfMethod(sig.constData()); + if(methodID == -1 || meta->method(methodID).methodType() != QMetaMethod::Signal) { + qWarning() << "QxtRPCPeer::attachSignal: No such signal " << signal; + return false; + } + QxtIntrospector* spec = new QxtIntrospector(this, sender, signal); + if(!rpcFunction.isEmpty()) { + spec->rpcFunction = rpcFunction.simplified(); + } else { + spec->rpcFunction = sig; + } + qxt_d().attachedSignals.insertMulti(sender, spec); + return true; +} + +bool QxtRPCPeer::attachSlot(const QByteArray& rpcFunction, QObject* recv, const char* slot) { + const QMetaObject* meta = recv->metaObject(); + int methodID = meta->indexOfMethod(meta->normalizedSignature(slot).mid(1)); + if(methodID == -1 || meta->method(methodID).methodType() == QMetaMethod::Method) { + qWarning() << "QxtRPCPeer::attachSlot: No such slot " << slot; + return false; + } + + QString fn; + if(rpcFunction[0] == '1' && rpcFunction.contains('(') && rpcFunction.contains(')')) { + fn = QMetaObject::normalizedSignature(rpcFunction.mid(1).constData()); + } else { + fn = rpcFunction.simplified(); + } + + qxt_d().attachedSlots[fn].append(QPair(recv, recv->metaObject()->indexOfMethod(recv->metaObject()->normalizedSignature(slot).mid(1)))); + return true; +} + +void QxtRPCPeer::detachSender() { + detachObject(sender()); +} + +void QxtRPCPeer::detachObject(QObject* obj) { + foreach(QxtIntrospector* i, qxt_d().attachedSignals.values(obj)) i->deleteLater(); + qxt_d().attachedSignals.remove(obj); + foreach(QString slot, qxt_d().attachedSlots.keys()) { + for(QList >::iterator i(qxt_d().attachedSlots[slot].begin()); + i!= qxt_d().attachedSlots[slot].end(); ) { + if((*i).first == obj) + i = qxt_d().attachedSlots[slot].erase(i); + else + i++; + } + } +} + +QByteArray QxtRPCPeer::serialize(QString fn, QVariant p1, QVariant p2, QVariant p3, QVariant p4, QVariant p5, QVariant p6, QVariant p7, QVariant p8, QVariant p9) const { + QByteArray rv; + QDataStream str(&rv, QIODevice::WriteOnly); + str << fn; + unsigned char ct = 9; + if(p1.isNull()) ct = 0; + else if(p2.isNull()) ct = 1; + else if(p3.isNull()) ct = 2; + else if(p4.isNull()) ct = 3; + else if(p5.isNull()) ct = 4; + else if(p6.isNull()) ct = 5; + else if(p7.isNull()) ct = 6; + else if(p8.isNull()) ct = 7; + else if(p9.isNull()) ct = 8; + str << ct; + if(ct--) str << p1; + if(ct--) str << p2; + if(ct--) str << p3; + if(ct--) str << p4; + if(ct--) str << p5; + if(ct--) str << p6; + if(ct--) str << p7; + if(ct--) str << p8; + if(ct--) str << p9; + rv.replace(QByteArray("\\"), QByteArray("\\\\")); + rv.replace(QByteArray("\n"), QByteArray("\\n")); + rv.append("\n"); + return rv; +} + +void QxtRPCPeer::call(const char * signal , QVariant p1, QVariant p2, QVariant p3, QVariant p4, QVariant p5, QVariant p6, QVariant p7, QVariant p8, QVariant p9) { + + QByteArray sig=QMetaObject::normalizedSignature(signal); + + if(!qxt_d().m_peer->isOpen ()) + { + qWarning("can't call on a closed device"); + return; + } + qxt_d().m_peer->write(serialize(sig, p1, p2, p3, p4, p5, p6, p7, p8, p9)); +} + +void QxtRPCPeer::callClientList(QList ids, QString fn, QVariant p1, QVariant p2, QVariant p3, QVariant p4, QVariant p5, QVariant p6, QVariant p7, QVariant p8) { + QByteArray c = serialize(fn, p1, p2, p3, p4, p5, p6, p7, p8, QVariant()); + foreach(quint64 id, ids) { + QxtRPCConnection* conn = qxt_d().m_clients.value((QObject*)(id)); + if(!conn) { + qWarning() << "QxtRPCPeer: no client with id" << id; + } else { + conn->socket->write(c); + } + } +} + +void QxtRPCPeer::callClient(quint64 id, QString fn, QVariant p1, QVariant p2, QVariant p3, QVariant p4, QVariant p5, QVariant p6, QVariant p7, QVariant p8) { + callClientList(QList() << id, fn, p1, p2, p3, p4, p5, p6, p7, p8); +} + +void QxtRPCPeer::callClientsExcept(quint64 id, QString fn, QVariant p1, QVariant p2, QVariant p3, QVariant p4, QVariant p5, QVariant p6, QVariant p7, QVariant p8) { + QList cs = clients(); + cs.removeAll(id); + callClientList(cs, fn, p1, p2, p3, p4, p5, p6, p7, p8); +} + +#define QXT_ARG(i) ((numParams>i)?QGenericArgument(p ## i .typeName(), p ## i .constData()):QGenericArgument()) +void QxtRPCPeerPrivate::receivePeerSignal(QString fn, QVariant p0, QVariant p1, QVariant p2, QVariant p3, QVariant p4, QVariant p5, QVariant p6, QVariant p7, QVariant p8) const { + QByteArray sig; + int numParams; + foreach(QxtRPCPeerPrivate::MethodID i, attachedSlots.value(fn)) { + sig = i.first->metaObject()->method(i.second).signature(); + sig = sig.left(sig.indexOf('(')); + numParams = i.first->metaObject()->method(i.second).parameterTypes().count(); + QMetaObject::invokeMethod(i.first, sig, QXT_ARG(0), QXT_ARG(1), QXT_ARG(2), QXT_ARG(3), QXT_ARG(4), QXT_ARG(5), QXT_ARG(6), QXT_ARG(7), QXT_ARG(8)); + } +} + +void QxtRPCPeerPrivate::receiveClientSignal(quint64 id, QString fn, QVariant p0, QVariant p1, QVariant p2, QVariant p3, QVariant p4, QVariant p5, QVariant p6, QVariant p7) const { + QByteArray sig; + int numParams; + foreach(QxtRPCPeerPrivate::MethodID i, attachedSlots.value(fn)) { + sig = i.first->metaObject()->method(i.second).signature(); + sig = sig.left(sig.indexOf('(')); + numParams = i.first->metaObject()->method(i.second).parameterTypes().count(); + QMetaObject::invokeMethod(i.first, sig, Q_ARG(quint64, id), QXT_ARG(0), QXT_ARG(1), QXT_ARG(2), QXT_ARG(3), QXT_ARG(4), QXT_ARG(5), QXT_ARG(6), QXT_ARG(7)); + } +} +#undef QXT_ARG + +void QxtRPCPeer::newConnection() { + QTcpSocket* next = qxt_d().m_server->nextPendingConnection(); + if(qxt_d().m_rpctype == QxtRPCPeer::Peer) { + if(qxt_d().m_peer->isOpen ()) { + qWarning() << "QxtRPCPeer: Rejected connection from " << next->peerAddress().toString() << "; another peer is connected"; + next->disconnectFromHost(); + next->deleteLater(); + } else { + qxt_d().m_peer->deleteLater(); + qxt_d().m_peer = next; + QObject::connect(qxt_d().m_peer, SIGNAL(connected()), this, SIGNAL(peerConnected())); + QObject::connect(qxt_d().m_peer, SIGNAL(disconnected()), this, SIGNAL(peerDisconnected())); + QObject::connect(qxt_d().m_peer, SIGNAL(disconnected()), this, SLOT(disconnectSender())); + QObject::connect(qxt_d().m_peer, SIGNAL(readyRead()), this, SLOT(dataAvailable())); + QObject::connect(qxt_d().m_peer, SIGNAL(error(QAbstractSocket::SocketError)), this, SIGNAL(peerError(QAbstractSocket::SocketError))); + emit peerConnected(); + } + } else { + QxtRPCConnection* conn = new QxtRPCConnection; + conn->socket = next; + qxt_d().m_clients[next] = conn; + QObject::connect(next, SIGNAL(disconnected()), this, SLOT(disconnectSender())); + QObject::connect(next, SIGNAL(readyRead()), this, SLOT(dataAvailable())); + QObject::connect(next, SIGNAL(error(QAbstractSocket::SocketError)), this, SIGNAL(peerError(QAbstractSocket::SocketError))); + emit clientConnected((quint64)(next)); + } +} + +void QxtRPCPeer::dataAvailable() { + if(qxt_d().m_rpctype!=QxtRPCPeer::Server && qxt_d().m_peer==sender()) { + qxt_d().m_buffer.append(qxt_d().m_peer->readAll()); + qxt_d().processInput(qxt_d().m_peer, qxt_d().m_buffer); + return; + } else { + QxtRPCConnection* conn = qxt_d().m_clients.value(sender()); + if(!conn) { + qWarning() << "QxtRPCPeer: Unrecognized client object connected to dataAvailable"; + return; + } + conn->buffer.append(conn->socket->readAll()); + qxt_d().processInput(conn->socket, (conn->buffer)); + return; + } + qWarning() << "QxtRPCPeer: Unrecognized peer object connected to dataAvailable"; +} + +void QxtRPCPeer::disconnectSender() { + QxtRPCConnection* conn = qxt_d().m_clients.value(sender()); + if(!conn) { + if(qxt_d().m_peer!= qobject_cast(sender())) { + qWarning() << "QxtRPCPeer: Unrecognized object connected to disconnectSender"; + return; + } + qxt_d().m_buffer.append(qxt_d().m_peer->readAll()); + qxt_d().m_buffer.append("\n"); + qxt_d().processInput(qxt_d().m_peer, qxt_d().m_buffer); + qxt_d().m_buffer.clear(); + emit clientDisconnected((quint64)(sender())); + return; + } + conn->buffer.append(conn->socket->readAll()); + conn->buffer.append("\n"); + qxt_d().processInput(conn->socket, conn->buffer); + conn->socket->deleteLater(); + delete conn; + qxt_d().m_clients.remove(sender()); +} + +void QxtRPCPeerPrivate::processInput(QIODevice* socket, QByteArray& buffer) { + while(qxt_p().canDeserialize(buffer)) { + QPair > sig = qxt_p().deserialize(buffer); + if(sig.first.isEmpty()) { + if(sig.second.count()) { + qWarning() << "QxtRPCPeer: Invalid data received; disconnecting"; + if(socket == m_peer) + qxt_p().disconnectPeer(); + else + qxt_p().disconnectPeer((quint64)(socket)); + return; + } + continue; + } + while(sig.second.count() < 9) sig.second << QVariant(); + if(socket == m_peer) { + receivePeerSignal(sig.first, sig.second[0], sig.second[1], sig.second[2], sig.second[3], sig.second[4], sig.second[5], sig.second[6], sig.second[7], sig.second[8]); + } else { + receiveClientSignal((quint64)(socket), sig.first, sig.second[0], sig.second[1], sig.second[2], sig.second[3], sig.second[4], sig.second[5], sig.second[6], sig.second[7]); + } + } +} + +QList QxtRPCPeer::clients() const { + QList rv; + QList cs = qxt_d().m_clients.keys(); + foreach(QObject* id, cs) rv << (const quint64)(id); + return rv; +} + +QxtIntrospector::QxtIntrospector(QxtRPCPeer* parent, QObject* source, const char* signal): QObject(parent) { + peer = parent; + QByteArray sig_ba = QMetaObject::normalizedSignature(QByteArray(signal).mid(1)); + ///FIXME: use normalizedsignature + const char * sig=sig_ba.constData(); + int idx = source->metaObject()->indexOfSignal(sig); + if(idx<0) + qWarning("no such signal: %s",sig_ba.constData()); + + // Our "method" will have the first ID not used by the superclass. + QMetaObject::connect(source, idx, this, QObject::staticMetaObject.methodCount()); + QObject::connect(source, SIGNAL(destroyed()), peer, SLOT(detachSender())); + QList p = source->metaObject()->method(idx).parameterTypes(); + int ct = p.count(); + for(int i=0; icall(rpcFunction.toUtf8().constData(), v[0], v[1], v[2], v[3], v[4], v[5], v[6], v[7], v[8]); + } + _id -= 1; + } + return _id; +} + +QPair > QxtRPCPeer::deserialize(QByteArray& data) { + QByteArray cmd; + int pos = data.indexOf('\n'); + cmd = data.left(pos-1); + data = data.mid(pos+1); + if(cmd.length()==0) return qMakePair(QString(), QList()); + cmd.replace(QByteArray("\\n"), QByteArray("\n")); + cmd.replace(QByteArray("\\\\"), QByteArray("\\")); + QDataStream str(cmd); + QString signal; + unsigned char argCount; + QList v; + QVariant t; + str >> signal >> argCount; + + if(str.status() == QDataStream::ReadCorruptData) { + v << QVariant(); + return qMakePair(QString(), v); + } + + for(int i=0; i> t; + v << t; + } + return qMakePair(signal, v); +} + +bool QxtRPCPeer::canDeserialize(const QByteArray& buffer) const { + if (buffer.indexOf('\n') == -1) + { + return false; + } + return true; + +} diff --git a/src/contrib/qxt/qxtrpcpeer.h b/src/contrib/qxt/qxtrpcpeer.h new file mode 100644 index 00000000..3ff8784a --- /dev/null +++ b/src/contrib/qxt/qxtrpcpeer.h @@ -0,0 +1,289 @@ +/**************************************************************************** +** +** Copyright (C) Qxt Foundation. Some rights reserved. +** +** This file is part of the QxtNetwork module of the Qt eXTension library +** +** This library is free software; you can redistribute it and/or modify it +** under the terms of th Common Public License, version 1.0, as published by +** IBM. +** +** This file is provided "AS IS", without WARRANTIES OR CONDITIONS OF ANY +** KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY +** WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR +** FITNESS FOR A PARTICULAR PURPOSE. +** +** You should have received a copy of the CPL along with this file. +** See the LICENSE file and the cpl1.0.txt file included with the source +** distribution for more information. If you did not receive a copy of the +** license, contact the Qxt Foundation. +** +** +** +***************************************************************************** +** +** This file has been modified from its original state to suit the needs of +** Quassel IRC. We have virtualized some methods. +** +*****************************************************************************/ + +#ifndef QXTRPCPEER +#define QXTRPCPEER + +#include +#include +#include +#include +#include +#include +#include +#include + +class QxtRPCPeerPrivate; +/*! + * \class QxtRPCPeer QxtRPCPeer + * \ingroup network + * \brief Transmits Qt signals over a network connection + * + * QxtRPCPeer is a tool that encapsulates Qt signals and transmits them over a network connection. + * The signal is subsequently re-emitted on the receiving end of the connection. + * + * QxtRPCPeer can operate in peer-to-peer mode (that is, one-to-one) or client-server (that is, one-to-many) mode. + * In peer or server mode, QxtRPCPeer can listen for and accept incoming connections. In peer or client mode, + * QxtRPCPeer can connect to a listening peer or server. + * + * All data types used in attached signals and slots must be declared and registered with QMetaType using + * Q_DECLARE_METATYPE and qRegisterMetaType, and they must have stream operators registered with qRegisterMetaTypeStreamOperators. + * + * The limits on the number of parameters passed to call() and related functions are a restriction of Qt, + * which limits parameters on a signal or slot to 10. + */ +class QXT_NETWORK_EXPORT QxtRPCPeer : public QObject { +Q_OBJECT +public: + + /*! + * This enum is used with the \a setRPCType() to describe the role played in a connection. It is also returned by \a rpcType(). + */ + enum RPCTypes { + Server, /**< Listen for clients and accept multiple connections. */ + Client, /**< Connect to a server. */ + Peer /**< Listen for a connection or connect to a peer. */ + }; + + /*! + * Creates a QxtRPCPeer object with the given parent. Unless changed later, this object will use Peer mode and QTcpSocket for its I/O device. + */ + QxtRPCPeer(QObject* parent = 0); + + /*! + * Creates a QxtRPCPeer object with the given parent and type. Unless changed later, this object will use QTcpSocket for its I/O device. + */ + QxtRPCPeer(RPCTypes type, QObject* parent = 0); + + /*! + * Creates a QxtRPCPeer object with the given parent and type and connects it to the specified I/O device. + * + * Note that the I/O device must already be opened for reading and writing. This constructor cannot be used for Server mode. + */ + QxtRPCPeer(QIODevice* device, RPCTypes type = QxtRPCPeer::Peer, QObject* parent = 0); + + /*! + * Sets the RPC type. + * + * Attempting to change the RPC type while listening or connected will be ignored with a warning. + */ + void setRPCType(RPCTypes type); + + /*! + * Returns the current RPC type. + */ + RPCTypes rpcType() const; + + /*! + * Connects to the specified peer or server on the selected port. + * + * When the connection is complete, the \a peerConnected() signal will be emitted. If an error occurs, the \a peerError() signal will be emitted. + */ + void connect(QHostAddress addr, int port = 80); + + /*! + * Listens on the specified interface on the specified port for connections. + * + * Attempting to listen while in Client mode or while connected in Peer mode will be ignored with a warning. In Peer mode, only one connection + * can be active at a time. Additional incoming connections while connected to a peer will be dropped. When a peer connects, the \a peerConnected() + * signal will be emitted. In Server mode, multiple connections can be active at a time. Each client that connects will be provided a unique ID, + * included in the \a clientConnected() signal that will be emitted. + */ + bool listen(QHostAddress iface = QHostAddress::Any, int port = 80); + + /*! + * Disconnects from a server, client, or peer. + * + * Servers must provide a client ID, provided by the \a clientConnected() signal; clients and peers must not. + */ + void disconnectPeer(quint64 id = -1); + + /*! + * Disconnects from all clients, or from the server or peer. + */ + void disconnectAll(); + + /*! + * Stops listening for connections. Any connections still open will remain connected. + */ + void stopListening(); + + /*! + * Returns a list of client IDs for all connected clients. + */ + QList clients() const; + + /*! + * Attaches the given signal. + * + * When the attached signal is emitted, it will be transmitted to all connected servers, clients, or peers. + * If an optional rpcFunction is provided, it will be used in place of the name of the transmitted signal. + * Use the SIGNAL() macro to specify the signal, just as you would for QObject::connect(). + * + * Like QObject::connect(), attachSignal returns false if the connection cannot be established. + */ + bool attachSignal(QObject* sender, const char* signal, const QByteArray& rpcFunction = QByteArray()); + + /*! + * Attaches the given slot. + * + * When a signal with the name given by rpcFunction is received from the network, the attached slot is executed. + * Use the SLOT() macro to specify the slot, just as you would for QObject::connect(). + * + * Like QObject::connect(), attachSignal returns false if the connection cannot be established. + * + * \Note In Server mode, the first parameter of the slot must be int id. The parameters of the signal follow. + * For example, SIGNAL(mySignal(QString)) from the client connects to SLOT(mySlot(int, QString)) on the server. + */ + bool attachSlot(const QByteArray& rpcFunction, QObject* recv, const char* slot); + + /*! + * Detaches all signals and slots for the given object. + */ + void detachObject(QObject* obj); + +public slots: + /*! + * Sends the signal fn with the given parameter list to the server or peer. + * + * This function accepts up to 9 QVariant parameters. + * + * The receiver is not obligated to act upon the signal. If no server or peer is connected, the call is ignored. + * In particular, this function does nothing in Server mode. + */ + void call(const char *signal, QVariant p1 = QVariant(), QVariant p2 = QVariant(), QVariant p3 = QVariant(), QVariant p4 = QVariant(), + QVariant p5 = QVariant(), QVariant p6 = QVariant(), QVariant p7 = QVariant(), QVariant p8 = QVariant(), QVariant p9 = QVariant()); + + /*! + * Sends the signal with the given parameter list to the provided list of clients. + * + * This function accepts up to 8 QVariant parameters. + * + * The receivers are not obligated to act upon the signal. If no client is connected with a provided ID, the ID + * is ignored with a warning. + */ + void callClientList(QList ids, QString fn, QVariant p1 = QVariant(), QVariant p2 = QVariant(), QVariant p3 = QVariant(), QVariant p4 = QVariant(), + QVariant p5 = QVariant(), QVariant p6 = QVariant(), QVariant p7 = QVariant(), QVariant p8 = QVariant()); + + /*! + * Sends the signal fn with the given parameter list to the specified client. + * + * This function accepts up to 8 QVariant parameters. + * + * The receiver is not obligated to act upon the signal. If no client with the given ID is connected, the call will be ignored with a warning. + */ + void callClient(quint64 id, QString fn, QVariant p1 = QVariant(), QVariant p2 = QVariant(), QVariant p3 = QVariant(), QVariant p4 = QVariant(), + QVariant p5 = QVariant(), QVariant p6 = QVariant(), QVariant p7 = QVariant(), QVariant p8 = QVariant()); + + /*! + * Sends the signal fn with the given parameter list to all connected clients except for the client specified. + * + * This function accepts up to 8 QVariant parameters. + * + * The receiver is not obligated to act upon the signal. This function is useful for rebroadcasting a signal from one client + * to all other connected clients. + */ + void callClientsExcept(quint64 id, QString fn, QVariant p1 = QVariant(), QVariant p2 = QVariant(), QVariant p3 = QVariant(), QVariant p4 = QVariant(), + QVariant p5 = QVariant(), QVariant p6 = QVariant(), QVariant p7 = QVariant(), QVariant p8 = QVariant()); + + /*! + * Detaches all signals and slots for the object that emitted the signal connected to detachSender(). + */ + void detachSender(); + +signals: + /*! + * This signal is emitted after a successful connection to or from a peer or server. + */ + void peerConnected(); + + /*! + * This signal is emitted after a successful connection from a client. + * + * The given ID is used for disconnectPeer(), callClient(), and related functions. + */ + void clientConnected(quint64 id); + + /*! + * This signal is emitted when a peer or server is disconnected. + */ + void peerDisconnected(); + + /*! + * This signal is emitted when a client disconnects. The given ID is no longer valid. + */ + void clientDisconnected(quint64 id); + + /*! + * This signal is emitted whenever an error occurs on a socket. + * + * Currently, no information about the socket that raised the error is available. + */ + void peerError(QAbstractSocket::SocketError); + +protected: + /*! + * Serializes a signal into a form suitable for transmitting over the network. + * + * Reimplement this function in a subclass to allow QxtRPCPeer to use a different protocol. + */ + virtual QByteArray serialize(QString fn, QVariant p1, QVariant p2, QVariant p3, QVariant p4, QVariant p5, QVariant p6, QVariant p7, QVariant p8, QVariant p9) const; + + /*! + * Deserializes network data into a signal name and a list of parameters. + * + * Reimplement this function in a subclass to allow QxtRPCPeer to understand a different protocol. + * If you reimplement it, be sure to remove the processed portion of the data from the reference parameter. + * Return "qMakePair(QString(), QList())" if the deserialized data doesn't invoke a signal. + * Return "qMakePair(QString(), QList() << QVariant())" if the protocol has been violated and + * the connection should be severed. + */ + virtual QPair > deserialize(QByteArray& data); + + /*! + * Indicates whether the data currently received from the network can be deserialized. + * + * The default behavior of this function returns true if the buffer contains a newline character. + * + * Reimplement this function in a subclass to allow QxtRPCPeer to understand a different protocol. + */ + virtual bool canDeserialize(const QByteArray& buffer) const; + +//protected: +// void newConnection(); + +private: + QXT_DECLARE_PRIVATE(QxtRPCPeer); + +private slots: + void newConnection(); + void dataAvailable(); + void disconnectSender(); +}; +#endif -- 2.20.1