snippetscollection.h 4.77 KB
Newer Older
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
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** 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.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/

#ifndef SNIPPETSCOLLECTION_H
#define SNIPPETSCOLLECTION_H

#include "snippet.h"

#include <QtCore/QVector>
36
#include <QtCore/QStringList>
37
#include <QtCore/QHash>
38

39 40
QT_FORWARD_DECLARE_CLASS(QXmlStreamWriter)

41 42 43 44 45 46 47 48 49 50 51 52
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.

53
class SnippetsCollection : public QObject
54
{
55
    Q_OBJECT
56
public:
57 58 59
    virtual ~SnippetsCollection();

    static SnippetsCollection *instance();
60 61 62 63 64 65 66

    class Hint
    {
        friend class SnippetsCollection;
    public:
        int index() const;
    private:
67
        explicit Hint(int index);
68 69 70 71 72
        Hint(int index, QList<Snippet>::iterator it);
        int m_index;
        QList<Snippet>::iterator m_it;
    };

73 74 75
    void insertSnippet(const Snippet &snippet);
    void insertSnippet(const Snippet &snippet, const Hint &hint);
    Hint computeInsertionHint(const Snippet &snippet);
76

77 78 79 80
    // 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);
81

82 83
    void removeSnippet(int index, const QString &groupId);
    void restoreRemovedSnippets(const QString &groupId);
84

85
    void setSnippetContent(int index, const QString &groupId, const QString &content);
86

87 88
    const Snippet &snippet(int index, const QString &groupId) const;
    Snippet revertedSnippet(int index, const QString &groupId) const;
Leandro Melo's avatar
Leandro Melo committed
89

90
    void reset(const QString &groupId);
91

92 93 94 95
    int totalActiveSnippets(const QString &groupId) const;
    int totalSnippets(const QString &groupId) const;

    QList<QString> groupIds() const;
96

97 98
    void reload();
    void synchronize();
99

100 101 102
private slots:
    void identifyGroups();

103
private:
104 105 106
    SnippetsCollection();
    Q_DISABLE_COPY(SnippetsCollection)

107
    int groupIndex(const QString &groupId) const;
108
    bool isGroupKnown(const QString &groupId) const;
109 110 111 112 113

    void clearSnippets();
    void clearSnippets(int groupIndex);

    void updateActiveSnippetsEnd(int groupIndex);
114

115 116
    QList<Snippet> readXML(const QString &fileName, const QString &snippetId = QString()) const;
    void writeSnippetXML(const Snippet &snippet, QXmlStreamWriter *writer) const;
117

118 119
    QList<Snippet> allBuiltInSnippets() const;

120 121 122 123 124 125 126 127 128
    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;

129
    // Built-in snippets are specified in XMLs distributed in a system's folder. Snippets
130 131
    // created or modified/removed (if they are built-ins) by the user are stored in user's
    // folder.
132
    QString m_userSnippetsPath;
133 134
    QString m_userSnippetsFile;
    QStringList m_builtInSnippetsFiles;
135 136 137 138 139 140 141 142

    // 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;
143 144 145 146 147 148
};

} // Internal
} // TextEditor

#endif // SNIPPETSCOLLECTION_H