made interface binary clean eg. inst() returns a hidden class

documentation

2 files changed, 80 insertions, 27 deletions

diff --git a/libopie2/opiecore/okeyfilter.cpp b/libopie2/opiecore/okeyfilter.cpp
index d806dbd..b064272 100644
--- a/libopie2/opiecore/okeyfilter.cpp
+++ b/libopie2/opiecore/okeyfilter.cpp
@@ -1,119 +1,144 @@
 /*
                             This file is part of the Opie Project
              =.             Copyright (C) 2004 Rajko 'Alwin' Albrecht <alwin@handhelds.org>
            .=l.             Copyright (C) The Opie Team <opie-devel@handhelds.org>
           .>+-=
 _;:,     .>    :=|.         This program is free software; you can
 .> <`_,   >  .   <=         redistribute it and/or  modify it under
 :`=1 )Y*s>-.--   :          the terms of the GNU Library General Public
 .="- .-=="i,     .._        License as published by the Free Software
 - .   .-<_>     .<>         Foundation; either version 2 of the License,
     ._= =}       :          or (at your option) any later version.
    .%`+i>       _;_.
    .i_,=:_.      -<s.       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
 ..}^=.=       =       ;     Library General Public License for more
 ++=   -.     .`     .:      details.
 :     =  ...= . :.=-
 -.   .:....=;==+<;          You should have received a copy of the GNU
  -_. . .   )=.  =           Library General Public License along with
    --        :-=`           this library; see the file COPYING.LIB.
                             If not, write to the Free Software Foundation,
                             Inc., 59 Temple Place - Suite 330,
                             Boston, MA 02111-1307, USA.
 */
 
 #include "okeyfilter.h"
 #include "device/odevice.h"
 #include "odebug.h"
 
 namespace Opie {
 namespace Core {
 
-QValueList<QWSServer::KeyboardFilter*> OKeyFilter::filterList;
-QValueList<QWSServer::KeyboardFilter*> OKeyFilter::preFilterList;
+class OKeyFilterPrivate:public OKeyFilter, QWSServer::KeyboardFilter
+{
+    static QValueList<QWSServer::KeyboardFilter*> filterList;
+    static QValueList<QWSServer::KeyboardFilter*> preFilterList;
+protected:
+    OKeyFilterPrivate(const OKeyFilterPrivate&):OKeyFilter(),QWSServer::KeyboardFilter(){};
+    virtual void addPreHandler(QWSServer::KeyboardFilter*);
+    virtual void remPreHandler(QWSServer::KeyboardFilter*);
+
+public:
+    OKeyFilterPrivate();
+    virtual ~OKeyFilterPrivate();
+    virtual bool filter( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat );
+    virtual void addHandler(QWSServer::KeyboardFilter*);
+    virtual void remHandler(QWSServer::KeyboardFilter*);
+};
+
+QValueList<QWSServer::KeyboardFilter*> OKeyFilterPrivate::filterList;
+QValueList<QWSServer::KeyboardFilter*> OKeyFilterPrivate::preFilterList;
 
 OKeyFilter::OKeyFilter()
-    :QWSServer::KeyboardFilter()
 {
-    filterList.clear();
-    preFilterList.clear();
-    if ( isQWS( ) ) {
-        QWSServer::setKeyboardFilter ( this );
-    }
 }
 
 OKeyFilter::~OKeyFilter()
 {
 }
 
 OKeyFilter* OKeyFilter::inst()
 {
     static OKeyFilter*ofilter = 0;
     if (!ofilter) {
-        ofilter = new OKeyFilter;
+        ofilter = new OKeyFilterPrivate;
     }
     return ofilter;
 }
 
-bool OKeyFilter::filter( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat )
+bool OKeyFilterPrivate::filter( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat )
 {
     QValueList<QWSServer::KeyboardFilter*>::Iterator iter;
     for (iter=preFilterList.begin();iter!=preFilterList.end();++iter) {
         if ((*iter)->filter(unicode,keycode,modifiers,isPress,autoRepeat)) {
             return true;
         }
     }
     for (iter=filterList.begin();iter!=filterList.end();++iter) {
         if ((*iter)->filter(unicode,keycode,modifiers,isPress,autoRepeat)) {
             return true;
         }
     }
     return false;
 }
 
-void OKeyFilter::addHandler(QWSServer::KeyboardFilter*aF)
+void OKeyFilterPrivate::addHandler(QWSServer::KeyboardFilter*aF)
 {
     if (filterList.find(aF)!=filterList.end()) {
         return;
     }
     odebug << "adding a keyboard filter handler"<<oendl;
     filterList.append(aF);
 }
 
-void OKeyFilter::remHandler(QWSServer::KeyboardFilter*aF)
+void OKeyFilterPrivate::remHandler(QWSServer::KeyboardFilter*aF)
 {
     QValueList<QWSServer::KeyboardFilter*>::Iterator iter;
     if ( (iter=filterList.find(aF))==filterList.end() ) {
         return;
     }
     odebug << "removing a keyboard filter handler"<<oendl;
     filterList.remove(iter);
 }
 
-void OKeyFilter::addPreHandler(QWSServer::KeyboardFilter*aF)
+void OKeyFilterPrivate::addPreHandler(QWSServer::KeyboardFilter*aF)
 {
     if (preFilterList.find(aF)!=preFilterList.end()) {
         return;
     }
     odebug << "adding a preferred keyboard filter handler"<<oendl;
     preFilterList.append(aF);
 }
 
-void OKeyFilter::remPreHandler(QWSServer::KeyboardFilter*aF)
+void OKeyFilterPrivate::remPreHandler(QWSServer::KeyboardFilter*aF)
 {
     QValueList<QWSServer::KeyboardFilter*>::Iterator iter;
     if ( (iter=preFilterList.find(aF))==preFilterList.end() ) {
         return;
     }
     odebug << "removing a preferred keyboard filter handler"<<oendl;
     preFilterList.remove(iter);
 }
 
+OKeyFilterPrivate::OKeyFilterPrivate()
+    :OKeyFilter(),QWSServer::KeyboardFilter()
+{
+    filterList.clear();
+    preFilterList.clear();
+    if ( isQWS( ) ) {
+        QWSServer::setKeyboardFilter ( this );
+    }
+}
+
+OKeyFilterPrivate::~OKeyFilterPrivate()
+{
+}
+
 /* namespace Core */
 }
 /* namespace Opie */
 }
diff --git a/libopie2/opiecore/okeyfilter.h b/libopie2/opiecore/okeyfilter.h
index 3f9f744..a65bc48 100644
--- a/libopie2/opiecore/okeyfilter.h
+++ b/libopie2/opiecore/okeyfilter.h
@@ -2,76 +2,104 @@
                             This file is part of the Opie Project
              =.             Copyright (C) 2004 Rajko 'Alwin' Albrecht <alwin@handhelds.org>
            .=l.             Copyright (C) The Opie Team <opie-devel@handhelds.org>
           .>+-=
 _;:,     .>    :=|.         This program is free software; you can
 .> <`_,   >  .   <=         redistribute it and/or  modify it under
 :`=1 )Y*s>-.--   :          the terms of the GNU Library General Public
 .="- .-=="i,     .._        License as published by the Free Software
 - .   .-<_>     .<>         Foundation; either version 2 of the License,
     ._= =}       :          or (at your option) any later version.
    .%`+i>       _;_.
    .i_,=:_.      -<s.       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
 ..}^=.=       =       ;     Library General Public License for more
 ++=   -.     .`     .:      details.
 :     =  ...= . :.=-
 -.   .:....=;==+<;          You should have received a copy of the GNU
  -_. . .   )=.  =           Library General Public License along with
    --        :-=`           this library; see the file COPYING.LIB.
                             If not, write to the Free Software Foundation,
                             Inc., 59 Temple Place - Suite 330,
                             Boston, MA 02111-1307, USA.
 */
 
 /* QT */
 #include <qwindowsystem_qws.h>
 #include <qvaluelist.h>
 
 namespace Opie {
 namespace Core {
     class ODevice;
 namespace Internal {
     class iPAQ;
     class SIMpad;
 }
 
 /**
  * A singleton which will manage all possible keyboard filters inside opie.
  * It makes sure that key handlers of odevice are checked first than the
  * keyfilters of software.
  * @short a keyfilter proxy
  * @see QWSServer::KeyboardFilter
  * @author Rajko Albrecht
  * @version 1.0
  */
-class OKeyFilter:public QWSServer::KeyboardFilter
+class OKeyFilter
 {
     friend class Opie::Core::ODevice;
     friend class Opie::Core::Internal::iPAQ;
     friend class Opie::Core::Internal::SIMpad;
 
-    static QValueList<QWSServer::KeyboardFilter*> filterList;
-    static QValueList<QWSServer::KeyboardFilter*> preFilterList;
-
-    OKeyFilter();
-    OKeyFilter(const OKeyFilter&):QWSServer::KeyboardFilter(){};
-
 protected:
-    void addPreHandler(QWSServer::KeyboardFilter*);
-    void remPreHandler(QWSServer::KeyboardFilter*);
+    /**
+     * Protected constructor - generate class via inst()
+     * @see inst()
+     */
+    OKeyFilter();
+    /**
+     * Protected constructor - generate class via inst()
+     * @see inst()
+     */
+    OKeyFilter(const OKeyFilter&){};
+    /**
+     * Append filter to the primary list.
+     * This is only allowed for friend classes from odevice
+     * @param aFilter a filter to append
+     * @see addHandler
+     */
+    virtual void addPreHandler(QWSServer::KeyboardFilter*aFilter)=0;
+    /**
+     * Remove the specified filter from list and give back ownership.
+     * This is only allowed for friend classes from odevice
+     * @param aFilter a filter to remove
+     * @see remHandler
+     */
+    virtual void remPreHandler(QWSServer::KeyboardFilter*aFilter)=0;
 
 public:
     virtual ~OKeyFilter();
-    virtual bool filter( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat );
-
-    void addHandler(QWSServer::KeyboardFilter*);
-    void remHandler(QWSServer::KeyboardFilter*);
+    /**
+     * Append filter to the secondary list.
+     * @param aFilter a filter to append
+     * @see addPreHandler
+     */
+    virtual void addHandler(QWSServer::KeyboardFilter*)=0;
+    /**
+     * Remove the specified filter from list and give back ownership.
+     * @param aFilter a filter to remove
+     * @see remPreHandler
+     */
+    virtual void remHandler(QWSServer::KeyboardFilter*)=0;
 
+    /**
+     * Returns a handler to an instance of OKeyFilter
+     * @return a pointer to a working OKeyFilter
+     */
     static OKeyFilter*inst();
 };
 
 }
 }