Wrap text also for --cache edit help text (#233)

Author: Gemba

src/cache.cpp

@@ -32,6 +32,7 @@
 #include "pathtools.h"
 #include "queue.h"
 #include "skyscraper.h"
+#include "strtools.h"
 
 #include <QBuffer>
 #include <QDateTime>
@@ -383,14 +384,16 @@ int Cache::editResources(QSharedPointer<Queue> queue, const QString &command,
 
     int retVal = 0;
     int queueLength = queue->length();
-    printf("\033[1mEntering resource cache editing mode.\n\nThis mode allows "
-           "you to edit textual resources for your files. To add media "
-           "resources use the 'import' scraping module instead.\nYou "
-           "can provide one or more file names on command line to edit "
-           "resources for just those specific files. You can also use the "
-           "'--startat' and '--endat' command line options to narrow down the "
-           "span of the roms you wish to edit. Otherwise Skyscraper will edit "
-           "ALL files found in the input folder one by one.\033[0m\n\n");
+    const QString cacheEditHint =
+        "\033[1m\nEntering resource cache editing mode.\033[0m\nThis mode "
+        "allows you to edit textual resources for your files. To add media and "
+        "text resources use the 'import' scraping module instead.\nIn the "
+        "cache editing mode you can provide one or more file names on command "
+        "line to edit resources for just those specific files. You can also "
+        "use the '--startat' and '--endat' command line options to narrow down "
+        "the span of the roms you wish to edit. Otherwise Skyscraper will edit "
+        "ALL files found in the input folder one by one.\n";
+    printf("%s", StrTools::wrapText(cacheEditHint).toStdString().c_str());
     while (queue->hasEntry()) {
         QFileInfo info = queue->takeEntry();
         QString cacheId = getQuickId(info);

src/cli.cpp

@@ -557,27 +557,10 @@ void Cli::showHint() {
 #ifdef Q_OS_LINUX
     hint = hint.replace(QDir::homePath(), "~");
 #endif
-    hint = "\033[1;33mDID YOU KNOW\033[0m: " + hint;
-
-    // TODO: put into StrTools
-    QStringList hintWrapped;
-    int ptr = 0;
-    QString line;
-    for (auto const &w : hint.split(' ')) {
-        if (ptr + w.length() >= 80) {
-            ptr = 0;
-            line.chop(1);
-            hintWrapped.append(line);
-            line = "";
-        }
-        ptr += w.length() + 1;
-        line.append(w);
-        line.append(' ');
-    }
-    line.chop(1);
-    hintWrapped.append(line);
-
-    printf("%s\n\n", hintWrapped.join("\n").toStdString().c_str());
+    hint = "DID YOU KNOW: " + hint;
+    QString hintWrapped = StrTools::wrapText(hint);
+    hintWrapped = hintWrapped.replace(" KNOW: "," KNOW\033[0m: ");
+    printf("\033[1;33m%s\n\n", hintWrapped.toStdString().c_str());
 }
 
 void Cli::showBuildinfo() {

src/strtools.cpp

@@ -407,3 +407,33 @@ QString StrTools::shortenText(QString text, int maxLength) {
         return text.left(maxLength - 5) % "[...]";
     return text;
 }
+
+QString StrTools::wrapText(const QString &inText, int width) {
+    QStringList wrappedLines;
+    int ptr = 0;
+    QString line;
+    for (auto const &ws : inText.split(' ', Qt::SkipEmptyParts)) {
+        for (auto const &wn : ws.split('\n')) {
+            bool nl = wn.isEmpty() || (wn != ws && !ws.endsWith(wn));
+            if (nl || ptr + wn.length() >= width) {
+                ptr = 0;
+                line.chop(1);
+                if (nl) {
+                    line.append(' ');
+                    line.append(wn);
+                }
+                wrappedLines.append(line);
+                line = "";
+                if (nl) {
+                    continue;
+                }
+            }
+            ptr += wn.length() + 1;
+            line.append(wn);
+            line.append(' ');
+        }
+    }
+    line.chop(1);
+    wrappedLines.append(line);
+    return wrappedLines.join("\n");
+}

src/strtools.h

@@ -26,25 +26,25 @@
 #ifndef STRTOOLS_H
 #define STRTOOLS_H
 
-#include <QObject>
-
-class StrTools : public QObject {
-public:
-    static QString xmlUnescape(QString str);
-    static QString xmlEscape(QString str);
-    static QByteArray magic(const QByteArray str);
-    static QByteArray unMagic(const QByteArray str);
-    static QString conformPlayers(const QString str);
-    static QString conformAges(QString str);
-    static QString conformReleaseDate(QString str);
-    static QString conformTags(const QString str);
-    static QString getVersionHeader();
-    static QString getVersionBanner();
-    static QString stripBrackets(const QString str);
-    static QString stripHtmlTags(QString str);
-    static QString getMd5Sum(const QByteArray &data);
-    static QString tidyText(QString text, bool ignoreBangs);
-    static QString shortenText(QString text, int maxLength);
-};
+#include <QByteArray>
+#include <QString>
 
+namespace StrTools {
+    QString xmlUnescape(QString str);
+    QString xmlEscape(QString str);
+    QByteArray magic(const QByteArray str);
+    QByteArray unMagic(const QByteArray str);
+    QString conformPlayers(const QString str);
+    QString conformAges(QString str);
+    QString conformReleaseDate(QString str);
+    QString conformTags(const QString str);
+    QString getVersionHeader();
+    QString getVersionBanner();
+    QString stripBrackets(const QString str);
+    QString stripHtmlTags(QString str);
+    QString getMd5Sum(const QByteArray &data);
+    QString tidyText(QString text, bool ignoreBangs);
+    QString shortenText(QString text, int maxLength);
+    QString wrapText(const QString &inText, int width = 80);
+};     // namespace StrTools
 #endif // STRTOOLS_H