ocompletion.h

Go to the documentation of this file.

/*
                             This file is part of the Opie Project
                             Originally part of the KDE Project
                             Copyright (C) 1999,2000 Carsten Pfeiffer <pfeiffer@kde.org>
              =.
            .=l.
           .>+-=
 _;:,     .>    :=|.         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.
*/

#ifndef OCOMPLETION_H
#define OCOMPLETION_H

/* QT */

#include <qmap.h>
#include <qlist.h>
#include <qobject.h>
#include <qstring.h>
#include <qstringlist.h>
#include <qguardedptr.h>

/* OPIE */

#include <opie2/oglobalsettings.h>
#include <opie2/osortablevaluelist.h>

/* FORWARDS */

class OCompTreeNode;
class OCompletionPrivate;
class OCompletionBasePrivate;
class OCompletionMatchesWrapper;
class OCompletionMatches;
class QPopupMenu;

// FIXME: Do we need special ShortCut handling in Opie? If so, revise this.
class OShortcut
{
public:
  bool isNull() const { return true; };
  bool operator == ( const OShortcut& bla ) const { return false; };
};


class OCompletion : public QObject
{
    Q_ENUMS( CompOrder )
    Q_PROPERTY( CompOrder order READ order WRITE setOrder )
    Q_PROPERTY( bool ignoreCase READ ignoreCase WRITE setIgnoreCase )
    Q_PROPERTY( QStringList items READ items WRITE setItems )
    Q_OBJECT

  public:
    enum CompOrder { Sorted, Insertion, Weighted };

    OCompletion();

    // FIXME: copy constructor, assignment constructor...

    virtual ~OCompletion();

    virtual QString makeCompletion( const QString& string );

    QStringList substringCompletion( const QString& string ) const;

    QString previousMatch();

    QString nextMatch();

    virtual const QString& lastMatch() const { return myLastMatch; }

    QStringList items() const;

    virtual void setCompletionMode( OGlobalSettings::Completion mode );

    OGlobalSettings::Completion completionMode() const { return myCompletionMode; };

    virtual void setOrder( CompOrder order );

    CompOrder order() const { return myOrder; }

    virtual void setIgnoreCase( bool ignoreCase );

    bool ignoreCase() const { return myIgnoreCase; };

    QStringList allMatches();

    QStringList allMatches( const QString& string );

    OCompletionMatches allWeightedMatches();

    OCompletionMatches allWeightedMatches( const QString& string );

    virtual void setEnableSounds( bool enable ) { myBeep = enable; }

    bool isSoundsEnabled() const { return myBeep; };

    bool hasMultipleMatches() const { return myHasMultipleMatches; };

  public slots:
    void slotMakeCompletion( const QString& string ) { (void) makeCompletion( string ); };

    void slotPreviousMatch() { (void) previousMatch(); };

    void slotNextMatch() { (void) nextMatch(); };

    void insertItems( const QStringList& items );

    virtual void setItems( const QStringList& );

    void addItem( const QString& );

    void addItem( const QString&, uint weight );

    void removeItem( const QString& );

    virtual void clear();

  signals:
    void match( const QString& );

    void matches( const QStringList& );

    void multipleMatches();

  protected:
    virtual void postProcessMatch( QString * /*match*/ ) const {}

    virtual void postProcessMatches( QStringList * /*matches*/ ) const {}

    virtual void postProcessMatches( OCompletionMatches * /*matches*/ ) const {}

private:
    void addWeightedItem( const QString& );
    QString findCompletion( const QString& string );
    void findAllCompletions( const QString&, OCompletionMatchesWrapper *matches, bool& hasMultipleMatches ) const;

    void extractStringsFromNode( const OCompTreeNode *,
                                 const QString& beginning,
                                 OCompletionMatchesWrapper *matches,
                                 bool addWeight = false ) const;
    void extractStringsFromNodeCI( const OCompTreeNode *,
                                   const QString& beginning,
                                   const QString& restString,
                                   OCompletionMatchesWrapper *matches) const;

    enum BeepMode { NoMatch, PartialMatch, Rotation };
    void doBeep( BeepMode ) const;

    OGlobalSettings::Completion myCompletionMode;

    CompOrder myOrder;
    QString myLastString;
    QString myLastMatch;
    QString myCurrentMatch;
    OCompTreeNode * myTreeRoot;
    QStringList myRotations;
    bool myBeep;
    bool myIgnoreCase;
    bool myHasMultipleMatches;
    uint myRotationIndex;

  private:
    OCompletionPrivate *d;
};

// some more helper stuff
typedef OSortableValueList<QString> OCompletionMatchesList;
class OCompletionMatchesPrivate;

class OCompletionMatches
    : public OCompletionMatchesList
{
  public:
    OCompletionMatches( bool sort );
    OCompletionMatches( const OCompletionMatchesWrapper& matches );
    ~OCompletionMatches();
    void removeDuplicates();
    QStringList list( bool sort = true ) const;
    bool sorting() const {
        return _sorting;
    }
private:
    bool _sorting;
    OCompletionMatchesPrivate* d;
};

#endif // OCOMPLETION_H

---