GUI - M-; to toggle line comments

sonic-pi-net · Aug 6, 2015 · dde71bb · dde71bb
1 parent d91b760
commit dde71bb
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 0 deletions.
diff --git a/app/gui/qt/mainwindow.cpp b/app/gui/qt/mainwindow.cpp
@@ -242,6 +242,10 @@ MainWindow::MainWindow(QApplication &app, bool i18n, QSplashScreen* splash)
     QShortcut *cutToBuffer = new QShortcut(ctrlKey(']'), workspace);
     connect(cutToBuffer, SIGNAL(activated()), workspace, SLOT(cut()));
 
+    //comment line
+    QShortcut *toggleLineComment= new QShortcut(metaKey(';'), workspace);
+    connect(toggleLineComment, SIGNAL(activated()), workspace, SLOT(toggleComment()));
+
     //upcase next word
     QShortcut *upcaseWord= new QShortcut(metaKey('u'), workspace);
     connect(upcaseWord, SIGNAL(activated()), workspace, SLOT(upcaseWordOrSelection()));

diff --git a/app/gui/qt/sonicpiscintilla.cpp b/app/gui/qt/sonicpiscintilla.cpp
@@ -415,6 +415,38 @@ void SonicPiScintilla::moveLines(int numLines) {
   }
 }
 
+void SonicPiScintilla::toggleComment() {
+  beginUndoAction();
+
+  int linenum, cursor;
+  getCursorPosition(&linenum, &cursor);
+
+  //select the whole line
+  setSelection(linenum, 0, linenum, cursor+1);
+
+  QString selection = selectedText();
+
+  // make sure we don't comment empty lines
+  if (selection.length() > 0) {
+      // if it's already commented, uncomment
+      if (selection[0] == '#') {
+          selection.remove(0, 1);
+          replaceSelectedText(selection);
+          if (cursor > 0) {
+              setCursorPosition(linenum, cursor - 1);
+          } else {
+              setCursorPosition(linenum, cursor);
+          }
+      } else {
+          selection.prepend('#');
+          replaceSelectedText(selection);
+          setCursorPosition(linenum, cursor + 1);
+      }
+  }
+  deselect();
+  endUndoAction();
+}
+
 void SonicPiScintilla::upcaseWordOrSelection(){
   if(hasSelectedText()) {
     SendScintilla(SCI_UPPERCASE);

diff --git a/app/gui/qt/sonicpiscintilla.h b/app/gui/qt/sonicpiscintilla.h
@@ -52,6 +52,7 @@ class SonicPiScintilla : public QsciScintilla
     int incLineNumWithinBounds(int linenum, int inc);
     void moveLines(int numLines);
     void deselect();
+    void toggleComment();
     void upcaseWordOrSelection();
     void downcaseWordOrSelection();
     void highlightAll();

diff --git a/etc/doc/tutorial/en/10.2-Shortcut-Cheatsheet.md b/etc/doc/tutorial/en/10.2-Shortcut-Cheatsheet.md
@@ -46,6 +46,7 @@ Windows/Linux or *Cmd* on Mac):
 * `M-m` - Align all text
 * `Tab` - Align current line/selection (or complete list)
 * `C-l` - Centre editor
+* `M-;` - Comment/Uncomment current line
 * `C-t` - Transpose/swap characters
 * `M-u` - Convert next word (or selection) to upper case.  
 * `M-l` - Convert next word (or selection) to lower case.