forked from qt-creator/qt-creator
f6943a712a
Many issues, mostly in headers, were not addressed in
e38410b76c
modernize-use-auto
modernize-use-nullptr
modernize-use-override
modernize-use-using
modernize-use-default-member-init
modernize-use-equals-default
Change-Id: I320a51726db881e582b898948d53735ebb06887a
Reviewed-by: hjk <hjk@qt.io>
89 lines
3.6 KiB
C++
89 lines
3.6 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2016 The Qt Company Ltd.
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** 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 The Qt Company. For licensing terms
|
|
** and conditions see https://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at https://www.qt.io/contact-us.
|
|
**
|
|
** GNU General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU
|
|
** General Public License version 3 as published by the Free Software
|
|
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
|
|
** included in the packaging of this file. Please review the following
|
|
** information to ensure the GNU General Public License requirements will
|
|
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#include "utils_global.h"
|
|
|
|
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;
|
|
QString getQMakeVariableOrFunctionDescription(const QString &html,
|
|
const QString &mark) const;
|
|
QString getQMakeFunctionId(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 = true;
|
|
Mode m_mode = FirstParagraph;
|
|
};
|
|
|
|
} // namespace Utils
|