StelFileMgr.hpp

/*
 * Stellarium
 * Copyright (C) 2008 Stellarium Developers
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA  02110-1335, USA.
 */

#ifndef _STELFILEMGR_HPP_
#define _STELFILEMGR_HPP_

#define CHECK_FILE "data/ssystem.ini"

#include <stdexcept>
#include <QSet>
#include <QString>
#include <QStringList>

class QFileInfo;

class StelFileMgr
{
public:
    enum Flags {
        RemovableMedia = 0x00000001,    
        Writable       = 0x00000002,    
        Directory      = 0x00000004,    
        File           = 0x00000008,    
        New            = 0x00000010 
    };

    static void init();

    static QString findFile(const QString& path, Flags flags=(Flags)0);

    static QStringList findFileInAllPaths(const QString& path, const Flags& flags=(Flags)0);

    static QSet<QString> listContents(const QString& path, const Flags& flags=(Flags)0, bool recursive=false);

    static const QStringList& getSearchPaths(void) {return fileLocations;}

    static void setSearchPaths(const QStringList& paths);

    static void makeSureDirExistsAndIsWritable(const QString& dirFullPath);

    static bool exists(const QString& path);

    static bool isAbsolute(const QString& path);

    static bool isReadable(const QString& path);

    static bool isWritable(const QString& path);

    static bool isDirectory(const QString& path);

    static qint64 size(const QString& path);

    static bool mkDir(const QString& path);

    static QString dirName(const QString& path);

    static QString baseName(const QString& path);

    static QString getDesktopDir();

    static QString getUserDir();

    static QString getInstallationDir();

    static QString getCacheDir();

    static void setUserDir(const QString& newDir);

    static QString getScreenshotDir();

    static void setScreenshotDir(const QString& newDir);

    static QString getLocaleDir();

private:

    StelFileMgr() {;}

    static bool fileFlagsCheck(const QFileInfo& thePath, const Flags& flags=(Flags)0);

    static QStringList fileLocations;

    static QString userDir;

    static QString screenshotDir;

    static QString installDir;
    
#ifdef Q_OS_WIN
    static QString getWin32SpecialDirPath(int csidlId);
#endif

};

#endif // _STELFILEMGR_HPP_