forked from qt-creator/qt-creator
41dee83bec
override, auto, nullptr, member initializers. Change-Id: I04c6ebb683849568973bd7782fb5a3279267141e Reviewed-by: Eike Ziller <eike.ziller@qt.io>
139 lines
4.6 KiB
C++
139 lines
4.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 "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:
|
|
~SnippetsCollection() override;
|
|
|
|
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:
|
|
void identifyGroups();
|
|
|
|
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
|