/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** 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, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#ifndef HELPEXTRACTOR_H
#define HELPEXTRACTOR_H

#include <QtCore>
#include <QtXml>
#include <QtHelp>

typedef QHash<QString, QString> StringHash;
typedef QHash<QString, StringHash> HashHash;

class HelpExtractor
{
public:
    HelpExtractor();
    void readXmlDocument();

private:
    void initHelpEngine();
    void convertToAggregatableXml(const QDomElement &documentElement);
    QByteArray getResource(const QString &name);
    QByteArray getHtml(const QString &name);
    QByteArray getImage(const QString &name);
    QString getImageUrl(const QString &name);
    QString resolveDocUrl(const QString &name);
    QString resolveImageUrl(const QString &name);
    QString loadDescription(const QString &name);
    void readInfoAboutExample(const QDomElement &example);
    QString extractTextFromParagraph(const QDomNode &parentNode);
    bool isSummaryOf(const QString &text, const QString &example);

    HashHash info;
    QHelpEngineCore *helpEngine;
    QDomDocument *contentsDoc;
    QString helpRootUrl;
    QDir docDir;
    QDir imgDir;
    QString lastCategory;

};

#endif // HELPEXTRACTOR_H