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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/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 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, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#ifndef SNIPPETSCOLLECTION_H
#define SNIPPETSCOLLECTION_H
#include "snippet.h"
#include <QVector>
#include <QStringList>
#include <QHash>
#include <QXmlStreamWriter>
namespace TextEditor {
namespace Internal {
// Characteristics of this collection:
// - Store snippets by group.
// - Keep groups of snippets sorted.
// - Allow snippet insertion/replacement based on a hint.
// - Allow modification of snippet members that are not sorting keys.
// - Track removed/modified built-in snippets.
// - Provide fast index access.
// - Not thread-safe.
class SnippetsCollection : public QObject
{
Q_OBJECT
public:
virtual ~SnippetsCollection();
static SnippetsCollection *instance();
class Hint
{
friend class SnippetsCollection;
public:
int index() const;
private:
explicit Hint(int index);
Hint(int index, QList<Snippet>::iterator it);
int m_index;
QList<Snippet>::iterator m_it;
};
void insertSnippet(const Snippet &snippet);
void insertSnippet(const Snippet &snippet, const Hint &hint);
Hint computeInsertionHint(const Snippet &snippet);
// Replace snippets only within the same group.
void replaceSnippet(int index, const Snippet &snippet);
void replaceSnippet(int index, const Snippet &snippet, const Hint &hint);
Hint computeReplacementHint(int index, const Snippet &snippet);
void removeSnippet(int index, const QString &groupId);
void restoreRemovedSnippets(const QString &groupId);
void setSnippetContent(int index, const QString &groupId, const QString &content);
const Snippet &snippet(int index, const QString &groupId) const;
Snippet revertedSnippet(int index, const QString &groupId) const;
void reset(const QString &groupId);
int totalActiveSnippets(const QString &groupId) const;
int totalSnippets(const QString &groupId) const;
QList<QString> groupIds() const;
void reload();
bool synchronize(QString *errorString);
private slots:
void identifyGroups();
private:
SnippetsCollection();
int groupIndex(const QString &groupId) const;
bool isGroupKnown(const QString &groupId) const;
void clearSnippets();
void clearSnippets(int groupIndex);
void updateActiveSnippetsEnd(int groupIndex);
QList<Snippet> readXML(const QString &fileName, const QString &snippetId = QString()) const;
void writeSnippetXML(const Snippet &snippet, QXmlStreamWriter *writer) const;
QList<Snippet> allBuiltInSnippets() const;
static const QLatin1String kSnippet;
static const QLatin1String kSnippets;
static const QLatin1String kTrigger;
static const QLatin1String kId;
static const QLatin1String kComplement;
static const QLatin1String kGroup;
static const QLatin1String kRemoved;
static const QLatin1String kModified;
// Built-in snippets are specified in XMLs distributed in a system's folder. Snippets
// created or modified/removed (if they are built-ins) by the user are stored in user's
// folder.
QString m_userSnippetsPath;
QString m_userSnippetsFile;
QStringList m_builtInSnippetsFiles;
// Snippets for each group are kept in a list. However, not all of them are necessarily
// active. Specifically, removed built-in snippets are kept as the last ones (for each
// group there is a iterator that marks the logical end).
QVector<QList<Snippet> > m_snippets;
QVector<QList<Snippet>::iterator> m_activeSnippetsEnd;
QHash<QString, int> m_groupIndexById;
};
} // Internal
} // TextEditor
#endif // SNIPPETSCOLLECTION_H
|
