beautifierplugin.cpp 16.1 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
#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/messagemanager.h>
#include <diffeditor/differ.h>
42
#include <texteditor/convenience.h>
43 44 45
#include <texteditor/textdocument.h>
#include <texteditor/textdocumentlayout.h>
#include <texteditor/texteditor.h>
46
#include <utils/qtcassert.h>
Eike Ziller's avatar
Eike Ziller committed
47
#include <utils/runextensions.h>
Lorenz Haas's avatar
Lorenz Haas committed
48

hjk's avatar
hjk committed
49
#include <QDir>
Lorenz Haas's avatar
Lorenz Haas committed
50
#include <QFileInfo>
51
#include <QFutureWatcher>
52
#include <QMenu>
Lorenz Haas's avatar
Lorenz Haas committed
53 54 55 56 57
#include <QPlainTextEdit>
#include <QProcess>
#include <QScrollBar>
#include <QTextBlock>

58 59
using namespace TextEditor;

Lorenz Haas's avatar
Lorenz Haas committed
60 61 62
namespace Beautifier {
namespace Internal {

63
FormatTask format(FormatTask task)
Lorenz Haas's avatar
Lorenz Haas committed
64
{
65 66
    task.error.clear();
    task.formattedData.clear();
Lorenz Haas's avatar
Lorenz Haas committed
67

68
    const QString executable = task.command.executable();
69
    if (executable.isEmpty())
70
        return task;
Lorenz Haas's avatar
Lorenz Haas committed
71

72
    switch (task.command.processing()) {
73 74
    case Command::FileProcessing: {
        // Save text to temporary file
75
        const QFileInfo fi(task.filePath);
76
        Utils::TempFileSaver sourceFile(QDir::tempPath() + "/qtc_beautifier_XXXXXXXX."
77 78
                                        + fi.suffix());
        sourceFile.setAutoRemove(true);
79
        sourceFile.write(task.sourceData.toUtf8());
80
        if (!sourceFile.finalize()) {
Takumi ASAKI's avatar
Takumi ASAKI committed
81
            task.error = BeautifierPlugin::tr("Cannot create temporary file \"%1\": %2.")
82 83
                    .arg(sourceFile.fileName()).arg(sourceFile.errorString());
            return task;
84 85 86 87
        }

        // Format temporary file
        QProcess process;
88
        QStringList options = task.command.options();
89
        options.replaceInStrings("%file", sourceFile.fileName());
90
        process.start(executable, options);
91 92
        if (!process.waitForFinished(5000)) {
            process.kill();
Takumi ASAKI's avatar
Takumi ASAKI committed
93
            task.error = BeautifierPlugin::tr("Cannot call %1 or some other error occurred. Timeout "
94 95 96
                                     "reached while formatting file %2.")
                    .arg(executable).arg(task.filePath);
            return task;
97 98 99
        }
        const QByteArray output = process.readAllStandardError();
        if (!output.isEmpty())
100
            task.error = executable + ": " + QString::fromUtf8(output);
101 102 103 104

        // Read text back
        Utils::FileReader reader;
        if (!reader.fetch(sourceFile.fileName(), QIODevice::Text)) {
Takumi ASAKI's avatar
Takumi ASAKI committed
105
            task.error = BeautifierPlugin::tr("Cannot read file \"%1\": %2.")
106 107
                    .arg(sourceFile.fileName()).arg(reader.errorString());
            return task;
108
        }
109 110
        task.formattedData = QString::fromUtf8(reader.data());
        return task;
111
    }
112 113 114

    case Command::PipeProcessing: {
        QProcess process;
115
        QStringList options = task.command.options();
116 117
        options.replaceInStrings("%filename", QFileInfo(task.filePath).fileName());
        options.replaceInStrings("%file", task.filePath);
118
        process.start(executable, options);
119
        if (!process.waitForStarted(3000)) {
Takumi ASAKI's avatar
Takumi ASAKI committed
120
            task.error = BeautifierPlugin::tr("Cannot call %1 or some other error occurred.")
121 122
                    .arg(executable);
            return task;
123
        }
124
        process.write(task.sourceData.toUtf8());
125
        process.closeWriteChannel();
126 127
        if (!process.waitForFinished(5000)) {
            process.kill();
Takumi ASAKI's avatar
Takumi ASAKI committed
128
            task.error = BeautifierPlugin::tr("Cannot call %1 or some other error occurred. Timeout "
129 130 131
                                     "reached while formatting file %2.")
                    .arg(executable).arg(task.filePath);
            return task;
132
        }
133 134
        const QByteArray errorText = process.readAllStandardError();
        if (!errorText.isEmpty()) {
135 136 137
            task.error = QString::fromLatin1("%1: %2").arg(executable)
                    .arg(QString::fromUtf8(errorText));
            return task;
138 139
        }

140 141
        const bool addsNewline = task.command.pipeAddsNewline();
        const bool returnsCRLF = task.command.returnsCRLF();
142
        if (addsNewline || returnsCRLF) {
143
            task.formattedData = QString::fromUtf8(process.readAllStandardOutput());
144
            if (addsNewline)
145
                task.formattedData.remove(QRegExp("(\\r\\n|\\n)$"));
146
            if (returnsCRLF)
147
                task.formattedData.replace("\r\n", "\n");
148
            return task;
149
        }
150 151
        task.formattedData = QString::fromUtf8(process.readAllStandardOutput());
        return task;
Lorenz Haas's avatar
Lorenz Haas committed
152 153
    }
    }
154

155
    return task;
Lorenz Haas's avatar
Lorenz Haas committed
156 157
}

158
QString sourceData(TextEditorWidget *editor, int startPos, int endPos)
Lorenz Haas's avatar
Lorenz Haas committed
159
{
160 161 162 163
    return (startPos < 0)
            ? editor->toPlainText()
            : Convenience::textAt(editor->textCursor(), startPos, (endPos - startPos));
}
164

165 166 167 168 169 170 171 172 173 174 175
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);
    menu->menu()->setTitle(QCoreApplication::translate("Beautifier", Constants::OPTION_TR_CATEGORY));
176
    menu->setOnAllDisabledBehavior(Core::ActionContainer::Show);
177 178
    Core::ActionManager::actionContainer(Core::Constants::M_TOOLS)->addMenu(menu);

179
    for (BeautifierAbstractTool *tool : m_tools) {
180 181
        tool->initialize();
        const QList<QObject *> autoReleasedObjects = tool->autoReleaseObjects();
182
        for (QObject *object : autoReleasedObjects)
183
            addAutoReleasedObject(object);
184
    }
185

186
    updateActions();
187 188 189 190 191 192 193 194 195 196 197 198 199 200
    return true;
}

void BeautifierPlugin::extensionsInitialized()
{
    if (const Core::EditorManager *editorManager = Core::EditorManager::instance()) {
        connect(editorManager, &Core::EditorManager::currentEditorChanged,
                this, &BeautifierPlugin::updateActions);
    }
}

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

203
void BeautifierPlugin::updateActions(Core::IEditor *editor)
204
{
205
    for (BeautifierAbstractTool *tool : m_tools)
206
        tool->updateActions(editor);
207 208
}

209
void BeautifierPlugin::formatCurrentFile(const Command &command, int startPos, int endPos)
210
{
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
    if (TextEditorWidget *editor = TextEditorWidget::currentTextEditorWidget())
        formatEditorAsync(editor, command, startPos, endPos);
}

/**
 * Formats the text of @a editor using @a command. @a startPos and @a endPos specifies the range of
 * the editor's text that will be formatted. If @a startPos is negative the editor's entire text is
 * formatted.
 *
 * @pre @a endPos must be greater than or equal to @a startPos
 */
void BeautifierPlugin::formatEditor(TextEditorWidget *editor, const Command &command, int startPos,
                                    int endPos)
{
    QTC_ASSERT(startPos <= endPos, return);

    const QString sd = sourceData(editor, startPos, endPos);
    if (sd.isEmpty())
229
        return;
230 231 232
    checkAndApplyTask(format(FormatTask(editor, editor->textDocument()->filePath().toString(), sd,
                                        command, startPos, endPos)));
}
233

234 235 236 237 238 239 240 241 242 243
/**
 * Behaves like formatEditor except that the formatting is done asynchronously.
 */
void BeautifierPlugin::formatEditorAsync(TextEditorWidget *editor, const Command &command,
                                         int startPos, int endPos)
{
    QTC_ASSERT(startPos <= endPos, return);

    const QString sd = sourceData(editor, startPos, endPos);
    if (sd.isEmpty())
244 245
        return;

246 247 248 249 250 251 252 253 254 255 256 257 258
    QFutureWatcher<FormatTask> *watcher = new QFutureWatcher<FormatTask>;
    const TextDocument *doc = editor->textDocument();
    connect(doc, &TextDocument::contentsChanged, watcher, &QFutureWatcher<FormatTask>::cancel);
    connect(watcher, &QFutureWatcherBase::finished, [this, watcher]() {
        if (watcher->isCanceled())
            showError(tr("File was modified."));
        else
            checkAndApplyTask(watcher->result());
        watcher->deleteLater();
    });
    watcher->setFuture(Utils::runAsync(&format, FormatTask(editor, doc->filePath().toString(), sd,
                                                           command, startPos, endPos)));
}
259

260 261 262 263 264 265 266 267
/**
 * Checks the state of @a task and if the formatting was successful calls updateEditorText() with
 * the respective members of @a task.
 */
void BeautifierPlugin::checkAndApplyTask(const FormatTask &task)
{
    if (!task.error.isEmpty()) {
        showError(task.error);
268 269 270
        return;
    }

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

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

282 283
    const QString formattedData = (task.startPos < 0)
            ? task.formattedData
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
            : QString(textEditor->toPlainText()).replace(
                  task.startPos, (task.endPos - task.startPos), task.formattedData);

    updateEditorText(textEditor, formattedData);
}

/**
 * Sets the text of @a editor to @a text. Instead of replacing the entire text, however, only the
 * actually changed parts are updated while preserving the cursor position, the folded
 * blocks, and the scroll bar position.
 */
void BeautifierPlugin::updateEditorText(QPlainTextEdit *editor, const QString &text)
{
    const QString editorText = editor->toPlainText();
    if (editorText == text)
Lorenz Haas's avatar
Lorenz Haas committed
299 300
        return;

301 302 303
    // Calculate diff
    DiffEditor::Differ differ;
    const QList<DiffEditor::Diff> diff = differ.diff(editorText, text);
304

Lorenz Haas's avatar
Lorenz Haas committed
305 306 307
    // 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;
308
    QTextBlock block = editor->document()->firstBlock();
Lorenz Haas's avatar
Lorenz Haas committed
309
    while (block.isValid()) {
310
        if (const TextBlockUserData *userdata = static_cast<TextBlockUserData *>(block.userData())) {
Lorenz Haas's avatar
Lorenz Haas committed
311 312
            if (userdata->folded()) {
                foldedBlocks << block.blockNumber();
313
                TextDocumentLayout::doFoldOrUnfold(block, true);
Lorenz Haas's avatar
Lorenz Haas committed
314 315 316 317
            }
        }
        block = block.next();
    }
318
    editor->update();
Lorenz Haas's avatar
Lorenz Haas committed
319 320 321

    // Save the current viewport position of the cursor to ensure the same vertical position after
    // the formatted text has set to the editor.
322
    int absoluteVerticalCursorOffset = editor->cursorRect().y();
Lorenz Haas's avatar
Lorenz Haas committed
323 324

    // Update changed lines and keep track of the cursor position
325
    QTextCursor cursor = editor->textCursor();
Lorenz Haas's avatar
Lorenz Haas committed
326 327 328 329
    int charactersInfrontOfCursor = cursor.position();
    int newCursorPos = charactersInfrontOfCursor;
    cursor.beginEditBlock();
    cursor.movePosition(QTextCursor::Start, QTextCursor::MoveAnchor);
330
    for (const DiffEditor::Diff &d : diff) {
Lorenz Haas's avatar
Lorenz Haas committed
331 332 333 334 335 336 337 338 339 340
        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.
341 342
            if (d.text.contains('\n')) {
                const int newLineCount = d.text.count('\n');
Lorenz Haas's avatar
Lorenz Haas committed
343 344 345 346 347 348 349 350 351
                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;
352 353
        }

Lorenz Haas's avatar
Lorenz Haas committed
354 355 356 357 358 359 360 361 362 363 364 365
        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.
366 367
            if (d.text.contains('\n')) {
                const int newLineCount = d.text.count('\n');
Lorenz Haas's avatar
Lorenz Haas committed
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
                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;
383 384
        }

Lorenz Haas's avatar
Lorenz Haas committed
385 386 387 388 389 390 391 392 393
        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);
394
    editor->setTextCursor(cursor);
Lorenz Haas's avatar
Lorenz Haas committed
395 396

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

409
    editor->document()->setModified(true);
Lorenz Haas's avatar
Lorenz Haas committed
410 411 412 413
}

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

417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
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
440 441
} // namespace Internal
} // namespace Beautifier