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 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
|
#include "filetemplatesplugin.h"
#include "templateclassassistant.h"
#include "templatepreviewtoolview.h"
#include "debug.h"
#include <language/codegen/templatesmodel.h>
#include <language/interfaces/editorcontext.h>
#include <interfaces/icore.h>
#include <interfaces/iproject.h>
#include <interfaces/iuicontroller.h>
#include <interfaces/context.h>
#include <interfaces/contextmenuextension.h>
#include <interfaces/idocumentcontroller.h>
#include <interfaces/iselectioncontroller.h>
#include <interfaces/iprojectcontroller.h>
#include <project/projectmodel.h>
#include <util/path.h>
#include <KActionCollection>
#include <KConfigGroup>
#include <KLocalizedString>
#include <KPluginFactory>
#include <QAction>
#include <QApplication>
#include <QDir>
#include <QIcon>
using namespace KDevelop;
K_PLUGIN_FACTORY_WITH_JSON(FileTemplatesFactory, "kdevfiletemplates.json", registerPlugin<FileTemplatesPlugin>();)
class TemplatePreviewFactory : public KDevelop::IToolViewFactory
{
public:
explicit TemplatePreviewFactory(FileTemplatesPlugin* plugin)
: KDevelop::IToolViewFactory()
, m_plugin(plugin)
{
}
QWidget* create(QWidget* parent = nullptr) override
{
return new TemplatePreviewToolView(m_plugin, parent);
}
QString id() const override
{
return QStringLiteral("org.kdevelop.TemplateFilePreview");
}
Qt::DockWidgetArea defaultPosition() const override
{
return Qt::RightDockWidgetArea;
}
private:
FileTemplatesPlugin* m_plugin;
};
FileTemplatesPlugin::FileTemplatesPlugin(QObject* parent, const QVariantList& args)
: IPlugin(QStringLiteral("kdevfiletemplates"), parent)
{
Q_UNUSED(args);
setXMLFile(QStringLiteral("kdevfiletemplates.rc"));
QAction* action = actionCollection()->addAction(QStringLiteral("new_from_template"));
action->setText(i18nc("@action", "New from Template..."));
action->setIcon( QIcon::fromTheme( QStringLiteral("code-class") ) );
action->setWhatsThis(i18nc("@info:whatsthis", "Allows you to create new source code files, such as classes or unit tests, using templates." ) );
action->setToolTip( i18nc("@info:tooltip", "Create new files from a template" ) );
connect (action, &QAction::triggered, this, &FileTemplatesPlugin::createFromTemplate);
m_toolView = new TemplatePreviewFactory(this);
core()->uiController()->addToolView(i18nc("@title:window", "Template Preview"), m_toolView);
}
FileTemplatesPlugin::~FileTemplatesPlugin()
{
}
void FileTemplatesPlugin::unload()
{
core()->uiController()->removeToolView(m_toolView);
}
ContextMenuExtension FileTemplatesPlugin::contextMenuExtension(Context* context, QWidget* parent)
{
ContextMenuExtension ext;
QUrl fileUrl;
if (context->type() == Context::ProjectItemContext)
{
auto* projectContext = static_cast<ProjectItemContext*>(context);
QList<ProjectBaseItem*> items = projectContext->items();
if (items.size() != 1)
{
return ext;
}
QUrl url;
ProjectBaseItem* item = items.first();
if (item->folder())
{
url = item->path().toUrl();
}
else if (item->target())
{
url = item->parent()->path().toUrl();
}
if (url.isValid())
{
auto* action = new QAction(i18nc("@action:inmenu", "Create from Template..."), parent);
action->setIcon(QIcon::fromTheme(QStringLiteral("code-class")));
action->setData(url);
connect(action, &QAction::triggered, this, &FileTemplatesPlugin::createFromTemplate);
ext.addAction(ContextMenuExtension::FileGroup, action);
}
if (item->file())
{
fileUrl = item->path().toUrl();
}
}
else if (context->type() == Context::EditorContext)
{
auto* editorContext = static_cast<KDevelop::EditorContext*>(context);
fileUrl = editorContext->url();
}
if (fileUrl.isValid() && determineTemplateType(fileUrl) != NoTemplate)
{
auto* action = new QAction(i18nc("@action:inmenu", "Show Template Preview"), parent);
action->setIcon(QIcon::fromTheme(QStringLiteral("document-preview")));
action->setData(fileUrl);
connect(action, &QAction::triggered, this, &FileTemplatesPlugin::previewTemplate);
ext.addAction(ContextMenuExtension::ExtensionGroup, action);
}
return ext;
}
QString FileTemplatesPlugin::name() const
{
return i18n("File Templates");
}
QIcon FileTemplatesPlugin::icon() const
{
return QIcon::fromTheme(QStringLiteral("code-class"));
}
QAbstractItemModel* FileTemplatesPlugin::templatesModel() const
{
if(!m_model) {
auto* self = const_cast<FileTemplatesPlugin*>(this);
m_model = new TemplatesModel(QStringLiteral("kdevfiletemplates"), self);
}
return m_model;
}
QString FileTemplatesPlugin::knsConfigurationFile() const
{
return QStringLiteral("kdevfiletemplates.knsrc");
}
QStringList FileTemplatesPlugin::supportedMimeTypes() const
{
const QStringList types{
QStringLiteral("application/x-desktop"),
QStringLiteral("application/x-bzip-compressed-tar"),
QStringLiteral("application/zip"),
};
return types;
}
void FileTemplatesPlugin::reload()
{
templatesModel();
m_model->refresh();
}
void FileTemplatesPlugin::loadTemplate(const QString& fileName)
{
templatesModel();
m_model->loadTemplateFile(fileName);
}
void FileTemplatesPlugin::createFromTemplate()
{
QUrl baseUrl;
if (auto* action = qobject_cast<QAction*>(sender()))
{
baseUrl = action->data().toUrl();
}
if (!baseUrl.isValid()) {
// fall-back to currently active document's parent directory
IDocument* doc = ICore::self()->documentController()->activeDocument();
if (doc && doc->url().isValid()) {
baseUrl = doc->url().adjusted(QUrl::RemoveFilename);
}
}
if (!baseUrl.isValid()) {
// fall-back to currently selected project's or item's base directory
auto* projectContext = dynamic_cast<ProjectItemContext*>(ICore::self()->selectionController()->currentSelection());
if (projectContext) {
const QList<ProjectBaseItem*> items = projectContext->items();
if (items.size() == 1) {
ProjectBaseItem* item = items.at(0);
if (item->folder()) {
baseUrl = item->path().toUrl();
} else if (item->target()) {
baseUrl = item->parent()->path().toUrl();
}
}
}
}
if (!baseUrl.isValid()) {
// fall back to base directory of currently open project, if there is only one
const QList<IProject*> projects = ICore::self()->projectController()->projects();
if (projects.size() == 1) {
baseUrl = projects.at(0)->path().toUrl();
}
}
if (!baseUrl.isValid()) {
// last resort
baseUrl = ICore::self()->projectController()->projectsBaseDirectory();
}
auto* assistant = new TemplateClassAssistant(QApplication::activeWindow(), baseUrl);
assistant->setAttribute(Qt::WA_DeleteOnClose);
assistant->show();
}
FileTemplatesPlugin::TemplateType FileTemplatesPlugin::determineTemplateType(const QUrl& url)
{
QDir dir(url.toLocalFile());
/*
* Search for a description file in the url's directory.
* If it is not found there, try cascading up a maximum of 5 directories.
*/
int level = 0;
while (dir.cdUp() && level < 5)
{
const QStringList filters{QStringLiteral("*.kdevtemplate"), QStringLiteral("*.desktop")};
const auto entries = dir.entryList(filters);
for (const QString& entry : entries) {
qCDebug(PLUGIN_FILETEMPLATES) << "Trying entry" << entry;
/*
* This logic is not perfect, but it works for most cases.
*
* Project template description files usually have the suffix
* ".kdevtemplate", so those are easy to find. For project templates,
* all the files in the directory are template files.
*
* On the other hand, file templates use the generic suffix ".desktop".
* Fortunately, those explicitly list input and output files, so we
* only match the explicitly listed files
*/
if (entry.endsWith(QLatin1String(".kdevtemplate")))
{
return ProjectTemplate;
}
auto* config = new KConfig(dir.absoluteFilePath(entry), KConfig::SimpleConfig);
KConfigGroup group = config->group("General");
qCDebug(PLUGIN_FILETEMPLATES) << "General group keys:" << group.keyList();
if (!group.hasKey("Name") || !group.hasKey("Category"))
{
continue;
}
if (group.hasKey("Files"))
{
qCDebug(PLUGIN_FILETEMPLATES) << "Group has files " << group.readEntry("Files", QStringList());
const auto outputFiles = group.readEntry("Files", QStringList());
for (const QString& outputFile : outputFiles) {
if (dir.absoluteFilePath(config->group(outputFile).readEntry("File")) == url.toLocalFile())
{
return FileTemplate;
}
}
}
if (group.hasKey("ShowFilesAfterGeneration"))
{
return ProjectTemplate;
}
}
++level;
}
return NoTemplate;
}
void FileTemplatesPlugin::previewTemplate()
{
auto* action = qobject_cast<QAction*>(sender());
if (!action || !action->data().toUrl().isValid())
{
return;
}
auto* preview = qobject_cast<TemplatePreviewToolView*>(core()->uiController()->findToolView(i18nc("@title:window", "Template Preview"), m_toolView));
if (!preview)
{
return;
}
core()->documentController()->activateDocument(core()->documentController()->openDocument(action->data().toUrl()));
}
#include "filetemplatesplugin.moc"
|