expect input, media and gamelist folder to be absolute for RA

Author: Gemba

docs/FRONTENDS.md

@@ -311,9 +311,11 @@ specific to your setup you can define in `~/.skyscraper/peas_local.json`. This
 file uses the same format as the `peas.json`.
 
 You can optionally use the `-e` parameter with `"<CORE_PATH>;<CORE_NAME>"` to
-set a default core path/name for the playlist. Or set it in `config.ini` like:
+set a default core path/name for the playlist. Or set
+[`raExtra`](CONFIGINI.md#raextra) it in `config.ini` like:
 
 ```ini
+; also allowed in [<platform>]
 [retroarch]
 raExtra="<CORE_PATH>;<CORE_NAME>"
 ```

docs/PATHHANDLING.md

@@ -12,7 +12,11 @@ how the absolute path is calculated when a you provide a relative path.
 
 Do not get confused by the lenghty flow diagram below. It covers game list folder,
 input folder and media folder handling. You wiil notice that input folder and
-media folder are processed in the same manner.
+media folder are almost processed in the same manner.
+
+If you use generate output with Skyscraper for RetroArch as frontend you can
+stop reading as Skyscraper expects any of the three parameters input, gamelist
+and media folder to be absolute.
 
 <figure markdown style="width:100%">
   <img style="width:100%" src="../resources/path_handling_flow.svg"/>

src/retroarch.cpp

@@ -299,8 +299,7 @@ QString RetroArch::getWheelsFolder() {
     return config->mediaFolder % "/Named_Logos";
 }
 
-// PENDING: This media type does exist yet...
-
+// PENDING: This media type is supported by RA but not yet by Skyscraper
 /*
 QString RetroArch::getTitleScreenshotsFolder() {
     return config->mediaFolder % "/Named_Titles";

src/settings.cpp

@@ -247,7 +247,10 @@ void RuntimeCfg::applyConfigIni(CfgType type, QSettings *settings,
                      type == CfgType::FRONTEND /* #68 */)
                         ? PathTools::concatPath(v, config->platform)
                         : v;
-                config->gameListFolder = toAbsolutePath(false, v);
+                // do not elaborate abs path for retroarch
+                config->gameListFolder = config->frontend == "retroarch"
+                                             ? config->gameListFolder
+                                             : toAbsolutePath(false, v);
                 gameListFolderSet = true;
                 continue;
             }
@@ -678,7 +681,10 @@ void RuntimeCfg::applyCli(bool &inputFolderSet, bool &gameListFolderSet,
         config->inputFolderNotMain = true;
     }
     if (parser->isSet("g")) {
-        config->gameListFolder = toAbsolutePath(true, parser->value("g"));
+        // do not elaborate abs path for retroarch
+        config->gameListFolder = config->frontend == "retroarch"
+                                     ? config->gameListFolder
+                                     : toAbsolutePath(true, parser->value("g"));
         gameListFolderSet = true;
     }
     if (parser->isSet("o")) {

src/skyscraper.cpp

@@ -1030,6 +1030,14 @@ void Skyscraper::loadConfig(const QCommandLineParser &parser) {
     if (config.frontend == "retroarch") {
         if (!inputFolderSet) {
             config.inputFolder = frontend->getInputFolder();
+        } else {
+            validateAbsolutePath("inputFolder", config.inputFolder);
+        }
+        if (gameListFolderSet) {
+            validateAbsolutePath("gameListFolder", config.gameListFolder);
+        }
+        if (mediaFolderSet) {
+            validateAbsolutePath("mediaFolder", config.mediaFolder);
         }
         // do call these ignoring gameListFolderSet and mediaFolderSet
         // as they will adjust the path to retroarch specs
@@ -1067,7 +1075,6 @@ void Skyscraper::loadConfig(const QCommandLineParser &parser) {
     PathTools::expandHomePath(config.inputFolder);
     PathTools::expandHomePath(config.mediaFolder);
 
-    const QFileInfo inputDirFileInfo = QFileInfo(config.inputFolder);
     if (config.frontend == "pegasus" || config.frontend == "batocera") {
         // defaults are always absolute, thus input- and mediafolder will be
         // unchanged by these calls.
@@ -1083,10 +1090,10 @@ void Skyscraper::loadConfig(const QCommandLineParser &parser) {
         config.mediaFolder = PathTools::makeAbsolutePath(config.gameListFolder,
                                                          config.mediaFolder);
     } else if (config.frontend == "retroarch") {
-        checkForAbsoluteInputFolder(inputDirFileInfo);
-        // media and gamelist folder already in proper format (see above)
+        ; // pass through, checks made above
     } else {
-        checkForAbsoluteInputFolder(inputDirFileInfo);
+        validateAbsolutePath("inputFolder", config.inputFolder);
+        const QFileInfo inputDirFileInfo = QFileInfo(config.inputFolder);
         QString last = config.inputFolder.split("/").last();
         config.gameListFolder = removeSurplusPlatformPath(
             config.platform, last, config.gameListFolder);
@@ -1278,16 +1285,20 @@ void Skyscraper::loadConfig(const QCommandLineParser &parser) {
     }
 }
 
-void Skyscraper::checkForAbsoluteInputFolder(
-    const QFileInfo &inputDirFileInfo) {
-    if (inputDirFileInfo.isRelative()) {
-        ncprintf("\033[1;31mBummer!\033[0m The parameter 'inputFolder' is "
-                 "provided as relative path which is not valid for this "
-                 "frontend. Provide the input folder as absolute path to "
-                 "remediate. Now quitting...\n");
+void Skyscraper::validateAbsolutePath(const QString &param,
+                                      const QString &path) {
+    if (QFileInfo(path).isRelative()) {
+        ncprintf("\033[1;31mBummer!\033[0m The value of '%s' is "
+                 "provided as relative path which is not valid for the "
+                 "frontend '%s'. Provide '%s' as absolute path to "
+                 "remediate. Now quitting...\n",
+                 param.toStdString().c_str(),
+                 config.frontend.toStdString().c_str(),
+                 param.toStdString().c_str());
         emit die(
-            1, "invalid frontend and input folder combination",
-            QString("Input folder may not be a relative path for frontend '%1'")
+            1, "invalid frontend and path combination",
+            QString("path of '%1' may not be a relative path for frontend '%2'")
+                .arg(param)
                 .arg(config.frontend));
     }
 }

src/skyscraper.h

@@ -106,7 +106,7 @@ private slots:
     const std::string mediaSubFolderStdStr(QString &in);
 
     QList<QString> readFileListFrom(const QString &filename);
-    void checkForAbsoluteInputFolder(const QFileInfo &inputDirFileInfo);
+    void validateAbsolutePath(const QString &param, const QString &path);
 
     QSharedPointer<AbstractFrontend> frontend;
     QSharedPointer<Cache> cache;