path: root/src/location/maps/qgeomappingmanagerengine.cpp

/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the QtLocation module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qgeomappingmanagerengine.h"
#include "qgeomappingmanagerengine_p.h"
#include "qgeotiledmapreply.h"
#include "qgeotilespec.h"

#include <QThread>
#include <QNetworkProxy>

QT_BEGIN_NAMESPACE

/*!
    \class QGeoMappingManagerEngine
    \inmodule QtLocation
    \ingroup QtLocation-impl
    \since QtLocation 5.0

    \brief The QGeoMappingManagerEngine class provides an interface and convenience methods
    to implementors of QGeoServiceProvider plugins who want to provide support for displaying
    and interacting with maps.
*/

/*!
    Constructs a new engine with the specified \a parent, using \a parameters
    to pass any implementation specific data to the engine.
*/
QGeoMappingManagerEngine::QGeoMappingManagerEngine(const QMap<QString, QVariant> &parameters, QObject *parent)
    : QObject(parent),
      d_ptr(new QGeoMappingManagerEnginePrivate())
{
    d_ptr->parameters = parameters;
    d_ptr->initialized = false;
}

/*!
  \internal
*/
QGeoMappingManagerEngine::QGeoMappingManagerEngine(QGeoMappingManagerEnginePrivate *dd, QObject *parent)
    : QObject(parent),
      d_ptr(dd) {}

/*!
    Destroys this engine.
*/
QGeoMappingManagerEngine::~QGeoMappingManagerEngine()
{
    Q_D(QGeoMappingManagerEngine);
    delete d;
}

QMap<QString, QVariant> QGeoMappingManagerEngine::parameters() const
{
    Q_D(const QGeoMappingManagerEngine);
    return d->parameters;
}

/*!
    Initializes the engine. Subclasses of QGeoMappingManagerEngine may
    implement this function to perform (potentially asynchronous) initialization.

    Static/already known data (such as min/max zoom levels) is better to
    initialize already earlier (e.g. in constructor).

    Once subclasses are done with initialization, they should call this baseclass
    implementation of init().
*/
void QGeoMappingManagerEngine::init()
{
    Q_D(QGeoMappingManagerEngine);
    if (d->stopped_)
        return;
    d->initialized = true;
    emit initialized();
}

void QGeoMappingManagerEngine::threadStarted()
{
    Q_D(QGeoMappingManagerEngine);

    if (d->stopped_)
        return;

    init();

    d->timer_ = new QTimer(this);

    d->timer_->setInterval(0);

    connect(d->timer_,
            SIGNAL(timeout()),
            this,
            SLOT(requestNextTile()));

    d->started_ = true;
    if (!d->queue_.isEmpty())
        d->timer_->start();
}

void QGeoMappingManagerEngine::threadFinished()
{
    Q_D(QGeoMappingManagerEngine);
    d->stopped_ = true;
    disconnect(d->timer_);
    d->timer_->stop();
    this->deleteLater();
}

void QGeoMappingManagerEngine::updateTileRequests(const QSet<QGeoTileSpec> &tilesAdded,
                                                  const QSet<QGeoTileSpec> &tilesRemoved)
{
    Q_D(QGeoMappingManagerEngine);

    if (d->stopped_)
        return;

    cancelTileRequests(tilesRemoved);

    d->queue_ += tilesAdded.toList();

    if (!d->queue_.empty())
        d->timer_->start();
}

void QGeoMappingManagerEngine::cancelTileRequests(const QSet<QGeoTileSpec> &tiles)
{
    Q_D(QGeoMappingManagerEngine);

    typedef QSet<QGeoTileSpec>::const_iterator tile_iter;
    tile_iter tile = tiles.constBegin();
    tile_iter end = tiles.constEnd();
    for (; tile != end; ++tile) {
        QGeoTiledMapReply* reply = d->invmap_.value(*tile, 0);
        if (reply) {
            d->invmap_.remove(*tile);
            reply->abort();
            reply->deleteLater();
        }
        d->queue_.removeAll(*tile);
    }

    if (d->queue_.isEmpty())
        d->timer_->stop();
}

void QGeoMappingManagerEngine::requestNextTile()
{
    Q_D(QGeoMappingManagerEngine);

    if (d->stopped_)
        return;

    if (d->queue_.isEmpty()) {
        d->timer_->stop();
        return;
    }

    QGeoTileSpec ts = d->queue_.takeFirst();

    QGeoTiledMapReply *reply = getTileImage(ts);

    if (reply->isFinished()) {
        handleReply(reply, ts);
    } else {
        connect(reply,
                SIGNAL(finished()),
                this,
                SLOT(finished()));

        d->invmap_.insert(ts, reply);
    }

    if (d->queue_.isEmpty())
        d->timer_->stop();
}

void QGeoMappingManagerEngine::finished()
{
    Q_D(QGeoMappingManagerEngine);

    QGeoTiledMapReply *reply = qobject_cast<QGeoTiledMapReply*>(sender());
    if (!reply)
        return;

    QGeoTileSpec spec = reply->tileSpec();

    if (!d->invmap_.contains(spec)) {
        reply->deleteLater();
        return;
    }

    d->invmap_.remove(spec);

    handleReply(reply, spec);
}

void QGeoMappingManagerEngine::handleReply(QGeoTiledMapReply *reply, const QGeoTileSpec &spec)
{
    Q_D(QGeoMappingManagerEngine);

    if (d->stopped_) {
        reply->deleteLater();
        return;
    }

    if (reply->error() == QGeoTiledMapReply::NoError) {
        emit tileFinished(spec, reply->mapImageData(), reply->mapImageFormat());
    } else {
        emit tileError(spec, reply->errorString());
    }

    reply->deleteLater();
}

/*!
    Sets the name which this engine implementation uses to distinguish itself
    from the implementations provided by other plugins to \a managerName.

    The combination of managerName() and managerVersion() should be unique
    amongst plugin implementations.
*/
void QGeoMappingManagerEngine::setManagerName(const QString &managerName)
{
    d_ptr->managerName = managerName;
}

/*!
    Returns the name which this engine implementation uses to distinguish
    itself from the implementations provided by other plugins.

    The combination of managerName() and managerVersion() should be unique
    amongst plugin implementations.
*/
QString QGeoMappingManagerEngine::managerName() const
{
    return d_ptr->managerName;
}

/*!
    Sets the version of this engine implementation to \a managerVersion.

    The combination of managerName() and managerVersion() should be unique
    amongst plugin implementations.
*/
void QGeoMappingManagerEngine::setManagerVersion(int managerVersion)
{
    d_ptr->managerVersion = managerVersion;
}

/*!
    Returns the version of this engine implementation.

    The combination of managerName() and managerVersion() should be unique
    amongst plugin implementations.
*/
int QGeoMappingManagerEngine::managerVersion() const
{
    return d_ptr->managerVersion;
}

QList<QGeoMapType> QGeoMappingManagerEngine::supportedMapTypes() const
{
    Q_D(const QGeoMappingManagerEngine);
    return d->supportedMapTypes;
}

/*!
    Sets the list of map types supported by this engine to \a mapTypes.

    Subclasses of QGeoMappingManagerEngine should use this function to ensure
    that supportedMapTypes() provides accurate information.
*/
void QGeoMappingManagerEngine::setSupportedMapTypes(const QList<QGeoMapType> &supportedMapTypes)
{
    Q_D(QGeoMappingManagerEngine);
    d->supportedMapTypes = supportedMapTypes;
}

void QGeoMappingManagerEngine::setTileSize(int tileSize)
{
    Q_D(QGeoMappingManagerEngine);
    d->tileSize = tileSize;
}

int QGeoMappingManagerEngine::tileSize() const
{
    Q_D(const QGeoMappingManagerEngine);
    return d->tileSize;
}


/*!
    Return whether the engine has been initialized and is ready to be used.
*/

bool QGeoMappingManagerEngine::isInitialized() const
{
    Q_D(const QGeoMappingManagerEngine);
    return d->initialized;
}

/*!
    \fn void QGeoMappingManagerEngine::initialized()

    This signal is emitted when the mapping manager has been initialized
    and is ready to be used.

    Subclasses of QGeoMappingManagerEngine should call the
    QGeoMappingManagerEngine init() when they have initialized themselves.
*/

/*!
    Sets the camera capabilities associated with this engine to \a cameraCapabilities.

    This is used to limit the modifications applied to the camera associated with
    maps created for use with this plugin.

    Since different plugins support different ranges of zoom levels, and
    have different capabilities with respect to the support of things like
    bearing and tilting, this information is important.

    Subclasses of QGeoMappingManagerEngine should use this function to ensure
    cameraCapabilities() provides accurate information.
*/
void QGeoMappingManagerEngine::setCameraCapabilities(const QGeoCameraCapabilities &cameraCapabilities)
{
    Q_D(QGeoMappingManagerEngine);
    d->cameraCapabilities_ = cameraCapabilities;
}

/*!
    Returns the camera capabilities associated with this engine.
*/
QGeoCameraCapabilities QGeoMappingManagerEngine::cameraCapabilities() const
{
    Q_D(const QGeoMappingManagerEngine);
    return d->cameraCapabilities_;
}

/*!
    Sets the locale to be used by this manager to \a locale.

    If this mapping manager supports returning map labels
    in different languages, they will be returned in the language of \a locale.

    The locale used defaults to the system locale if this is not set.
*/
void QGeoMappingManagerEngine::setLocale(const QLocale &locale)
{
    d_ptr->locale = locale;
}

/*!
    Returns the locale used to hint to this mapping manager about what
    language to use for map labels.
*/
QLocale QGeoMappingManagerEngine::locale() const
{
    return d_ptr->locale;
}

QGeoMappingManager::CacheAreas QGeoMappingManagerEngine::cacheHint() const
{
    Q_D(const QGeoMappingManagerEngine);
    return d->cacheHint;
}

void QGeoMappingManagerEngine::setCacheHint(QGeoMappingManager::CacheAreas cacheHint)
{
    Q_D(QGeoMappingManagerEngine);
    d->cacheHint = cacheHint;
}

/*******************************************************************************
*******************************************************************************/

QGeoMappingManagerEnginePrivate::QGeoMappingManagerEnginePrivate()
    : managerVersion(-1),
    cacheHint(QGeoMappingManager::AllCaches),
    started_(false),
    stopped_(false) {}

QGeoMappingManagerEnginePrivate::~QGeoMappingManagerEnginePrivate() {}

#include "moc_qgeomappingmanagerengine.cpp"

QT_END_NAMESPACE