beautifierplugin.cpp 16.3 KB
Newer Older
Lorenz Haas's avatar
Lorenz Haas committed
1 2
/**************************************************************************
**
Eike Ziller's avatar
Eike Ziller committed
3 4
** Copyright (C) 2015 Lorenz Haas
** Contact: http://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
Eike Ziller's avatar
Eike Ziller committed
12 13
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
Eike Ziller's avatar
Eike Ziller committed
14
** use the contact form at http://www.qt.io/contact-us.
Lorenz Haas's avatar
Lorenz Haas committed
15 16 17
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18 19 20 21 22 23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
Lorenz Haas's avatar
Lorenz Haas committed
24
**
Eike Ziller's avatar
Eike Ziller committed
25 26
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
Lorenz Haas's avatar
Lorenz Haas committed
27 28 29 30 31 32 33
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#include "beautifierplugin.h"

#include "beautifierconstants.h"
34

Lorenz Haas's avatar
Lorenz Haas committed
35 36 37 38 39 40 41 42 43 44 45 46 47 48
#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>
49
#include <texteditor/convenience.h>
50 51 52
#include <texteditor/textdocument.h>
#include <texteditor/textdocumentlayout.h>
#include <texteditor/texteditor.h>
Lorenz Haas's avatar
Lorenz Haas committed
53 54
#include <texteditor/texteditorconstants.h>
#include <utils/fileutils.h>
55
#include <utils/qtcassert.h>
56
#include <utils/QtConcurrentTools>
Lorenz Haas's avatar
Lorenz Haas committed
57 58

#include <QAction>
hjk's avatar
hjk committed
59
#include <QDir>
Lorenz Haas's avatar
Lorenz Haas committed
60
#include <QFileInfo>
61
#include <QFutureWatcher>
62
#include <QMenu>
Lorenz Haas's avatar
Lorenz Haas committed
63 64 65 66 67 68 69
#include <QPlainTextEdit>
#include <QProcess>
#include <QScrollBar>
#include <QTextBlock>
#include <QTimer>
#include <QtPlugin>

70 71
using namespace TextEditor;

Lorenz Haas's avatar
Lorenz Haas committed
72 73 74
namespace Beautifier {
namespace Internal {

75 76
BeautifierPlugin::BeautifierPlugin() :
    m_asyncFormatMapper(new QSignalMapper)
Lorenz Haas's avatar
Lorenz Haas committed
77
{
78 79 80
    connect(m_asyncFormatMapper,
            static_cast<void (QSignalMapper::*)(QObject *)>(&QSignalMapper::mapped),
            this, &BeautifierPlugin::formatCurrentFileContinue);
Montel Laurent's avatar
Montel Laurent committed
81
    connect(this, &BeautifierPlugin::pipeError, this, &BeautifierPlugin::showError);
Lorenz Haas's avatar
Lorenz Haas committed
82 83 84 85
}

BeautifierPlugin::~BeautifierPlugin()
{
86
    m_asyncFormatMapper->deleteLater();
Lorenz Haas's avatar
Lorenz Haas committed
87 88 89 90 91 92 93 94 95 96 97 98
}

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
99
    menu->menu()->setTitle(QCoreApplication::translate("Beautifier", Constants::OPTION_TR_CATEGORY));
Lorenz Haas's avatar
Lorenz Haas committed
100 101
    Core::ActionManager::actionContainer(Core::Constants::M_TOOLS)->addMenu(menu);

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

    // 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()) {
118 119
        connect(editorManager, &Core::EditorManager::currentEditorChanged,
                this, &BeautifierPlugin::updateActions);
Lorenz Haas's avatar
Lorenz Haas committed
120 121 122 123 124 125 126 127 128 129
    }
}

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

void BeautifierPlugin::updateActions(Core::IEditor *editor)
{
130 131
    foreach (BeautifierAbstractTool *tool, m_tools)
        tool->updateActions(editor);
Lorenz Haas's avatar
Lorenz Haas committed
132 133
}

134 135 136
// 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
137
{
138 139
    const QString executable = command.executable();
    if (executable.isEmpty())
Lorenz Haas's avatar
Lorenz Haas committed
140 141
        return QString();

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

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

        // Read text back
        Utils::FileReader reader;
        if (!reader.fetch(sourceFile.fileName(), QIODevice::Text)) {
175 176
            emit pipeError(tr("Cannot read file \"%1\": %2.")
                           .arg(sourceFile.fileName()).arg(reader.errorString()));
177 178 179 180 181 182 183 184 185 186
            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);
187 188
        if (!process.waitForStarted(3000)) {
            emit pipeError(tr("Cannot call %1 or some other error occurred.").arg(executable));
189 190 191 192
            return QString();
        }
        process.write(text.toUtf8());
        process.closeWriteChannel();
193 194 195 196 197
        if (!process.waitForFinished(5000)) {
            if (timeout)
                *timeout = true;
            process.kill();
            emit pipeError(tr("Cannot call %1 or some other error occurred.").arg(executable));
198 199
            return QString();
        }
200 201 202 203
        const QByteArray errorText = process.readAllStandardError();
        if (!errorText.isEmpty()) {
            emit pipeError(QString::fromLatin1("%1: %2").arg(executable)
                           .arg(QString::fromUtf8(errorText)));
204 205 206
            return QString();
        }

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

    return QString();
Lorenz Haas's avatar
Lorenz Haas committed
222 223
}

224
void BeautifierPlugin::formatCurrentFile(const Command &command, int startPos, int endPos)
Lorenz Haas's avatar
Lorenz Haas committed
225
{
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
    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);
241 242
            connect(watcher, &QFutureWatcherBase::finished, m_asyncFormatMapper,
                    static_cast<void (QSignalMapper::*)()>(&QSignalMapper::map));
243 244 245 246
            m_asyncFormatMapper->setMapping(watcher, watcher);
            watcher->setFuture(QtConcurrent::run(&BeautifierPlugin::formatAsync, this, task));
        }
    }
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
}

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;
    }

278 279 280 281 282
    if (task.formattedData.isEmpty()) {
        showError(tr("Could not format file %1.").arg(task.filePath));
        return;
    }

283 284 285 286 287 288 289
    QPlainTextEdit *textEditor = task.editor;
    if (!textEditor) {
        showError(tr("File %1 was closed.").arg(task.filePath));
        return;
    }

    const QString sourceData = textEditor->toPlainText();
290 291 292 293 294
    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
295 296
        return;

297

Lorenz Haas's avatar
Lorenz Haas committed
298 299 300 301 302
    // 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()) {
303
        if (const TextBlockUserData *userdata = static_cast<TextBlockUserData *>(block.userData())) {
Lorenz Haas's avatar
Lorenz Haas committed
304 305
            if (userdata->folded()) {
                foldedBlocks << block.blockNumber();
306
                TextDocumentLayout::doFoldOrUnfold(block, true);
Lorenz Haas's avatar
Lorenz Haas committed
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
            }
        }
        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);
327
    foreach (const DiffEditor::Diff &d, diff) {
Lorenz Haas's avatar
Lorenz Haas committed
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 393 394 395 396 397
        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();
398 399
    foreach (const int blockId, foldedBlocks) {
        QTextBlock block = doc->findBlockByNumber(qMax(0, blockId));
Lorenz Haas's avatar
Lorenz Haas committed
400
        if (block.isValid())
401
            TextDocumentLayout::doFoldOrUnfold(block, false);
Lorenz Haas's avatar
Lorenz Haas committed
402 403 404 405 406 407 408
    }

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

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

412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
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
435 436
} // namespace Internal
} // namespace Beautifier