diff options
| author | Andre Heinecke <[email protected]> | 2016-02-22 17:28:08 +0000 | 
|---|---|---|
| committer | Andre Heinecke <[email protected]> | 2016-02-22 18:01:37 +0000 | 
| commit | 0855a1296a1908016f011eb5e6552854ac53e63a (patch) | |
| tree | ae662e7201a7d60d0e7733532ebded629cfacb94 /lang/cpp/src/eventloopinteractor.h | |
| parent | Fix possible _SC_OPEN_MAX max problem on AIX. (diff) | |
| download | gpgme-0855a1296a1908016f011eb5e6552854ac53e63a.tar.gz gpgme-0855a1296a1908016f011eb5e6552854ac53e63a.zip | |
Initial checkin of gpgmepp sources
Based on git.kde.org/pim/gpgmepp rev. 0e3ebc02
* lang/cpp/src/assuanresult.cpp,
 lang/cpp/src/assuanresult.h,
 lang/cpp/src/callbacks.cpp,
 lang/cpp/src/callbacks.h,
 lang/cpp/src/configuration.cpp,
 lang/cpp/src/configuration.h,
 lang/cpp/src/context.cpp,
 lang/cpp/src/context.h,
 lang/cpp/src/context_glib.cpp,
 lang/cpp/src/context_p.h,
 lang/cpp/src/context_qt.cpp,
 lang/cpp/src/context_vanilla.cpp,
 lang/cpp/src/data.cpp,
 lang/cpp/src/data.h,
 lang/cpp/src/data_p.h,
 lang/cpp/src/decryptionresult.cpp,
 lang/cpp/src/decryptionresult.h,
 lang/cpp/src/defaultassuantransaction.cpp,
 lang/cpp/src/defaultassuantransaction.h,
 lang/cpp/src/editinteractor.cpp,
 lang/cpp/src/editinteractor.h,
 lang/cpp/src/encryptionresult.cpp,
 lang/cpp/src/encryptionresult.h,
 lang/cpp/src/engineinfo.cpp,
 lang/cpp/src/engineinfo.h,
 lang/cpp/src/error.h,
 lang/cpp/src/eventloopinteractor.cpp,
 lang/cpp/src/eventloopinteractor.h,
 lang/cpp/src/exception.cpp,
 lang/cpp/src/exception.h,
 lang/cpp/src/global.h,
 lang/cpp/src/gpgadduserideditinteractor.cpp,
 lang/cpp/src/gpgadduserideditinteractor.h,
 lang/cpp/src/gpgagentgetinfoassuantransaction.cpp,
 lang/cpp/src/gpgagentgetinfoassuantransaction.h,
 lang/cpp/src/gpgmefw.h,
 lang/cpp/src/gpgmepp_export.h,
 lang/cpp/src/gpgsetexpirytimeeditinteractor.cpp,
 lang/cpp/src/gpgsetexpirytimeeditinteractor.h,
 lang/cpp/src/gpgsetownertrusteditinteractor.cpp,
 lang/cpp/src/gpgsetownertrusteditinteractor.h,
 lang/cpp/src/gpgsignkeyeditinteractor.cpp,
 lang/cpp/src/gpgsignkeyeditinteractor.h,
 lang/cpp/src/importresult.cpp,
 lang/cpp/src/importresult.h,
 lang/cpp/src/key.cpp,
 lang/cpp/src/key.h,
 lang/cpp/src/keygenerationresult.cpp,
 lang/cpp/src/keygenerationresult.h,
 lang/cpp/src/keylistresult.cpp,
 lang/cpp/src/keylistresult.h,
 lang/cpp/src/notation.h,
 lang/cpp/src/result.h,
 lang/cpp/src/result_p.h,
 lang/cpp/src/scdgetinfoassuantransaction.cpp,
 lang/cpp/src/scdgetinfoassuantransaction.h,
 lang/cpp/src/signingresult.cpp,
 lang/cpp/src/signingresult.h,
 lang/cpp/src/trustitem.cpp,
 lang/cpp/src/trustitem.h,
 lang/cpp/src/util.h,
 lang/cpp/src/verificationresult.cpp,
 lang/cpp/src/verificationresult.h,
 lang/cpp/src/vfsmountresult.cpp,
 lang/cpp/src/vfsmountresult.h,
 lang/cpp/src/interfaces/assuantransaction.h,
 lang/cpp/src/interfaces/dataprovider.h,
 lang/cpp/src/interfaces/passphraseprovider.h,
 lang/cpp/src/interfaces/progressprovider.h: New.
Diffstat (limited to '')
| -rw-r--r-- | lang/cpp/src/eventloopinteractor.h | 156 | 
1 files changed, 156 insertions, 0 deletions
| diff --git a/lang/cpp/src/eventloopinteractor.h b/lang/cpp/src/eventloopinteractor.h new file mode 100644 index 00000000..94821d6d --- /dev/null +++ b/lang/cpp/src/eventloopinteractor.h @@ -0,0 +1,156 @@ +/* +  eventloopinteractor.h +  Copyright (C) 2003,2004 Klarälvdalens Datakonsult AB + +  This file is part of GPGME++. + +  GPGME++ is free software; you can redistribute it and/or +  modify it under the terms of the GNU Library General Public +  License as published by the Free Software Foundation; either +  version 2 of the License, or (at your option) any later version. + +  GPGME++ 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 Library General Public License for more details. + +  You should have received a copy of the GNU Library General Public License +  along with GPGME++; see the file COPYING.LIB.  If not, write to the +  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, +  Boston, MA 02110-1301, USA. +*/ + +// -*- c++ -*- +#ifndef __GPGMEPP_EVENTLOOPINTERACTOR_H__ +#define __GPGMEPP_EVENTLOOPINTERACTOR_H__ + +#include "gpgmepp_export.h" + +namespace GpgME +{ + +class Context; +class Error; +class TrustItem; +class Key; + +/*! \file eventloopinteractor.h +    \brief Abstract base class for gpgme's external event loop support + +    This class does most of the work involved with hooking GpgME++ +    up with external event loops, such as the GTK or Qt ones. + +    It actually provides two interfaces: An interface to the gpgme +    IO Callback handling and one for gpgme events. The IO Callback +    interface consists of the three methods \c actOn(), \c +    registerWatcher() and \c unregisterWatcher(). The event +    interface consists of the three methods \c nextTrustItemEvent(), +    \c nextKeyEvent() and \c operationDoneEvent(). + +    \sect General Usage + +    \c EventLoopInteractor is designed to be used as a +    singleton. However, in order to make any use of it, you have to +    subclass it and reimplement it's pure virtual methods (see +    below). We suggest you keep the constructor protected and +    provide a static \c instance() method that returns the single +    instance. Alternatively, you can create an instance on the +    stack, e.g. in \c main(). + +    If you want \c EventLoopInteractor to manage a particular \c +    Context, just call \c manage() on the \c Context. OTOH, if you +    want to disable IO callbacks for a \c Context, use \c unmanage(). + +    \sect IO Callback Interface + +    One part of this interface is represented by \c +    registerWatcher() and \c unregisterWatcher(), both of which are +    pure virtual. \c registerWatcher() should do anything necessary +    to hook up watching of file descriptor \c fd for reading (\c dir +    = \c Read) or writing (\c dir = Write) to the event loop you use +    and return a tag identifying that particular watching process +    uniquely. This could be the index into an array of objects you +    use for that purpose or the address of such an object. E.g. in +    Qt, you'd essentially just create a new \c QSocketNotifier: + +    \verbatim +    void * registerWatcher( int fd, Direction dir ) { +      return new QSocketNotifier( fd, dir == Read ? QSocketNotifier::Read : QSocketNotifier::Write ); +      // misses connecting to the activated() signal... +    } +    \endverbatim + +    which uses the address of the created object as unique tag. The +    tag returned by \c registerWatcher is stored by \c +    EventLoopInteractor and passed as argument to \c +    unregisterWatcher(). So, in the picture above, you'd implement \c +    unregisterWatcher() like this: + +    \verbatim +    void unregisterWatcher( void * tag ) { +      delete static_cast<QSocketNotifier*>( tag ); +    } +    \endverbatim + +    The other part of the IO callback interface is \c actOn(), which +    you should call if you receive notification from your event loop +    about activity on file descriptor \c fd in direction \c dir. In +    the picture above, you'd call this from the slot connected to +    the socket notifier's \c activated() signal. + +    \note \c registerWatcher() as well as \c unregisterWatcher() may +    be called from within \c actOn(), so be careful with +    e.g. locking in threaded environments and keep in mind that the +    object you used to find the \c fd and \c dir fo the \c actOn() +    call might be deleted when \c actOn() returns! + +    \sect Event Handler Interface + +*/ +class GPGMEPP_EXPORT EventLoopInteractor +{ +protected: +    EventLoopInteractor(); +public: +    virtual ~EventLoopInteractor(); + +    static EventLoopInteractor *instance() +    { +        return mSelf; +    } + +    void manage(Context *context); +    void unmanage(Context *context); + +    enum Direction { Read, Write }; +protected: +    // +    // IO Notification Interface +    // + +    /** Call this if your event loop detected activity on file +        descriptor fd, with direction dir */ +    void actOn(int fd, Direction dir); + +    virtual void *registerWatcher(int fd, Direction dir, bool &ok) = 0; +    virtual void unregisterWatcher(void *tag) = 0; + +    // +    // Event Handler Interface +    // + +    virtual void operationStartEvent(Context *context) = 0; +    virtual void nextTrustItemEvent(Context *context, const TrustItem &item) = 0; +    virtual void nextKeyEvent(Context *context, const Key &key) = 0; +    virtual void operationDoneEvent(Context *context, const Error &e) = 0; + +private: +    class Private; +    friend class Private; +    Private *const d; +    static EventLoopInteractor *mSelf; +}; + +} + +#endif // __GPGMEPP_EVENTLOOPINTERACTOR_H__ | 
