beautifierplugin.cpp 16 KB
Newer Older
1
/****************************************************************************
Lorenz Haas's avatar
Lorenz Haas committed
2
**
3 4
** Copyright (C) 2016 Lorenz Haas
** Contact: https://www.qt.io/licensing/
Lorenz Haas's avatar
Lorenz Haas committed
5 6 7 8 9 10 11
**
** 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
12 13 14
** 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.
Lorenz Haas's avatar
Lorenz Haas committed
15
**
16 17 18 19 20 21 22
** 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.
Lorenz Haas's avatar
Lorenz Haas committed
23 24 25 26 27 28
**
****************************************************************************/

#include "beautifierplugin.h"

#include "beautifierconstants.h"
29

Lorenz Haas's avatar
Lorenz Haas committed
30 31 32 33 34 35 36 37 38 39 40 41 42 43
#include "artisticstyle/artisticstyle.h"
#include "clangformat/clangformat.h"
#include "uncrustify/uncrustify.h"

#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/actionmanager.h>
#include <coreplugin/actionmanager/command.h>
#include <coreplugin/coreconstants.h>
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/editormanager/ieditor.h>
#include <coreplugin/icontext.h>
#include <coreplugin/icore.h>
#include <coreplugin/messagemanager.h>
#include <diffeditor/differ.h>
44
#include <texteditor/convenience.h>
45 46 47
#include <texteditor/textdocument.h>
#include <texteditor/textdocumentlayout.h>
#include <texteditor/texteditor.h>
Lorenz Haas's avatar
Lorenz Haas committed
48 49
#include <texteditor/texteditorconstants.h>
#include <utils/fileutils.h>
50
#include <utils/qtcassert.h>
Eike Ziller's avatar
Eike Ziller committed
51
#include <utils/runextensions.h>
Lorenz Haas's avatar
Lorenz Haas committed
52 53

#include <QAction>
hjk's avatar
hjk committed
54
#include <QDir>
Lorenz Haas's avatar
Lorenz Haas committed
55
#include <QFileInfo>
56
#include <QFutureWatcher>
57
#include <QMenu>
Lorenz Haas's avatar
Lorenz Haas committed
58 59 60 61 62 63 64
#include <QPlainTextEdit>
#include <QProcess>
#include <QScrollBar>
#include <QTextBlock>
#include <QTimer>
#include <QtPlugin>

65 66
using namespace TextEditor;

Lorenz Haas's avatar
Lorenz Haas committed
67 68 69
namespace Beautifier {
namespace Internal {

70 71
BeautifierPlugin::BeautifierPlugin() :
    m_asyncFormatMapper(new QSignalMapper)
Lorenz Haas's avatar
Lorenz Haas committed
72
{
73 74 75
    connect(m_asyncFormatMapper,
            static_cast<void (QSignalMapper::*)(QObject *)>(&QSignalMapper::mapped),
            this, &BeautifierPlugin::formatCurrentFileContinue);
Montel Laurent's avatar
Montel Laurent committed
76
    connect(this, &BeautifierPlugin::pipeError, this, &BeautifierPlugin::showError);
Lorenz Haas's avatar
Lorenz Haas committed
77 78 79 80
}

BeautifierPlugin::~BeautifierPlugin()
{
81
    m_asyncFormatMapper->deleteLater();
Lorenz Haas's avatar
Lorenz Haas committed
82 83 84 85 86 87 88 89 90 91 92 93
}

bool BeautifierPlugin::initialize(const QStringList &arguments, QString *errorString)
{
    Q_UNUSED(arguments)
    Q_UNUSED(errorString)

    m_tools << new ArtisticStyle::ArtisticStyle(this);
    m_tools << new ClangFormat::ClangFormat(this);
    m_tools << new Uncrustify::Uncrustify(this);

    Core::ActionContainer *menu = Core::ActionManager::createMenu(Constants::MENU_ID);
Sergey Belyashov's avatar
Sergey Belyashov committed
94
    menu->menu()->setTitle(QCoreApplication::translate("Beautifier", Constants::OPTION_TR_CATEGORY));
Lorenz Haas's avatar
Lorenz Haas committed
95 96
    Core::ActionManager::actionContainer(Core::Constants::M_TOOLS)->addMenu(menu);

97
    foreach (BeautifierAbstractTool *tool, m_tools) {
Lorenz Haas's avatar
Lorenz Haas committed
98 99
        tool->initialize();
        const QList<QObject *> autoReleasedObjects = tool->autoReleaseObjects();
100 101
        foreach (QObject *object, autoReleasedObjects)
            addAutoReleasedObject(object);
Lorenz Haas's avatar
Lorenz Haas committed
102 103 104 105 106 107 108 109 110 111 112
    }

    // The single shot is needed, otherwise the menu will stay disabled even
    // when the submenu's actions get enabled later on.
    QTimer::singleShot(0, this, SLOT(updateActions()));
    return true;
}

void BeautifierPlugin::extensionsInitialized()
{
    if (const Core::EditorManager *editorManager = Core::EditorManager::instance()) {
113 114
        connect(editorManager, &Core::EditorManager::currentEditorChanged,
                this, &BeautifierPlugin::updateActions);
Lorenz Haas's avatar
Lorenz Haas committed
115 116 117 118 119 120 121 122 123 124
    }
}

ExtensionSystem::IPlugin::ShutdownFlag BeautifierPlugin::aboutToShutdown()
{
    return SynchronousShutdown;
}

void BeautifierPlugin::updateActions(Core::IEditor *editor)
{
125 126
    foreach (BeautifierAbstractTool *tool, m_tools)
        tool->updateActions(editor);
Lorenz Haas's avatar
Lorenz Haas committed
127 128
}

129 130 131
// Use pipeError() instead of calling showError() because this function may run in another thread.
QString BeautifierPlugin::format(const QString &text, const Command &command,
                                 const QString &fileName, bool *timeout)
Lorenz Haas's avatar
Lorenz Haas committed
132
{
133 134
    const QString executable = command.executable();
    if (executable.isEmpty())
Lorenz Haas's avatar
Lorenz Haas committed
135 136
        return QString();

137 138 139
    switch (command.processing()) {
    case Command::FileProcessing: {
        // Save text to temporary file
140
        const QFileInfo fi(fileName);
141 142 143 144 145
        Utils::TempFileSaver sourceFile(QDir::tempPath() + QLatin1String("/qtc_beautifier_XXXXXXXX.")
                                        + fi.suffix());
        sourceFile.setAutoRemove(true);
        sourceFile.write(text.toUtf8());
        if (!sourceFile.finalize()) {
146 147
            emit pipeError(tr("Cannot create temporary file \"%1\": %2.")
                           .arg(sourceFile.fileName()).arg(sourceFile.errorString()));
148 149 150 151 152 153 154 155
            return QString();
        }

        // Format temporary file
        QProcess process;
        QStringList options = command.options();
        options.replaceInStrings(QLatin1String("%file"), sourceFile.fileName());
        process.start(executable, options);
156 157 158 159 160
        if (!process.waitForFinished(5000)) {
            if (timeout)
                *timeout = true;
            process.kill();
            emit pipeError(tr("Cannot call %1 or some other error occurred.").arg(executable));
161 162 163 164
            return QString();
        }
        const QByteArray output = process.readAllStandardError();
        if (!output.isEmpty())
165
            emit pipeError(executable + QLatin1String(": ") + QString::fromUtf8(output));
166 167 168 169

        // Read text back
        Utils::FileReader reader;
        if (!reader.fetch(sourceFile.fileName(), QIODevice::Text)) {
170 171
            emit pipeError(tr("Cannot read file \"%1\": %2.")
                           .arg(sourceFile.fileName()).arg(reader.errorString()));
172 173 174 175 176 177 178 179 180 181
            return QString();
        }
        return QString::fromUtf8(reader.data());
    } break;

    case Command::PipeProcessing: {
        QProcess process;
        QStringList options = command.options();
        options.replaceInStrings(QLatin1String("%file"), fileName);
        process.start(executable, options);
182 183
        if (!process.waitForStarted(3000)) {
            emit pipeError(tr("Cannot call %1 or some other error occurred.").arg(executable));
184 185 186 187
            return QString();
        }
        process.write(text.toUtf8());
        process.closeWriteChannel();
188 189 190 191 192
        if (!process.waitForFinished(5000)) {
            if (timeout)
                *timeout = true;
            process.kill();
            emit pipeError(tr("Cannot call %1 or some other error occurred.").arg(executable));
193 194
            return QString();
        }
195 196 197 198
        const QByteArray errorText = process.readAllStandardError();
        if (!errorText.isEmpty()) {
            emit pipeError(QString::fromLatin1("%1: %2").arg(executable)
                           .arg(QString::fromUtf8(errorText)));
199 200 201
            return QString();
        }

202 203 204
        const bool addsNewline = command.pipeAddsNewline();
        const bool returnsCRLF = command.returnsCRLF();
        if (addsNewline || returnsCRLF) {
205
            QString formatted = QString::fromUtf8(process.readAllStandardOutput());
206 207 208 209
            if (addsNewline)
                formatted.remove(QRegExp(QLatin1String("(\\r\\n|\\n)$")));
            if (returnsCRLF)
                formatted.replace(QLatin1String("\r\n"), QLatin1String("\n"));
210 211 212
            return formatted;
        }
        return QString::fromUtf8(process.readAllStandardOutput());
Lorenz Haas's avatar
Lorenz Haas committed
213 214
    }
    }
215 216

    return QString();
Lorenz Haas's avatar
Lorenz Haas committed
217 218
}

219
void BeautifierPlugin::formatCurrentFile(const Command &command, int startPos, int endPos)
Lorenz Haas's avatar
Lorenz Haas committed
220
{
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
    QTC_ASSERT(startPos <= endPos, return);

    if (TextEditorWidget *widget = TextEditorWidget::currentTextEditorWidget()) {
        if (const TextDocument *doc = widget->textDocument()) {
            const QString sourceData = (startPos < 0)
                    ? widget->toPlainText()
                    : Convenience::textAt(widget->textCursor(), startPos, (endPos - startPos));
            if (sourceData.isEmpty())
                return;
            const FormatTask task = FormatTask(widget, doc->filePath().toString(), sourceData,
                                               command, startPos, endPos);

            QFutureWatcher<FormatTask> *watcher = new QFutureWatcher<FormatTask>;
            connect(doc, &TextDocument::contentsChanged,
                    watcher, &QFutureWatcher<FormatTask>::cancel);
236 237
            connect(watcher, &QFutureWatcherBase::finished, m_asyncFormatMapper,
                    static_cast<void (QSignalMapper::*)()>(&QSignalMapper::map));
238
            m_asyncFormatMapper->setMapping(watcher, watcher);
Eike Ziller's avatar
Eike Ziller committed
239
            watcher->setFuture(Utils::runAsync(&BeautifierPlugin::formatAsync, this, task));
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
}

void BeautifierPlugin::formatAsync(QFutureInterface<FormatTask> &future, FormatTask task)
{
    task.formattedData = format(task.sourceData, task.command, task.filePath, &task.timeout);
    future.reportResult(task);
}

void BeautifierPlugin::formatCurrentFileContinue(QObject *watcher)
{
    QFutureWatcher<FormatTask> *futureWatcher = static_cast<QFutureWatcher<FormatTask>*>(watcher);
    if (!futureWatcher) {
        if (watcher)
            watcher->deleteLater();
        return;
    }

    if (futureWatcher->isCanceled()) {
        showError(tr("File was modified."));
        futureWatcher->deleteLater();
        return;
    }

    const FormatTask task = futureWatcher->result();
    futureWatcher->deleteLater();

    if (task.timeout) {
        showError(tr("Time out reached while formatting file %1.").arg(task.filePath));
        return;
    }

273 274 275 276 277
    if (task.formattedData.isEmpty()) {
        showError(tr("Could not format file %1.").arg(task.filePath));
        return;
    }

278 279 280 281 282 283 284
    QPlainTextEdit *textEditor = task.editor;
    if (!textEditor) {
        showError(tr("File %1 was closed.").arg(task.filePath));
        return;
    }

    const QString sourceData = textEditor->toPlainText();
285 286 287 288 289
    const QString formattedData = (task.startPos < 0)
            ? task.formattedData
            : QString(sourceData).replace(task.startPos, (task.endPos - task.startPos),
                                          task.formattedData);
    if (sourceData == formattedData)
Lorenz Haas's avatar
Lorenz Haas committed
290 291
        return;

292

Lorenz Haas's avatar
Lorenz Haas committed
293 294 295 296 297
    // Since QTextCursor does not work properly with folded blocks, all blocks must be unfolded.
    // To restore the current state at the end, keep track of which block is folded.
    QList<int> foldedBlocks;
    QTextBlock block = textEditor->document()->firstBlock();
    while (block.isValid()) {
298
        if (const TextBlockUserData *userdata = static_cast<TextBlockUserData *>(block.userData())) {
Lorenz Haas's avatar
Lorenz Haas committed
299 300
            if (userdata->folded()) {
                foldedBlocks << block.blockNumber();
301
                TextDocumentLayout::doFoldOrUnfold(block, true);
Lorenz Haas's avatar
Lorenz Haas committed
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
            }
        }
        block = block.next();
    }
    textEditor->update();

    // Save the current viewport position of the cursor to ensure the same vertical position after
    // the formatted text has set to the editor.
    int absoluteVerticalCursorOffset = textEditor->cursorRect().y();

    // Calculate diff
    DiffEditor::Differ differ;
    const QList<DiffEditor::Diff> diff = differ.diff(sourceData, formattedData);

    // Update changed lines and keep track of the cursor position
    QTextCursor cursor = textEditor->textCursor();
    int charactersInfrontOfCursor = cursor.position();
    int newCursorPos = charactersInfrontOfCursor;
    cursor.beginEditBlock();
    cursor.movePosition(QTextCursor::Start, QTextCursor::MoveAnchor);
322
    foreach (const DiffEditor::Diff &d, diff) {
Lorenz Haas's avatar
Lorenz Haas committed
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
        switch (d.command) {
        case DiffEditor::Diff::Insert:
        {
            // Adjust cursor position if we do work in front of the cursor.
            if (charactersInfrontOfCursor > 0) {
                const int size = d.text.size();
                charactersInfrontOfCursor += size;
                newCursorPos += size;
            }
            // Adjust folded blocks, if a new block is added.
            if (d.text.contains(QLatin1Char('\n'))) {
                const int newLineCount = d.text.count(QLatin1Char('\n'));
                const int number = cursor.blockNumber();
                const int total = foldedBlocks.size();
                for (int i = 0; i < total; ++i) {
                    if (foldedBlocks.at(i) > number)
                        foldedBlocks[i] += newLineCount;
                }
            }
            cursor.insertText(d.text);
        }
            break;
        case DiffEditor::Diff::Delete:
        {
            // Adjust cursor position if we do work in front of the cursor.
            if (charactersInfrontOfCursor > 0) {
                const int size = d.text.size();
                charactersInfrontOfCursor -= size;
                newCursorPos -= size;
                // Cursor was inside the deleted text, so adjust the new cursor position
                if (charactersInfrontOfCursor < 0)
                    newCursorPos -= charactersInfrontOfCursor;
            }
            // Adjust folded blocks, if at least one block is being deleted.
            if (d.text.contains(QLatin1Char('\n'))) {
                const int newLineCount = d.text.count(QLatin1Char('\n'));
                const int number = cursor.blockNumber();
                for (int i = 0, total = foldedBlocks.size(); i < total; ++i) {
                    if (foldedBlocks.at(i) > number) {
                        foldedBlocks[i] -= newLineCount;
                        if (foldedBlocks[i] < number) {
                            foldedBlocks.removeAt(i);
                            --i;
                            --total;
                        }
                    }
                }
            }
            cursor.movePosition(QTextCursor::Right, QTextCursor::KeepAnchor, d.text.size());
            cursor.removeSelectedText();
        }
            break;
        case DiffEditor::Diff::Equal:
            // Adjust cursor position
            charactersInfrontOfCursor -= d.text.size();
            cursor.movePosition(QTextCursor::Right, QTextCursor::MoveAnchor, d.text.size());
            break;
        }
    }
    cursor.endEditBlock();
    cursor.setPosition(newCursorPos);
    textEditor->setTextCursor(cursor);

    // Adjust vertical scrollbar
    absoluteVerticalCursorOffset = textEditor->cursorRect().y() - absoluteVerticalCursorOffset;
    const double fontHeight = QFontMetrics(textEditor->document()->defaultFont()).height();
    textEditor->verticalScrollBar()->setValue(textEditor->verticalScrollBar()->value()
                                              + absoluteVerticalCursorOffset / fontHeight);
    // Restore folded blocks
    const QTextDocument *doc = textEditor->document();
393
    foreach (const int blockId, foldedBlocks) {
394
        const QTextBlock block = doc->findBlockByNumber(qMax(0, blockId));
Lorenz Haas's avatar
Lorenz Haas committed
395
        if (block.isValid())
396
            TextDocumentLayout::doFoldOrUnfold(block, false);
Lorenz Haas's avatar
Lorenz Haas committed
397 398 399 400 401 402 403
    }

    textEditor->document()->setModified(true);
}

void BeautifierPlugin::showError(const QString &error)
{
404
    Core::MessageManager::write(tr("Error in Beautifier: %1").arg(error.trimmed()));
Lorenz Haas's avatar
Lorenz Haas committed
405 406
}

407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
QString BeautifierPlugin::msgCannotGetConfigurationFile(const QString &command)
{
    return tr("Cannot get configuration file for %1.").arg(command);
}

QString BeautifierPlugin::msgFormatCurrentFile()
{
    //: Menu entry
    return tr("Format Current File");
}

QString BeautifierPlugin::msgFormatSelectedText()
{
    //: Menu entry
    return tr("Format Selected Text");
}

QString BeautifierPlugin::msgCommandPromptDialogTitle(const QString &command)
{
    //: File dialog title for path chooser when choosing binary
    return tr("%1 Command").arg(command);
}

Lorenz Haas's avatar
Lorenz Haas committed
430 431
} // namespace Internal
} // namespace Beautifier