summaryrefslogtreecommitdiffstats
path: root/src/gui/text/qtextmarkdownimporter_p.h
blob: b73e7444345de6ff06e6f6b9e094234e146c5c14 (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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtGui module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** 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-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QTEXTMARKDOWNIMPORTER_H
#define QTEXTMARKDOWNIMPORTER_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include <QtGui/qfont.h>
#include <QtGui/qtguiglobal.h>
#include <QtGui/qpalette.h>
#include <QtGui/qtextlist.h>
#include <QtCore/qstack.h>

#include "../../3rdparty/md4c/md4c.h"

QT_BEGIN_NAMESPACE

class QTextCursor;
class QTextDocument;
class QTextTable;

class Q_GUI_EXPORT QTextMarkdownImporter
{
public:
    enum Feature {
        FeatureCollapseWhitespace = MD_FLAG_COLLAPSEWHITESPACE,
        FeaturePermissiveATXHeaders = MD_FLAG_PERMISSIVEATXHEADERS,
        FeaturePermissiveURLAutoLinks = MD_FLAG_PERMISSIVEURLAUTOLINKS,
        FeaturePermissiveMailAutoLinks = MD_FLAG_PERMISSIVEEMAILAUTOLINKS,
        FeatureNoIndentedCodeBlocks = MD_FLAG_NOINDENTEDCODEBLOCKS,
        FeatureNoHTMLBlocks = MD_FLAG_NOHTMLBLOCKS,
        FeatureNoHTMLSpans = MD_FLAG_NOHTMLSPANS,
        FeatureTables = MD_FLAG_TABLES,
        FeatureStrikeThrough = MD_FLAG_STRIKETHROUGH,
        FeaturePermissiveWWWAutoLinks = MD_FLAG_PERMISSIVEWWWAUTOLINKS,
        FeatureTasklists = MD_FLAG_TASKLISTS,
        // composite flags
        FeaturePermissiveAutoLinks = MD_FLAG_PERMISSIVEAUTOLINKS,
        FeatureNoHTML = MD_FLAG_NOHTML,
        DialectCommonMark = MD_DIALECT_COMMONMARK,
        DialectGitHub = MD_DIALECT_GITHUB
    };
    Q_DECLARE_FLAGS(Features, Feature)

    QTextMarkdownImporter(Features features);

    void import(QTextDocument *doc, const QString &markdown);

public:
    // MD4C callbacks
    int cbEnterBlock(MD_BLOCKTYPE type, void* detail);
    int cbLeaveBlock(MD_BLOCKTYPE type, void* detail);
    int cbEnterSpan(MD_SPANTYPE type, void* detail);
    int cbLeaveSpan(MD_SPANTYPE type, void* detail);
    int cbText(MD_TEXTTYPE type, const MD_CHAR* text, MD_SIZE size);

private:
    QTextDocument *m_doc = nullptr;
    QTextCursor *m_cursor = nullptr;
    QTextTable *m_currentTable = nullptr; // because m_cursor->currentTable() doesn't work
    QString m_htmlAccumulator;
    QVector<int> m_nonEmptyTableCells; // in the current row
    QStack<QTextList *> m_listStack;
    QStack<QTextCharFormat> m_spanFormatStack;
    QFont m_monoFont;
    QPalette m_palette;
    int m_htmlTagDepth = 0;
    int m_tableColumnCount = 0;
    int m_tableRowCount = 0;
    int m_tableCol = -1; // because relative cell movements (e.g. m_cursor->movePosition(QTextCursor::NextCell)) don't work
    Features m_features;
    MD_BLOCKTYPE m_blockType = MD_BLOCK_DOC;
    bool m_emptyList = false; // true when the last thing we did was insertList
    bool m_imageSpan = false;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QTextMarkdownImporter::Features)

QT_END_NAMESPACE

#endif // QTEXTMARKDOWNIMPORTER_H