From 5fcd52fe834108cb134ecb40dd42aec8af280029 Mon Sep 17 00:00:00 2001
From: Tom Praschan <tom@praschan.de>
Date: Wed, 3 Mar 2021 19:32:48 +0100
Subject: [PATCH] ClangCodeModel/TextEditor: Add support for highlighting
 parameters

This is already built into clang, so we just need to expose it to the
highlighter and the UI.

Fixes: QTCREATORBUG-24880
Change-Id: I6d0595af2589a9b69eb954aafad46457ab2c5752
Reviewed-by: David Schulz <david.schulz@qt.io>
---
 share/qtcreator/styles/creator-dark.xml                      | 1 +
 share/qtcreator/styles/intellij.xml                          | 1 +
 share/qtcreator/styles/solarized-dark.xml                    | 1 +
 share/qtcreator/styles/solarized-light.xml                   | 1 +
 src/libs/clangsupport/clangsupport_global.h                  | 1 +
 src/libs/clangsupport/tokeninfocontainer.h                   | 1 +
 .../clangcodemodel/clanghighlightingresultreporter.cpp       | 2 ++
 src/plugins/languageclient/semantichighlightsupport.cpp      | 2 +-
 src/plugins/texteditor/texteditorconstants.cpp               | 1 +
 src/plugins/texteditor/texteditorconstants.h                 | 1 +
 src/plugins/texteditor/texteditorsettings.cpp                | 2 ++
 src/tools/clangbackend/source/cursor.cpp                     | 5 +++++
 src/tools/clangbackend/source/cursor.h                       | 1 +
 src/tools/clangbackend/source/tokeninfo.cpp                  | 4 +++-
 14 files changed, 22 insertions(+), 2 deletions(-)

diff --git a/share/qtcreator/styles/creator-dark.xml b/share/qtcreator/styles/creator-dark.xml
index 1ab4653423c..b86483f30f7 100644
--- a/share/qtcreator/styles/creator-dark.xml
+++ b/share/qtcreator/styles/creator-dark.xml
@@ -20,6 +20,7 @@
   <style name="String" foreground="#d69545"/>
   <style name="Type" foreground="#ff8080"/>
   <style name="Local" foreground="#d6bb9a"/>
+  <style name="Parameter" foreground="#d6bb9a"/>
   <style name="Global" foreground="#9aa7d6"/>
   <style name="Field"/>
   <style name="Static" foreground="#66a334" italic="true"/>
diff --git a/share/qtcreator/styles/intellij.xml b/share/qtcreator/styles/intellij.xml
index b4a30c3f845..ee579f0e36d 100644
--- a/share/qtcreator/styles/intellij.xml
+++ b/share/qtcreator/styles/intellij.xml
@@ -13,6 +13,7 @@
   <style name="PrimitiveType" foreground="#000080" bold="true"/>
   <style name="Label" foreground="#800000" bold="true"/>
   <style name="Local" foreground="#000000"/>
+  <style name="Parameter" foreground="#000000"/>
   <style name="Number" foreground="#0000ff"/>
   <style name="Operator" foreground="#000000"/>
   <style name="Overloaded Operator" foreground="#000000"/>
diff --git a/share/qtcreator/styles/solarized-dark.xml b/share/qtcreator/styles/solarized-dark.xml
index 1d7b64058dc..6930af67e06 100644
--- a/share/qtcreator/styles/solarized-dark.xml
+++ b/share/qtcreator/styles/solarized-dark.xml
@@ -26,6 +26,7 @@
   <style name="String" foreground="#2aa198"/>
   <style name="Type" foreground="#b58900"/>
   <style name="Local" foreground="#839496"/>
+  <style name="Parameter" foreground="#839496"/>
   <style name="Global"/>
   <style name="Field" foreground="#268bd2"/>
   <style name="Static" foreground="#b58900" italic="true"/>
diff --git a/share/qtcreator/styles/solarized-light.xml b/share/qtcreator/styles/solarized-light.xml
index 4344e94d649..221fc8c211f 100644
--- a/share/qtcreator/styles/solarized-light.xml
+++ b/share/qtcreator/styles/solarized-light.xml
@@ -26,6 +26,7 @@
   <style name="String" foreground="#2aa198"/>
   <style name="Type" foreground="#b58900"/>
   <style name="Local" foreground="#657b83"/>
+  <style name="Parameter" foreground="#657b83"/>
   <style name="Global"/>
   <style name="Field" foreground="#268bd2"/>
   <style name="Static" foreground="#b58900" italic="true"/>
diff --git a/src/libs/clangsupport/clangsupport_global.h b/src/libs/clangsupport/clangsupport_global.h
index 44201151658..97329d764a6 100644
--- a/src/libs/clangsupport/clangsupport_global.h
+++ b/src/libs/clangsupport/clangsupport_global.h
@@ -78,6 +78,7 @@ enum class HighlightingType : quint8
     Type,
     PrimitiveType,
     LocalVariable,
+    Parameter,
     Field,
     GlobalVariable,
     Enumeration,
diff --git a/src/libs/clangsupport/tokeninfocontainer.h b/src/libs/clangsupport/tokeninfocontainer.h
index c819268fb9e..dc2f8ba2524 100644
--- a/src/libs/clangsupport/tokeninfocontainer.h
+++ b/src/libs/clangsupport/tokeninfocontainer.h
@@ -138,6 +138,7 @@ public:
 
         return extraInfo.declaration
                 && types.mainHighlightingType != HighlightingType::LocalVariable
+                && types.mainHighlightingType != HighlightingType::Parameter
                 && (types.mixinHighlightingTypes.contains(HighlightingType::Operator)
                     == extraInfo.token.startsWith("operator"));
     }
diff --git a/src/plugins/clangcodemodel/clanghighlightingresultreporter.cpp b/src/plugins/clangcodemodel/clanghighlightingresultreporter.cpp
index dc78a4d7d32..2f7275b4b64 100644
--- a/src/plugins/clangcodemodel/clanghighlightingresultreporter.cpp
+++ b/src/plugins/clangcodemodel/clanghighlightingresultreporter.cpp
@@ -50,6 +50,8 @@ TextEditor::TextStyle toTextStyle(ClangBackEnd::HighlightingType type)
         return TextEditor::C_PRIMITIVE_TYPE;
     case HighlightingType::LocalVariable:
         return TextEditor::C_LOCAL;
+    case HighlightingType::Parameter:
+        return TextEditor::C_PARAMETER;
     case HighlightingType::Field:
     case HighlightingType::QtProperty:
         return TextEditor::C_FIELD;
diff --git a/src/plugins/languageclient/semantichighlightsupport.cpp b/src/plugins/languageclient/semantichighlightsupport.cpp
index 591280fa34f..3be55608ecd 100644
--- a/src/plugins/languageclient/semantichighlightsupport.cpp
+++ b/src/plugins/languageclient/semantichighlightsupport.cpp
@@ -80,7 +80,7 @@ static Utils::optional<TextEditor::TextStyle> styleForScopes(const QList<QString
         {"variable.other.member", TextEditor::C_FIELD},
         {"variable.other.field", TextEditor::C_FIELD},
         {"variable.other.field.static", TextEditor::C_GLOBAL},
-        {"variable.parameter", TextEditor::C_LOCAL},
+        {"variable.parameter", TextEditor::C_PARAMETER},
     };
 
     for (QString scope : scopes) {
diff --git a/src/plugins/texteditor/texteditorconstants.cpp b/src/plugins/texteditor/texteditorconstants.cpp
index 3902c13665c..6063b1c5e8b 100644
--- a/src/plugins/texteditor/texteditorconstants.cpp
+++ b/src/plugins/texteditor/texteditorconstants.cpp
@@ -55,6 +55,7 @@ const char *nameForStyle(TextStyle style)
     case C_STRING:              return "String";
     case C_TYPE:                return "Type";
     case C_LOCAL:               return "Local";
+    case C_PARAMETER:           return "Parameter";
     case C_GLOBAL:              return "Global";
     case C_FIELD:               return "Field";
     // TODO: Rename "Static" to "Enumeration" in next major update,
diff --git a/src/plugins/texteditor/texteditorconstants.h b/src/plugins/texteditor/texteditorconstants.h
index 22b602074d8..abab979b611 100644
--- a/src/plugins/texteditor/texteditorconstants.h
+++ b/src/plugins/texteditor/texteditorconstants.h
@@ -55,6 +55,7 @@ enum TextStyle : quint8 {
     C_STRING,
     C_TYPE,
     C_LOCAL,
+    C_PARAMETER,
     C_GLOBAL,
     C_FIELD,
     C_ENUMERATION,
diff --git a/src/plugins/texteditor/texteditorsettings.cpp b/src/plugins/texteditor/texteditorsettings.cpp
index f88988e825b..c89cb1b4d44 100644
--- a/src/plugins/texteditor/texteditorsettings.cpp
+++ b/src/plugins/texteditor/texteditorsettings.cpp
@@ -162,6 +162,8 @@ FormatDescriptions TextEditorSettingsPrivate::initialFormats()
                              Qt::darkMagenta);
     formatDescr.emplace_back(C_LOCAL, tr("Local"),
                              tr("Local variables."), QColor(9, 46, 100));
+    formatDescr.emplace_back(C_PARAMETER, tr("Parameter"),
+                             tr("Function or method parameters."), QColor(9, 46, 100));
     formatDescr.emplace_back(C_FIELD, tr("Field"),
                              tr("Class' data members."), Qt::darkRed);
     formatDescr.emplace_back(C_GLOBAL, tr("Global"),
diff --git a/src/tools/clangbackend/source/cursor.cpp b/src/tools/clangbackend/source/cursor.cpp
index e8092186be6..be84a64331a 100644
--- a/src/tools/clangbackend/source/cursor.cpp
+++ b/src/tools/clangbackend/source/cursor.cpp
@@ -110,6 +110,11 @@ bool Cursor::isInvalidDeclaration() const
     return clang_isInvalidDeclaration(m_cxCursor);
 }
 
+bool Cursor::isParameter() const
+{
+    return kind() == CXCursor_ParmDecl;
+}
+
 bool Cursor::isLocalVariable() const
 {
     switch (semanticParent().kind()) {
diff --git a/src/tools/clangbackend/source/cursor.h b/src/tools/clangbackend/source/cursor.h
index c748db47252..fe9641ecfee 100644
--- a/src/tools/clangbackend/source/cursor.h
+++ b/src/tools/clangbackend/source/cursor.h
@@ -62,6 +62,7 @@ public:
     bool isCompoundType() const;
     bool isDeclaration() const;
     bool isInvalidDeclaration() const;
+    bool isParameter() const;
     bool isLocalVariable() const;
     bool isReference() const;
     bool isExpression() const;
diff --git a/src/tools/clangbackend/source/tokeninfo.cpp b/src/tools/clangbackend/source/tokeninfo.cpp
index 1ca8f4cac03..ea10f717fb2 100644
--- a/src/tools/clangbackend/source/tokeninfo.cpp
+++ b/src/tools/clangbackend/source/tokeninfo.cpp
@@ -142,7 +142,9 @@ void TokenInfo::overloadedDeclRefKind(const Cursor &cursor)
 
 void TokenInfo::variableKind(const Cursor &cursor)
 {
-    if (cursor.isLocalVariable())
+    if (cursor.isParameter())
+        m_types.mainHighlightingType = HighlightingType::Parameter;
+    else if (cursor.isLocalVariable())
         m_types.mainHighlightingType = HighlightingType::LocalVariable;
     else
         m_types.mainHighlightingType = HighlightingType::GlobalVariable;