Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.

BUG:215923


git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdevelop@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

4 files changed, 504 insertions, 0 deletions

diff --git a/parts/documentation/plugins/devhelp/Makefile.am b/parts/documentation/plugins/devhelp/Makefile.am
new file mode 100644
index 00000000..e0682833
--- /dev/null
+++ b/parts/documentation/plugins/devhelp/Makefile.am
@@ -0,0 +1,14 @@
+INCLUDES = -I$(top_srcdir)/lib/interfaces -I$(top_srcdir)/lib/util \
+	-I$(top_srcdir)/parts/documentation/interfaces $(all_includes)
+
+METASOURCES = AUTO
+
+kde_module_LTLIBRARIES =  libdocdevhelpplugin.la
+
+noinst_HEADERS =  docdevhelpplugin.h
+kde_services_DATA =  docdevhelpplugin.desktop
+
+libdocdevhelpplugin_la_LDFLAGS = -module -avoid-version -no-undefined $(all_libraries)
+libdocdevhelpplugin_la_SOURCES =  docdevhelpplugin.cpp
+libdocdevhelpplugin_la_LIBADD = $(top_builddir)/lib/libkdevelop.la \
+	$(top_builddir)/parts/documentation/interfaces/libdocumentation_interfaces.la
diff --git a/parts/documentation/plugins/devhelp/docdevhelpplugin.cpp b/parts/documentation/plugins/devhelp/docdevhelpplugin.cpp
new file mode 100644
index 00000000..dca19e51
--- /dev/null
+++ b/parts/documentation/plugins/devhelp/docdevhelpplugin.cpp
@@ -0,0 +1,386 @@
+/***************************************************************************
+ *   Copyright (C) 2004 by Alexander Dymo                                  *
+ *   cloudtemple@mksat.net                                                 *
+ *                                                                         *
+ *   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 2 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, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+#include "docdevhelpplugin.h"
+
+#include <unistd.h>
+
+#include <qdom.h>
+#include <qfile.h>
+#include <qfileinfo.h>
+#include <qdialog.h>
+
+#include <kurl.h>
+#include <kaboutdata.h>
+#include <kconfig.h>
+#include <klocale.h>
+#include <kstandarddirs.h>
+
+#include <kdevgenericfactory.h>
+#include <kdevplugininfo.h>
+
+#include "../../../../config.h"
+
+class DevHelpDocumentationCatalogItem: public DocumentationCatalogItem
+{
+public:
+    DevHelpDocumentationCatalogItem(const QString &devHelpFile, DocumentationPlugin* plugin,
+        KListView *parent, const QString &name)
+        :DocumentationCatalogItem(plugin, parent, name), m_devHelpFile(devHelpFile)
+    {
+    }
+    DevHelpDocumentationCatalogItem(const QString &devHelpFile, DocumentationPlugin* plugin,
+        DocumentationItem *parent, const QString &name)
+        :DocumentationCatalogItem(plugin, parent, name), m_devHelpFile(devHelpFile)
+    {
+    }
+    QString devHelpFile() const { return m_devHelpFile; }
+
+    virtual QString cacheVersion() const {
+        unsigned int checksum=0;
+        for(int a=0;a<m_devHelpFile.length(); a++) {
+            checksum += (a+1) * (int)m_devHelpFile[a];
+        }
+        QString str;
+        QTextOStream( &str ) << checksum;
+        return str;
+    }
+    
+protected:
+
+private:
+    QString m_devHelpFile;
+};
+
+
+static const KDevPluginInfo data("docdevhelpplugin");
+typedef KDevGenericFactory<DocDevHelpPlugin> DocDevHelpPluginFactory;
+K_EXPORT_COMPONENT_FACTORY( libdocdevhelpplugin, DocDevHelpPluginFactory(data) )
+
+DocDevHelpPlugin::DocDevHelpPlugin(QObject* parent, const char* name,
+    const QStringList /*args*/)
+    :DocumentationPlugin(DocDevHelpPluginFactory::instance()->config(), parent, name)
+{
+    setCapabilities(Index | FullTextSearch | ProjectDocumentation);
+    autoSetup();
+}
+
+DocDevHelpPlugin::~DocDevHelpPlugin()
+{
+}
+
+DocumentationCatalogItem* DocDevHelpPlugin::createCatalog(KListView* contents, const QString& title, const QString& url)
+{
+    return new DevHelpDocumentationCatalogItem(url, this, contents, title);
+}
+
+QPair<KFile::Mode, QString> DocDevHelpPlugin::catalogLocatorProps()
+{
+    return QPair<KFile::Mode, QString>(KFile::File, "*.devhelp");
+}
+
+QString DocDevHelpPlugin::catalogTitle(const QString& url)
+{
+    QFileInfo fi(url);
+    if (!fi.exists())
+        return QString::null;
+
+    QFile f(url);
+    if (!f.open(IO_ReadOnly))
+        return QString::null;
+    
+    QDomDocument doc;
+    if (!doc.setContent(&f))
+        return QString::null;
+    f.close();
+
+    QDomElement docEl = doc.documentElement();
+
+    return docEl.attribute("title", QString::null);
+}
+
+QString DocDevHelpPlugin::pluginName() const
+{
+    return i18n("Devhelp Documentation Collection");
+}
+
+QStringList DocDevHelpPlugin::fullTextSearchLocations()
+{
+    QStringList locs;
+        
+    QMap<QString, QString> entryMap = config->entryMap("Locations");
+
+    for (QMap<QString, QString>::const_iterator it = entryMap.begin();
+        it != entryMap.end(); ++it)
+    {
+        config->setGroup("Search Settings");
+        if (config->readBoolEntry(it.key(), false))
+        {
+            config->setGroup("Locations");
+            QFileInfo fi(config->readPathEntry(it.key()));
+            locs << fi.dirPath(true);
+        }
+    }
+    
+    return locs;
+}
+
+bool DocDevHelpPlugin::needRefreshIndex(DocumentationCatalogItem* item)
+{
+    DevHelpDocumentationCatalogItem *dhItem = dynamic_cast<DevHelpDocumentationCatalogItem *>(item);
+    if (!dhItem)
+        return false;
+    
+    QFileInfo fi(dhItem->devHelpFile());
+    config->setGroup("Index");
+    if (fi.lastModified() > config->readDateTimeEntry(dhItem->text(0), new QDateTime()))
+    {
+        kdDebug() << "need rebuild index for " << dhItem->text(0) << endl;
+        config->writeEntry(item->text(0), fi.lastModified());
+        return true;
+    }
+    else
+        return false;
+}
+
+void DocDevHelpPlugin::autoSetupPlugin()
+{
+    QValueStack<QString> scanStack;
+    
+    pushToScanStack(scanStack, getenv("DEVHELP_SEARCH_PATH"));
+    pushToScanStack(scanStack, QString(getenv("HOME")) + "/.devhelp/books");
+    
+    QString dhexepath = DocDevHelpPluginFactory::instance()->dirs()->findExe("devhelp");
+    if (!dhexepath.isEmpty())
+    {
+        QFileInfo fi(dhexepath);
+        QString path = KURL(fi.dirPath(true)).upURL().path(1);
+        pushToScanStack(scanStack, path + "share/devhelp/books");
+        pushToScanStack(scanStack, path + "share/gtk-doc/html");
+    }
+    
+    pushToScanStack(scanStack, "/usr/share/gtk-doc/html");
+    pushToScanStack(scanStack, "/usr/share/devhelp/books/");
+    pushToScanStack(scanStack, "/usr/local/share/devhelp/books");
+    pushToScanStack(scanStack, "/usr/local/share/gtk-doc/html");
+    pushToScanStack(scanStack, "/opt/gnome/share/devhelp/books");
+    pushToScanStack(scanStack, "/opt/gnome/share/gtk-doc/html");
+    pushToScanStack(scanStack, "/opt/gnome2/share/devhelp/books");
+    pushToScanStack(scanStack, "/opt/gnome2/share/gtk-doc/html");
+
+    //fill the list of scan dirs (with subdirectories)
+    QStringList scanList;
+    QDir dir;
+    do 
+    {
+        dir.setPath(scanStack.pop());
+        if (!dir.exists())
+            continue;
+        scanList << dir.path();
+
+        const QFileInfoList *dirEntries = dir.entryInfoList();
+        if ( !dirEntries ) continue;
+        QPtrListIterator<QFileInfo> it(*dirEntries);
+        for (; it.current(); ++it) 
+        {
+            QString fileName = it.current()->fileName();
+            if (fileName == "." || fileName == "..")
+                continue;
+            QString path = it.current()->absFilePath();
+            if (it.current()->isDir()) 
+            {
+                scanStack.push(path);
+            }
+        }
+    } while (!scanStack.isEmpty());
+
+    for (QStringList::const_iterator it = scanList.begin(); it != scanList.end(); ++it)
+    {
+        scanDevHelpDir(*it);
+    }
+}
+
+void DocDevHelpPlugin::scanDevHelpDir(const QString &path)
+{
+    QDir d(path);
+    if (! d.exists() || !d.isReadable())
+        return;
+    
+    d.setFilter(QDir::Files);
+    //scan for *.devhelp files
+    const QFileInfoList *list = d.entryInfoList();
+    QFileInfoListIterator it( *list );
+    QFileInfo *fi;
+    while ( (fi = it.current()) != 0 ) 
+    {
+        if (fi->extension() == "devhelp")
+        {
+            config->setGroup("Locations");
+            config->writePathEntry(catalogTitle(fi->absFilePath()), fi->absFilePath());
+        }
+        ++it;
+    }
+}
+
+void DocDevHelpPlugin::pushToScanStack(QValueStack<QString> &stack, const QString &value)
+{
+    if ( (!value.isEmpty()) && (!stack.contains(value)) )
+    {
+        stack << value;
+        kdDebug() << "Devhelp scan stack: +: " << value << endl;
+    }
+}
+
+void DocDevHelpPlugin::createIndex(IndexBox* index, DocumentationCatalogItem* item)
+{
+    DevHelpDocumentationCatalogItem *dhItem = dynamic_cast<DevHelpDocumentationCatalogItem *>(item);
+    if (!dhItem)
+        return;
+    
+    QFileInfo fi(dhItem->devHelpFile());
+
+    QFile f(dhItem->devHelpFile());
+    if (!f.open(IO_ReadOnly))
+    {
+        kdDebug(9002) << "Could not read" << dhItem->devHelpFile() << endl;
+        return;
+    }
+
+    QDomDocument doc;
+    if (!doc.setContent(&f))
+    {
+        kdDebug() << "Not a valid devhelp file: " << dhItem->devHelpFile() << endl;
+        return;
+    }
+    f.close();
+    
+    QString baseUrl = KURL(dhItem->devHelpFile()).directory();
+    
+    QDomElement docEl = doc.documentElement();
+    QDomElement chaptersEl = docEl.namedItem("functions").toElement();
+    QDomElement childEl = chaptersEl.firstChild().toElement();
+    while (!childEl.isNull())
+    {
+        if (childEl.tagName() == "function")
+        {
+            QString name = childEl.attribute("name");
+            QString url = childEl.attribute("link");
+            
+            IndexItemProto *ii = new IndexItemProto(this, item, index, name, item->text(0));
+            ii->addURL(KURL(baseUrl+"/"+url));
+        }
+        childEl = childEl.nextSibling().toElement();
+    }
+}
+
+void DocDevHelpPlugin::createTOC(DocumentationCatalogItem* item)
+{
+    DevHelpDocumentationCatalogItem *dhItem = dynamic_cast<DevHelpDocumentationCatalogItem *>(item);
+    if (!dhItem)
+        return;
+    
+    QFileInfo fi(dhItem->devHelpFile());
+
+    QFile f(dhItem->devHelpFile());
+    if (!f.open(IO_ReadOnly))
+    {
+        kdDebug(9002) << "Could not read" << dhItem->devHelpFile() << endl;
+        return;
+    }
+
+    QDomDocument doc;
+    if (!doc.setContent(&f))
+    {
+        kdDebug() << "Not a valid devhelp file: " << dhItem->devHelpFile() << endl;
+        return;
+    }
+    f.close();
+    
+    QDomElement docEl = doc.documentElement();
+    QDomElement chaptersEl = docEl.namedItem("chapters").toElement();
+
+    QDomElement childEl = chaptersEl.lastChild().toElement();
+    QString baseUrl = KURL(dhItem->devHelpFile()).directory();
+    addTocSect(dhItem, childEl, baseUrl, true);
+}
+
+void DocDevHelpPlugin::addTocSect(DocumentationItem *parent, QDomElement childEl, 
+    QString baseUrl, bool book)
+{
+    while (!childEl.isNull())
+    {
+        if ( (childEl.tagName() == "sub") || (childEl.tagName() == "chapter"))
+        {
+            QString name = childEl.attribute("name");
+            QString url = childEl.attribute("link");
+            
+            if (name.isEmpty() && url.contains("ix"))
+                name = "Index";
+            
+            DocumentationItem *item = new DocumentationItem(
+                book ? DocumentationItem::Book : DocumentationItem::Document, parent, name);
+            item->setURL(KURL(baseUrl+"/"+url));
+            
+            QDomElement grandchildEl = childEl.lastChild().toElement();
+            addTocSect(item, grandchildEl, baseUrl);
+        }
+        childEl = childEl.previousSibling().toElement();
+    }
+}
+
+void DocDevHelpPlugin::setCatalogURL(DocumentationCatalogItem* item)
+{
+    DevHelpDocumentationCatalogItem *dhItem = dynamic_cast<DevHelpDocumentationCatalogItem *>(item);
+    if (!dhItem)
+        return;
+    
+    QFileInfo fi(dhItem->devHelpFile());
+
+    QFile f(dhItem->devHelpFile());
+    if (!f.open(IO_ReadOnly))
+    {
+        kdDebug(9002) << "Could not read" << dhItem->devHelpFile() << endl;
+        return;
+    }
+    QDomDocument doc;
+    if (!doc.setContent(&f))
+    {
+        kdDebug(9002) << "Not a valid Devhelp file: " << dhItem->devHelpFile() << endl;
+        return;
+    }
+    f.close();
+
+    QDomElement docEl = doc.documentElement();
+    QDomElement titleEl = docEl.namedItem("book").toElement();
+
+    if (item->url().isEmpty())
+    {
+        KURL url(fi.dirPath(true) + "/" + docEl.attribute("link", QString::null));
+        item->setURL(url);
+    }
+}
+
+ProjectDocumentationPlugin *DocDevHelpPlugin::projectDocumentationPlugin(ProjectDocType type)
+{
+    if (type == APIDocs)
+        return new ProjectDocumentationPlugin(this, type);
+    return DocumentationPlugin::projectDocumentationPlugin(type);
+}
+
+#include "docdevhelpplugin.moc"
diff --git a/parts/documentation/plugins/devhelp/docdevhelpplugin.desktop b/parts/documentation/plugins/devhelp/docdevhelpplugin.desktop
new file mode 100644
index 00000000..14c3f700
--- /dev/null
+++ b/parts/documentation/plugins/devhelp/docdevhelpplugin.desktop
@@ -0,0 +1,44 @@
+[Desktop Entry]
+Type=Service
+Name=DevHelpPlugin
+Name[da]=DevHelp-plugin
+Name[sk]=DevHelp modul
+Name[sv]=DevHelp-insticksmodul
+Name[ta]=Devஉதவி சொருகு
+Name[zh_TW]=DevHelp 外掛程式
+Comment=Documentation plugin for DevHelp documentation
+Comment[ca]=Connector de documentació per a documentació DevHelp
+Comment[da]=Dokumentations-plugin for DevHelp-dokumentation
+Comment[de]=Komponente für DevHelp-Dokumentation
+Comment[el]=Πρόσθετο τεκμηρίωσης για τεκμηρίωση DevHelp
+Comment[es]=Complemento de documentación para documentación DevHelp
+Comment[et]=DevHelp dokumentatsiooni plugin
+Comment[eu]=DevHelp dokumentaziorako dokumentazio plugin-a
+Comment[fa]=وصلۀ مستندسازی برای مستندات DevHelp
+Comment[fr]=Module externe de documentation pour la documentation DevHelp
+Comment[gl]=Extensión de documentación para documentación DevHelp
+Comment[hu]=Dokumentációmodul DevHelp-dokumentációhoz
+Comment[it]=Plugin di documentazione per file DevHelp
+Comment[ja]=DevHelp ドキュメンテーションのためのドキュメンテーションプラグイン
+Comment[ms]=Plugin dokumentasi untuk dokumentasi DevHelp
+Comment[nds]=Dokmentatschoon-Moduul för DevHelp-Dokmentatschoon
+Comment[ne]=DevHelp मिसिलीकरणका लागि मिसिलीकरण प्लगइन
+Comment[nl]=Documentatie plugin fvoor DevHelp documentatie
+Comment[pl]=Wtyczka dokumentacji dla dokumentacji w formacie DevHelp
+Comment[pt]='Plugin' para documentação DevHelp
+Comment[pt_BR]=Plug-in de documentação para documento DevHelp
+Comment[ru]=Модуль для просмотра документации DevHelp
+Comment[sk]=Dokumentačný modul pre DevHelp dokumentáciu
+Comment[sl]=Dokumentacijski vstavek za dokumentacijo DevHelp
+Comment[sr]=Документациони прикључак за DevHelp документацију
+Comment[sr@Latn]=Dokumentacioni priključak za DevHelp dokumentaciju
+Comment[sv]=Dokumentationsinsticksmodul för DevHelp-dokumentation
+Comment[ta]= DevHelp ஆவணத்திற்கான ஆவணச் சொருகு
+Comment[tg]=Модул барои наоиш намудани DevHelp-и асоснок карда шуда
+Comment[tr]=DevHelp belgelendirmesi için belgelendirme eklentisi
+Comment[zh_CN]=DevHelp 文档的文档插件
+Comment[zh_TW]=DevHelp 文件外掛程式
+Exec=blubb
+ServiceTypes=KDevelop/DocumentationPlugins
+X-KDevelop-Version=5
+X-KDE-Library=libdocdevhelpplugin
diff --git a/parts/documentation/plugins/devhelp/docdevhelpplugin.h b/parts/documentation/plugins/devhelp/docdevhelpplugin.h
new file mode 100644
index 00000000..ab0b0ece
--- /dev/null
+++ b/parts/documentation/plugins/devhelp/docdevhelpplugin.h
@@ -0,0 +1,60 @@
+/***************************************************************************
+ *   Copyright (C) 2004 by Alexander Dymo                                  *
+ *   cloudtemple@mksat.net                                                 *
+ *                                                                         *
+ *   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 2 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, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+#ifndef DOCDEVHELPPLUGIN_H
+#define DOCDEVHELPPLUGIN_H
+
+#include <qvaluestack.h>
+#include <qdom.h>
+
+#include <kdevdocumentationplugin.h>
+
+class DocDevHelpPlugin: public DocumentationPlugin
+{
+    Q_OBJECT
+public:
+    DocDevHelpPlugin(QObject* parent, const char* name, const QStringList args = QStringList());
+    ~DocDevHelpPlugin();
+
+    virtual QString pluginName() const;
+
+    virtual QString catalogTitle(const QString& url);
+    virtual void setCatalogURL(DocumentationCatalogItem* item);
+    
+    virtual void createTOC(DocumentationCatalogItem* item);
+    
+    virtual DocumentationCatalogItem* createCatalog(KListView* contents, const QString& title, const QString& url);
+
+    virtual bool needRefreshIndex(DocumentationCatalogItem* item);
+    virtual void createIndex(IndexBox* index, DocumentationCatalogItem* item);
+        
+    virtual QStringList fullTextSearchLocations();
+    virtual void autoSetupPlugin();
+    
+    virtual QPair<KFile::Mode, QString> catalogLocatorProps();
+
+    virtual ProjectDocumentationPlugin *projectDocumentationPlugin(ProjectDocType type);
+        
+protected:
+    void pushToScanStack(QValueStack<QString> &stack, const QString &value);
+    void scanDevHelpDir(const QString &path);
+    void addTocSect(DocumentationItem *parent, QDomElement childEl, QString baseUrl, bool book=false);
+};
+
+#endif