forked from qt-creator/qt-creator
97 lines
3.5 KiB
C++
97 lines
3.5 KiB
C++
/**************************************************************************
|
|
**
|
|
** This file is part of Qt Creator
|
|
**
|
|
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
|
|
**
|
|
** Contact: Nokia Corporation (info@qt.nokia.com)
|
|
**
|
|
**
|
|
** GNU Lesser General Public License Usage
|
|
**
|
|
** 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.
|
|
**
|
|
** Other Usage
|
|
**
|
|
** Alternatively, this file may be used in accordance with the terms and
|
|
** conditions contained in a signed written agreement between you and Nokia.
|
|
**
|
|
** If you have questions regarding the use of this file, please contact
|
|
** Nokia at info@qt.nokia.com.
|
|
**
|
|
**************************************************************************/
|
|
|
|
#ifndef HTMLDOCEXTRACTOR_H
|
|
#define HTMLDOCEXTRACTOR_H
|
|
|
|
#include "utils_global.h"
|
|
|
|
#include <QtCore/QString>
|
|
|
|
namespace Utils {
|
|
|
|
class QTCREATOR_UTILS_EXPORT HtmlDocExtractor
|
|
{
|
|
public:
|
|
HtmlDocExtractor();
|
|
|
|
enum Mode {
|
|
FirstParagraph,
|
|
Extended
|
|
};
|
|
|
|
void setMode(Mode mode);
|
|
void applyFormatting(const bool format);
|
|
|
|
QString getClassOrNamespaceBrief(const QString &html, const QString &mark) const;
|
|
QString getClassOrNamespaceDescription(const QString &html, const QString &mark) const;
|
|
QString getEnumDescription(const QString &html, const QString &mark) const;
|
|
QString getTypedefDescription(const QString &html, const QString &mark) const;
|
|
QString getMacroDescription(const QString &html, const QString &mark) const;
|
|
QString getFunctionDescription(const QString &html,
|
|
const QString &mark,
|
|
const bool mainOverload = true) const;
|
|
QString getQmlComponentDescription(const QString &html, const QString &mark) const;
|
|
QString getQmlPropertyDescription(const QString &html, const QString &mark) const;
|
|
|
|
private:
|
|
QString getClassOrNamespaceMemberDescription(const QString &html,
|
|
const QString &startMark,
|
|
const QString &endMark) const;
|
|
QString getContentsByMarks(const QString &html,
|
|
QString startMark,
|
|
QString endMark) const;
|
|
|
|
void processOutput(QString *html) const;
|
|
|
|
static void stripAllHtml(QString *html);
|
|
static void stripHeadings(QString *html);
|
|
static void stripLinks(QString *html);
|
|
static void stripHorizontalLines(QString *html);
|
|
static void stripDivs(QString *html);
|
|
static void stripTagsStyles(QString *html);
|
|
static void stripTeletypes(QString *html);
|
|
static void stripImagens(QString *html);
|
|
static void stripBold(QString *html);
|
|
static void stripEmptyParagraphs(QString *html);
|
|
static void replaceNonStyledHeadingsForBold(QString *html);
|
|
static void replaceTablesForSimpleLines(QString *html);
|
|
static void replaceListsForSimpleLines(QString *html);
|
|
|
|
bool m_formatContents;
|
|
Mode m_mode;
|
|
};
|
|
|
|
} // namespace Utils
|
|
|
|
#endif // HTMLDOCEXTRACTOR_H
|