lfilesystem_SpecialDirectories.h

Go to the documentation of this file.

/*
 * ======================================================================================
 *  __    ____  __  __  ____  ___
 * (  )  (_  _)(  \/  )( ___)/ __)
 *  )(__  _)(_  )    (  )__) \__ \
 * (____)(____)(_/\/\_)(____)(___/
 *
 *  This file is part of the Limes open source library and is licensed under the terms of the GNU Public License.
 *
 *  Commercial licenses are available; contact the maintainers at ben.the.vining@gmail.com to inquire for details.
 *
 * ======================================================================================
 */
 
#pragma once
 
#include <vector>
#include "lfilesystem/lfilesystem_Export.h"
#include "lfilesystem/lfilesystem_Directory.h"
 
namespace limes::files::dirs
{
 
[[nodiscard]] LFILE_EXPORT Directory cwd();
 
[[nodiscard]] LFILE_EXPORT Directory cwdAtStartup();
 
LFILE_EXPORT bool setCWD (const Path& path);
 
[[nodiscard]] LFILE_EXPORT Directory temp();
 
[[nodiscard]] LFILE_EXPORT std::vector<Directory> PATH();
 
LFILE_EXPORT bool appendToPATH (const Directory& dir);
 
[[nodiscard]] LFILE_EXPORT Directory home();
 
[[nodiscard]] LFILE_EXPORT Directory desktop();
 
[[nodiscard]] LFILE_EXPORT Directory userDocuments();
 
[[nodiscard]] LFILE_EXPORT Directory commonDocuments();
 
[[nodiscard]] LFILE_EXPORT Directory userAppData();
 
[[nodiscard]] LFILE_EXPORT Directory commonAppData();
 
[[nodiscard]] LFILE_EXPORT Directory apps();
 
[[nodiscard]] LFILE_EXPORT Directory downloads();
 
}  // namespace limes::files::dirs