Add ellipsis on truncated text description (#227)

* add ellipsis on truncated text (longer than maxLength)
* apply maxLength on description also for ES and derivates

Author: Gemba

docs/CLIHELP.md

@@ -130,7 +130,7 @@ Skyscraper -p snes -i "/path/to/your/snes/roms"
 
 ### -l <0-10000>
 
-Sets the maximum length of returned game descriptions. This is a convenience option if you feel like game descriptions are too long. By default it is set to 2500 (which is approx. two-thirds of a typewriter page). Consider setting this in [`config.ini`](CONFIGINI.md#maxlength) instead.
+Sets the maximum length of returned game descriptions. This is a convenience option if you feel like game descriptions are too long. By default it is set to 2500 (approx. two-thirds of a typewriter page). Consider setting this in [`config.ini`](CONFIGINI.md#maxlength) instead.
 
 **Example(s)**
 

docs/CONFIGINI.md

@@ -638,7 +638,7 @@ Allowed in sections: `[main]`, `[<PLATFORM>]`
 
 #### maxLength
 
-Sets the maximum length of returned game descriptions. This is a convenience option if you feel like game descriptions are too long. By default it is set to 2500.
+Sets the maximum length of returned game descriptions. This is a convenience option if you feel like game descriptions are too long. By default it is set to 2500 (approx. two-thirds of a typewriter page). Allowed range is 0 to 10000 characters. A truncated text will end with [...] (Ellipsis). The text is only truncated in the gamelist/frontend output. The cache will hold the full text.
 
 Default value: `2500`  
 Allowed in sections: `[main]`, `[<PLATFORM>]`, `[<FRONTEND>]`, `[<SCRAPER>]`

src/attractmode.cpp

@@ -196,8 +196,10 @@ void AttractMode::assembleList(QString &finalOutput,
             QFile descFile(descDir.absolutePath() % "/" % entry.baseName %
                            ".txt");
             if (descFile.open(QIODevice::WriteOnly)) {
-                descFile.write(entry.description.trimmed().toUtf8().left(
-                    config->maxLength));
+                descFile.write(
+                    StrTools::shortenText(entry.description.trimmed(),
+                                          config->maxLength)
+                        .toUtf8());
                 descFile.close();
             }
         }

src/emulationstation.cpp

@@ -344,7 +344,8 @@ QString EmulationStation::createXml(GameEntry &entry) {
     l.append(elem(GameEntry::getTag(GameEntry::Elem::RATING), entry.rating,
                   addEmptyElem));
     l.append(elem(GameEntry::getTag(GameEntry::Elem::DESCRIPTION),
-                  entry.description, addEmptyElem));
+                  StrTools::shortenText(entry.description, config->maxLength),
+                  addEmptyElem));
 
     QString released = entry.releaseDate;
     QRegularExpressionMatch m = isoTimeRe().match(released);

src/esgamelist.cpp

@@ -87,7 +87,15 @@ void ESGameList::getGameData(GameEntry &game) {
     game.rating = getElementText(GameEntry::Elem::RATING);
     game.tags = getElementText(GameEntry::Elem::TAGS);
     game.description = getElementText(GameEntry::Elem::DESCRIPTION);
-
+    if (game.description.endsWith("[...]")) {
+        qWarning()
+            << QString(
+                   "Game title '%1' has shortened description '[...]' at %2 "
+                   "chars. Consider using a different source than esgamelist "
+                   "when the current maxLength setting is higher than %2.")
+                   .arg(game.title)
+                   .arg(game.description.length());
+    }
     if (config->cacheWheels) {
         // ES uses XML "marquee" but content is wheel (logo)
         game.wheelData =

src/pegasus.cpp

@@ -284,7 +284,8 @@ void Pegasus::assembleList(QString &finalOutput,
                 QString::number((int)(entry.rating.toDouble() * 100)) % "%"));
         }
         if (!entry.description.isEmpty()) {
-            QString desc = entry.description.left(config->maxLength);
+            QString desc =
+                StrTools::shortenText(entry.description, config->maxLength);
             replaceColon(desc, entry.title);
             out.append(toPegasusFormat("description", desc));
         }

src/settings.cpp

@@ -546,7 +546,11 @@ void RuntimeCfg::applyConfigIni(CfgType type, QSettings *settings,
                 continue;
             }
             if (k == "maxLength") {
-                config->maxLength = v;
+                if (0 < v && v <= 10000) {
+                    config->maxLength = v;
+                } else {
+                    outOfRange(k, v);
+                }
                 continue;
             }
             if (k == "maxFails") {

src/strtools.cpp

@@ -401,3 +401,9 @@ QString StrTools::tidyText(QString text, bool ignoreBangs) {
     }
     return po.join("\n");
 }
+
+QString StrTools::shortenText(QString text, int maxLength) {
+    if (text.length() > maxLength && maxLength > 4)
+        return text.left(maxLength - 5) % "[...]";
+    return text;
+}

src/strtools.h

@@ -44,6 +44,7 @@ class StrTools : public QObject {
     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);
 };
 
 #endif // STRTOOLS_H