datapaths.h

//------------------------------------------------------------------------------
// datapaths.h
//------------------------------------------------------------------------------
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301  USA
//
//------------------------------------------------------------------------------
// Copyright (C) 2010 "Zalewa" <zalewapl@gmail.com>
//------------------------------------------------------------------------------
#ifndef __DATAPATHS_H__
#define __DATAPATHS_H__

#include "global.h"
#include "dptr.h"
#include <QDir>
#include <QString>
#include <QStringList>

#define gDefaultDataPaths (DataPaths::defaultInstance())

class EnginePlugin;

class MAIN_EXPORT DataPaths
{
        public:
                enum MachineType
                {
                        x86,
                        x64,
                        Preferred
                };

                static const QString CHATLOGS_DIR_NAME;
                static const QString TRANSLATIONS_DIR_NAME;
                static const QString UPDATE_PACKAGES_DIR_NAME;
                static const QString UPDATE_PACKAGE_FILENAME_PREFIX;

                struct DirErrno
                {
                        static const int CUSTOM_ERROR = -1;

                        QDir directory;
                        int errnoNum;
                        QString errnoString;

                        DirErrno() : errnoNum(0) {}

                        DirErrno(QDir directory, int errnoNum, QString errnoString)
                                : directory(directory), errnoNum(errnoNum), errnoString(errnoString)
                        {}

                        bool isError() const
                        {
                                return errnoNum != 0;
                        }
                };

                static QString programFilesDirectory(MachineType machineType);

                static QStringList staticDataSearchDirs(const QString& subdir = QString());

                static void initDefault(bool bPortableModeOn);
                static DataPaths *defaultInstance();

                DataPaths(bool bPortableModeOn = false);
                virtual ~DataPaths();

                QString cacheLocationPath() const;

                QStringList canWrite() const;

                QList<DirErrno> createDirectories();

                QStringList defaultWadPaths() const;

                QString demosDirectoryPath() const;

                QString documentsLocationPath(const QString &subpath = QString()) const;

                QString localDataLocationPath(const QString& subpath = QString()) const;

                QString pluginDocumentsLocationPath(const EnginePlugin &plugin) const;

                QString pluginLocalDataLocationPath(const EnginePlugin &plugin) const;

                QStringList pluginSearchLocationPaths() const;

                QString programsDataDirectoryPath() const;

                bool isPortableModeOn() const;

                void setWorkingDirectory(const QString &workingDirectory);

                QString systemAppDataDirectory(QString append = QString()) const;

                bool validateAppDataDirectory();

                const QString &workingDirectory() const;

        protected:
                static bool validateDir(const QString& path);

                DirErrno tryCreateDirectory(const QDir& rootDir, const QString& dirToCreate) const;

        private:
                DPtr<DataPaths> d;

                static QString env(const QString &key);
                static DataPaths *staticDefaultInstance;
};

#endif