summaryrefslogtreecommitdiffstats
path: root/src/qdoc/qdoc/src/qdoc/quoter.h
blob: 087e9ffd2a9dea7d9de83db8e5be00e8d161c251 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#ifndef QUOTER_H
#define QUOTER_H

#include "location.h"

#include <QtCore/qhash.h>
#include <QtCore/qstringlist.h>

QT_BEGIN_NAMESPACE

class Quoter
{
public:
    Quoter();

    void reset();
    void quoteFromFile(const QString &userFriendlyFileName, const QString &plainCode,
                       const QString &markedCode);
    QString quoteLine(const Location &docLocation, const QString &command, const QString &pattern);
    QString quoteTo(const Location &docLocation, const QString &command, const QString &pattern);
    QString quoteUntil(const Location &docLocation, const QString &command, const QString &pattern);
    QString quoteSnippet(const Location &docLocation, const QString &identifier);

    static QStringList splitLines(const QString &line);

private:
    QString getLine(int unindent = 0);
    void failedAtEnd(const Location &docLocation, const QString &command);
    bool match(const Location &docLocation, const QString &pattern, const QString &line);
    [[nodiscard]] QString commentForCode() const;
    QString removeSpecialLines(const QString &line, const QString &comment, int unindent = 0);

    bool m_silent {};
    QStringList m_plainLines {};
    QStringList m_markedLines {};
    Location m_codeLocation {};
    static QHash<QString, QString> s_commentHash;
};

QT_END_NAMESPACE

#endif