tools/assistant/compat/profile.cpp
changeset 0 1918ee327afb
child 4 3b1da2848fc7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/tools/assistant/compat/profile.cpp	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,196 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the Qt Assistant of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** 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.
+**
+** 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.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "profile.h"
+#include <QTextCodec>
+#include <QFileInfo>
+#include <QRegExp>
+#include <QDir>
+#include <QList>
+#include <QLibraryInfo>
+
+QT_BEGIN_NAMESPACE
+
+#define QT_TITLE         QLatin1String("Qt Reference Documentation")
+#define DESIGNER_TITLE   QLatin1String("Qt Designer Manual")
+#define ASSISTANT_TITLE  QLatin1String("Qt Assistant Manual")
+#define LINGUIST_TITLE   QLatin1String("Qt Linguist Manual")
+#define QMAKE_TITLE      QLatin1String("qmake Manual")
+
+Profile *Profile::createDefaultProfile(const QString &docPath)
+{
+    QString path = QLibraryInfo::location(QLibraryInfo::DocumentationPath);
+    if (!docPath.isEmpty())
+        path = docPath;
+    path = QDir::cleanPath(path) + QLatin1String("/html/");
+
+    Profile *profile = new Profile;
+    profile->valid = true;
+    profile->type = DefaultProfile;
+    profile->props[QLatin1String("name")] = QLatin1String("default");
+    profile->props[QLatin1String("applicationicon")] = QLatin1String("assistant.png");
+    profile->props[QLatin1String("aboutmenutext")] = QLatin1String("About Qt");
+    profile->props[QLatin1String("abouturl")] = QLatin1String("about_qt");
+    profile->props[QLatin1String("basepath")] = path;
+    profile->props[QLatin1String("startpage")] = path + QLatin1String("index.html");
+
+    profile->addDCFTitle( path + QLatin1String("qt.dcf"), QT_TITLE );
+    profile->addDCFTitle( path + QLatin1String("designer.dcf"), DESIGNER_TITLE );
+    profile->addDCFTitle( path + QLatin1String("assistant.dcf"), ASSISTANT_TITLE );
+    profile->addDCFTitle( path + QLatin1String("linguist.dcf"), LINGUIST_TITLE );
+    profile->addDCFTitle( path + QLatin1String("qmake.dcf"), QMAKE_TITLE );
+
+    profile->addDCFIcon( QT_TITLE, QLatin1String("qt.png") );
+    profile->addDCFIcon( DESIGNER_TITLE, QLatin1String("designer.png") );
+    profile->addDCFIcon( ASSISTANT_TITLE, QLatin1String("assistant.png") );
+    profile->addDCFIcon( LINGUIST_TITLE, QLatin1String("linguist.png") );
+
+    profile->addDCFIndexPage( QT_TITLE, path + QLatin1String("index.html") );
+    profile->addDCFIndexPage( DESIGNER_TITLE, path + QLatin1String("designer-manual.html") );
+    profile->addDCFIndexPage( ASSISTANT_TITLE, path + QLatin1String("assistant-manual.html") );
+    profile->addDCFIndexPage( LINGUIST_TITLE, path + QLatin1String("linguist-manual.html") );
+    profile->addDCFIndexPage( QMAKE_TITLE, path + QLatin1String("qmake-manual.html") );
+
+    profile->addDCFImageDir( QT_TITLE, QLatin1String("../../gif/") );
+    profile->addDCFImageDir( DESIGNER_TITLE, QLatin1String("../../gif/") );
+    profile->addDCFImageDir( ASSISTANT_TITLE, QLatin1String("../../gif/") );
+    profile->addDCFImageDir( LINGUIST_TITLE, QLatin1String("../../gif/") );
+    profile->addDCFImageDir( QMAKE_TITLE, QLatin1String("../../gif/") );
+
+    return profile;
+}
+
+Profile::Profile()
+    : valid( true ), dparser( 0 )
+{
+    type = DefaultProfile;
+}
+
+bool Profile::isValid() const
+{
+    return valid;
+}
+
+void Profile::addDCFTitle(const QString &dcf, const QString &title)
+{
+    QString absdcf = QFileInfo(dcf).absoluteFilePath();
+    dcfTitles[title] = absdcf;
+    if (!docs.contains(absdcf))
+        docs << absdcf;
+}
+
+void Profile::addDCF(const QString &docfile)
+{
+    if( !docs.contains( docfile ) == 0 )
+        docs << docfile;
+}
+
+void Profile::addDCFIcon(const QString docfile, const QString &icon)
+{
+    icons[docfile] = icon;
+}
+
+void Profile::addDCFIndexPage(const QString title, const QString &indexPage)
+{
+    indexPages[title] = indexPage;
+}
+
+void Profile::addDCFImageDir(const QString docfile, const QString &imgDir)
+{
+    imageDirs[docfile] = imgDir;
+}
+
+void Profile::addProperty(const QString &name, const QString &value)
+{
+    props[name] = value;
+}
+
+bool Profile::hasDocFile(const QString &name)
+{
+    return docs.contains( name );
+}
+
+void Profile::removeDocFileEntry(const QString &docfile)
+{
+    docs.removeAll(docfile);
+    QStringList titles;
+
+    for( QMap<QString,QString>::Iterator it = dcfTitles.begin();
+        it != dcfTitles.end(); ++it ) {
+        if( (*it) == docfile ) {
+            indexPages.remove( *it );
+            icons.remove( *it );
+            imageDirs.remove( *it );
+            titles << it.key();
+        }
+    }
+
+    for( QStringList::ConstIterator title = titles.constBegin();
+        title != titles.constEnd(); ++title )
+        dcfTitles.remove( *title );
+
+#ifdef ASSISTANT_DEBUG
+    qDebug() << "docs:\n  - " << docs.join("\n  - ");
+    qDebug() << "titles:\n  - " << titles.join("\n  - ");
+    qDebug() << "keys:\n  - " << ((QStringList*)&(dcfTitles.keys()))->join("\n  - ");
+    qDebug() << "values:\n  - " << ((QStringList*)&(dcfTitles.values()))->join("\n  - ");
+#endif
+}
+
+QString Profile::storableFilePath(const QString &fileName)
+{
+    QString path = QLibraryInfo::location(QLibraryInfo::DocumentationPath).replace(QLatin1String("\\"), QLatin1String("/"));
+    QString fName = fileName;
+    if (fName.startsWith(path))
+        fName.replace(0, path.length(), QLatin1String("$DOCPATH$"));
+    return fName;
+}
+
+QString Profile::loadableFilePath(const QString &fileName)
+{
+    QString path = QLibraryInfo::location(QLibraryInfo::DocumentationPath).replace(QLatin1String("\\"), QLatin1String("/"));
+    QString fName = fileName;
+    if (fName.startsWith(QLatin1String("$DOCPATH$")))
+        fName.replace(0, 9, path);
+    return fName;
+}
+
+QT_END_NAMESPACE