searchenginesmanager.h

Go to the documentation of this file.

/* ============================================================
* Falkon - Qt web browser
* Copyright (C) 2010-2018 David Rosca <nowrep@gmail.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, 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 General Public License
* along with this program.  If not, see <http://www.gnu.org/licenses/>.
* ============================================================ */
#ifndef SEARCHENGINESMANAGER_H
#define SEARCHENGINESMANAGER_H
 
#include <QObject>
#include <QIcon>
#include <QList>
#include <QVariant>
 
#include "qzcommon.h"
#include "opensearchengine.h"
 
class QWebElement;
 
class WebView;
class LoadRequest;
 
class FALKON_EXPORT SearchEnginesManager : public QObject
{
    Q_OBJECT
public:
    explicit SearchEnginesManager(QObject* parent = nullptr);
 
    struct Engine {
        QString name;
        QIcon icon;
        QString url;
        QString shortcut;
 
        QString suggestionsUrl;
        QByteArray suggestionsParameters;
        QByteArray postData;
 
        bool isValid() const {
            return !name.isEmpty() && !url.isEmpty();
        }
 
        bool operator==(const Engine &other) const {
            return (this->name == other.name &&
                    this->url == other.url &&
                    this->suggestionsUrl == other.suggestionsUrl &&
                    this->shortcut == other.shortcut);
        }
    };
 
    LoadRequest searchResult(const Engine &engine, const QString &string);
    LoadRequest searchResult(const QString &string);
 
    void addEngine(const QUrl &url);
    void addEngine(OpenSearchEngine* engine);
    void addEngine(const Engine &engine);
 
    void addEngineFromForm(const QVariantMap &formData, WebView *view);
 
    void removeEngine(const Engine &engine);
 
    void setActiveEngine(const Engine &engine);
    Engine activeEngine() const { return m_activeEngine; }
 
    void setDefaultEngine(const Engine &engine);
    Engine defaultEngine() const { return m_defaultEngine; }
 
    void editEngine(const Engine &before, const Engine &after);
 
    Engine engineForShortcut(const QString &shortcut);
 
    void setAllEngines(const QVector<Engine> &engines);
    QVector<Engine> allEngines();
 
    QString startingEngineName() { return m_startingEngineName; }
 
    void saveSettings();
    void restoreDefaults();
 
    static QIcon iconForSearchEngine(const QUrl &url);
 
Q_SIGNALS:
    void enginesChanged();
    void activeEngineChanged();
    void defaultEngineChanged();
 
public Q_SLOTS:
 
private Q_SLOTS:
    void engineChangedImage();
    void replyFinished();
 
    void scheduleSave() { m_saveScheduled = true; }
 
private:
    bool checkEngine(OpenSearchEngine* engine);
 
    void loadSettings();
 
    bool m_settingsLoaded;
    bool m_saveScheduled;
 
    QString m_startingEngineName;
    QString m_defaultEngineName;
    QVector<Engine> m_allEngines;
    Engine m_activeEngine;
    Engine m_defaultEngine;
};
 
using SearchEngine = SearchEnginesManager::Engine;
 
// Hint to QVector to use std::realloc on item moving
Q_DECLARE_TYPEINFO(SearchEngine, Q_MOVABLE_TYPE);
 
Q_DECLARE_METATYPE(SearchEngine)
 
#endif // SEARCHENGINESMANAGER_H