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
|
/****************************************************************************
**
** 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>
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 interfaces for suitable editors. The selected
IEditorFactory is then asked to create an editor.
Guidelines for the implementation:
\list
\li displayName() is used as a user visible description of the editor
type that is created. For example, the name displayed in the
\uicontrol {Open With} menu.
\li If duplication is supported (IEditor::duplicateSupported()), you
need to ensure that all duplicates return the same document().
\endlist
\sa Core::IEditor, Core::EditorManager
*/
/*!
\fn void Core::IEditorFactory::addMimeType(const QString &mimeType)
Adds \a mimeType to the list of MIME types supported by this editor type.
*/
/*!
\fn QString Core::IEditorFactory::displayName() const
Returns a user-visible description of the editor type.
*/
/*!
\fn Utils::Id Core::IEditorFactory::id() const
Returns the ID of the factory or editor type.
*/
/*!
\fn QString Core::IEditorFactory::mimeTypes() const
Returns a list of MIME types that the editor supports.
*/
/*!
\fn void Core::IEditorFactory::setDisplayName(const QString &displayName)
Sets the \a displayName of the factory or editor type.
*/
/*!
\fn void Core::IEditorFactory::setId(Id id)
Sets the \a id of the factory or editor type.
*/
/*!
\fn void Core::IEditorFactory::setMimeTypes(const QStringList &mimeTypes)
Sets the MIME types supported by the editor to \a mimeTypes.
*/
static QList<IEditorFactory *> g_editorFactories;
static QHash<Utils::MimeType, IEditorFactory *> g_userPreferredEditorFactories;
/*!
\internal
*/
IEditorFactory::IEditorFactory()
{
g_editorFactories.append(this);
}
/*!
\internal
*/
IEditorFactory::~IEditorFactory()
{
g_editorFactories.removeOne(this);
}
/*!
\internal
*/
const EditorFactoryList IEditorFactory::allEditorFactories()
{
return g_editorFactories;
}
/*!
Returns all available editors for this \a mimeType in the default order
(editors 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 editors for \a fileName in order of preference.
That is the default order for the document's MIME type but with a user
overridden default editor first, and if the document is a too large
text file, with the binary editor as the very first.
*/
const EditorFactoryList IEditorFactory::preferredEditorFactories(const QString &fileName)
{
const QFileInfo fileInfo(fileName);
// default factories by mime type
const Utils::MimeType mimeType = Utils::mimeTypeForFile(fileInfo);
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 (fileInfo.size() > 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.
Either override this in a subclass, or set the function to use for
creating an editor instance with 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() by default to \a creator.
*/
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
|
