forked from qt-creator/qt-creator
7ab6783e24
Recently tons of warnings show up for presumably "problematic" singned <-> unsigned and size conversions. The Qt side uses 'int', and that's the biggest 'integration surface' for us, so instead of establishing some internal boundary between signed and unsigned areas, push that boundary out of creator core code, and use 'int' everywhere. Because it reduces friction further, also do it in libcplusplus. Change-Id: I84f3b79852c8029713e7ea6f133ffb9ef7030a70 Reviewed-by: Nikolai Kosjar <nikolai.kosjar@qt.io>
421 lines
13 KiB
C++
421 lines
13 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2016 The Qt Company Ltd.
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** 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
|
|
** 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.
|
|
**
|
|
** 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.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#include "refactoringchanges.h"
|
|
#include "texteditor.h"
|
|
#include "textdocument.h"
|
|
|
|
#include <coreplugin/icore.h>
|
|
#include <coreplugin/dialogs/readonlyfilesdialog.h>
|
|
#include <coreplugin/documentmanager.h>
|
|
#include <coreplugin/editormanager/editormanager.h>
|
|
#include <utils/qtcassert.h>
|
|
#include <utils/fileutils.h>
|
|
|
|
#include <QFile>
|
|
#include <QFileInfo>
|
|
#include <QTextBlock>
|
|
#include <QTextCursor>
|
|
#include <QTextDocument>
|
|
#include <QDebug>
|
|
#include <QApplication>
|
|
|
|
using namespace Core;
|
|
using namespace Utils;
|
|
|
|
namespace TextEditor {
|
|
|
|
RefactoringChanges::RefactoringChanges()
|
|
: m_data(new RefactoringChangesData)
|
|
{}
|
|
|
|
RefactoringChanges::RefactoringChanges(RefactoringChangesData *data)
|
|
: m_data(data)
|
|
{}
|
|
|
|
RefactoringChanges::~RefactoringChanges() = default;
|
|
|
|
RefactoringSelections RefactoringChanges::rangesToSelections(QTextDocument *document,
|
|
const QList<Range> &ranges)
|
|
{
|
|
RefactoringSelections selections;
|
|
|
|
foreach (const Range &range, ranges) {
|
|
QTextCursor start(document);
|
|
start.setPosition(range.start);
|
|
start.setKeepPositionOnInsert(true);
|
|
QTextCursor end(document);
|
|
end.setPosition(qMin(range.end, document->characterCount() - 1));
|
|
|
|
selections.append(qMakePair(start, end));
|
|
}
|
|
|
|
return selections;
|
|
}
|
|
|
|
bool RefactoringChanges::createFile(const QString &fileName, const QString &contents, bool reindent, bool openEditor) const
|
|
{
|
|
if (QFile::exists(fileName))
|
|
return false;
|
|
|
|
// Create a text document for the new file:
|
|
auto document = new QTextDocument;
|
|
QTextCursor cursor(document);
|
|
cursor.beginEditBlock();
|
|
cursor.insertText(contents);
|
|
|
|
// Reindent the contents:
|
|
if (reindent) {
|
|
cursor.select(QTextCursor::Document);
|
|
m_data->indentSelection(cursor, fileName, nullptr);
|
|
}
|
|
cursor.endEditBlock();
|
|
|
|
// Write the file to disk:
|
|
TextFileFormat format;
|
|
format.codec = EditorManager::defaultTextCodec();
|
|
QString error;
|
|
bool saveOk = format.writeFile(fileName, document->toPlainText(), &error);
|
|
delete document;
|
|
if (!saveOk)
|
|
return false;
|
|
|
|
m_data->fileChanged(fileName);
|
|
|
|
if (openEditor)
|
|
this->openEditor(fileName, /*bool activate =*/ false, -1, -1);
|
|
|
|
return true;
|
|
}
|
|
|
|
bool RefactoringChanges::removeFile(const QString &fileName) const
|
|
{
|
|
if (!QFile::exists(fileName))
|
|
return false;
|
|
|
|
// ### implement!
|
|
qWarning() << "RefactoringChanges::removeFile is not implemented";
|
|
return true;
|
|
}
|
|
|
|
TextEditorWidget *RefactoringChanges::openEditor(const QString &fileName, bool activate, int line, int column)
|
|
{
|
|
EditorManager::OpenEditorFlags flags = EditorManager::IgnoreNavigationHistory;
|
|
if (!activate)
|
|
flags |= EditorManager::DoNotChangeCurrentEditor;
|
|
if (line != -1) {
|
|
// openEditorAt uses a 1-based line and a 0-based column!
|
|
column -= 1;
|
|
}
|
|
IEditor *editor = EditorManager::openEditorAt(fileName, line, column, Id(), flags);
|
|
|
|
if (editor)
|
|
return qobject_cast<TextEditorWidget *>(editor->widget());
|
|
else
|
|
return nullptr;
|
|
}
|
|
|
|
RefactoringFilePtr RefactoringChanges::file(TextEditorWidget *editor)
|
|
{
|
|
return RefactoringFilePtr(new RefactoringFile(editor));
|
|
}
|
|
|
|
RefactoringFilePtr RefactoringChanges::file(const QString &fileName) const
|
|
{
|
|
return RefactoringFilePtr(new RefactoringFile(fileName, m_data));
|
|
}
|
|
|
|
RefactoringFile::RefactoringFile(QTextDocument *document, const QString &fileName)
|
|
: m_fileName(fileName)
|
|
, m_document(document)
|
|
{ }
|
|
|
|
RefactoringFile::RefactoringFile(TextEditorWidget *editor)
|
|
: m_fileName(editor->textDocument()->filePath().toString())
|
|
, m_editor(editor)
|
|
{ }
|
|
|
|
RefactoringFile::RefactoringFile(const QString &fileName, const QSharedPointer<RefactoringChangesData> &data)
|
|
: m_fileName(fileName)
|
|
, m_data(data)
|
|
{
|
|
QList<IEditor *> editors = DocumentModel::editorsForFilePath(fileName);
|
|
if (!editors.isEmpty()) {
|
|
auto editorWidget = qobject_cast<TextEditorWidget *>(editors.first()->widget());
|
|
if (editorWidget && !editorWidget->isReadOnly())
|
|
m_editor = editorWidget;
|
|
}
|
|
}
|
|
|
|
RefactoringFile::~RefactoringFile()
|
|
{
|
|
delete m_document;
|
|
}
|
|
|
|
bool RefactoringFile::isValid() const
|
|
{
|
|
if (m_fileName.isEmpty())
|
|
return false;
|
|
return document();
|
|
}
|
|
|
|
const QTextDocument *RefactoringFile::document() const
|
|
{
|
|
return mutableDocument();
|
|
}
|
|
|
|
QTextDocument *RefactoringFile::mutableDocument() const
|
|
{
|
|
if (m_editor)
|
|
return m_editor->document();
|
|
if (!m_document) {
|
|
QString fileContents;
|
|
if (!m_fileName.isEmpty()) {
|
|
QString error;
|
|
QTextCodec *defaultCodec = EditorManager::defaultTextCodec();
|
|
TextFileFormat::ReadResult result = TextFileFormat::readFile(
|
|
m_fileName, defaultCodec,
|
|
&fileContents, &m_textFileFormat,
|
|
&error);
|
|
if (result != TextFileFormat::ReadSuccess) {
|
|
qWarning() << "Could not read " << m_fileName << ". Error: " << error;
|
|
m_textFileFormat.codec = nullptr;
|
|
}
|
|
}
|
|
// always make a QTextDocument to avoid excessive null checks
|
|
m_document = new QTextDocument(fileContents);
|
|
}
|
|
return m_document;
|
|
}
|
|
|
|
const QTextCursor RefactoringFile::cursor() const
|
|
{
|
|
if (m_editor)
|
|
return m_editor->textCursor();
|
|
if (!m_fileName.isEmpty()) {
|
|
if (QTextDocument *doc = mutableDocument())
|
|
return QTextCursor(doc);
|
|
}
|
|
|
|
return QTextCursor();
|
|
}
|
|
|
|
QString RefactoringFile::fileName() const
|
|
{
|
|
return m_fileName;
|
|
}
|
|
|
|
TextEditorWidget *RefactoringFile::editor() const
|
|
{
|
|
return m_editor;
|
|
}
|
|
|
|
int RefactoringFile::position(int line, int column) const
|
|
{
|
|
QTC_ASSERT(line != 0, return -1);
|
|
QTC_ASSERT(column != 0, return -1);
|
|
if (const QTextDocument *doc = document())
|
|
return doc->findBlockByNumber(line - 1).position() + column - 1;
|
|
return -1;
|
|
}
|
|
|
|
void RefactoringFile::lineAndColumn(int offset, int *line, int *column) const
|
|
{
|
|
QTC_ASSERT(line, return);
|
|
QTC_ASSERT(column, return);
|
|
QTC_ASSERT(offset >= 0, return);
|
|
QTextCursor c(cursor());
|
|
c.setPosition(offset);
|
|
*line = c.blockNumber() + 1;
|
|
*column = c.positionInBlock() + 1;
|
|
}
|
|
|
|
QChar RefactoringFile::charAt(int pos) const
|
|
{
|
|
if (const QTextDocument *doc = document())
|
|
return doc->characterAt(pos);
|
|
return QChar();
|
|
}
|
|
|
|
QString RefactoringFile::textOf(int start, int end) const
|
|
{
|
|
QTextCursor c = cursor();
|
|
c.setPosition(start);
|
|
c.setPosition(end, QTextCursor::KeepAnchor);
|
|
return c.selectedText();
|
|
}
|
|
|
|
QString RefactoringFile::textOf(const Range &range) const
|
|
{
|
|
return textOf(range.start, range.end);
|
|
}
|
|
|
|
ChangeSet RefactoringFile::changeSet() const
|
|
{
|
|
return m_changes;
|
|
}
|
|
|
|
void RefactoringFile::setChangeSet(const ChangeSet &changeSet)
|
|
{
|
|
if (m_fileName.isEmpty())
|
|
return;
|
|
|
|
m_changes = changeSet;
|
|
}
|
|
|
|
void RefactoringFile::appendIndentRange(const Range &range)
|
|
{
|
|
if (m_fileName.isEmpty())
|
|
return;
|
|
|
|
m_indentRanges.append(range);
|
|
}
|
|
|
|
void RefactoringFile::appendReindentRange(const Range &range)
|
|
{
|
|
if (m_fileName.isEmpty())
|
|
return;
|
|
|
|
m_reindentRanges.append(range);
|
|
}
|
|
|
|
void RefactoringFile::setOpenEditor(bool activate, int pos)
|
|
{
|
|
m_openEditor = true;
|
|
m_activateEditor = activate;
|
|
m_editorCursorPosition = pos;
|
|
}
|
|
|
|
bool RefactoringFile::apply()
|
|
{
|
|
// test file permissions
|
|
if (!QFileInfo(fileName()).isWritable()) {
|
|
ReadOnlyFilesDialog roDialog(FilePath::fromString(fileName()), ICore::mainWindow());
|
|
const QString &failDetailText = QApplication::translate("RefactoringFile::apply",
|
|
"Refactoring cannot be applied.");
|
|
roDialog.setShowFailWarning(true, failDetailText);
|
|
if (roDialog.exec() == ReadOnlyFilesDialog::RO_Cancel)
|
|
return false;
|
|
}
|
|
|
|
// open / activate / goto position
|
|
if (m_openEditor && !m_fileName.isEmpty()) {
|
|
int line = -1, column = -1;
|
|
if (m_editorCursorPosition != -1)
|
|
lineAndColumn(m_editorCursorPosition, &line, &column);
|
|
m_editor = RefactoringChanges::openEditor(m_fileName, m_activateEditor, line, column);
|
|
m_openEditor = false;
|
|
m_activateEditor = false;
|
|
m_editorCursorPosition = -1;
|
|
}
|
|
|
|
bool result = true;
|
|
|
|
// apply changes, if any
|
|
if (m_data && !(m_indentRanges.isEmpty() && m_changes.isEmpty())) {
|
|
QTextDocument *doc = mutableDocument();
|
|
if (doc) {
|
|
QTextCursor c = cursor();
|
|
if (m_appliedOnce)
|
|
c.joinPreviousEditBlock();
|
|
else
|
|
c.beginEditBlock();
|
|
|
|
// build indent selections now, applying the changeset will change locations
|
|
const RefactoringSelections &indentSelections =
|
|
RefactoringChanges::rangesToSelections(doc, m_indentRanges);
|
|
m_indentRanges.clear();
|
|
const RefactoringSelections &reindentSelections =
|
|
RefactoringChanges::rangesToSelections(doc, m_reindentRanges);
|
|
m_reindentRanges.clear();
|
|
|
|
// apply changes and reindent
|
|
m_changes.apply(&c);
|
|
m_changes.clear();
|
|
|
|
indentOrReindent(&RefactoringChangesData::indentSelection, indentSelections);
|
|
indentOrReindent(&RefactoringChangesData::reindentSelection, reindentSelections);
|
|
|
|
c.endEditBlock();
|
|
|
|
// if this document doesn't have an editor, write the result to a file
|
|
if (!m_editor && m_textFileFormat.codec) {
|
|
QTC_ASSERT(!m_fileName.isEmpty(), return false);
|
|
QString error;
|
|
// suppress "file has changed" warnings if the file is open in a read-only editor
|
|
Core::FileChangeBlocker block(m_fileName);
|
|
if (!m_textFileFormat.writeFile(m_fileName, doc->toPlainText(), &error)) {
|
|
qWarning() << "Could not apply changes to" << m_fileName << ". Error: " << error;
|
|
result = false;
|
|
}
|
|
}
|
|
|
|
fileChanged();
|
|
}
|
|
}
|
|
|
|
m_appliedOnce = true;
|
|
return result;
|
|
}
|
|
|
|
void RefactoringFile::indentOrReindent(void (RefactoringChangesData::*mf)(const QTextCursor &,
|
|
const QString &,
|
|
const TextDocument *) const,
|
|
const RefactoringSelections &ranges)
|
|
{
|
|
using CursorPair = QPair<QTextCursor, QTextCursor>;
|
|
|
|
foreach (const CursorPair &p, ranges) {
|
|
QTextCursor selection(p.first.document());
|
|
selection.setPosition(p.first.position());
|
|
selection.setPosition(p.second.position(), QTextCursor::KeepAnchor);
|
|
((*m_data).*(mf))(selection, m_fileName, m_editor ? m_editor->textDocument() : nullptr);
|
|
}
|
|
}
|
|
|
|
void RefactoringFile::fileChanged()
|
|
{
|
|
if (!m_fileName.isEmpty())
|
|
m_data->fileChanged(m_fileName);
|
|
}
|
|
|
|
RefactoringChangesData::~RefactoringChangesData() = default;
|
|
|
|
void RefactoringChangesData::indentSelection(const QTextCursor &, const QString &, const TextDocument *) const
|
|
{
|
|
qWarning() << Q_FUNC_INFO << "not implemented";
|
|
}
|
|
|
|
void RefactoringChangesData::reindentSelection(const QTextCursor &, const QString &, const TextDocument *) const
|
|
{
|
|
qWarning() << Q_FUNC_INFO << "not implemented";
|
|
}
|
|
|
|
void RefactoringChangesData::fileChanged(const QString &)
|
|
{
|
|
}
|
|
|
|
} // namespace TextEditor
|