From 95cb5ea52e0a133558a2b62cf15149ba25506142 Mon Sep 17 00:00:00 2001
From: "royqh1979@gmail.com" <Roy>
Date: Tue, 21 Sep 2021 20:36:43 +0800
Subject: [PATCH] - enhancement: options for editor tooltips

---
 NEWS.md                                       |  4 +-
 RedPandaIDE/RedPandaIDE.pro                   |  3 +
 RedPandaIDE/editor.cpp                        | 21 +++--
 RedPandaIDE/settings.cpp                      | 76 +++++++++++++++++
 RedPandaIDE/settings.h                        | 22 +++++
 .../editorsymbolcompletionwidget.ui           | 13 ---
 .../settingsdialog/editorsyntaxcheckwidget.ui | 23 ++----
 .../settingsdialog/editortooltipswidget.cpp   | 37 +++++++++
 .../settingsdialog/editortooltipswidget.h     | 28 +++++++
 .../settingsdialog/editortooltipswidget.ui    | 81 +++++++++++++++++++
 RedPandaIDE/settingsdialog/settingsdialog.cpp |  5 ++
 11 files changed, 273 insertions(+), 40 deletions(-)
 create mode 100644 RedPandaIDE/settingsdialog/editortooltipswidget.cpp
 create mode 100644 RedPandaIDE/settingsdialog/editortooltipswidget.h
 create mode 100644 RedPandaIDE/settingsdialog/editortooltipswidget.ui

diff --git a/NEWS.md b/NEWS.md
index e4fcce41..ea164dfd 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -1,6 +1,8 @@
 Version 0.2
+ - enhancement: project support
  - enhancement: paint color editor use system palette's disabled group color
  - fix: add watch not work when there's no editor openned;
  - enhancement: rainbow parenthesis
  - enhancement: run executable with parameters
- - add: widget for function tips
\ No newline at end of file
+ - add: widget for function tips
+ - enhancement: options for editor tooltips
\ No newline at end of file
diff --git a/RedPandaIDE/RedPandaIDE.pro b/RedPandaIDE/RedPandaIDE.pro
index 7db73e97..40fc560d 100644
--- a/RedPandaIDE/RedPandaIDE.pro
+++ b/RedPandaIDE/RedPandaIDE.pro
@@ -44,6 +44,7 @@ SOURCES += \
     settingsdialog/editorautosavewidget.cpp \
     settingsdialog/editorcodecompletionwidget.cpp \
     settingsdialog/editormiscwidget.cpp \
+    settingsdialog/editortooltipswidget.cpp \
     settingsdialog/formattergeneralwidget.cpp \
     settingsdialog/projectcompileparamaterswidget.cpp \
     settingsdialog/projectcompilerwidget.cpp \
@@ -141,6 +142,7 @@ HEADERS += \
     settingsdialog/editorautosavewidget.h \
     settingsdialog/editorcodecompletionwidget.h \
     settingsdialog/editormiscwidget.h \
+    settingsdialog/editortooltipswidget.h \
     settingsdialog/formattergeneralwidget.h \
     settingsdialog/projectcompileparamaterswidget.h \
     settingsdialog/projectcompilerwidget.h \
@@ -212,6 +214,7 @@ FORMS += \
     settingsdialog/editorautosavewidget.ui \
     settingsdialog/editorcodecompletionwidget.ui \
     settingsdialog/editormiscwidget.ui \
+    settingsdialog/editortooltipswidget.ui \
     settingsdialog/formattergeneralwidget.ui \
     settingsdialog/projectcompileparamaterswidget.ui \
     settingsdialog/projectcompilerwidget.ui \
diff --git a/RedPandaIDE/editor.cpp b/RedPandaIDE/editor.cpp
index ee804a66..03168ce4 100644
--- a/RedPandaIDE/editor.cpp
+++ b/RedPandaIDE/editor.cpp
@@ -722,7 +722,9 @@ void Editor::onPreparePaintHighlightToken(int line, int aChar, const QString &to
 
 bool Editor::event(QEvent *event)
 {
-    if (event->type() == QEvent::HoverEnter || event->type() == QEvent::HoverMove) {
+    if ((event->type() == QEvent::HoverEnter || event->type() == QEvent::HoverMove)
+            && pSettings->editor().enableTooltips()
+            ) {
         QHoverEvent *helpEvent = static_cast<QHoverEvent *>(event);
         BufferCoord p;
         TipType reason = getTipType(helpEvent->pos(),p);
@@ -731,8 +733,7 @@ bool Editor::event(QEvent *event)
         if (reason == TipType::Error) {
             pError = getSyntaxIssueAtPosition(p);
         } else if (pointToLine(helpEvent->pos(),line)) {
-            //it's on gutter
-            //see if its error;
+            //issue tips is prefered
             PSyntaxIssueList issues = getSyntaxIssuesAtLine(line);
             if (issues && !issues->isEmpty()) {
                 reason = TipType::Error;
@@ -799,26 +800,30 @@ bool Editor::event(QEvent *event)
         switch (reason) {
         case TipType::Preprocessor:
             if (isIncludeLine) {
-                hint = getFileHint(s);
+                if (pSettings->editor().enableHeaderToolTips())
+                    hint = getFileHint(s);
             } else if (//devEditor.ParserHints and
                      !mCompletionPopup->isVisible()
                      && !mHeaderCompletionPopup->isVisible()) {
-                hint = getParserHint(s,p.Line);
+                if (pSettings->editor().enableIdentifierToolTips())
+                    hint = getParserHint(s,p.Line);
             }
             break;
         case TipType::Identifier:
         case TipType::Selection:
             if (!mCompletionPopup->isVisible()
                     && !mHeaderCompletionPopup->isVisible()) {
-                if (pMainWindow->debugger()->executing()) {
+                if (pMainWindow->debugger()->executing()
+                        && (pSettings->editor().enableDebugTooltips())) {
                     showDebugHint(s,p.Line);
-                } else { //if devEditor.ParserHints {
+                } else if (pSettings->editor().enableIdentifierToolTips()) { //if devEditor.ParserHints {
                     hint = getParserHint(s, p.Line);
                 }
             }
             break;
         case TipType::Error:
-            hint = getErrorHint(pError);
+            if (pSettings->editor().enableIssueToolTips())
+                hint = getErrorHint(pError);
         }
 //        qDebug()<<"hint:"<<hint;
         if (!hint.isEmpty()) {
diff --git a/RedPandaIDE/settings.cpp b/RedPandaIDE/settings.cpp
index fd36b7a6..af785d2e 100644
--- a/RedPandaIDE/settings.cpp
+++ b/RedPandaIDE/settings.cpp
@@ -470,6 +470,66 @@ void Settings::Editor::setRainbowParenthesis(bool newRainbowParenthesis)
     mRainbowParenthesis = newRainbowParenthesis;
 }
 
+bool Editor::showFunctionTips() const
+{
+    return mShowFunctionTips;
+}
+
+void Editor::setShowFunctionTips(bool newShowFunctionTips)
+{
+    mShowFunctionTips = newShowFunctionTips;
+}
+
+bool Editor::enableTooltips() const
+{
+    return mEnableTooltips;
+}
+
+void Editor::setEnableTooltips(bool newEnableTooltips)
+{
+    mEnableTooltips = newEnableTooltips;
+}
+
+bool Editor::enableDebugTooltips() const
+{
+    return mEnableDebugTooltips;
+}
+
+void Editor::setEnableDebugTooltips(bool newEnableDebugTooltips)
+{
+    mEnableDebugTooltips = newEnableDebugTooltips;
+}
+
+bool Editor::enableIdentifierToolTips() const
+{
+    return mEnableIdentifierToolTips;
+}
+
+void Editor::setEnableIdentifierToolTips(bool newEnableIdentifierToolTips)
+{
+    mEnableIdentifierToolTips = newEnableIdentifierToolTips;
+}
+
+bool Editor::enableHeaderToolTips() const
+{
+    return mEnableHeaderToolTips;
+}
+
+void Editor::setEnableHeaderToolTips(bool newEnableHeaderToolTips)
+{
+    mEnableHeaderToolTips = newEnableHeaderToolTips;
+}
+
+bool Editor::enableIssueToolTips() const
+{
+    return mEnableIssueToolTips;
+}
+
+void Editor::setEnableIssueToolTips(bool newEnableIssueToolTips)
+{
+    mEnableIssueToolTips = newEnableIssueToolTips;
+}
+
 int Settings::Editor::rightEdgeWidth() const
 {
     return mRightEdgeWidth;
@@ -976,6 +1036,14 @@ void Settings::Editor::doSave()
     saveValue("readonly_system_header",mReadOnlySytemHeader);
     saveValue("auto_load_last_files",mAutoLoadLastFiles);
     saveValue("default_file_cpp",mDefaultFileCpp);
+
+    //tooltips
+    saveValue("enable_tooltips",mEnableTooltips);
+    saveValue("enable_debug_tooltips",mEnableDebugTooltips);
+    saveValue("enable_identifier_tooltips",mEnableIdentifierToolTips);
+    saveValue("enable_header_tooltips",mEnableHeaderToolTips);
+    saveValue("enable_issue_tooltips",mEnableIssueToolTips);
+    saveValue("show_function_tips",mShowFunctionTips);
 }
 
 void Settings::Editor::doLoad()
@@ -1078,6 +1146,14 @@ void Settings::Editor::doLoad()
     mReadOnlySytemHeader = boolValue("readonly_system_header",true);
     mAutoLoadLastFiles = boolValue("auto_load_last_files",true);
     mDefaultFileCpp = boolValue("default_file_cpp",true);
+
+    //tooltips
+    mEnableTooltips = boolValue("enable_tooltips",true);
+    mEnableDebugTooltips = boolValue("enable_debug_tooltips",true);
+    mEnableIdentifierToolTips = boolValue("enable_identifier_tooltips",true);
+    mEnableHeaderToolTips = boolValue("enable_header_tooltips", true);
+    mEnableIssueToolTips = boolValue("enable_issue_tooltips", true);
+    mShowFunctionTips = boolValue("show_function_tips",true);
 }
 
 SynEditCaretType Settings::Editor::caretForOverwrite() const
diff --git a/RedPandaIDE/settings.h b/RedPandaIDE/settings.h
index 2b35db67..6480a556 100644
--- a/RedPandaIDE/settings.h
+++ b/RedPandaIDE/settings.h
@@ -305,6 +305,20 @@ public:
         bool rainbowParenthesis() const;
         void setRainbowParenthesis(bool newRainbowParenthesis);
 
+        bool enableTooltips() const;
+        void setEnableTooltips(bool newEnableTooltips);
+        bool enableDebugTooltips() const;
+        void setEnableDebugTooltips(bool newEnableDebugTooltips);
+        bool enableIdentifierToolTips() const;
+        void setEnableIdentifierToolTips(bool newEnableIdentifierToolTips);
+        bool enableHeaderToolTips() const;
+        void setEnableHeaderToolTips(bool newEnableHeaderToolTips);
+        bool enableIssueToolTips() const;
+        void setEnableIssueToolTips(bool newEnableIssueToolTips);
+
+        bool showFunctionTips() const;
+        void setShowFunctionTips(bool newShowFunctionTips);
+
     private:
         //General
         // indents
@@ -403,6 +417,14 @@ public:
         bool mAutoLoadLastFiles;
         bool mDefaultFileCpp;
 
+        //hints tooltip
+        bool mEnableTooltips;
+        bool mEnableDebugTooltips;
+        bool mEnableIdentifierToolTips;
+        bool mEnableHeaderToolTips;
+        bool mEnableIssueToolTips;
+        bool mShowFunctionTips;
+
         // _Base interface
     protected:
         void doSave() override;
diff --git a/RedPandaIDE/settingsdialog/editorsymbolcompletionwidget.ui b/RedPandaIDE/settingsdialog/editorsymbolcompletionwidget.ui
index 1ab2862c..3370a835 100644
--- a/RedPandaIDE/settingsdialog/editorsymbolcompletionwidget.ui
+++ b/RedPandaIDE/settingsdialog/editorsymbolcompletionwidget.ui
@@ -134,19 +134,6 @@
         </layout>
        </widget>
       </item>
-      <item>
-       <spacer name="horizontalSpacer">
-        <property name="orientation">
-         <enum>Qt::Horizontal</enum>
-        </property>
-        <property name="sizeHint" stdset="0">
-         <size>
-          <width>40</width>
-          <height>20</height>
-         </size>
-        </property>
-       </spacer>
-      </item>
      </layout>
     </widget>
    </item>
diff --git a/RedPandaIDE/settingsdialog/editorsyntaxcheckwidget.ui b/RedPandaIDE/settingsdialog/editorsyntaxcheckwidget.ui
index 8d06fdb3..aafa69e9 100644
--- a/RedPandaIDE/settingsdialog/editorsyntaxcheckwidget.ui
+++ b/RedPandaIDE/settingsdialog/editorsyntaxcheckwidget.ui
@@ -14,15 +14,15 @@
    <string>Form</string>
   </property>
   <layout class="QGridLayout" name="gridLayout">
-   <item row="0" column="1">
-    <spacer name="horizontalSpacer">
+   <item row="1" column="0">
+    <spacer name="verticalSpacer">
      <property name="orientation">
-      <enum>Qt::Horizontal</enum>
+      <enum>Qt::Vertical</enum>
      </property>
      <property name="sizeHint" stdset="0">
       <size>
-       <width>40</width>
-       <height>20</height>
+       <width>20</width>
+       <height>40</height>
       </size>
      </property>
     </spacer>
@@ -53,19 +53,6 @@
      </layout>
     </widget>
    </item>
-   <item row="1" column="0">
-    <spacer name="verticalSpacer">
-     <property name="orientation">
-      <enum>Qt::Vertical</enum>
-     </property>
-     <property name="sizeHint" stdset="0">
-      <size>
-       <width>20</width>
-       <height>40</height>
-      </size>
-     </property>
-    </spacer>
-   </item>
   </layout>
  </widget>
  <resources/>
diff --git a/RedPandaIDE/settingsdialog/editortooltipswidget.cpp b/RedPandaIDE/settingsdialog/editortooltipswidget.cpp
new file mode 100644
index 00000000..c2fdff44
--- /dev/null
+++ b/RedPandaIDE/settingsdialog/editortooltipswidget.cpp
@@ -0,0 +1,37 @@
+#include "editortooltipswidget.h"
+#include "ui_editortooltipswidget.h"
+#include "../settings.h"
+
+EditorTooltipsWidget::EditorTooltipsWidget(const QString &name, const QString &group, QWidget *parent) :
+    SettingsWidget(name,group,parent),
+    ui(new Ui::EditorTooltipsWidget)
+{
+    ui->setupUi(this);
+}
+
+EditorTooltipsWidget::~EditorTooltipsWidget()
+{
+    delete ui;
+}
+
+void EditorTooltipsWidget::doLoad()
+{
+    ui->chkShowFunctionTips->setChecked(pSettings->editor().showFunctionTips());
+    ui->grpEnableTooltips->setChecked(pSettings->editor().enableTooltips());
+    ui->chkIssueTooltips->setChecked(pSettings->editor().enableIssueToolTips());
+    ui->chkIdentifierTooltips->setChecked(pSettings->editor().enableIdentifierToolTips());
+    ui->chkHeaderTooltips->setChecked(pSettings->editor().enableHeaderToolTips());
+    ui->chkDebugTooltips->setChecked(pSettings->editor().enableDebugTooltips());
+
+}
+
+void EditorTooltipsWidget::doSave()
+{
+    pSettings->editor().setShowFunctionTips(ui->chkShowFunctionTips->isChecked());
+    pSettings->editor().setEnableTooltips(ui->grpEnableTooltips->isChecked());
+    pSettings->editor().setEnableIssueToolTips(ui->chkIssueTooltips->isChecked());
+    pSettings->editor().setEnableIdentifierToolTips(ui->chkIdentifierTooltips->isChecked());
+    pSettings->editor().setEnableHeaderToolTips(ui->chkHeaderTooltips->isChecked());
+    pSettings->editor().setEnableDebugTooltips(ui->chkDebugTooltips->isChecked());
+    pSettings->editor().save();
+}
diff --git a/RedPandaIDE/settingsdialog/editortooltipswidget.h b/RedPandaIDE/settingsdialog/editortooltipswidget.h
new file mode 100644
index 00000000..7cdf8bdc
--- /dev/null
+++ b/RedPandaIDE/settingsdialog/editortooltipswidget.h
@@ -0,0 +1,28 @@
+#ifndef EDITORTOOLTIPSWIDGET_H
+#define EDITORTOOLTIPSWIDGET_H
+
+#include <QWidget>
+#include "settingswidget.h"
+
+namespace Ui {
+class EditorTooltipsWidget;
+}
+
+class EditorTooltipsWidget : public SettingsWidget
+{
+    Q_OBJECT
+
+public:
+    explicit EditorTooltipsWidget(const QString& name, const QString& group, QWidget *parent = nullptr);
+    ~EditorTooltipsWidget();
+
+private:
+    Ui::EditorTooltipsWidget *ui;
+
+    // SettingsWidget interface
+protected:
+    void doLoad() override;
+    void doSave() override;
+};
+
+#endif // EDITORTOOLTIPSWIDGET_H
diff --git a/RedPandaIDE/settingsdialog/editortooltipswidget.ui b/RedPandaIDE/settingsdialog/editortooltipswidget.ui
new file mode 100644
index 00000000..5f32703b
--- /dev/null
+++ b/RedPandaIDE/settingsdialog/editortooltipswidget.ui
@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>EditorTooltipsWidget</class>
+ <widget class="QWidget" name="EditorTooltipsWidget">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>637</width>
+    <height>300</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>Form</string>
+  </property>
+  <layout class="QVBoxLayout" name="verticalLayout">
+   <item>
+    <widget class="QCheckBox" name="chkShowFunctionTips">
+     <property name="text">
+      <string>Show function tips</string>
+     </property>
+    </widget>
+   </item>
+   <item>
+    <widget class="QGroupBox" name="grpEnableTooltips">
+     <property name="title">
+      <string>Enable mouse hover tooltips</string>
+     </property>
+     <property name="checkable">
+      <bool>true</bool>
+     </property>
+     <layout class="QVBoxLayout" name="verticalLayout_2">
+      <item>
+       <widget class="QCheckBox" name="chkIssueTooltips">
+        <property name="text">
+         <string>Show syntax issue tooltips</string>
+        </property>
+       </widget>
+      </item>
+      <item>
+       <widget class="QCheckBox" name="chkHeaderTooltips">
+        <property name="text">
+         <string>Show full header filename tooltips</string>
+        </property>
+       </widget>
+      </item>
+      <item>
+       <widget class="QCheckBox" name="chkIdentifierTooltips">
+        <property name="text">
+         <string>Show identifier definition tooltips</string>
+        </property>
+       </widget>
+      </item>
+      <item>
+       <widget class="QCheckBox" name="chkDebugTooltips">
+        <property name="text">
+         <string>Show expression value tooltips when debugging</string>
+        </property>
+       </widget>
+      </item>
+     </layout>
+    </widget>
+   </item>
+   <item>
+    <spacer name="verticalSpacer">
+     <property name="orientation">
+      <enum>Qt::Vertical</enum>
+     </property>
+     <property name="sizeHint" stdset="0">
+      <size>
+       <width>20</width>
+       <height>40</height>
+      </size>
+     </property>
+    </spacer>
+   </item>
+  </layout>
+ </widget>
+ <resources/>
+ <connections/>
+</ui>
diff --git a/RedPandaIDE/settingsdialog/settingsdialog.cpp b/RedPandaIDE/settingsdialog/settingsdialog.cpp
index c8131116..18b0ecc0 100644
--- a/RedPandaIDE/settingsdialog/settingsdialog.cpp
+++ b/RedPandaIDE/settingsdialog/settingsdialog.cpp
@@ -10,6 +10,7 @@
 #include "editorcodecompletionwidget.h"
 #include "editorsyntaxcheckwidget.h"
 #include "editorsymbolcompletionwidget.h"
+#include "editortooltipswidget.h"
 #include "editorautosavewidget.h"
 #include "editormiscwidget.h"
 #include "environmentappearencewidget.h"
@@ -129,6 +130,10 @@ PSettingsDialog SettingsDialog::optionDialog()
     widget->init();
     dialog->addWidget(widget);
 
+    widget = new EditorTooltipsWidget(tr("Tooltips"),tr("Editor"));
+    widget->init();
+    dialog->addWidget(widget);
+
     widget = new EditorAutoSaveWidget(tr("Auto save"),tr("Editor"));
     widget->init();
     dialog->addWidget(widget);