File indexing completed on 2024-05-05 04:14:47

 /* ============================================================
  *
  * This file is a part of digiKam project
  * https://www.digikam.org
  *
  * Date        : 2022-10-10
  * Description : Common class to provides convenient access to digiKam
  *               test data directories and files.
  *
  * SPDX-FileCopyrightText: 2022 Steve Robbins <steve at sumost dot ca>
  *
  * SPDX-License-Identifier: GPL-2.0-or-later
  *
  * ============================================================ */
 
 #ifndef DIGIKAM_DTEST_DATA_DIR_H
 #define DIGIKAM_DTEST_DATA_DIR_H
 
 // Qt includes
 
 #include <QDir>
 
 /**
  * \brief Class that provides convenient access to digiKam test data directories and files.
  *
  * When instantiated, the test-data directory is located dynamically; this algorithm works as long as
  * the current directory is the source root directory or any sub-directory.  After construction,
  * the function \ref isValid returns true if the test data was successfully located.
  */
 
 class DTestDataDir
 {
 public:
 
     /**
      * True if the instance is correctly instantiated.
      * Valid means that the desired root directory was located.
      */
     bool isValid() const
     {
         return m_isValid;
     }
 
     /**
      * Root directory of test data hierarchy.
      */
     QDir root() const
     {
         return m_testDataDir;
     }
 
     /**
      * Path to any test file or directory, specified using relative path from root.
      */
     QString path(const QString& name) const
     {
         return root().filePath(name);
     }
 
     /**
      * Any test directory, specified using relative path from root.
      */
     QDir dir(const QString& relPath) const
     {
         return QDir(path(relPath));
     }
 
     /**
      * Any test file, specified using relative path from root.
      */
     QFile file(const QString& name) const
     {
         return QFile(path(name));
     }
 
     /**
      * Returns DTestDataDir for the digiKam Test Data root directory.
      * This provides access to all files in Digikam Test Data.
      */
     static DTestDataDir TestDataRoot()
     {
         return DTestDataDir();
     }
 
     /**
      * Returns DTestDataDir for a sub-tree of the digiKam Test Data.
      * This provides access to files in the subtree.
      * 
      * \param subdirPath path of subdir, relative to the Digikam Test Data root
      */
     static DTestDataDir TestData(const QString& subdirPath)
     {
         return DTestDataDir(subdirPath);
     }
 
 private:
 
     QDir m_testDataDir;
     bool m_isValid = false;
 
 private:
 
     static bool s_findDirectoryUpwards(const QDir& directory, const QString& target, QDir& result)
     {
         QDir dir = directory;
 
         while (dir.exists(target) == false)
         {
             if (!dir.cdUp())
             {
                 return false;
             }
         }
 
         if (!dir.cd(target))
         {
             return false;
         }
 
         result = dir;
 
         return true;
     }
 
     void initialize()
     {
         m_isValid = s_findDirectoryUpwards(QDir(), QString::fromUtf8("test-data"), m_testDataDir);
     }
 
 protected:
 
     /**
      * Constructor with internal instance creation.
      */
     DTestDataDir()
     {
         initialize();
     }
 
     DTestDataDir(const QString& subdirPath)
     {
         initialize();
 
         if (!m_isValid)
         {
             return;
         }
 
         m_isValid = m_testDataDir.exists(subdirPath);
 
         if (!m_isValid)
         {
             return;
         }
 
         bool b = m_testDataDir.cd(subdirPath);
         Q_UNUSED(b);
     }
 };
 
 #endif // DIGIKAM_DTEST_DATA_DIR