feat: add a removeLines method in CppDocument (#154)

Fixes #24

Author: smnppKDAB

docs/API/knut/cppdocument.md

@@ -47,6 +47,7 @@ Inherited properties: [CodeDocument properties](../knut/codedocument.md#properti
 |array<[QueryMatch](../knut/querymatch.md)> |**[queryMethodDeclaration](#queryMethodDeclaration)**(string className, string functionName)|
 |array<[QueryMatch](../knut/querymatch.md)> |**[queryMethodDefinition](#queryMethodDefinition)**(string scope, string methodName)|
 ||**[removeInclude](#removeInclude)**(string include)|
+|void |**[removeLines](#removeLines)**(const [RangeMark](../knut/rangemark.md) &rangeMark)|
 |int |**[selectBlockEnd](#selectBlockEnd)**()|
 |int |**[selectBlockStart](#selectBlockStart)**()|
 |int |**[selectBlockUp](#selectBlockUp)**()|
@@ -332,6 +333,10 @@ Remove `include` from the file. If the include is not in the file, do nothing (a
 
 The `include` string should be either `<foo.h>` or `"foo.h"`, it will returns false otherwise.
 
+#### <a name="removeLines"></a>void **removeLines**(const [RangeMark](../knut/rangemark.md) &rangeMark)
+
+Removes the line specified by the given RangeMark, including any comments attached to it.
+
 #### <a name="selectBlockEnd"></a>int **selectBlockEnd**()
 
 Selects the text from current cursor position to the end of the block, and returns the new cursor position.

src/core/cppdocument.cpp

@@ -504,6 +504,40 @@ CppDocument *CppDocument::openHeaderSource()
     return nullptr;
 }
 
+/*!
+ * \qmlmethod void CppDocument::removeLines(const RangeMark &rangeMark)
+ * Removes the line specified by the given RangeMark, including any comments attached to it.
+ */
+void CppDocument::removeLines(const RangeMark &rangeMark)
+{
+    LOG("CppDocument::removeLines" + rangeMark.text());
+
+    QTextCursor cursor = textEdit()->textCursor();
+    cursor.setPosition(rangeMark.start());
+    cursor.movePosition(QTextCursor::StartOfBlock);
+    cursor.setPosition(rangeMark.end(), QTextCursor::KeepAnchor);
+    cursor.movePosition(QTextCursor::EndOfBlock, QTextCursor::KeepAnchor);
+
+    cursor.removeSelectedText();
+    cursor.deleteChar();
+
+    while (cursor.movePosition(QTextCursor::PreviousBlock)) {
+        cursor.select(QTextCursor::LineUnderCursor);
+        const QString lineText = cursor.selectedText().trimmed();
+
+        if (lineText.isEmpty()) {
+            cursor.removeSelectedText();
+            cursor.deleteChar();
+            break;
+        } else if (lineText.startsWith("//") || lineText.startsWith("/*")) {
+            cursor.removeSelectedText();
+            cursor.deleteChar();
+        } else {
+            break;
+        }
+    }
+}
+
 /*!
  * \qmlmethod QueryMatch CppDocument::queryClassDefinition(string className)
  *

src/core/cppdocument.h

@@ -44,6 +44,8 @@ class CppDocument : public CodeDocument
 
     Q_INVOKABLE QString correspondingHeaderSource() const;
 
+    Q_INVOKABLE void removeLines(const Core::RangeMark &rangeMark);
+
     Q_INVOKABLE Core::QueryMatch queryClassDefinition(const QString &className);
     Q_INVOKABLE Core::QueryMatchList queryMethodDeclaration(const QString &className, const QString &functionName);
     Q_INVOKABLE Core::QueryMatch queryMember(const QString &className, const QString &memberName);

test_data/tst_cppdocument/removeLines/myobject.h.expected

@@ -0,0 +1,12 @@
+#pragma once
+
+#include <string>
+
+class MyObject {
+public:
+    MyObject(const std::string& message);
+    // this comment should stay
+
+private:
+    std::string m_message;
+};

test_data/tst_cppdocument/removeLines/myobject.h.original

@@ -0,0 +1,24 @@
+#pragma once
+
+#include <string>
+
+class MyObject {
+public:
+    MyObject(const std::string& message);
+    // this comment should stay
+
+    ~MyObject();// this comment should be removed
+
+    // this comment should be removed
+    void sayMessage();
+
+    /* this comment should be removed */
+    void sayMessage(const std::string& test);
+
+    // this comment should be removed
+    // this one too
+    void sayMessage(const std::string& test, int num);
+
+private:
+    std::string m_message;
+};

tests/tst_cppdocument.cpp

@@ -12,6 +12,7 @@
 #include "common/test_utils.h"
 #include "core/cppdocument.h"
 #include "core/knutcore.h"
+#include "core/rangemark.h"
 #include "core/utils.h"
 
 #include <QFileInfo>
@@ -233,6 +234,33 @@ private slots:
         QVERIFY(sourceFile.compare());
     }
 
+    void removeLines()
+    {
+        Test::FileTester headerFile(Test::testDataPath() + "/tst_cppdocument/removeLines/myobject.h");
+
+        Test::testCppDocument("/tst_cppdocument/removeLines", headerFile.fileName(), [](auto *header) {
+            header->find("~MyObject();");
+            Core::RangeMark rangeMark = header->createRangeMark();
+            header->removeLines(rangeMark);
+
+            header->find("void sayMessage();");
+            rangeMark = header->createRangeMark();
+            header->removeLines(rangeMark);
+
+            header->find("void sayMessage(const std::string& test);");
+            rangeMark = header->createRangeMark();
+            header->removeLines(rangeMark);
+
+            header->find("void sayMessage(const std::string& test, int num);");
+            rangeMark = header->createRangeMark();
+            header->removeLines(rangeMark);
+
+            header->save();
+        });
+
+        QVERIFY(headerFile.compare());
+    }
+
     void queryMethod()
     {
         Test::testCppDocument("projects/cpp-project", "myobject.cpp", [](auto *document) {