Add LongJobHelper to the Addons::Comments

Author: u-235

addons/src/addons-actions.cpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright (C) 2023 Nick Egorrov, nicegorov@yandex.ru
+ *  Copyright (C) 2023-2025 Nick Egorrov, nicegorov@yandex.ru
  *
  *  This file is part of GCodeWorkShop.
  *
@@ -233,8 +233,18 @@ void Addons::Actions::doParaComment()
 		return;
 	}
 
-	Utils::paraComment(ctx.text());
-	ctx.push();
+	LongJobHelper helper{GCodeWorkShop::instance()};
+	helper.begin(ctx.text().length(), tr("Comments/uncomments"));
+
+	bool changed = Utils::autoComments(ctx.text(), Utils::ParenthesisComments, [&helper](int pos) -> bool{
+		return helper.check(pos) == LongJobHelper::CANCEL;
+	});
+
+	helper.end();
+
+	if (changed) {
+		ctx.push();
+	}
 }
 
 void Addons::Actions::doSemiComment()
@@ -245,8 +255,18 @@ void Addons::Actions::doSemiComment()
 		return;
 	}
 
-	Utils::semiComment(ctx.text());
-	ctx.push();
+	LongJobHelper helper{GCodeWorkShop::instance()};
+	helper.begin(ctx.text().length(), tr("Comments/uncomments"));
+
+	bool changed = Utils::autoComments(ctx.text(), Utils::SemicolonComments, [&helper](int pos) -> bool{
+		return helper.check(pos) == LongJobHelper::CANCEL;
+	});
+
+	helper.end();
+
+	if (changed) {
+		ctx.push();
+	}
 }
 
 void Addons::Actions::doCompileMacro()

addons/src/comment/utils-comment.cpp

@@ -1,6 +1,5 @@
 /*
- *  Copyright (C) 2006-2018 by Artur Kozioł, artkoz78@gmail.com
- *  Copyright (C) 2023 Nick Egorrov, nicegorov@yandex.ru
+ *  Copyright (C) 2023-2025 Nick Egorrov, nicegorov@yandex.ru
  *
  *  This file is part of GCodeWorkShop.
  *
@@ -18,79 +17,108 @@
  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include <QChar>        // for operator==, QChar, QChar::LineFeed
-#include <QString>      // for QString, QCharRef
-#include <QStringList>  // for QStringList
-#include <QtGlobal>     // for QForeachContainer, qMakeForeachContainer, foreach
+#include <QString>  // for QString
 
 #include "utils-comment.h"
 
 
-void Utils::paraComment(QString& tx)
+bool Utils::autoComments(QString& text, int mode, const std::function<bool(int)>& interrupt)
 {
-	QStringList list = tx.split(QChar::LineFeed);
+	bool changed = false;
 	bool remove = false;
+	QString result;
+	int substr_start = 0;
+	int substr_end = 0;
+
+	switch (mode) {
+	case ParenthesisComments:
+		if (text.startsWith('(')) {
+			remove = true;
+		}
+
+		break;
+
+	case SemicolonComments:
+		if (text.startsWith(';')) {
+			remove = true;
+		}
+
+		break;
 
-	if (tx[0] == '(') {
-		remove = true;
+	default:
+		;
 	}
 
-	tx.clear();
+	while (substr_end >= 0) {
+		substr_end = text.indexOf('\n', substr_start);
+		QString line = text.mid(substr_start, substr_end - substr_start + 1);
+		substr_start = substr_end + 1;
+		bool localChange = false;
 
-	foreach (QString txLine, list) {
-		if (remove) {
-			if (txLine.length() > 0) {
-				int idx = txLine.indexOf("(");
+		if (interrupt(substr_start)) {
+			return false;
+		}
 
-				if (idx >= 0) {
-					txLine.remove(idx, 1);
-				}
+		switch (mode) {
+		case ParenthesisComments:
+			localChange = parenthesisComments(line, remove);
+			break;
 
-				idx = txLine.indexOf(")");
+		case SemicolonComments:
+			localChange = semicolonComments(line, remove);
+			break;
 
-				if (idx >= 0) {
-					txLine.remove(idx, 1);
-				}
-			}
-		} else {
-			txLine.prepend("(");
-			txLine.append(")");
+		default:
+			;
+		}
+
+		if (localChange) {
+			changed = true;
 		}
 
-		txLine.append("\n");
-		tx.append(txLine);
+		result += line;
 	}
 
-	tx.remove(tx.length() - 1, 1);
+	text = result;
+	return changed;
 }
 
-void Utils::semiComment(QString& tx)
+bool Utils::parenthesisComments(QString& line, bool remove)
 {
-	QStringList list = tx.split(QChar::LineFeed);
-	bool remove = false;
+	int oldSize = line.size();
 
-	if (tx[0] == ';') {
-		remove = true;
-	}
+	if (remove && line.startsWith('(')) {
+		line.remove(0, 1);
+		int pli = line.lastIndexOf(')');
 
-	tx.clear();
+		if (pli >= 0) {
+			line.remove(pli, 1);
+		}
+	}
 
-	foreach (QString txLine, list) {
-		if (remove) {
-			if (txLine.length() > 0) {
-				int idx = txLine.indexOf(";");
+	if (!remove) {
+		line.prepend("(");
+		int eol = line.indexOf('\n');
 
-				if (idx >= 0) {
-					txLine.remove(idx, 1);
-				}
-			}
+		if (eol < 0) {
+			line.append(')');
 		} else {
-			txLine.prepend(";");
+			line.insert(eol, ')');
 		}
+	}
+
+	return oldSize != line.size();
+}
+
+bool Utils::semicolonComments(QString& line, bool remove)
+{
+	int oldSize = line.size();
 
-		txLine.append("\n");
-		tx.append(txLine);
+	if (remove && line.startsWith(';')) {
+		line.remove(0, 1);
+	} else {
+		line.prepend(";");
 	}
 
-	tx.remove(tx.length() - 1, 1);
+	return oldSize != line.size();
 }

addons/src/comment/utils-comment.h

@@ -1,5 +1,5 @@
 /*
- *  Copyright (C) 2023 Nick Egorrov, nicegorov@yandex.ru
+ *  Copyright (C) 2023-2025 Nick Egorrov, nicegorov@yandex.ru
  *
  *  This file is part of GCodeWorkShop.
  *
@@ -20,12 +20,22 @@
 #ifndef UTILS_COMMENT_H
 #define UTILS_COMMENT_H
 
+#include <functional>   // for function
+
 class QString;
 
 
 namespace Utils {
-void paraComment(QString& tx);
-void semiComment(QString& tx);
-}
+
+enum CommentMode {
+	ParenthesisComments,
+	SemicolonComments
+};
+
+bool autoComments(QString& text, int mode, const std::function<bool(int)>& interrupt);
+bool parenthesisComments(QString& line, bool remove);
+bool semicolonComments(QString& line, bool remove);
+
+} // namespace Utils
 
 #endif // UTILS_COMMENT_H