Move toggle comment handling to base QgsCodeEditor class

nyalldawson · nyalldawson · commit 8e526353f9c2 · 2023-03-20T16:06:24.000+10:00
diff --git a/python/core/auto_additions/qgis.py b/python/core/auto_additions/qgis.py
@@ -2591,7 +2591,8 @@
 # monkey patching scoped based enum
 Qgis.ScriptLanguageCapability.Reformat.__doc__ = "Language supports automatic code reformatting"
 Qgis.ScriptLanguageCapability.CheckSyntax.__doc__ = "Language supports syntax checking"
-Qgis.ScriptLanguageCapability.__doc__ = 'Script language capabilities.\n\nThe flags reflect the support capabilities of a scripting language.\n\n.. versionadded:: 3.32\n\n' + '* ``Reformat``: ' + Qgis.ScriptLanguageCapability.Reformat.__doc__ + '\n' + '* ``CheckSyntax``: ' + Qgis.ScriptLanguageCapability.CheckSyntax.__doc__
+Qgis.ScriptLanguageCapability.ToggleComment.__doc__ = "Language supports comment toggling"
+Qgis.ScriptLanguageCapability.__doc__ = 'Script language capabilities.\n\nThe flags reflect the support capabilities of a scripting language.\n\n.. versionadded:: 3.32\n\n' + '* ``Reformat``: ' + Qgis.ScriptLanguageCapability.Reformat.__doc__ + '\n' + '* ``CheckSyntax``: ' + Qgis.ScriptLanguageCapability.CheckSyntax.__doc__ + '\n' + '* ``ToggleComment``: ' + Qgis.ScriptLanguageCapability.ToggleComment.__doc__
 # --
 Qgis.ScriptLanguageCapability.baseClass = Qgis
 Qgis.ScriptLanguageCapabilities.baseClass = Qgis
diff --git a/python/core/auto_generated/qgis.sip.in b/python/core/auto_generated/qgis.sip.in
@@ -1593,6 +1593,7 @@ The development version
     {
       Reformat,
       CheckSyntax,
+      ToggleComment,
     };
 
     typedef QFlags<Qgis::ScriptLanguageCapability> ScriptLanguageCapabilities;
diff --git a/python/gui/auto_generated/codeeditors/qgscodeeditor.sip.in b/python/gui/auto_generated/codeeditors/qgscodeeditor.sip.in
@@ -436,6 +436,15 @@ Applies syntax checking to the editor.
 
 This is only supported for editors which return the Qgis.ScriptLanguageCapability.CheckSyntax capability from :py:func:`~QgsCodeEditor.languageCapabilities`.
 
+.. versionadded:: 3.32
+%End
+
+    virtual void toggleComment();
+%Docstring
+Toggle comment for the selected text.
+
+This is only supported for editors which return the Qgis.ScriptLanguageCapability.ToggleComment capability from :py:func:`~QgsCodeEditor.languageCapabilities`.
+
 .. versionadded:: 3.32
 %End
 
diff --git a/python/gui/auto_generated/codeeditors/qgscodeeditorpython.sip.in b/python/gui/auto_generated/codeeditors/qgscodeeditorpython.sip.in
@@ -97,7 +97,8 @@ Searches the selected text in the official PyQGIS online documentation.
 .. versionadded:: 3.16
 %End
 
-    void toggleComment();
+    virtual void toggleComment();
+
 %Docstring
 Toggle comment for the selected text.
 
diff --git a/src/core/qgis.h b/src/core/qgis.h
@@ -2736,6 +2736,7 @@ class CORE_EXPORT Qgis
     {
       Reformat = 1 << 0, //!< Language supports automatic code reformatting
       CheckSyntax = 1 << 1, //!< Language supports syntax checking
+      ToggleComment = 1 << 2, //!< Language supports comment toggling
     };
     Q_ENUM( ScriptLanguageCapability )
 
diff --git a/src/gui/codeeditors/qgscodeeditor.cpp b/src/gui/codeeditors/qgscodeeditor.cpp
@@ -247,6 +247,15 @@ void QgsCodeEditor::contextMenuEvent( QContextMenuEvent *event )
         menu->addAction( syntaxCheckAction );
       }
 
+      if ( languageCapabilities() & Qgis::ScriptLanguageCapability::ToggleComment )
+      {
+        QAction *toggleCommentAction = new QAction( tr( "Toggle Comment" ), menu );
+        toggleCommentAction->setIcon( QgsApplication::getThemeIcon( QStringLiteral( "console/iconCommentEditorConsole.svg" ) ) );
+        toggleCommentAction->setEnabled( !isReadOnly() );
+        connect( toggleCommentAction, &QAction::triggered, this, &QgsCodeEditor::toggleComment );
+        menu->addAction( toggleCommentAction );
+      }
+
       populateContextMenu( menu );
 
       menu->exec( mapToGlobal( event->pos() ) );
@@ -727,6 +736,11 @@ bool QgsCodeEditor::checkSyntax()
   return true;
 }
 
+void QgsCodeEditor::toggleComment()
+{
+
+}
+
 QStringList QgsCodeEditor::history() const
 {
   return mHistory;
diff --git a/src/gui/codeeditors/qgscodeeditor.h b/src/gui/codeeditors/qgscodeeditor.h
@@ -455,6 +455,15 @@ class GUI_EXPORT QgsCodeEditor : public QsciScintilla
      */
     virtual bool checkSyntax();
 
+    /**
+     * Toggle comment for the selected text.
+     *
+     * This is only supported for editors which return the Qgis::ScriptLanguageCapability::ToggleComment capability from languageCapabilities().
+     *
+     * \since QGIS 3.32
+     */
+    virtual void toggleComment();
+
   signals:
 
     /**
diff --git a/src/gui/codeeditors/qgscodeeditorpython.cpp b/src/gui/codeeditors/qgscodeeditorpython.cpp
@@ -622,7 +622,7 @@ QString QgsCodeEditorPython::characterAfterCursor() const
 
 void QgsCodeEditorPython::updateCapabilities()
 {
-  mCapabilities = Qgis::ScriptLanguageCapabilities();
+  mCapabilities = Qgis::ScriptLanguageCapability::ToggleComment;
 
   if ( !QgsPythonRunner::isValid() )
     return;
diff --git a/src/gui/codeeditors/qgscodeeditorpython.h b/src/gui/codeeditors/qgscodeeditorpython.h
@@ -120,7 +120,7 @@ class GUI_EXPORT QgsCodeEditorPython : public QgsCodeEditor
      *
      * \since QGIS 3.30
      */
-    void toggleComment();
+    void toggleComment() override;
 
   protected:
 

Original file line number	Diff line number	Diff line change
`@@ -1593,6 +1593,7 @@ The development version`
`1593`	`1593`	`{`
`1594`	`1594`	`Reformat,`
`1595`	`1595`	`CheckSyntax,`
	`1596`	`+ ToggleComment,`
`1596`	`1597`	`};`
`1597`	`1598`
`1598`	`1599`	`typedef QFlags<Qgis::ScriptLanguageCapability> ScriptLanguageCapabilities;`
Original file line number	Diff line number	Diff line change
`@@ -2736,6 +2736,7 @@ class CORE_EXPORT Qgis`
`2736`	`2736`	`{`
`2737`	`2737`	`Reformat = 1 << 0, //!< Language supports automatic code reformatting`
`2738`	`2738`	`CheckSyntax = 1 << 1, //!< Language supports syntax checking`
	`2739`	`+ ToggleComment = 1 << 2, //!< Language supports comment toggling`
`2739`	`2740`	`};`
`2740`	`2741`	`Q_ENUM( ScriptLanguageCapability )`
`2741`	`2742`
Original file line number	Diff line number	Diff line change
`@@ -622,7 +622,7 @@ QString QgsCodeEditorPython::characterAfterCursor() const`
`622`	`622`
`623`	`623`	`void QgsCodeEditorPython::updateCapabilities()`
`624`	`624`	`{`
`625`		`- mCapabilities = Qgis::ScriptLanguageCapabilities();`
	`625`	`+ mCapabilities = Qgis::ScriptLanguageCapability::ToggleComment;`
`626`	`626`
`627`	`627`	`if ( !QgsPythonRunner::isValid() )`
`628`	`628`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,7 @@ class GUI_EXPORT QgsCodeEditorPython : public QgsCodeEditor`
`120`	`120`	`*`
`121`	`121`	`* \since QGIS 3.30`
`122`	`122`	`*/`
`123`		`- void toggleComment();`
	`123`	`+ void toggleComment() override;`
`124`	`124`
`125`	`125`	`protected:`
`126`	`126`