File indexing completed on 2024-05-12 05:10:15

0001 /***************************************************************************
0002     Copyright (C) 2015 Robby Stephenson <robby@periapsis.org>
0003  ***************************************************************************/
0004 
0005 /***************************************************************************
0006  *                                                                         *
0007  *   This program is free software; you can redistribute it and/or         *
0008  *   modify it under the terms of the GNU General Public License as        *
0009  *   published by the Free Software Foundation; either version 2 of        *
0010  *   the License or (at your option) version 3 or any later version        *
0011  *   accepted by the membership of KDE e.V. (or its successor approved     *
0012  *   by the membership of KDE e.V.), which shall act as a proxy            *
0013  *   defined in Section 14 of version 3 of the license.                    *
0014  *                                                                         *
0015  *   This program is distributed in the hope that it will be useful,       *
0016  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
0017  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
0018  *   GNU General Public License for more details.                          *
0019  *                                                                         *
0020  *   You should have received a copy of the GNU General Public License     *
0021  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
0022  *                                                                         *
0023  ***************************************************************************/
0024 
0025 #ifndef TELLICO_DATAFILEREGISTRY_H
0026 #define TELLICO_DATAFILEREGISTRY_H
0027 
0028 #include <QStringList>
0029 
0030 namespace Tellico {
0031 
0032 /**
0033  * @author Robby Stephenson
0034  *
0035  * This class replicates, in small part, a functionality deprecated and removed
0036  * by the KDE4 KStandardDirs class for adding a list of custom directories for
0037  * searching for resource types. This class only looks for data file, and defaults
0038  * to QStandardPaths::DataLocation. For unit tests, in particular, it is useful
0039  * to be able to read and use data files from the source directory.
0040  */
0041 class DataFileRegistry {
0042 
0043 public:
0044   static DataFileRegistry* self();
0045 
0046   void addDataLocation(const QString& dir, bool prepend = false);
0047   QString locate(const QString& fileName);
0048 
0049 private:
0050   DataFileRegistry();
0051 
0052   QStringList m_dataLocations;
0053 };
0054 
0055 } // end namespace
0056 #endif