/**************************************************************************** ** ** 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 "tabsettings.h" #include "texteditorplugin.h" #include #include #include #include #include #include static const char spacesForTabsKey[] = "SpacesForTabs"; static const char autoSpacesForTabsKey[] = "AutoSpacesForTabs"; static const char tabSizeKey[] = "TabSize"; static const char indentSizeKey[] = "IndentSize"; static const char groupPostfix[] = "TabSettings"; static const char paddingModeKey[] = "PaddingMode"; namespace TextEditor { TabSettings::TabSettings(TabSettings::TabPolicy tabPolicy, int tabSize, int indentSize, TabSettings::ContinuationAlignBehavior continuationAlignBehavior) : m_tabPolicy(tabPolicy) , m_tabSize(tabSize) , m_indentSize(indentSize) , m_continuationAlignBehavior(continuationAlignBehavior) { } void TabSettings::toSettings(const QString &category, QSettings *s) const { Utils::toSettings(QLatin1String(groupPostfix), category, s, this); } void TabSettings::fromSettings(const QString &category, const QSettings *s) { *this = TabSettings(); // Assign defaults Utils::fromSettings(QLatin1String(groupPostfix), category, s, this); } void TabSettings::toMap(const QString &prefix, QVariantMap *map) const { map->insert(prefix + QLatin1String(spacesForTabsKey), m_tabPolicy != TabsOnlyTabPolicy); map->insert(prefix + QLatin1String(autoSpacesForTabsKey), m_tabPolicy == MixedTabPolicy); map->insert(prefix + QLatin1String(tabSizeKey), m_tabSize); map->insert(prefix + QLatin1String(indentSizeKey), m_indentSize); map->insert(prefix + QLatin1String(paddingModeKey), m_continuationAlignBehavior); } void TabSettings::fromMap(const QString &prefix, const QVariantMap &map) { const bool spacesForTabs = map.value(prefix + QLatin1String(spacesForTabsKey), true).toBool(); const bool autoSpacesForTabs = map.value(prefix + QLatin1String(autoSpacesForTabsKey), false).toBool(); m_tabPolicy = spacesForTabs ? (autoSpacesForTabs ? MixedTabPolicy : SpacesOnlyTabPolicy) : TabsOnlyTabPolicy; m_tabSize = map.value(prefix + QLatin1String(tabSizeKey), m_tabSize).toInt(); m_indentSize = map.value(prefix + QLatin1String(indentSizeKey), m_indentSize).toInt(); m_continuationAlignBehavior = (ContinuationAlignBehavior) map.value(prefix + QLatin1String(paddingModeKey), m_continuationAlignBehavior).toInt(); } bool TabSettings::cursorIsAtBeginningOfLine(const QTextCursor &cursor) { QString text = cursor.block().text(); int fns = firstNonSpace(text); return (cursor.position() - cursor.block().position() <= fns); } int TabSettings::lineIndentPosition(const QString &text) const { int i = 0; while (i < text.size()) { if (!text.at(i).isSpace()) break; ++i; } int column = columnAt(text, i); return i - (column % m_indentSize); } int TabSettings::firstNonSpace(const QString &text) { int i = 0; while (i < text.size()) { if (!text.at(i).isSpace()) return i; ++i; } return i; } QString TabSettings::indentationString(const QString &text) const { return text.left(firstNonSpace(text)); } int TabSettings::indentationColumn(const QString &text) const { return columnAt(text, firstNonSpace(text)); } int TabSettings::maximumPadding(const QString &text) { int fns = firstNonSpace(text); int i = fns; while (i > 0) { if (text.at(i-1) != QLatin1Char(' ')) break; --i; } return fns - i; } int TabSettings::trailingWhitespaces(const QString &text) { int i = 0; while (i < text.size()) { if (!text.at(text.size()-1-i).isSpace()) return i; ++i; } return i; } void TabSettings::removeTrailingWhitespace(QTextCursor cursor, QTextBlock &block) { if (const int trailing = trailingWhitespaces(block.text())) { cursor.setPosition(block.position() + block.length() - 1); cursor.movePosition(QTextCursor::PreviousCharacter, QTextCursor::KeepAnchor, trailing); cursor.removeSelectedText(); } } bool TabSettings::isIndentationClean(const QTextBlock &block, const int indent) const { int i = 0; int spaceCount = 0; QString text = block.text(); bool spacesForTabs = guessSpacesForTabs(block); while (i < text.size()) { QChar c = text.at(i); if (!c.isSpace()) return true; if (c == QLatin1Char(' ')) { ++spaceCount; if (spaceCount == m_tabSize) if (!spacesForTabs) if ((m_continuationAlignBehavior != ContinuationAlignWithSpaces) || (i < indent)) return false; if (spaceCount > indent && m_continuationAlignBehavior == NoContinuationAlign) return false; } else if (c == QLatin1Char('\t')) { if (spacesForTabs || (spaceCount != 0)) return false; if ((m_continuationAlignBehavior != ContinuationAlignWithIndent) && ((i + 1) * m_tabSize > indent)) return false; } ++i; } return true; } int TabSettings::columnAt(const QString &text, int position) const { int column = 0; for (int i = 0; i < position; ++i) { if (text.at(i) == QLatin1Char('\t')) column = column - (column % m_tabSize) + m_tabSize; else ++column; } return column; } int TabSettings::positionAtColumn(const QString &text, int column, int *offset, bool allowOverstep) const { int col = 0; int i = 0; int textSize = text.size(); while ((i < textSize || allowOverstep) && col < column) { if (i < textSize && text.at(i) == QLatin1Char('\t')) col = col - (col % m_tabSize) + m_tabSize; else ++col; ++i; } if (offset) *offset = column - col; return i; } int TabSettings::columnCountForText(const QString &text, int startColumn) const { int column = startColumn; for (int i = 0; i < text.size(); ++i) { if (text.at(i) == QLatin1Char('\t')) column = column - (column % m_tabSize) + m_tabSize; else ++column; } return column - startColumn; } int TabSettings::spacesLeftFromPosition(const QString &text, int position) { if (position > text.size()) return 0; int i = position; while (i > 0) { if (!text.at(i-1).isSpace()) break; --i; } return position - i; } int TabSettings::indentedColumn(int column, bool doIndent) const { int aligned = (column / m_indentSize) * m_indentSize; if (doIndent) return aligned + m_indentSize; if (aligned < column) return aligned; return qMax(0, aligned - m_indentSize); } bool TabSettings::guessSpacesForTabs(const QTextBlock &_block) const { if (m_tabPolicy == MixedTabPolicy && _block.isValid()) { const QTextDocument *doc = _block.document(); QVector currentBlocks(2, _block); // [0] looks back; [1] looks forward int maxLookAround = 100; while (maxLookAround-- > 0) { if (currentBlocks.at(0).isValid()) currentBlocks[0] = currentBlocks.at(0).previous(); if (currentBlocks.at(1).isValid()) currentBlocks[1] = currentBlocks.at(1).next(); bool done = true; foreach (const QTextBlock &block, currentBlocks) { if (block.isValid()) done = false; if (!block.isValid() || block.length() == 0) continue; const QChar firstChar = doc->characterAt(block.position()); if (firstChar == QLatin1Char(' ')) return true; else if (firstChar == QLatin1Char('\t')) return false; } if (done) break; } } return m_tabPolicy != TabsOnlyTabPolicy; } QString TabSettings::indentationString(int startColumn, int targetColumn, int padding, const QTextBlock &block) const { targetColumn = qMax(startColumn, targetColumn); if (guessSpacesForTabs(block)) return QString(targetColumn - startColumn, QLatin1Char(' ')); QString s; int alignedStart = startColumn == 0 ? 0 : startColumn - (startColumn % m_tabSize) + m_tabSize; if (alignedStart > startColumn && alignedStart <= targetColumn) { s += QLatin1Char('\t'); startColumn = alignedStart; } if (m_continuationAlignBehavior == NoContinuationAlign) { targetColumn -= padding; padding = 0; } else if (m_continuationAlignBehavior == ContinuationAlignWithIndent) { padding = 0; } const int columns = targetColumn - padding - startColumn; const int tabs = columns / m_tabSize; s += QString(tabs, QLatin1Char('\t')); s += QString(targetColumn - startColumn - tabs * m_tabSize, QLatin1Char(' ')); return s; } void TabSettings::indentLine(const QTextBlock &block, int newIndent, int padding) const { const QString text = block.text(); const int oldBlockLength = text.size(); if (m_continuationAlignBehavior == NoContinuationAlign) { newIndent -= padding; padding = 0; } else if (m_continuationAlignBehavior == ContinuationAlignWithIndent) { padding = 0; } // Quickly check whether indenting is required. // fixme: after changing "use spaces for tabs" the change was not reflected // because of the following optimisation. Commenting it out for now. // if (indentationColumn(text) == newIndent) // return; const QString indentString = indentationString(0, newIndent, padding, block); if (oldBlockLength == indentString.length() && text == indentString) return; QTextCursor cursor(block); cursor.beginEditBlock(); cursor.movePosition(QTextCursor::StartOfBlock); cursor.movePosition(QTextCursor::NextCharacter, QTextCursor::KeepAnchor, firstNonSpace(text)); cursor.removeSelectedText(); cursor.insertText(indentString); cursor.endEditBlock(); } void TabSettings::reindentLine(QTextBlock block, int delta) const { const QString text = block.text(); const int oldBlockLength = text.size(); int oldIndent = indentationColumn(text); int newIndent = qMax(oldIndent + delta, 0); if (oldIndent == newIndent) return; int padding = 0; // user likes tabs for spaces and uses tabs for indentation, preserve padding if (m_tabPolicy == TabsOnlyTabPolicy && m_tabSize == m_indentSize) padding = qMin(maximumPadding(text), newIndent); const QString indentString = indentationString(0, newIndent, padding, block); if (oldBlockLength == indentString.length() && text == indentString) return; QTextCursor cursor(block); cursor.beginEditBlock(); cursor.movePosition(QTextCursor::NextCharacter, QTextCursor::KeepAnchor, firstNonSpace(text)); cursor.removeSelectedText(); cursor.insertText(indentString); cursor.endEditBlock(); } bool TabSettings::equals(const TabSettings &ts) const { return m_tabPolicy == ts.m_tabPolicy && m_tabSize == ts.m_tabSize && m_indentSize == ts.m_indentSize && m_continuationAlignBehavior == ts.m_continuationAlignBehavior; } } // namespace TextEditor