plasma-framework/abstractrunner.cpp

/*
 *   Copyright 2006-2007 Aaron Seigo <aseigo@kde.org>
 *
 *   This program 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, 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 Library General Public
 *   License along with this program; if not, write to the
 *   Free Software Foundation, Inc.,
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#include "abstractrunner.h"

#include <QAction>
#include <KActionCollection>
#include <KServiceTypeTrader>
#include <KDebug>

namespace Plasma
{

class AbstractRunner::Private
{
    public:
        Private( AbstractRunner* runner ) :
            exactMatch( 0 ),
            actions( new KActionCollection( runner ) )
        {
            delete exactMatch;
            actions->clear();
        }

        QAction* exactMatch;
        KActionCollection* actions;
        // FIXME: it's a bit lame to keep a copy of the term in each runner
        QString term;
};

AbstractRunner::AbstractRunner( QObject* parent )
    : QObject( parent ),
      d( new Private( this ) )
{
}

AbstractRunner::~AbstractRunner()
{
    delete d;
}

bool AbstractRunner::hasOptions()
{
    return false;
}

QWidget* AbstractRunner::options()
{
    return 0;
}

QAction* AbstractRunner::exactMatch( )
{
    return d->exactMatch;
}

QAction* AbstractRunner::exactMatch( const QString& term )
{
    delete d->exactMatch;
    d->term.clear();

    d->exactMatch = accepts( term );
    if ( d->exactMatch ) {
        d->term = term;
        connect( d->exactMatch, SIGNAL( triggered() ),
                 this, SLOT( runExactMatch() ) );
    }

    return d->exactMatch;
}

KActionCollection* AbstractRunner::matches( const QString& term, int max, int offset )
{
    d->actions->clear();
    fillMatches( d->actions, term, max, offset );
    return d->actions;
}

void AbstractRunner::fillMatches( KActionCollection* matches,
                          const QString& term,
                          int max, int offset )
{
    Q_UNUSED( matches );
    Q_UNUSED( term );
    Q_UNUSED( max );
    Q_UNUSED( offset );
}

void AbstractRunner::runExactMatch()
{
    if (!d->exactMatch) {
        return;
    }

    exec(d->exactMatch, d->term);
}

AbstractRunner::List AbstractRunner::loadRunners( QWidget* parent )
{
    List firstRunners;
    List runners;
    List lastRunners;

    KService::List offers = KServiceTypeTrader::self()->query("Plasma/Runner");
    QString error;
    foreach (KService::Ptr service, offers) {
        AbstractRunner* runner = service->createInstance<AbstractRunner>(parent, QVariantList(), &error);
        if (runner) {
            kDebug() << "loaded runner : " << service->name();
            QString phase = service->property("X-Plasma-RunnerPhase").toString();
            if (phase == "last") {
                lastRunners.append(runner);
            } else if (phase == "first") {
                firstRunners.append(runner);
            } else {
                runners.append(runner);
            }
        }
        else {
            kDebug() << "failed to load runner : " << service->name() << ". error reported: " << error;
        }
    }

    firstRunners << runners << lastRunners;
    return firstRunners;
}

} // Plasma namespace

#include "abstractrunner.moc"