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
|
/* This file is part of KDevelop
Copyright 2009 Andreas Pakulat <apaku@gmx.de>
Copyright (C) 2008 Cédric Pasteur <cedric.pasteur@free.fr>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KDEVPLATFORM_SOURCEFORMATTERCONTROLLER_H
#define KDEVPLATFORM_SOURCEFORMATTERCONTROLLER_H
#include <interfaces/isourceformattercontroller.h>
#include <interfaces/isourceformatter.h>
#include <QSet>
#include <QVector>
#include <QMimeType>
#include <KXMLGUIClient>
#include <KConfigGroup>
#include "shellexport.h"
class QUrl;
namespace KTextEditor {
class Document;
}
namespace KDevelop
{
class Context;
class ContextMenuExtension;
class IDocument;
class IProject;
class TextDocument;
class ISourceFormatter;
class IPlugin;
class SourceFormatterControllerPrivate;
struct SourceFormatter
{
KDevelop::ISourceFormatter* formatter;
// style name -> style. style objects owned by this
using StyleMap = QMap<QString,KDevelop::SourceFormatterStyle*>;
StyleMap styles;
// Get a list of supported mime types from the style map.
QSet<QString> supportedMimeTypes() const
{
QSet<QString> supported;
for ( auto style: styles ) {
const auto mimeTypes = style->mimeTypes();
for (auto& item : mimeTypes) {
supported.insert(item.mimeType);
}
}
return supported;
}
SourceFormatter() = default;
~SourceFormatter()
{
qDeleteAll(styles);
};
private:
Q_DISABLE_COPY(SourceFormatter)
};
/** \short A singleton class managing all source formatter plugins
*/
class KDEVPLATFORMSHELL_EXPORT SourceFormatterController : public ISourceFormatterController, public KXMLGUIClient
{
Q_OBJECT
friend class SourceFormatterJob;
public:
static QString kateModeLineConfigKey();
static QString kateOverrideIndentationConfigKey();
static QString styleCaptionKey();
static QString styleShowPreviewKey();
static QString styleContentKey();
static QString styleMimeTypesKey();
static QString styleSampleKey();
explicit SourceFormatterController(QObject *parent = nullptr);
~SourceFormatterController() override;
void initialize();
void cleanup();
//----------------- Public API defined in interfaces -------------------
/** \return The formatter corresponding to the language
* of the document corresponding to the \arg url.
*/
ISourceFormatter* formatterForUrl(const QUrl &url) override;
/** Loads and returns a source formatter for this mime type.
* The language is then activated and the style is loaded.
* The source formatter is then ready to use on a file.
*/
ISourceFormatter* formatterForUrl(const QUrl& url, const QMimeType& mime) override;
bool hasFormatters() const override;
/** \return Whether this mime type is supported by any plugin.
*/
bool isMimeTypeSupported(const QMimeType& mime) override;
/**
* @brief Instantiate a Formatter for the given plugin and load its configuration.
*
* @param ifmt The ISourceFormatter interface of the plugin
* @return KDevelop::SourceFormatter* the SourceFormatter instance for the plugin, including config items
*/
SourceFormatter* createFormatterForPlugin(KDevelop::ISourceFormatter* ifmt) const;
/**
* @brief Find the first formatter which supports a given mime type.
*/
ISourceFormatter* findFirstFormatterForMimeType(const QMimeType& mime) const;
KDevelop::ContextMenuExtension contextMenuExtension(KDevelop::Context* context, QWidget* parent);
KDevelop::SourceFormatterStyle styleForUrl(const QUrl& url, const QMimeType& mime) override;
KConfigGroup configForUrl(const QUrl& url) const;
KConfigGroup sessionConfig() const;
KConfigGroup globalConfig() const;
void settingsChanged();
void disableSourceFormatting(bool disable) override;
bool sourceFormattingEnabled() override;
QVector<KDevelop::ISourceFormatter*> formatters() const;
Q_SIGNALS:
void formatterLoaded(KDevelop::ISourceFormatter* ifmt);
void formatterUnloading(KDevelop::ISourceFormatter* ifmt);
private Q_SLOTS:
void updateFormatTextAction();
void beautifySource();
void beautifyLine();
void formatFiles();
void documentLoaded(const QPointer<KDevelop::TextDocument>& doc);
void projectOpened(const KDevelop::IProject* project);
void pluginLoaded(KDevelop::IPlugin* plugin);
void unloadingPlugin(KDevelop::IPlugin* plugin);
private:
/** \return A modeline string (to add at the end or the beginning of a file)
* corresponding to the settings of the active language.
*/
QString addModelineForCurrentLang(QString input, const QUrl& url, const QMimeType&);
/** \return The name of kate indentation mode for the mime type.
* examples are cstyle, python, etc.
*/
QString indentationMode(const QMimeType& mime);
void formatDocument(KDevelop::IDocument* doc, ISourceFormatter* formatter, const QMimeType& mime);
// Adapts the mode of the editor regarding indentation-style
void adaptEditorIndentationMode(KTextEditor::Document* doc, KDevelop::ISourceFormatter* formatter,
const QUrl& url, bool ignoreModeline = false);
void resetUi();
private:
const QScopedPointer<class SourceFormatterControllerPrivate> d_ptr;
Q_DECLARE_PRIVATE(SourceFormatterController)
};
}
#endif // KDEVPLATFORM_SOURCEFORMATTERMANAGER_H
|
