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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
/****************************************************************************
**
** 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 <coreplugin/id.h>
#include <QObject>
#include <QPair>
QT_BEGIN_NAMESPACE
class QStringList;
QT_END_NAMESPACE
namespace Utils { class FilePath; }
namespace Core {
class IDocument;
namespace Internal {
class DocumentManagerPrivate;
class MainWindow;
}
class CORE_EXPORT DocumentManager : public QObject
{
Q_OBJECT
public:
enum ResolveMode {
ResolveLinks,
KeepLinks
};
using RecentFile = QPair<QString, Id>;
static DocumentManager *instance();
// file pool to monitor
static void addDocuments(const QList<IDocument *> &documents, bool addWatcher = true);
static void addDocument(IDocument *document, bool addWatcher = true);
static bool removeDocument(IDocument *document);
static QList<IDocument *> modifiedDocuments();
static void renamedFile(const QString &from, const QString &to);
static void expectFileChange(const QString &fileName);
static void unexpectFileChange(const QString &fileName);
// recent files
static void addToRecentFiles(const QString &fileName, Id editorId = Id());
Q_SLOT void clearRecentFiles();
static QList<RecentFile> recentFiles();
static void saveSettings();
// helper functions
static QString cleanAbsoluteFilePath(const QString &filePath, ResolveMode resolveMode);
static QString filePathKey(const QString &filePath, ResolveMode resolveMode);
static bool saveDocument(IDocument *document,
const QString &fileName = QString(),
bool *isReadOnly = nullptr);
static QString allDocumentFactoryFiltersString(QString *allFilesFilter);
static QStringList getOpenFileNames(const QString &filters,
const QString &path = QString(),
QString *selectedFilter = nullptr);
static QString getSaveFileName(const QString &title,
const QString &pathIn,
const QString &filter = QString(),
QString *selectedFilter = nullptr);
static QString getSaveFileNameWithExtension(const QString &title, const QString &pathIn,
const QString &filter);
static QString getSaveAsFileName(const IDocument *document);
static bool saveAllModifiedDocumentsSilently(bool *canceled = nullptr,
QList<IDocument *> *failedToClose = nullptr);
static bool saveModifiedDocumentsSilently(const QList<IDocument *> &documents,
bool *canceled = nullptr,
QList<IDocument *> *failedToClose = nullptr);
static bool saveModifiedDocumentSilently(IDocument *document,
bool *canceled = nullptr,
QList<IDocument *> *failedToClose = nullptr);
static bool saveAllModifiedDocuments(const QString &message = QString(),
bool *canceled = nullptr,
const QString &alwaysSaveMessage = QString(),
bool *alwaysSave = nullptr,
QList<IDocument *> *failedToClose = nullptr);
static bool saveModifiedDocuments(const QList<IDocument *> &documents,
const QString &message = QString(),
bool *canceled = nullptr,
const QString &alwaysSaveMessage = QString(),
bool *alwaysSave = nullptr,
QList<IDocument *> *failedToClose = nullptr);
static bool saveModifiedDocument(IDocument *document,
const QString &message = QString(),
bool *canceled = nullptr,
const QString &alwaysSaveMessage = QString(),
bool *alwaysSave = nullptr,
QList<IDocument *> *failedToClose = nullptr);
static void showFilePropertiesDialog(const Utils::FilePath &filePath);
static QString fileDialogLastVisitedDirectory();
static void setFileDialogLastVisitedDirectory(const QString &);
static QString fileDialogInitialDirectory();
static QString defaultLocationForNewFiles();
static void setDefaultLocationForNewFiles(const QString &location);
static bool useProjectsDirectory();
static void setUseProjectsDirectory(bool);
static Utils::FilePath projectsDirectory();
static void setProjectsDirectory(const Utils::FilePath &directory);
/* Used to notify e.g. the code model to update the given files. Does *not*
lead to any editors to reload or any other editor manager actions. */
static void notifyFilesChangedInternally(const QStringList &files);
signals:
/* Used to notify e.g. the code model to update the given files. Does *not*
lead to any editors to reload or any other editor manager actions. */
void filesChangedInternally(const QStringList &files);
/// emitted if all documents changed their name e.g. due to the file changing on disk
void allDocumentsRenamed(const QString &from, const QString &to);
/// emitted if one document changed its name e.g. due to save as
void documentRenamed(Core::IDocument *document, const QString &from, const QString &to);
void projectsDirectoryChanged(const Utils::FilePath &directory);
private:
explicit DocumentManager(QObject *parent);
~DocumentManager() override;
void documentDestroyed(QObject *obj);
void checkForNewFileName();
void checkForReload();
void changedFile(const QString &file);
void filePathChanged(const Utils::FilePath &oldName, const Utils::FilePath &newName);
void updateSaveAll();
static void registerSaveAllAction();
friend class Core::Internal::MainWindow;
friend class Core::Internal::DocumentManagerPrivate;
};
class CORE_EXPORT FileChangeBlocker
{
public:
explicit FileChangeBlocker(const QString &fileName);
~FileChangeBlocker();
private:
const QString m_fileName;
Q_DISABLE_COPY(FileChangeBlocker)
};
} // namespace Core
Q_DECLARE_METATYPE(Core::DocumentManager::RecentFile)
|
