Move help manager into core.

- lessens open file handles - improves help plugin startup further Task-number: QTCREATORBUG-337 Reviewed-by: ck
2010-06-11 13:11:37 +02:00
parent 40b983a91b
commit 1b6ad08795
41 changed files with 622 additions and 520 deletions
--- a/src/plugins/coreplugin/helpmanager.h
+++ b/src/plugins/coreplugin/helpmanager.h
@@ -0,0 +1,96 @@
+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** Commercial Usage
+**
+** Licensees holding valid Qt Commercial licenses may use this file in
+** accordance with the Qt Commercial License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Nokia.
+**
+** GNU Lesser General Public License Usage
+**
+** Alternatively, 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.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at http://qt.nokia.com/contact.
+**
+**************************************************************************/
+
+#ifndef HELPMANAGER_H
+#define HELPMANAGER_H
+
+#include "core_global.h"
+
+#include <QtCore/QMap>
+#include <QtCore/QObject>
+#include <QtCore/QString>
+#include <QtCore/QStringList>
+#include <QtCore/QUrl>
+#include <QtCore/QVariant>
+
+QT_FORWARD_DECLARE_CLASS(QHelpEngineCore)
+QT_FORWARD_DECLARE_CLASS(QSqlQuery)
+
+namespace Core {
+
+class CORE_EXPORT HelpManager : public QObject
+{
+    Q_OBJECT
+    Q_DISABLE_COPY(HelpManager)
+
+public:
+    explicit HelpManager(QObject *parent = 0);
+    virtual ~HelpManager();
+
+    static HelpManager* instance();
+    static QString collectionFilePath();
+
+    void registerDocumentation(const QStringList &fileNames);
+    void unregisterDocumentation(const QStringList &nameSpaces);
+
+    QMap<QString, QUrl> linksForKeyword(const QString &key) const;
+    QMap<QString, QUrl> linksForIdentifier(const QString &id) const;
+    QStringList findKeywords(const QString &key, int maxHits = INT_MAX) const;
+
+    QUrl findFile(const QUrl &url) const;
+    void handleHelpRequest(const QString &url);
+
+    QStringList registeredNamespaces() const;
+    QString namespaceFromFile(const QString &file) const;
+    QString fileFromNamespace(const QString &nameSpace) const;
+
+signals:
+    void setupFinished();
+    void documentationChanged();
+    void helpRequested(const QUrl &url);
+
+private slots:
+    void setupHelpManager();
+
+private:
+    void verifyDocumenation();
+
+private:
+    bool m_needsSetup;
+    QHelpEngineCore *m_helpEngine;
+
+    QStringList m_filesToRegister;
+    QStringList m_nameSpacesToUnregister;
+
+    static HelpManager *m_instance;
+};
+
+}   // Core
+
+#endif  // HELPMANAGER_H