diff options
Diffstat (limited to 'src/assistant/tools/qhelpconverter/qhpwriter.cpp')
-rw-r--r-- | src/assistant/tools/qhelpconverter/qhpwriter.cpp | 184 |
1 files changed, 184 insertions, 0 deletions
diff --git a/src/assistant/tools/qhelpconverter/qhpwriter.cpp b/src/assistant/tools/qhelpconverter/qhpwriter.cpp new file mode 100644 index 000000000..51d392d32 --- /dev/null +++ b/src/assistant/tools/qhelpconverter/qhpwriter.cpp @@ -0,0 +1,184 @@ +/**************************************************************************** +** +** Copyright (C) 2011 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 <QtCore/QFile> + +#include "qhpwriter.h" +#include "adpreader.h" + +QT_BEGIN_NAMESPACE + +QhpWriter::QhpWriter(const QString &namespaceName, + const QString &virtualFolder) +{ + m_namespaceName = namespaceName; + m_virtualFolder = virtualFolder; + setAutoFormatting(true); +} + +void QhpWriter::setAdpReader(AdpReader *reader) +{ + m_adpReader = reader; +} + +void QhpWriter::setFilterAttributes(const QStringList &attributes) +{ + m_filterAttributes = attributes; +} + +void QhpWriter::setCustomFilters(const QList<CustomFilter> filters) +{ + m_customFilters = filters; +} + +void QhpWriter::setFiles(const QStringList &files) +{ + m_files = files; +} + +void QhpWriter::generateIdentifiers(IdentifierPrefix prefix, + const QString prefixString) +{ + m_prefix = prefix; + m_prefixString = prefixString; +} + +bool QhpWriter::writeFile(const QString &fileName) +{ + QFile out(fileName); + if (!out.open(QIODevice::WriteOnly)) + return false; + + setDevice(&out); + writeStartDocument(); + writeStartElement(QLatin1String("QtHelpProject")); + writeAttribute(QLatin1String("version"), QLatin1String("1.0")); + writeTextElement(QLatin1String("namespace"), m_namespaceName); + writeTextElement(QLatin1String("virtualFolder"), m_virtualFolder); + writeCustomFilters(); + writeFilterSection(); + writeEndDocument(); + + out.close(); + return true; +} + +void QhpWriter::writeCustomFilters() +{ + if (!m_customFilters.count()) + return; + + foreach (const CustomFilter &f, m_customFilters) { + writeStartElement(QLatin1String("customFilter")); + writeAttribute(QLatin1String("name"), f.name); + foreach (const QString &a, f.filterAttributes) + writeTextElement(QLatin1String("filterAttribute"), a); + writeEndElement(); + } +} + +void QhpWriter::writeFilterSection() +{ + writeStartElement(QLatin1String("filterSection")); + foreach (const QString &a, m_filterAttributes) + writeTextElement(QLatin1String("filterAttribute"), a); + + writeToc(); + writeKeywords(); + writeFiles(); + writeEndElement(); +} + +void QhpWriter::writeToc() +{ + QList<ContentItem> lst = m_adpReader->contents(); + if (lst.isEmpty()) + return; + + int depth = -1; + writeStartElement(QLatin1String("toc")); + foreach (const ContentItem &i, lst) { + while (depth-- >= i.depth) + writeEndElement(); + writeStartElement(QLatin1String("section")); + writeAttribute(QLatin1String("title"), i.title); + writeAttribute(QLatin1String("ref"), i.reference); + depth = i.depth; + } + while (depth-- >= -1) + writeEndElement(); +} + +void QhpWriter::writeKeywords() +{ + QList<KeywordItem> lst = m_adpReader->keywords(); + if (lst.isEmpty()) + return; + + writeStartElement(QLatin1String("keywords")); + foreach (const KeywordItem &i, lst) { + writeEmptyElement(QLatin1String("keyword")); + writeAttribute(QLatin1String("name"), i.keyword); + writeAttribute(QLatin1String("ref"), i.reference); + if (m_prefix == FilePrefix) { + QString str = i.reference.mid( + i.reference.lastIndexOf(QLatin1Char('/'))+1); + str = str.left(str.lastIndexOf(QLatin1Char('.'))); + writeAttribute(QLatin1String("id"), str + QLatin1String("::") + i.keyword); + } else if (m_prefix == GlobalPrefix) { + writeAttribute(QLatin1String("id"), m_prefixString + i.keyword); + } + } + writeEndElement(); +} + +void QhpWriter::writeFiles() +{ + if (m_files.isEmpty()) + return; + + writeStartElement(QLatin1String("files")); + foreach (const QString &f, m_files) + writeTextElement(QLatin1String("file"), f); + writeEndElement(); +} + +QT_END_NAMESPACE |