blob: 59d0b988c0833e9d539d9cbc5537c4a862b67f13 (
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
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
/****************************************************************************
**
** 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.
**
****************************************************************************/
#include "ieditorfactory.h"
#include "ieditorfactory_p.h"
#include "editormanager.h"
#include <utils/mimetypes/mimedatabase.h>
#include <utils/qtcassert.h>
#include <QFileInfo>
using namespace Utils;
namespace Core {
/*!
\class Core::IEditorFactory
\inheaderfile coreplugin/editormanager/ieditorfactory.h
\inmodule QtCreator
\brief The IEditorFactory class creates suitable editors for documents
according to their MIME type.
Whenever a user wants to edit or create a document, the EditorManager
scans all IEditorFactory instances for suitable editors. The selected
IEditorFactory is then asked to create an editor.
Implementations should set the properties of the IEditorFactory subclass in
their constructor.
IEditorFactory instances automatically register themselves in \QC in their
constructor.
\sa Core::IEditor
\sa Core::IDocument
\sa Core::EditorManager
*/
/*!
\fn void Core::IEditorFactory::addMimeType(const QString &mimeType)
Adds \a mimeType to the list of MIME types supported by this editor type.
\sa mimeTypes()
\sa setMimeTypes()
*/
/*!
\fn QString Core::IEditorFactory::displayName() const
Returns a user-visible description of the editor type.
\sa setDisplayName()
*/
/*!
\fn Utils::Id Core::IEditorFactory::id() const
Returns the ID of the editors' document type.
\sa setId()
*/
/*!
\fn QString Core::IEditorFactory::mimeTypes() const
Returns the list of supported MIME types of this editor factory.
\sa addMimeType()
\sa setMimeTypes()
*/
/*!
\fn void Core::IEditorFactory::setDisplayName(const QString &displayName)
Sets the \a displayName of the editor type. This is for example shown in
the \uicontrol {Open With} menu and the MIME type preferences.
\sa displayName()
*/
/*!
\fn void Core::IEditorFactory::setId(Utils::Id id)
Sets the \a id of the editors' document type. This must be the same as the
IDocument::id() of the documents returned by created editors.
\sa id()
*/
/*!
\fn void Core::IEditorFactory::setMimeTypes(const QStringList &mimeTypes)
Sets the MIME types supported by the editor type to \a mimeTypes.
\sa addMimeType()
\sa mimeTypes()
*/
static QList<IEditorFactory *> g_editorFactories;
static QHash<Utils::MimeType, IEditorFactory *> g_userPreferredEditorFactories;
/*!
Creates an IEditorFactory.
Registers the IEditorFactory in \QC.
*/
IEditorFactory::IEditorFactory()
{
g_editorFactories.append(this);
}
/*!
\internal
*/
IEditorFactory::~IEditorFactory()
{
g_editorFactories.removeOne(this);
}
/*!
\internal
*/
const EditorFactoryList IEditorFactory::allEditorFactories()
{
return g_editorFactories;
}
/*!
Returns all available editor factories for the \a mimeType in the default
order (editor types ordered by MIME type hierarchy).
*/
const EditorFactoryList IEditorFactory::defaultEditorFactories(const Utils::MimeType &mimeType)
{
EditorFactoryList rc;
const EditorFactoryList allFactories = IEditorFactory::allEditorFactories();
Internal::mimeTypeFactoryLookup(mimeType, allFactories, &rc);
return rc;
}
/*!
Returns the available editor factories for \a filePath in order of
preference. That is the default order for the document's MIME type but with
a user overridden default editor first, and the binary editor as the very
first item if a text document is too large to be opened as a text file.
*/
const EditorFactoryList IEditorFactory::preferredEditorFactories(const FilePath &filePath)
{
// default factories by mime type
const Utils::MimeType mimeType = Utils::mimeTypeForFile(filePath);
EditorFactoryList factories = defaultEditorFactories(mimeType);
const auto factories_moveToFront = [&factories](IEditorFactory *f) {
factories.removeAll(f);
factories.prepend(f);
};
// user preferred factory to front
IEditorFactory *userPreferred = Internal::userPreferredEditorFactories().value(mimeType);
if (userPreferred)
factories_moveToFront(userPreferred);
// open text files > 48 MB in binary editor
if (filePath.fileSize() > EditorManager::maxTextFileSize()
&& mimeType.inherits("text/plain")) {
const Utils::MimeType binary = Utils::mimeTypeForName("application/octet-stream");
const EditorFactoryList binaryEditors = defaultEditorFactories(binary);
if (!binaryEditors.isEmpty())
factories_moveToFront(binaryEditors.first());
}
return factories;
}
/*!
Creates an editor.
Uses the function set with setEditorCreator() to create the editor.
\sa setEditorCreator()
*/
IEditor *IEditorFactory::createEditor() const
{
QTC_ASSERT(m_creator, return nullptr);
return m_creator();
}
/*!
Sets the function that is used to create an editor instance in
createEditor() to \a creator.
\sa createEditor()
*/
void IEditorFactory::setEditorCreator(const std::function<IEditor *()> &creator)
{
m_creator = creator;
}
/*!
\internal
*/
QHash<Utils::MimeType, Core::IEditorFactory *> Core::Internal::userPreferredEditorFactories()
{
return g_userPreferredEditorFactories;
}
/*!
\internal
*/
void Internal::setUserPreferredEditorFactories(const QHash<Utils::MimeType, IEditorFactory *> &factories)
{
g_userPreferredEditorFactories = factories;
}
} // Core
|
