blob: 8334a66a492ff234b3ebca3456a5dfafaaecf3a8 (
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
|
/****************************************************************************
**
** 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 <texteditor/texteditor_global.h>
#include <utils/id.h>
#include <utils/variant.h>
#include <QChar>
#include <QCoreApplication>
#include <QList>
#include <QString>
namespace TextEditor {
class TEXTEDITOR_EXPORT NameMangler
{
public:
virtual ~NameMangler();
virtual Utils::Id id() const = 0;
virtual QString mangle(const QString &unmangled) const = 0;
};
class TEXTEDITOR_EXPORT ParsedSnippet
{
public:
class Part {
public:
Part() = default;
explicit Part(const QString &text) : text(text) {}
QString text;
int variableIndex = -1; // if variable index is >= 0 the text is interpreted as a variable
NameMangler *mangler = nullptr;
};
QList<Part> parts;
QList<QList<int>> variables;
};
class TEXTEDITOR_EXPORT SnippetParseError
{
public:
QString errorMessage;
QString text;
int pos;
QString htmlMessage() const;
};
using SnippetParseResult = Utils::variant<ParsedSnippet, SnippetParseError>;
class TEXTEDITOR_EXPORT Snippet
{
Q_DECLARE_TR_FUNCTIONS(Snippet)
public:
explicit Snippet(const QString &groupId = QString(), const QString &id = QString());
~Snippet();
const QString &id() const;
const QString &groupId() const;
bool isBuiltIn() const;
void setTrigger(const QString &trigger);
const QString &trigger() const;
static bool isValidTrigger(const QString &trigger);
void setContent(const QString &content);
const QString &content() const;
void setComplement(const QString &complement);
const QString &complement() const;
void setIsRemoved(bool removed);
bool isRemoved() const;
void setIsModified(bool modified);
bool isModified() const;
QString generateTip() const;
static const QChar kVariableDelimiter;
static const QChar kEscapeChar;
static SnippetParseResult parse(const QString &snippet);
private:
bool m_isRemoved = false;
bool m_isModified = false;
QString m_groupId;
QString m_id; // Only built-in snippets have an id.
QString m_trigger;
QString m_content;
QString m_complement;
};
} // TextEditor
|
