platform_folders.h

/*
Its is under the MIT license, to encourage reuse by cut-and-paste.

The original files are hosted here: https://github.com/sago007/PlatformFolders

Copyright (c) 2015 Poul Sander

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files
(the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

#ifndef SAGO_PLATFORM_FOLDERS_H
#define SAGO_PLATFORM_FOLDERS_H

#include <vector>
#include <string>

namespace sago {

std::string getDataHome();

std::string getConfigHome();

std::string getCacheDir();

void appendAdditionalDataDirectories(std::vector<std::string>& homes);

void appendAdditionalConfigDirectories(std::vector<std::string>& homes);

std::string getDesktopFolder();

std::string getDocumentsFolder();

std::string getDownloadFolder();

std::string getDownloadFolder1();

std::string getPicturesFolder();

std::string getPublicFolder();

std::string getMusicFolder();

std::string getVideoFolder();

std::string getSaveGamesFolder1();

std::string getSaveGamesFolder2();

#ifndef DOXYGEN_SHOULD_SKIP_THIS

class PlatformFolders {
public:
    PlatformFolders();
    ~PlatformFolders();
    std::string getDesktopFolder() const;
    std::string getDocumentsFolder() const;
    std::string getPicturesFolder() const;
    std::string getPublicFolder() const;
    std::string getDownloadFolder1() const;
    std::string getMusicFolder() const;
    std::string getVideoFolder() const;
    std::string getSaveGamesFolder1() const;
private:
    PlatformFolders(const PlatformFolders&);
    PlatformFolders& operator=(const PlatformFolders&);
#if !defined(_WIN32) && !defined(__APPLE__)
    struct PlatformFoldersData;
    PlatformFoldersData* data;
#endif
};

#endif // skip doxygen


}  //namespace sago

#endif  /* PLATFORM_FOLDERS_H */