Commit d56becc8 authored by Friedemann Kleint's avatar Friedemann Kleint

Python Editor: Introduce simple folding

Mainly go by code indentation, ignoring empty lines.
Handle comment blocks at 0 as a special case.

Change-Id: Ibe5bef7286c640a2eea8b50140dae256b6635a56
Reviewed-by: default avatarhjk <hjk@qt.io>
parent 67b4a7a8
...@@ -37,6 +37,7 @@ ...@@ -37,6 +37,7 @@
#include "pythonscanner.h" #include "pythonscanner.h"
#include <texteditor/textdocument.h> #include <texteditor/textdocument.h>
#include <texteditor/textdocumentlayout.h>
#include <texteditor/texteditorconstants.h> #include <texteditor/texteditorconstants.h>
#include <utils/qtcassert.h> #include <utils/qtcassert.h>
...@@ -116,6 +117,24 @@ static bool isImportKeyword(const QString &keyword) ...@@ -116,6 +117,24 @@ static bool isImportKeyword(const QString &keyword)
return keyword == "import" || keyword == "from"; return keyword == "import" || keyword == "from";
} }
static int indent(const QString &line)
{
for (int i = 0, size = line.size(); i < size; ++i) {
if (!line.at(i).isSpace())
return i;
}
return -1;
}
static void setFoldingIndent(const QTextBlock &block, int indent)
{
if (TextEditor::TextBlockUserData *userData = TextEditor::TextDocumentLayout::userData(block)) {
userData->setFoldingIndent(indent);
userData->setFoldingStartIncluded(false);
userData->setFoldingEndIncluded(false);
}
}
/** /**
* @brief Highlight line of code, returns new block state * @brief Highlight line of code, returns new block state
* @param text Source code to highlight * @param text Source code to highlight
...@@ -127,6 +146,23 @@ int PythonHighlighter::highlightLine(const QString &text, int initialState) ...@@ -127,6 +146,23 @@ int PythonHighlighter::highlightLine(const QString &text, int initialState)
Scanner scanner(text.constData(), text.size()); Scanner scanner(text.constData(), text.size());
scanner.setState(initialState); scanner.setState(initialState);
const int pos = indent(text);
if (pos < 0) {
// Empty lines do not change folding indent
setFoldingIndent(currentBlock(), m_lastIndent);
} else {
m_lastIndent = pos;
if (pos == 0 && text.startsWith('#') && !text.startsWith("#!")) {
// A comment block at indentation 0. Fold on first line.
setFoldingIndent(currentBlock(), withinLicenseHeader ? 1 : 0);
withinLicenseHeader = true;
} else {
// Normal Python code. Line indentation can be used as folding indent.
setFoldingIndent(currentBlock(), m_lastIndent);
withinLicenseHeader = false;
}
}
FormatToken tk; FormatToken tk;
bool hasOnlyWhitespace = true; bool hasOnlyWhitespace = true;
while (!(tk = scanner.read()).isEndOfBlock()) { while (!(tk = scanner.read()).isEndOfBlock()) {
......
...@@ -41,6 +41,9 @@ private: ...@@ -41,6 +41,9 @@ private:
void highlightBlock(const QString &text) override; void highlightBlock(const QString &text) override;
int highlightLine(const QString &text, int initialState); int highlightLine(const QString &text, int initialState);
void highlightImport(Internal::Scanner &scanner); void highlightImport(Internal::Scanner &scanner);
int m_lastIndent = 0;
bool withinLicenseHeader = false;
}; };
} // namespace Internal } // namespace Internal
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment