cppcheck/gui/codeeditor.cpp

462 lines
15 KiB
C++

/*
* Cppcheck - A tool for static C/C++ code analysis
* Copyright (C) 2007-2023 Cppcheck team.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "codeeditor.h"
#include "codeeditorstyle.h"
#include <QChar>
#include <QColor>
#include <QCryptographicHash>
#include <QFont>
#include <QFontMetrics>
#include <QKeySequence>
#include <QLatin1Char>
#include <QList>
#include <QPainter>
#include <QPaintEvent>
#include <QRect>
#include <QRectF>
#include <QRegularExpressionMatchIterator>
#include <QShortcut>
#include <QTextBlock>
#include <QTextCursor>
#include <QTextEdit>
#include <QTextFormat>
class QTextDocument;
Highlighter::Highlighter(QTextDocument *parent,
CodeEditorStyle *widgetStyle) :
QSyntaxHighlighter(parent),
mWidgetStyle(widgetStyle)
{
HighlightingRule rule;
mKeywordFormat.setForeground(mWidgetStyle->keywordColor);
mKeywordFormat.setFontWeight(mWidgetStyle->keywordWeight);
QStringList keywordPatterns;
// TODO: use Keywords::getX()
keywordPatterns << "alignas"
<< "alignof"
<< "asm"
<< "auto"
<< "bool"
<< "break"
<< "case"
<< "catch"
<< "char"
<< "char8_t"
<< "char16_t"
<< "char32_t"
<< "class"
<< "concept"
<< "const"
<< "consteval"
<< "constexpr"
<< "constinit"
<< "const_cast"
<< "continue"
<< "co_await"
<< "co_return"
<< "co_yield"
<< "decltype"
<< "default"
<< "delete"
<< "do"
<< "double"
<< "dynamic_cast"
<< "else"
<< "enum"
<< "explicit"
<< "export"
<< "extern"
<< "false"
<< "final"
<< "float"
<< "for"
<< "friend"
<< "goto"
<< "if"
<< "import"
<< "inline"
<< "int"
<< "long"
<< "module"
<< "mutable"
<< "namespace"
<< "new"
<< "noexcept"
<< "nullptr"
<< "operator"
<< "override"
<< "private"
<< "protected"
<< "public"
<< "reinterpret_cast"
<< "requires"
<< "return"
<< "short"
<< "signed"
<< "static"
<< "static_assert"
<< "static_cast"
<< "struct"
<< "switch"
<< "template"
<< "this"
<< "thread_local"
<< "throw"
<< "true"
<< "try"
<< "typedef"
<< "typeid"
<< "typename"
<< "union"
<< "unsigned"
<< "virtual"
<< "void"
<< "volatile"
<< "wchar_t"
<< "while";
for (const QString &pattern : keywordPatterns) {
rule.pattern = QRegularExpression("\\b" + pattern + "\\b");
rule.format = mKeywordFormat;
rule.ruleRole = RuleRole::Keyword;
mHighlightingRules.append(rule);
}
mClassFormat.setForeground(mWidgetStyle->classColor);
mClassFormat.setFontWeight(mWidgetStyle->classWeight);
rule.pattern = QRegularExpression("\\bQ[A-Za-z]+\\b");
rule.format = mClassFormat;
rule.ruleRole = RuleRole::Class;
mHighlightingRules.append(rule);
mQuotationFormat.setForeground(mWidgetStyle->quoteColor);
mQuotationFormat.setFontWeight(mWidgetStyle->quoteWeight);
// We use lazy `*?` instead greed `*` quantifier to find the real end of the c-string.
// We use negative lookbehind assertion `(?<!\)` to ignore `\"` sequence in the c-string.
rule.pattern = QRegularExpression("\".*?(?<!\\\\)\"");
rule.format = mQuotationFormat;
rule.ruleRole = RuleRole::Quote;
mHighlightingRules.append(rule);
mSingleLineCommentFormat.setForeground(mWidgetStyle->commentColor);
mSingleLineCommentFormat.setFontWeight(mWidgetStyle->commentWeight);
rule.pattern = QRegularExpression("//[^\n]*");
rule.format = mSingleLineCommentFormat;
rule.ruleRole = RuleRole::Comment;
mHighlightingRules.append(rule);
mHighlightingRulesWithSymbols = mHighlightingRules;
mMultiLineCommentFormat.setForeground(mWidgetStyle->commentColor);
mMultiLineCommentFormat.setFontWeight(mWidgetStyle->commentWeight);
mSymbolFormat.setForeground(mWidgetStyle->symbolFGColor);
mSymbolFormat.setBackground(mWidgetStyle->symbolBGColor);
mSymbolFormat.setFontWeight(mWidgetStyle->symbolWeight);
// We use negative lookbehind assertion `(?<!/)`
// to ignore case: single line comment and line of asterisk
mCommentStartExpression = QRegularExpression("(?<!/)/\\*");
mCommentEndExpression = QRegularExpression("\\*/");
}
void Highlighter::setSymbols(const QStringList &symbols)
{
mHighlightingRulesWithSymbols = mHighlightingRules;
for (const QString &sym : symbols) {
HighlightingRule rule;
rule.pattern = QRegularExpression("\\b" + sym + "\\b");
rule.format = mSymbolFormat;
rule.ruleRole = RuleRole::Symbol;
mHighlightingRulesWithSymbols.append(rule);
}
}
void Highlighter::setStyle(const CodeEditorStyle &newStyle)
{
mKeywordFormat.setForeground(newStyle.keywordColor);
mKeywordFormat.setFontWeight(newStyle.keywordWeight);
mClassFormat.setForeground(newStyle.classColor);
mClassFormat.setFontWeight(newStyle.classWeight);
mSingleLineCommentFormat.setForeground(newStyle.commentColor);
mSingleLineCommentFormat.setFontWeight(newStyle.commentWeight);
mMultiLineCommentFormat.setForeground(newStyle.commentColor);
mMultiLineCommentFormat.setFontWeight(newStyle.commentWeight);
mQuotationFormat.setForeground(newStyle.quoteColor);
mQuotationFormat.setFontWeight(newStyle.quoteWeight);
mSymbolFormat.setForeground(newStyle.symbolFGColor);
mSymbolFormat.setBackground(newStyle.symbolBGColor);
mSymbolFormat.setFontWeight(newStyle.symbolWeight);
for (HighlightingRule& rule : mHighlightingRules) {
applyFormat(rule);
}
for (HighlightingRule& rule : mHighlightingRulesWithSymbols) {
applyFormat(rule);
}
}
void Highlighter::highlightBlock(const QString &text)
{
for (const HighlightingRule &rule : mHighlightingRulesWithSymbols) {
QRegularExpressionMatchIterator matchIterator = rule.pattern.globalMatch(text);
while (matchIterator.hasNext()) {
QRegularExpressionMatch match = matchIterator.next();
setFormat(match.capturedStart(), match.capturedLength(), rule.format);
}
}
setCurrentBlockState(0);
int startIndex = 0;
if (previousBlockState() != 1)
startIndex = text.indexOf(mCommentStartExpression);
while (startIndex >= 0) {
QRegularExpressionMatch match = mCommentEndExpression.match(text, startIndex);
const int endIndex = match.capturedStart();
int commentLength = 0;
if (endIndex == -1) {
setCurrentBlockState(1);
commentLength = text.length() - startIndex;
} else {
commentLength = endIndex - startIndex
+ match.capturedLength();
}
setFormat(startIndex, commentLength, mMultiLineCommentFormat);
startIndex = text.indexOf(mCommentStartExpression, startIndex + commentLength);
}
}
void Highlighter::applyFormat(HighlightingRule &rule)
{
switch (rule.ruleRole) {
case RuleRole::Keyword:
rule.format = mKeywordFormat;
break;
case RuleRole::Class:
rule.format = mClassFormat;
break;
case RuleRole::Comment:
rule.format = mSingleLineCommentFormat;
break;
case RuleRole::Quote:
rule.format = mQuotationFormat;
break;
case RuleRole::Symbol:
rule.format = mSymbolFormat;
break;
}
}
CodeEditor::CodeEditor(QWidget *parent) :
QPlainTextEdit(parent),
mWidgetStyle(new CodeEditorStyle(defaultStyleLight))
{
mLineNumberArea = new LineNumberArea(this);
mHighlighter = new Highlighter(document(), mWidgetStyle);
mErrorPosition = -1;
QFont font("Monospace");
font.setStyleHint(QFont::TypeWriter);
setFont(font);
mLineNumberArea->setFont(font);
// set widget coloring by overriding widget style sheet
setObjectName("CodeEditor");
setStyleSheet(generateStyleString());
#if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
QShortcut *copyText = new QShortcut(QKeySequence(Qt::CTRL | Qt::Key_C),this);
QShortcut *allText = new QShortcut(QKeySequence(Qt::CTRL | Qt::Key_A),this);
#else
const QShortcut *copyText = new QShortcut(QKeySequence(Qt::CTRL + Qt::Key_C),this);
const QShortcut *allText = new QShortcut(QKeySequence(Qt::CTRL + Qt::Key_A),this);
#endif
connect(this, SIGNAL(blockCountChanged(int)), this, SLOT(updateLineNumberAreaWidth(int)));
connect(this, SIGNAL(updateRequest(QRect,int)), this, SLOT(updateLineNumberArea(QRect,int)));
connect(copyText, SIGNAL(activated()), this, SLOT(copy()));
connect(allText, SIGNAL(activated()), this, SLOT(selectAll()));
updateLineNumberAreaWidth(0);
}
CodeEditor::~CodeEditor()
{
// NOTE: not a Qt Object - delete manually
delete mWidgetStyle;
}
static int getPos(const QString &fileData, int lineNumber)
{
if (lineNumber <= 1)
return 0;
for (int pos = 0, line = 1; pos < fileData.size(); ++pos) {
if (fileData[pos] != '\n')
continue;
++line;
if (line >= lineNumber)
return pos + 1;
}
return fileData.size();
}
void CodeEditor::setStyle(const CodeEditorStyle& newStyle)
{
*mWidgetStyle = newStyle;
// apply new styling
setStyleSheet(generateStyleString());
mHighlighter->setStyle(newStyle);
mHighlighter->rehighlight();
highlightErrorLine();
}
void CodeEditor::setError(const QString &code, int errorLine, const QStringList &symbols)
{
mHighlighter->setSymbols(symbols);
setPlainText(code);
mErrorPosition = getPos(code, errorLine);
QTextCursor tc = textCursor();
tc.setPosition(mErrorPosition);
setTextCursor(tc);
centerCursor();
highlightErrorLine();
}
void CodeEditor::setError(int errorLine, const QStringList &symbols)
{
mHighlighter->setSymbols(symbols);
mErrorPosition = getPos(toPlainText(), errorLine);
QTextCursor tc = textCursor();
tc.setPosition(mErrorPosition);
setTextCursor(tc);
centerCursor();
highlightErrorLine();
}
int CodeEditor::lineNumberAreaWidth()
{
int digits = 1;
int max = qMax(1, blockCount());
while (max >= 10) {
max /= 10;
++digits;
}
#if (QT_VERSION >= QT_VERSION_CHECK(5, 11, 0))
const int space = 3 + fontMetrics().horizontalAdvance(QLatin1Char('9')) * digits;
#else
const int space = 3 + fontMetrics().width(QLatin1Char('9')) * digits;
#endif
return space;
}
void CodeEditor::updateLineNumberAreaWidth(int /* newBlockCount */)
{
setViewportMargins(lineNumberAreaWidth(), 0, 0, 0);
}
void CodeEditor::updateLineNumberArea(const QRect &rect, int dy)
{
if (dy)
mLineNumberArea->scroll(0, dy);
else
mLineNumberArea->update(0, rect.y(), mLineNumberArea->width(), rect.height());
if (rect.contains(viewport()->rect()))
updateLineNumberAreaWidth(0);
}
void CodeEditor::resizeEvent(QResizeEvent *event)
{
QPlainTextEdit::resizeEvent(event);
QRect cr = contentsRect();
mLineNumberArea->setGeometry(QRect(cr.left(), cr.top(), lineNumberAreaWidth(), cr.height()));
}
void CodeEditor::highlightErrorLine()
{
QList<QTextEdit::ExtraSelection> extraSelections;
QTextEdit::ExtraSelection selection;
selection.format.setBackground(mWidgetStyle->highlightBGColor);
selection.format.setProperty(QTextFormat::FullWidthSelection, true);
selection.cursor = QTextCursor(document());
if (mErrorPosition >= 0) {
selection.cursor.setPosition(mErrorPosition);
} else {
selection.cursor.setPosition(0);
}
selection.cursor.clearSelection();
extraSelections.append(selection);
setExtraSelections(extraSelections);
}
void CodeEditor::lineNumberAreaPaintEvent(const QPaintEvent *event)
{
QPainter painter(mLineNumberArea);
painter.fillRect(event->rect(), mWidgetStyle->lineNumBGColor);
QTextBlock block = firstVisibleBlock();
int blockNumber = block.blockNumber();
int top = (int) blockBoundingGeometry(block).translated(contentOffset()).top();
int bottom = top + (int) blockBoundingRect(block).height();
while (block.isValid() && top <= event->rect().bottom()) {
if (block.isVisible() && bottom >= event->rect().top()) {
QString number = QString::number(blockNumber + 1);
painter.setPen(mWidgetStyle->lineNumFGColor);
painter.drawText(0, top, mLineNumberArea->width(), fontMetrics().height(),
Qt::AlignRight, number);
}
block = block.next();
top = bottom;
bottom = top + (int) blockBoundingRect(block).height();
++blockNumber;
}
}
QString CodeEditor::generateStyleString()
{
QString bgcolor = QString("background:rgb(%1,%2,%3);")
.arg(mWidgetStyle->widgetBGColor.red(),
mWidgetStyle->widgetBGColor.green(),
mWidgetStyle->widgetBGColor.blue());
QString fgcolor = QString("color:rgb(%1,%2,%3);")
.arg(mWidgetStyle->widgetFGColor.red(),
mWidgetStyle->widgetFGColor.green(),
mWidgetStyle->widgetFGColor.blue());
QString style = QString("%1 %2")
.arg(bgcolor, fgcolor);
return style;
}