Differential D17971 Diff 50859 addons/externaltools/katemacroexpander.cpp

Changeset View

Standalone View

View Options

addons/externaltools/katemacroexpander.cpp

  • This file was added.
1​/* This file is part of the KDE project
2​ *
3​ * Copyright 2019 Dominik Haumann <dhaumann@kde.org>
4​ *
5​ * This library is free software; you can redistribute it and/or
6​ * modify it under the terms of the GNU Library General Public
7​ * License as published by the Free Software Foundation; either
8​ * version 2 of the License, or (at your option) any later version.
9​ *
10​ * This library is distributed in the hope that it will be useful,
11​ * but WITHOUT ANY WARRANTY; without even the implied warranty of
12​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13​ * Library General Public License for more details.
14​ *
15​ * You should have received a copy of the GNU Library General Public License
16​ * along with this library; see the file COPYING.LIB. If not, write to
17​ * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18​ * Boston, MA 02110-1301, USA.
19​ */
20​#include "katemacroexpander.h"
21​
22​#include <KTextEditor/Application>
23​#include <KTextEditor/Document>
24​#include <KTextEditor/Editor>
25​#include <KTextEditor/View>
26​
27​#include <QDir>
28​#include <QFileInfo>
29​#include <QDate>
30​#include <QTime>
31​#include <QUuid>
32​
33​MacroExpander::MacroExpander(KTextEditor::View* view)
34​ : KWordMacroExpander()
35​ , m_view(view)
36​ , m_url(view ? view->document()->url().toLocalFile() : QString())
37​{
38​}
39​
40​// CurrentDocument:FileBaseName - Current document: File base name without path and suffix.
41​// CurrentDocument:FileExtension - Current document: File extension.
42​// CurrentDocument:FileName - Current document: File name without path.
43​// CurrentDocument:FilePath - Current document: Full path including file name.
44​// CurrentDocument:Text - Current document: Contents of entire file.
45​// CurrentDocument:Path - Current document: Full path excluding file name.
46​// CurrentDocument:NativeFilePath - Current document: Full path including file name, with native path separator (backslash on Windows).
47​// CurrentDocument:NativePath - Current document: Full path excluding file name, with native path separator (backslash on Windows).
48​//
49​// CurrentDocument:Cursor:Line - Line number of the text cursor position in current document (starts with 0).
50​// CurrentDocument:Cursor:Column - Column number of the text cursor position in current document (starts with 0).
51​// CurrentDocument:Cursor:XPos - X component in global screen coordinates of the cursor position.
52​// CurrentDocument:Cursor:YPos - Y component in global screen coordinates of the cursor position.
53​// CurrentDocument:Selection:Text - Current document: Full path excluding file name.
54​// CurrentDocument:Selection:StartLine
55​// CurrentDocument:Selection:StartColumn
56​// CurrentDocument:Selection:EndLine
57​// CurrentDocument:Selection:EndColumn
58​// CurrentDocument:RowCount - Total number of lines in the current document.
59​//
60​// Date:<format> - The current date (QDate formatstring).
61​// Date:Locale - The current date in current locale format.
62​// Date:ISO - The current date (ISO).
63​//
64​// Time:<format> - The current time (QTime formatstring).
65​// Time:Locale - The current time in current locale format.
66​// Time:ISO - The current time (ISO).
67​//
68​// Env:<value> - Access environment variables.
69​//
70​// JS:<expression> - Evaluate simple JavaScript statements. The statements may not contain '{' nor '}' characters.
71​//
72​// UUID - Generate a new UUID.
73​
74​bool MacroExpander::expandMacro(const QString& str, QStringList& ret)
75​{
76​ KTextEditor::View* view = m_view;
77​ if (!view)
78​ return false;
79​
80​ KTextEditor::Document* doc = view->document();
81​ const QUrl url = doc->url();
82​
83​ if (str == QStringLiteral("CurrentDocument:FileBaseName")) // Current document: File base name without path and suffix.
84​ ret += QFileInfo(m_url).baseName();
85​ else if (str == QStringLiteral("CurrentDocument:FileExtension")) // Current document: File extension.
86​ ret += QFileInfo(m_url).completeSuffix();
87​ else if (str == QStringLiteral("CurrentDocument:FileName")) // Current document: File name without path.
88​ ret += QFileInfo(m_url).fileName();
89​ else if (str == QStringLiteral("CurrentDocument:FilePath")) // Current document: Full path including file name
90​ ret += QFileInfo(m_url).absoluteFilePath();
91​ else if (str == QStringLiteral("CurrentDocument:Text")) // Current document: Contents of entire file
92​ ret += doc->text();
93​ else if (str == QStringLiteral("CurrentDocument:Path")) // Current document: Full path excluding file name
94​ ret += QFileInfo(m_url).absolutePath();
95​ else if (str == QStringLiteral("CurrentDocument:NativeFilePath")) // Current document: Full path including file name, with native path separator (backslash on Windows).
96​ ret += m_url.isEmpty() ? QString() : QDir::toNativeSeparators(QFileInfo(m_url).absoluteFilePath());
97​ else if (str == QStringLiteral("CurrentDocument:NativePath")) // Current document: Full path excluding file name, with native path separator (backslash on Windows).
98​ ret += m_url.isEmpty() ? QString() : QDir::toNativeSeparators(QFileInfo(m_url).absolutePath());
99​
100​ else if (str == QStringLiteral("CurrentDocument:Cursor:Line")) // Line number of the text cursor position in current document (starts with 0).
101​ ret += QString::number(view->cursorPosition().line());
102​ else if (str == QStringLiteral("CurrentDocument:Cursor:Column")) // Column number of the text cursor position in current document (starts with 0).
103​ ret += QString::number(view->cursorPosition().column());
104​ else if (str == QStringLiteral("CurrentDocument:Cursor:XPos")) // X component in global screen coordinates of the cursor position.
105​ ret += QString::number(view->cursorPositionCoordinates().x());
106​ else if (str == QStringLiteral("CurrentDocument:Cursor:YPos")) // Y component in global screen coordinates of the cursor position.
107​ ret += QString::number(view->cursorPositionCoordinates().y());
108​ else if (str == QStringLiteral("CurrentDocument:Selection:Text")) // Current document: Full path excluding file name.
109​ ret += view->selectionText();
110​ else if (str == QStringLiteral("CurrentDocument:Selection:StartLine"))
111​ ret += QString::number(view->selectionRange().start().line());
112​ else if (str == QStringLiteral("CurrentDocument:Selection:StartColumn"))
113​ ret += QString::number(view->selectionRange().start().column());
114​ else if (str == QStringLiteral("CurrentDocument:Selection:EndLine"))
115​ ret += QString::number(view->selectionRange().end().line());
116​ else if (str == QStringLiteral("CurrentDocument:Selection:EndColumn"))
117​ ret += QString::number(view->selectionRange().end().column());
118​ else if (str == QStringLiteral("CurrentDocument:RowCount"))
119​ ret += QString::number(view->document()->lines());
120​
121​ else if (str == QStringLiteral("Date:Locale")) // The current date in current locale format.
122​ ret += QDate::currentDate().toString(Qt::DefaultLocaleShortDate);
123​ else if (str == QStringLiteral("Date:ISO")) // The current date (ISO).
124​ ret += QDate::currentDate().toString(Qt::ISODate);
125​ else if (str.startsWith(QStringLiteral("Date:"))) // The current date (QDate formatstring).
126​ ret += QDate::currentDate().toString(QStringView(str.constData() + 5, str.length() - 5));
127​
128​ else if (str == QStringLiteral("Time:Locale")) // The current time in current locale format.
129​ ret += QTime::currentTime().toString(Qt::DefaultLocaleShortDate);
130​ else if (str == QStringLiteral("Time:ISO")) // The current time (ISO).
131​ ret += QTime::currentTime().toString(Qt::ISODate);
132​ else if (str.startsWith(QStringLiteral("Time:"))) // The current time (QTime formatstring).
133​ ret += QTime::currentTime().toString(QStringView(str.constData() + 5, str.length() - 5));
134​
135​ else if (str.startsWith(QStringLiteral("ENV:"))) // Access environment variables.
136​ ; // FIXME
137​ else if (str.startsWith(QStringLiteral("JS:"))) // Evaluate simple JavaScript statements. The statements may not contain '{' nor '}' characters.
138​ ; // FIXME
139​ else if (str == QStringLiteral("UUID")) // Generate a new UUID.
140​#if QT_VERSION >= QT_VERSION_CHECK(5, 11, 0)
141​ ret += QUuid::createUuid().toString(QUuid::WithoutBraces);
142​#else
143​ { // LEGACY
144​ QString uuid = QUuid::createUuid().toString();
145​ if (uuid.startsWith(QLatin1Char('{')))
146​ uuid.remove(0, 1);
147​ if (uuid.endsWith(QLatin1Char('}')))
148​ uuid.truncate(uuid.length() - 1);
149​ ret += uuid;
150​ }
151​#endif
152​ else
153​ return false;
154​
155​ return true;
156​}
157​
158​// kate: space-indent on; indent-width 4; replace-tabs on;