// Copyright (C) 2016 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 #include "changeset.h" #include "algorithm.h" #include namespace Utils { ChangeSet::ChangeSet() : m_string(nullptr), m_cursor(nullptr), m_error(false) { } ChangeSet::ChangeSet(const QList &operations) : m_string(nullptr), m_cursor(nullptr), m_operationList(operations), m_error(false) { } static bool overlaps(int posA, int lengthA, int posB, int lengthB) { if (lengthB > 0) { return // right edge of B contained in A (posA < posB + lengthB && posA + lengthA >= posB + lengthB) // left edge of B contained in A || (posA <= posB && posA + lengthA > posB) // A contained in B || (posB < posA && posB + lengthB > posA + lengthA); } else { return (posB > posA && posB < posA + lengthA); } } bool ChangeSet::hasOverlap(int pos, int length) const { for (const EditOp &cmd : m_operationList) { switch (cmd.type()) { case EditOp::Replace: if (overlaps(pos, length, cmd.pos1, cmd.length1)) return true; break; case EditOp::Move: if (overlaps(pos, length, cmd.pos1, cmd.length1)) return true; if (cmd.pos2 > pos && cmd.pos2 < pos + length) return true; break; case EditOp::Insert: if (cmd.pos1 > pos && cmd.pos1 < pos + length) return true; break; case EditOp::Remove: if (overlaps(pos, length, cmd.pos1, cmd.length1)) return true; break; case EditOp::Flip: if (overlaps(pos, length, cmd.pos1, cmd.length1)) return true; if (overlaps(pos, length, cmd.pos2, cmd.length2)) return true; break; case EditOp::Copy: if (overlaps(pos, length, cmd.pos1, cmd.length1)) return true; if (cmd.pos2 > pos && cmd.pos2 < pos + length) return true; break; } } return false; } bool ChangeSet::isEmpty() const { return m_operationList.isEmpty(); } QList ChangeSet::operationList() const { return const_cast(this)->operationList(); } QList &ChangeSet::operationList() { return m_operationList; } void ChangeSet::clear() { m_string = nullptr; m_cursor = nullptr; m_operationList.clear(); m_error = false; } ChangeSet ChangeSet::makeReplace(const Range &range, const QString &replacement) { ChangeSet c; c.replace(range, replacement); return c; } ChangeSet ChangeSet::makeReplace(int start, int end, const QString &replacement) { ChangeSet c; c.replace(start, end, replacement); return c; } ChangeSet ChangeSet::makeRemove(const Range &range) { ChangeSet c; c.remove(range); return c; } ChangeSet ChangeSet::makeFlip(int start1, int end1, int start2, int end2) { ChangeSet c; c.flip(start1, end1, start2, end2); return c; } ChangeSet ChangeSet::makeInsert(int pos, const QString &text) { ChangeSet c; c.insert(pos, text); return c; } bool ChangeSet::replace_helper(int pos, int length, const QString &replacement) { if (hasOverlap(pos, length)) m_error = true; EditOp cmd(EditOp::Replace, replacement); cmd.pos1 = pos; cmd.length1 = length; m_operationList += cmd; return !m_error; } bool ChangeSet::move_helper(int pos, int length, int to) { if (hasOverlap(pos, length) || hasOverlap(to, 0) || overlaps(pos, length, to, 0)) { m_error = true; } EditOp cmd(EditOp::Move); cmd.pos1 = pos; cmd.length1 = length; cmd.pos2 = to; m_operationList += cmd; return !m_error; } bool ChangeSet::insert(int pos, const QString &text) { Q_ASSERT(pos >= 0); if (hasOverlap(pos, 0)) m_error = true; EditOp cmd(EditOp::Insert, text); cmd.pos1 = pos; m_operationList += cmd; return !m_error; } bool ChangeSet::replace(const Range &range, const QString &replacement) { return replace(range.start, range.end, replacement); } bool ChangeSet::remove(const Range &range) { return remove(range.start, range.end); } bool ChangeSet::move(const Range &range, int to) { return move(range.start, range.end, to); } bool ChangeSet::flip(const Range &range1, const Range &range2) { return flip(range1.start, range1.end, range2.start, range2.end); } bool ChangeSet::copy(const Range &range, int to) { return copy(range.start, range.end, to); } bool ChangeSet::replace(int start, int end, const QString &replacement) { return replace_helper(start, end - start, replacement); } bool ChangeSet::remove(int start, int end) { return remove_helper(start, end - start); } bool ChangeSet::move(int start, int end, int to) { return move_helper(start, end - start, to); } bool ChangeSet::flip(int start1, int end1, int start2, int end2) { return flip_helper(start1, end1 - start1, start2, end2 - start2); } bool ChangeSet::copy(int start, int end, int to) { return copy_helper(start, end - start, to); } bool ChangeSet::remove_helper(int pos, int length) { if (hasOverlap(pos, length)) m_error = true; EditOp cmd(EditOp::Remove); cmd.pos1 = pos; cmd.length1 = length; m_operationList += cmd; return !m_error; } bool ChangeSet::flip_helper(int pos1, int length1, int pos2, int length2) { if (hasOverlap(pos1, length1) || hasOverlap(pos2, length2) || overlaps(pos1, length1, pos2, length2)) { m_error = true; } EditOp cmd(EditOp::Flip); cmd.pos1 = pos1; cmd.length1 = length1; cmd.pos2 = pos2; cmd.length2 = length2; m_operationList += cmd; return !m_error; } bool ChangeSet::copy_helper(int pos, int length, int to) { if (hasOverlap(pos, length) || hasOverlap(to, 0) || overlaps(pos, length, to, 0)) { m_error = true; } EditOp cmd(EditOp::Copy); cmd.pos1 = pos; cmd.length1 = length; cmd.pos2 = to; m_operationList += cmd; return !m_error; } void ChangeSet::doReplace(const EditOp &op) { Q_ASSERT(op.type() == EditOp::Replace); if (m_string) { m_string->replace(op.pos1, op.length1, op.text()); } else if (m_cursor) { m_cursor->setPosition(op.pos1); m_cursor->setPosition(op.pos1 + op.length1, QTextCursor::KeepAnchor); m_cursor->insertText(op.text()); } } void ChangeSet::convertToReplace(const EditOp &op, QList *replaceList) { switch (op.type()) { case EditOp::Replace: replaceList->append(op); break; case EditOp::Move: { EditOp replace1(EditOp::Replace); replace1.pos1 = op.pos1; replace1.length1 = op.length1; if (op.hasFormat1()) replace1.setFormat1(op.format1()); replaceList->append(replace1); EditOp replace2(EditOp::Replace, textAt(op.pos1, op.length1)); replace2.pos1 = op.pos2; if (op.hasFormat2()) replace2.setFormat1(op.format2()); replaceList->append(replace2); break; } case EditOp::Insert: { EditOp replace(EditOp::Replace, op.text()); replace.pos1 = op.pos1; if (op.hasFormat1()) replace.setFormat1(op.format1()); replaceList->append(replace); break; } case EditOp::Remove: { EditOp replace(EditOp::Replace); replace.pos1 = op.pos1; replace.length1 = op.length1; if (op.hasFormat1()) replace.setFormat1(op.format1()); replaceList->append(replace); break; } case EditOp::Flip: { EditOp replace1(EditOp::Replace, textAt(op.pos2, op.length2)); replace1.pos1 = op.pos1; replace1.length1 = op.length1; if (op.hasFormat1()) replace1.setFormat1(op.format1()); replaceList->append(replace1); EditOp replace2(EditOp::Replace, textAt(op.pos1, op.length1)); replace2.pos1 = op.pos2; replace2.length1 = op.length2; if (op.hasFormat2()) replace2.setFormat1(op.format2()); replaceList->append(replace2); break; } case EditOp::Copy: { EditOp replace(EditOp::Replace, textAt(op.pos1, op.length1)); replace.pos1 = op.pos2; if (op.hasFormat2()) replace.setFormat1(op.format2()); replaceList->append(replace); break; } } } bool ChangeSet::hadErrors() const { return m_error; } void ChangeSet::apply(QString *s) { m_string = s; apply_helper(); m_string = nullptr; } void ChangeSet::apply(QTextCursor *textCursor) { m_cursor = textCursor; apply_helper(); m_cursor = nullptr; } void ChangeSet::apply(QTextDocument *document) { QTextCursor c(document); apply(&c); } QString ChangeSet::textAt(int pos, int length) { if (m_string) { return m_string->mid(pos, length); } else if (m_cursor) { m_cursor->setPosition(pos); m_cursor->setPosition(pos + length, QTextCursor::KeepAnchor); return m_cursor->selectedText(); } return QString(); } void ChangeSet::apply_helper() { // convert all ops to replace QList replaceList; while (!m_operationList.isEmpty()) convertToReplace(m_operationList.takeFirst(), &replaceList); if (m_cursor) m_cursor->beginEditBlock(); // Sort operations by position and apply back-to-front. // However, operations with the same position need to be applied in order, // which the funky looking loop below takes care of. sort(replaceList, [](const EditOp &op1, const EditOp &op2) { return op1.pos1 < op2.pos1; }); for (qsizetype i = replaceList.size() - 1; i >= 0; --i) { qsizetype equalRangeStart = i; for (qsizetype j = i - 1; j >= 0 && replaceList.at(j).pos1 == replaceList.at(i).pos1; --j) equalRangeStart = j; for (qsizetype j = equalRangeStart; j <= i; ++j) { const EditOp &curOp = replaceList.at(j); for (qsizetype k = j + 1; k <= i; ++k) { EditOp &laterOp = replaceList[k]; laterOp.pos1 += curOp.text().size(); if (curOp.pos1 < laterOp.pos1) laterOp.pos1 -= curOp.length1; } doReplace(curOp); } i = equalRangeStart; } if (m_cursor) m_cursor->endEditBlock(); } ChangeSet::EditOp::EditOp(Type t, const QString &text) : m_type(t), m_text(text) { // The formatting default values are derived as follows: // 1) Inserted code generally needs to be formatted, because indentation etc is // context-dependent. // 2) Removed code should not be formatted, as it is gone. // 3) Copied code needs to be formatted at the insertion site as per 1). // 4) Moved code needs to be formatted at the insertion site as per 1) and 2). // 5) Replaced code generally does not need to be formatted, as it's typically just a name // change. Exception: The new text contains newlines, in which case we do want to format. // 6) Flipped may or may be formatted at either side, as per 5). switch (t) { case Insert: m_format1 = true; break; case Remove: break; case Copy: case Move: m_format2 = true; break; case Replace: m_format1 = text.contains('\n') || text.contains(QChar::ParagraphSeparator); break; case Flip: break; // Default will be set at conversion to Replace. } } } // end namespace Utils