Merge pull request #70 from oblivioncth/dev

Merge to master for v0.8.1

Author: oblivioncth

.github/workflows/build-project.yml

@@ -21,6 +21,7 @@ jobs:
     secrets:
       ffynnon_access: ${{ secrets.OBYBOT_FFYNNON_ACCESS }}
     with:
+      qt_version: 6.8.2
       runs_exclude: >
         [
             { "linkage": "shared" },
@@ -31,17 +32,16 @@ jobs:
         ]
       runs_include: >
         [
-            { "os": "ubuntu-20.04", "compiler": "clang++-18", "linkage": "static" }, 
-            { "os": "ubuntu-22.04", "compiler": "clang++-18", "linkage": "static" }
+            { "os": "ubuntu-22.04", "compiler": "clang++-18", "linkage": "static" },
+            { "os": "ubuntu-24.04", "compiler": "clang++-18", "linkage": "static" },
+            { "os": "ubuntu-24.04", "compiler": "g++-14", "linkage": "static" }
         ]
       pre_build_steps: |
         - name: Install Clang 18 [Linux]
-          if: env.run_is_linux == 'true' && env.run_compiler == 'clang++-18'
+          if: env.run_os == 'ubuntu-22.04' && env.run_compiler == 'clang++-18'
           shell: bash
           run: |
             wget https://apt.llvm.org/llvm.sh
             chmod u+x llvm.sh
             sudo ./llvm.sh 18
 
-            
-        

CMakeLists.txt

@@ -6,7 +6,7 @@ cmake_minimum_required(VERSION 3.24.0...3.30.0)
 # Project
 # NOTE: DON'T USE TRAILING ZEROS IN VERSIONS
 project(FIL
-    VERSION 0.8
+    VERSION 0.8.1
     LANGUAGES CXX
     DESCRIPTION "Flashpoint Importer for Launchers"
 )
@@ -74,20 +74,20 @@ endif()
 
 include(OB/FetchQx)
 ob_fetch_qx(
-    REF "v0.6.1"
+    REF "v0.6.2"
     COMPONENTS
         ${FIL_QX_COMPONENTS}
 )
 
 # Fetch libfp (build and import from source)
 include(OB/Fetchlibfp)
-ob_fetch_libfp("v0.5.5")
+ob_fetch_libfp("v0.5.6")
 
 # Fetch CLIFp (build and import from source)
 include(OB/Utility)
 ob_cache_project_version(CLIFp)
 include(OB/FetchCLIFp)
-ob_fetch_clifp("v0.9.13")
+ob_fetch_clifp("v0.9.14")
 
 # TODO: The shared build of this is essentially useless as only the CLIFp executable
 # is deployed, which only works if it's statically linked. There isn't a simple way

README.md

@@ -25,6 +25,7 @@ You will still be able to use the standard Flashpoint launcher as normal after c
 ### Supported Launchers
  - [LaunchBox](https://www.launchbox-app.com/)
  - [AttractMode](http://attractmode.org/)
+ - [ES-DE](https://es-de.org/)
 
 ### Flashpoint
 While testing for 100% compatibility is infeasible given the size of Flashpoint, FIL was designed with full compatibility in mind.

app/CMakeLists.txt

@@ -27,6 +27,8 @@ set(FIL_SOURCE
     import/backup.cpp
     import/details.h
     import/details.cpp
+    import/image.h
+    import/image.cpp
     import/properties.h
     import/properties.cpp
     import/settings.h
@@ -54,6 +56,16 @@ set(FIL_SOURCE
     launcher/implementation/attractmode/am-settings-items.cpp
     launcher/implementation/attractmode/am-registration.h
     launcher/implementation/attractmode/am-registration.cpp
+    launcher/implementation/emulationstation/es-data.h
+    launcher/implementation/emulationstation/es-data.cpp
+    launcher/implementation/emulationstation/es-install.h
+    launcher/implementation/emulationstation/es-install.cpp
+    launcher/implementation/emulationstation/es-install_win.cpp
+    launcher/implementation/emulationstation/es-install_linux.cpp
+    launcher/implementation/emulationstation/es-items.h
+    launcher/implementation/emulationstation/es-items.cpp
+    launcher/implementation/emulationstation/es-registration.h
+    launcher/implementation/emulationstation/es-registration.cpp
     launcher/interface/lr-data-interface.h
     launcher/interface/lr-data-interface.cpp
     launcher/interface/lr-install-interface.h

app/res/launcher/EmulationStation/icon.png

@@ -11,6 +11,7 @@
         <file>launcher/LaunchBox/icon.svg</file>
         <file>launcher/AttractMode/icon.png</file>
         <file>launcher/AttractMode/marquee.png</file>
+        <file>launcher/EmulationStation/icon.png</file>
         <file>flashpoint/icon.png</file>
         <file>ui/About.png</file>
     </qresource>

app/res/resources.qrc

@@ -5,6 +5,9 @@
 #include <QFile>
 #include <QFileInfo>
 
+// Qx Includes
+#include <qx/io/qx-common-io.h>
+
 namespace Import
 {
 
@@ -59,12 +62,12 @@ BackupManager* BackupManager::instance() { static BackupManager inst; return &in
 //Private:
 BackupError BackupManager::backup(const QString& path, bool (*fn)(const QString& a, const QString& b))
 {
-    // Prevent double+ backups (THIS IS CRITICAL, HENCE WHY A SET IS USED)
-    if(mRevertablePaths.contains(path))
+    // Prevent double+ backups (THIS IS CRITICAL, HENCE WHY A HASH IS USED)
+    if(mRevertables.contains(path))
         return BackupError();
 
     // Note revertable
-    mRevertablePaths.insert(path);
+    mRevertables[path] = false;
 
     // Backup if exists
     if(QFile::exists(path))
@@ -84,12 +87,12 @@ BackupError BackupManager::backup(const QString& path, bool (*fn)(const QString&
     return BackupError();
 }
 
-BackupError BackupManager::restore(QSet<QString>::const_iterator pathItr)
+BackupError BackupManager::restore(RevertItr itr)
 {
-    Q_ASSERT(pathItr != mRevertablePaths.cend());
+    Q_ASSERT(itr != mRevertables.cend());
 
-    const QString path = *pathItr;
-    mRevertablePaths.erase(pathItr);
+    const QString path = itr.key();
+    mRevertables.erase(itr);
     QString backupPath = filePathToBackupPath(path);
 
     if(QFile::exists(path) && !QFile::remove(path))
@@ -114,8 +117,8 @@ BackupError BackupManager::backupRename(const QString& path)
 
 BackupError BackupManager::restore(const QString& path)
 {
-    auto store = mRevertablePaths.constFind(path);
-    if(store == mRevertablePaths.cend())
+    auto store = mRevertables.constFind(path);
+    if(store == mRevertables.cend())
         return BackupError();
 
     return restore(store);
@@ -151,31 +154,72 @@ BackupError BackupManager::safeReplace(const QString& src, const QString& dst, b
     if(dstOccupied)
         QFile::remove(backupPath);
     else // Mark new files (only) as revertible so that existing ones will remain in the event of a revert
-        mRevertablePaths.insert(dst);
+        mRevertables[dst] = false;
+
+    return BackupError();
+}
+
+BackupError BackupManager::revertableTouch(const QString& path)
+{
+    if(!Qx::createFile(path))
+        return BackupError(BackupError::FileWontCreate, path);
 
+    mRevertables[path] = false;
     return BackupError();
 }
 
-int BackupManager::revertQueueCount() const { return mRevertablePaths.size(); }
+// - Backs up the file at 'path' via copy, and then deletes the backup at the end of the import
+// - File is restored on revert.
+BackupError BackupManager::revertableRemove(const QString& path)
+{
+    // TODO: Use this for AM extra files
+    QString backupPath = filePathToBackupPath(path);
+
+    if(QFile::exists(backupPath) && QFileInfo(backupPath).isFile())
+    {
+        if(!QFile::remove(backupPath))
+            return BackupError(BackupError::FileWontDelete, backupPath);
+    }
+
+    if(!QFile::rename(path, backupPath))
+        return BackupError(BackupError::FileWontBackup, path);
+
+    mRevertables[path] = true;
+    return BackupError();
+}
+
+bool BackupManager::hasReversions() const { return !mRevertables.isEmpty(); }
+int BackupManager::revertQueueCount() const { return mRevertables.size(); }
 
 int BackupManager::revertNextChange(BackupError& error, bool skipOnFail)
 {
     // Ensure error message is null
     error = BackupError();
 
     // Delete new files and restore backups if present
-    if(!mRevertablePaths.isEmpty())
+    if(!mRevertables.isEmpty())
     {
-        BackupError rErr = restore(mRevertablePaths.cbegin());
+        BackupError rErr = restore(mRevertables.cbegin());
         if(rErr && !skipOnFail)
             error = rErr;
 
-        return mRevertablePaths.size();
+        return mRevertables.size();
     }
 
     // Return 0 if all empty (shouldn't be reached if function is used correctly)
     qWarning("Reversion function called with no reverts left!");
     return 0;
 }
 
+void BackupManager::purge()
+{
+    for(auto itr = mRevertables.cbegin(); itr != mRevertables.cend();)
+    {
+        bool purge = itr.value();
+        if(purge)
+            QFile::remove(itr.key());
+        itr = mRevertables.erase(itr); // clazy:exclude=strict-iterators
+    }
+}
+
 }

app/src/import/backup.cpp

@@ -1,5 +1,5 @@
-#ifndef BACKUP_H
-#define BACKUP_H
+#ifndef IMPORT_BACKUP_H
+#define IMPORT_BACKUP_H
 
 // Qt Includes
 #include <QString>
@@ -28,7 +28,8 @@ class QX_ERROR_TYPE(BackupError, "Lr::BackupError", 1301)
         FileWontDelete,
         FileWontRestore,
         FileWontBackup,
-        FileWontReplace
+        FileWontReplace,
+        FileWontCreate
     };
 
 //-Class Variables-------------------------------------------------------------
@@ -38,7 +39,8 @@ class QX_ERROR_TYPE(BackupError, "Lr::BackupError", 1301)
         {FileWontDelete, u"Cannot remove a file. It may need to be deleted manually."_s},
         {FileWontRestore, u"Cannot restore a file backup. It may need to be renamed manually.."_s},
         {FileWontBackup, u"Cannot backup file."_s},
-        {FileWontReplace, u"A file that was part of a safe replace operation could not be transfered."_s}
+        {FileWontReplace, u"A file that was part of a safe replace operation could not be transferred."_s},
+        {FileWontCreate, u"A file that was part of a safe touch operation could not be created."_s}
     };
 
     static inline const QString CAPTION_REVERT_ERR = u"Error managing backups"_s;
@@ -71,14 +73,21 @@ class QX_ERROR_TYPE(BackupError, "Lr::BackupError", 1301)
 
 class BackupManager
 {
-//-Class Variables-----------------------------------------------------------------------------------------------
+//-Aliases---------------------------------------------------------------------------
+private:
+    using OriginalPath = QString;
+    using Purge = bool;
+    using Reverts = QHash<OriginalPath, Purge>;
+    using RevertItr = Reverts::const_iterator;
+
+//-Class Variables-------------------------------------------------------------------
 private:
     // Files
     static inline const QString BACKUP_FILE_EXT = u"fbk"_s;
 
 //-Instance Variables-------------------------------------------------------------
 private:
-    QSet<QString> mRevertablePaths;
+    Reverts mRevertables;
 
 //-Constructor-------------------------------------------------------------
 private:
@@ -94,18 +103,43 @@ class BackupManager
 //-Instance Functions-------------------------------------------------------------
 private:
     BackupError backup(const QString& path, bool (*fn)(const QString& a, const QString& b));
-    BackupError restore(QSet<QString>::const_iterator pathItr);
+    BackupError restore(RevertItr itr);
 
 public:
+    // - If it exists, backs up 'path' via copy, original remains in place to be worked on
+    // - Backup is restored on revert
+    // - 'path' is marked such that any new file placed there is deleted on revert
     BackupError backupCopy(const QString& path);
+
+    // - If it exists, backs up 'path' via rename, original remains in place to be worked on
+    // - Backup is restored on revert
+    // - 'path' is marked such that any new file placed there is deleted on revert
     BackupError backupRename(const QString& path);
+
+    // - Immediately restores a backed up file using its original path
     BackupError restore(const QString& path);
+
+    // - Replaces dst with src (via a copy or symlink)
+    // - dst, if present, if temporarily backed up in case the replacement fails and is immediately
+    //   is restored if so. If the replacement succeeds the backup is immediately deleted
+    // - If dst is new (did not originally exist), the file is marked as revertable for if
+    //   a revert occurs
     BackupError safeReplace(const QString& src, const QString& dst, bool symlink);
 
+    // - Creates an empty file at 'path' (fails if it already exists) and marks it for deletion
+    //   in the event of a revert
+    BackupError revertableTouch(const QString& path);
+
+    // - Backs up the file at 'path' via copy, and then deletes the backup at the end of the import
+    // - File is restored on revert.
+    BackupError revertableRemove(const QString& path);
+
+    bool hasReversions() const;
     int revertQueueCount() const;
     int revertNextChange(BackupError& error, bool skipOnFail);
+    void purge();
 };
 
 }
 
-#endif // BACKUP_H
+#endif // IMPORT_BACKUP_H