diff --git a/CHANGELOG.md b/CHANGELOG.md index 9ec280c..f4696c8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,7 @@ ### Changed - Now uses {fmt} for internal formatting + - Now possible to compile using local copy of PlatformFolders - Install the sample mod "1.3.0.bricks" - Update library versions for the compiled version: - SDL2: 2.0.16 to 2.0.20 diff --git a/CMakeLists.txt b/CMakeLists.txt index b825ff6..79f5813 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -20,6 +20,7 @@ set(INSTALL_LOCALE_DIR "${INSTALL_DATA_DIR}/locale/" CACHE STRING "Install trans set(INSTALL_METAINFO_DIR "share/metainfo" CACHE STRING "Install appstream matedata to this directory") option(BLOCKATTACK_USE_EMBEDDED_FMT "Use the embedded version of {fmt}" ON) +option(BLOCKATTACK_USE_EMBEDDED_PLATFORM_FOLDERS "Use the embedded version of PlatformFolders" ON) # This sets up the exe icon for windows under mingw. # Taken from https://hansonry.wordpress.com/2010/12/15/windows-application-icon-using-mingw-and-cmake/ @@ -90,6 +91,12 @@ if (BLOCKATTACK_USE_EMBEDDED_FMT) message("Done processing {fmt}") endif() +if (BLOCKATTACK_USE_EMBEDDED_PLATFORM_FOLDERS) + message("Using embedded PlatformFolders") + add_subdirectory("source/misc/embedded_libs/PlatformFolders-4.2.0" EXCLUDE_FROM_ALL) + message("Done processing PlatformFolders") +endif() + include_directories("source/code/Libs/include") include_directories("source/code/Libs/include/cereal/external") #Contains rapidjson @@ -97,6 +104,7 @@ include_directories("source/code/Libs/include/cereal/external") #Contains rapid add_executable(blockattack ${GUI_TYPE} ${SOURCES} ${RES_FILES}) target_link_libraries( blockattack ${SDL2_LIBRARIES}) target_link_libraries( blockattack fmt) +target_link_libraries( blockattack platform_folders) target_link_libraries( blockattack physfs) target_link_libraries( blockattack ${SDL2MIXER_LIBRARIES} ${SDL2IMAGE_LIBRARIES} ${SDL2TTF_LIBRARIES}) target_link_libraries( blockattack ${Boost_LIBRARIES} ) diff --git a/source/code/gamecontroller.cpp b/source/code/gamecontroller.cpp index 69341d7..2470246 100644 --- a/source/code/gamecontroller.cpp +++ b/source/code/gamecontroller.cpp @@ -23,7 +23,7 @@ http://www.blockattack.net #include "gamecontroller.h" #include "SDL_gamecontroller.h" -#include "sago/platform_folders.h" +#include "platform_folders.h" #include "common.h" #include #include diff --git a/source/code/main.cpp b/source/code/main.cpp index 096c48a..43c8326 100644 --- a/source/code/main.cpp +++ b/source/code/main.cpp @@ -317,7 +317,7 @@ static ExplosionManager theExplosionManager; #include "BlockGameSdl.inc" #include "sago/SagoMisc.hpp" #include "ReplayPlayer.hpp" -#include "sago/platform_folders.h" +#include "platform_folders.h" std::string pathToScreenShots() { Config::getInstance()->setDefault("screenshot_dir", _("Block Attack - Rise of the Blocks")); diff --git a/source/code/os.cpp b/source/code/os.cpp index e03b00f..b86bc7f 100644 --- a/source/code/os.cpp +++ b/source/code/os.cpp @@ -24,7 +24,7 @@ https://blockattack.net #include "os.hpp" #include #include -#include "sago/platform_folders.h" +#include "platform_folders.h" #include "version.h" #include "common.h" diff --git a/source/code/sago/platform_folders.cpp b/source/code/sago/platform_folders.cpp deleted file mode 100644 index b1a0874..0000000 --- a/source/code/sago/platform_folders.cpp +++ /dev/null @@ -1,457 +0,0 @@ -/* -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-2016 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. -*/ - -#include "platform_folders.h" -#include -#include -#include -#include - -#ifndef _WIN32 - -#include -#include - -/** - * Retrives the effective user's home dir. - * If the user is running as root we ignore the HOME environment. It works badly with sudo. - * Writing to $HOME as root implies security concerns that a multiplatform program cannot be assumed to handle. - * @return The home directory. HOME environment is respected for non-root users if it exists. - */ -static std::string getHome() { - std::string res; - int uid = getuid(); - const char* homeEnv = std::getenv("HOME"); - if ( uid != 0 && homeEnv) { - //We only acknowlegde HOME if not root. - res = homeEnv; - return res; - } - struct passwd* pw = nullptr; - struct passwd pwd; - long bufsize = sysconf(_SC_GETPW_R_SIZE_MAX); - if (bufsize < 0) { - bufsize = 16384; - } - std::vector buffer; - buffer.resize(bufsize); - int error_code = getpwuid_r(uid, &pwd, buffer.data(), buffer.size(), &pw); - if (error_code) { - throw std::runtime_error("Unable to get passwd struct."); - } - const char* tempRes = pw->pw_dir; - if (!tempRes) { - throw std::runtime_error("User has no home directory"); - } - res = tempRes; - return res; -} - -#endif - -#ifdef _WIN32 -// Make sure we don't bring in all the extra junk with windows.h -#ifndef WIN32_LEAN_AND_MEAN -#define WIN32_LEAN_AND_MEAN -#endif -// stringapiset.h depends on this -#include -// For SUCCEEDED macro -#include -// For WideCharToMultiByte -#include -// For SHGetFolderPathW and various CSIDL "magic numbers" -#include - -namespace sago { -namespace internal { - -std::string win32_utf16_to_utf8(const wchar_t* wstr) { - std::string res; - // If the 6th parameter is 0 then WideCharToMultiByte returns the number of bytes needed to store the result. - int actualSize = WideCharToMultiByte(CP_UTF8, 0, wstr, -1, nullptr, 0, nullptr, nullptr); - if (actualSize > 0) { - //If the converted UTF-8 string could not be in the initial buffer. Allocate one that can hold it. - std::vector buffer(actualSize); - actualSize = WideCharToMultiByte(CP_UTF8, 0, wstr, -1, &buffer[0], static_cast(buffer.size()), nullptr, nullptr); - res = buffer.data(); - } - if (actualSize == 0) { - // WideCharToMultiByte return 0 for errors. - throw std::runtime_error("UTF16 to UTF8 failed with error code: " + std::to_string(GetLastError())); - } - return res; -} - -} // namesapce internal -} // namespace sago - -class FreeCoTaskMemory { - LPWSTR pointer = NULL; -public: - explicit FreeCoTaskMemory(LPWSTR pointer) : pointer(pointer) {}; - ~FreeCoTaskMemory() { - CoTaskMemFree(pointer); - } -}; - -static std::string GetKnownWindowsFolder(REFKNOWNFOLDERID folderId, const char* errorMsg) { - LPWSTR wszPath = NULL; - HRESULT hr; - hr = SHGetKnownFolderPath(folderId, KF_FLAG_CREATE, NULL, &wszPath); - FreeCoTaskMemory scopeBoundMemory(wszPath); - - if (!SUCCEEDED(hr)) { - throw std::runtime_error(errorMsg); - } - return sago::internal::win32_utf16_to_utf8(wszPath); -} - -static std::string GetAppData() { - return GetKnownWindowsFolder(FOLDERID_RoamingAppData, "RoamingAppData could not be found"); -} - -static std::string GetAppDataCommon() { - return GetKnownWindowsFolder(FOLDERID_ProgramData, "ProgramData could not be found"); -} - -static std::string GetAppDataLocal() { - return GetKnownWindowsFolder(FOLDERID_LocalAppData, "LocalAppData could not be found"); -} -#elif defined(__APPLE__) -#else -#include -#include -#include -// For strlen and strtok -#include -#include -//Typically Linux. For easy reading the comments will just say Linux but should work with most *nixes - -static void throwOnRelative(const char* envName, const char* envValue) { - if (envValue[0] != '/') { - char buffer[200]; - std::snprintf(buffer, sizeof(buffer), "Environment \"%s\" does not start with an '/'. XDG specifies that the value must be absolute. The current value is: \"%s\"", envName, envValue); - throw std::runtime_error(buffer); - } -} - - - -static std::string getLinuxFolderDefault(const char* envName, const char* defaultRelativePath) { - std::string res; - const char* tempRes = std::getenv(envName); - if (tempRes) { - throwOnRelative(envName, tempRes); - res = tempRes; - return res; - } - res = getHome() + "/" + defaultRelativePath; - return res; -} - -static void appendExtraFolders(const char* envName, const char* defaultValue, std::vector& folders) { - const char* envValue = std::getenv(envName); - if (!envValue) { - envValue = defaultValue; - } - sago::internal::appendExtraFoldersTokenizer(envName, envValue, folders); -} - -#endif - - -namespace sago { - -#if !defined(_WIN32) && !defined(__APPLE__) -namespace internal { -void appendExtraFoldersTokenizer(const char* envName, const char* envValue, std::vector& folders) { - std::stringstream ss(envValue); - std::string value; - while (std::getline(ss, value, ':')) { - if (value[0] == '/') { - folders.push_back(value); - } - else { - //Unless the system is wrongly configured this should never happen... But of course some systems will be incorectly configured. - //The XDG documentation indicates that the folder should be ignored but that the program should continue. - std::cerr << "Skipping path \"" << value << "\" in \"" << envName << "\" because it does not start with a \"/\"\n"; - } - } -} -} -#endif - -std::string getDataHome() { -#ifdef _WIN32 - return GetAppData(); -#elif defined(__APPLE__) - return getHome()+"/Library/Application Support"; -#else - return getLinuxFolderDefault("XDG_DATA_HOME", ".local/share"); -#endif -} - -std::string getConfigHome() { -#ifdef _WIN32 - return GetAppData(); -#elif defined(__APPLE__) - return getHome()+"/Library/Application Support"; -#else - return getLinuxFolderDefault("XDG_CONFIG_HOME", ".config"); -#endif -} - -std::string getCacheDir() { -#ifdef _WIN32 - return GetAppDataLocal(); -#elif defined(__APPLE__) - return getHome()+"/Library/Caches"; -#else - return getLinuxFolderDefault("XDG_CACHE_HOME", ".cache"); -#endif -} - -std::string getStateDir() { -#ifdef _WIN32 - return GetAppDataLocal(); -#elif defined(__APPLE__) - return getHome()+"/Library/Application Support"; -#else - return getLinuxFolderDefault("XDG_STATE_HOME", ".local/state"); -#endif -} - -void appendAdditionalDataDirectories(std::vector& homes) { -#ifdef _WIN32 - homes.push_back(GetAppDataCommon()); -#elif !defined(__APPLE__) - appendExtraFolders("XDG_DATA_DIRS", "/usr/local/share/:/usr/share/", homes); -#endif -} - -void appendAdditionalConfigDirectories(std::vector& homes) { -#ifdef _WIN32 - homes.push_back(GetAppDataCommon()); -#elif !defined(__APPLE__) - appendExtraFolders("XDG_CONFIG_DIRS", "/etc/xdg", homes); -#endif -} - -#if !defined(_WIN32) && !defined(__APPLE__) -struct PlatformFolders::PlatformFoldersData { - std::map folders; -}; - -static void PlatformFoldersAddFromFile(const std::string& filename, std::map& folders) { - std::ifstream infile(filename.c_str()); - std::string line; - while (std::getline(infile, line)) { - if (line.length() == 0 || line.at(0) == '#' || line.substr(0, 4) != "XDG_" || line.find("_DIR") == std::string::npos) { - continue; - } - try { - std::size_t splitPos = line.find('='); - std::string key = line.substr(0, splitPos); - std::size_t valueStart = line.find('"', splitPos); - std::size_t valueEnd = line.find('"', valueStart+1); - std::string value = line.substr(valueStart+1, valueEnd - valueStart - 1); - folders[key] = value; - } - catch (std::exception& e) { - std::cerr << "WARNING: Failed to process \"" << line << "\" from \"" << filename << "\". Error: "<< e.what() << "\n"; - continue; - } - } -} - -static void PlatformFoldersFillData(std::map& folders) { - folders["XDG_DOCUMENTS_DIR"] = "$HOME/Documents"; - folders["XDG_DESKTOP_DIR"] = "$HOME/Desktop"; - folders["XDG_DOWNLOAD_DIR"] = "$HOME/Downloads"; - folders["XDG_MUSIC_DIR"] = "$HOME/Music"; - folders["XDG_PICTURES_DIR"] = "$HOME/Pictures"; - folders["XDG_PUBLICSHARE_DIR"] = "$HOME/Public"; - folders["XDG_TEMPLATES_DIR"] = "$HOME/.Templates"; - folders["XDG_VIDEOS_DIR"] = "$HOME/Videos"; - PlatformFoldersAddFromFile( getConfigHome()+"/user-dirs.dirs", folders); - for (std::map::iterator itr = folders.begin() ; itr != folders.end() ; ++itr ) { - std::string& value = itr->second; - if (value.compare(0, 5, "$HOME") == 0) { - value = getHome() + value.substr(5, std::string::npos); - } - } -} -#endif - -PlatformFolders::PlatformFolders() { -#if !defined(_WIN32) && !defined(__APPLE__) - this->data = new PlatformFolders::PlatformFoldersData(); - try { - PlatformFoldersFillData(data->folders); - } - catch (...) { - delete this->data; - throw; - } -#endif -} - -PlatformFolders::~PlatformFolders() { -#if !defined(_WIN32) && !defined(__APPLE__) - delete this->data; -#endif -} - -std::string PlatformFolders::getDocumentsFolder() const { -#ifdef _WIN32 - return GetKnownWindowsFolder(FOLDERID_Documents, "Failed to find My Documents folder"); -#elif defined(__APPLE__) - return getHome()+"/Documents"; -#else - return data->folders["XDG_DOCUMENTS_DIR"]; -#endif -} - -std::string PlatformFolders::getDesktopFolder() const { -#ifdef _WIN32 - return GetKnownWindowsFolder(FOLDERID_Desktop, "Failed to find Desktop folder"); -#elif defined(__APPLE__) - return getHome()+"/Desktop"; -#else - return data->folders["XDG_DESKTOP_DIR"]; -#endif -} - -std::string PlatformFolders::getPicturesFolder() const { -#ifdef _WIN32 - return GetKnownWindowsFolder(FOLDERID_Pictures, "Failed to find My Pictures folder"); -#elif defined(__APPLE__) - return getHome()+"/Pictures"; -#else - return data->folders["XDG_PICTURES_DIR"]; -#endif -} - -std::string PlatformFolders::getPublicFolder() const { -#ifdef _WIN32 - return GetKnownWindowsFolder(FOLDERID_Public, "Failed to find the Public folder"); -#elif defined(__APPLE__) - return getHome()+"/Public"; -#else - return data->folders["XDG_PUBLICSHARE_DIR"]; -#endif -} - -std::string PlatformFolders::getDownloadFolder1() const { -#ifdef _WIN32 - return GetKnownWindowsFolder(FOLDERID_Downloads, "Failed to find My Downloads folder"); -#elif defined(__APPLE__) - return getHome()+"/Downloads"; -#else - return data->folders["XDG_DOWNLOAD_DIR"]; -#endif -} - -std::string PlatformFolders::getMusicFolder() const { -#ifdef _WIN32 - return GetKnownWindowsFolder(FOLDERID_Music, "Failed to find My Music folder"); -#elif defined(__APPLE__) - return getHome()+"/Music"; -#else - return data->folders["XDG_MUSIC_DIR"]; -#endif -} - -std::string PlatformFolders::getVideoFolder() const { -#ifdef _WIN32 - return GetKnownWindowsFolder(FOLDERID_Videos, "Failed to find My Video folder"); -#elif defined(__APPLE__) - return getHome()+"/Movies"; -#else - return data->folders["XDG_VIDEOS_DIR"]; -#endif -} - -std::string PlatformFolders::getSaveGamesFolder1() const { -#ifdef _WIN32 - //A dedicated Save Games folder was not introduced until Vista. For XP and older save games are most often saved in a normal folder named "My Games". - //Data that should not be user accessible should be placed under GetDataHome() instead - return GetKnownWindowsFolder(FOLDERID_Documents, "Failed to find My Documents folder")+"\\My Games"; -#elif defined(__APPLE__) - return getHome()+"/Library/Application Support"; -#else - return getDataHome(); -#endif -} - -std::string getDesktopFolder() { - return PlatformFolders().getDesktopFolder(); -} - -std::string getDocumentsFolder() { - return PlatformFolders().getDocumentsFolder(); -} - -std::string getDownloadFolder() { - return PlatformFolders().getDownloadFolder1(); -} - -std::string getDownloadFolder1() { - return getDownloadFolder(); -} - -std::string getPicturesFolder() { - return PlatformFolders().getPicturesFolder(); -} - -std::string getPublicFolder() { - return PlatformFolders().getPublicFolder(); -} - -std::string getMusicFolder() { - return PlatformFolders().getMusicFolder(); -} - -std::string getVideoFolder() { - return PlatformFolders().getVideoFolder(); -} - -std::string getSaveGamesFolder1() { - return PlatformFolders().getSaveGamesFolder1(); -} - -std::string getSaveGamesFolder2() { -#ifdef _WIN32 - return GetKnownWindowsFolder(FOLDERID_SavedGames, "Failed to find Saved Games folder"); -#else - return PlatformFolders().getSaveGamesFolder1(); -#endif -} - -} //namespace sago diff --git a/source/code/sago/platform_folders.h b/source/code/sago/platform_folders.h deleted file mode 100644 index 742c829..0000000 --- a/source/code/sago/platform_folders.h +++ /dev/null @@ -1,287 +0,0 @@ -/* -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 -#include - -/** - * The namespace I use for common function. Nothing special about it. - */ -namespace sago { - -#ifndef DOXYGEN_SHOULD_SKIP_THIS -namespace internal { -#if !defined(_WIN32) && !defined(__APPLE__) -void appendExtraFoldersTokenizer(const char* envName, const char* envValue, std::vector& folders); -#endif -#ifdef _WIN32 -std::string win32_utf16_to_utf8(const wchar_t* wstr); -#endif -} -#endif //DOXYGEN_SHOULD_SKIP_THIS - -/** - * Retrives the base folder for storing data files. - * You must add the program name yourself like this: - * @code{.cpp} - * string data_home = getDataHome()+"/My Program Name/"; - * @endcode - * On Windows this defaults to %APPDATA% (Roaming profile) - * On Linux this defaults to ~/.local/share but can be configured by the user - * @return The base folder for storing program data. - */ -std::string getDataHome(); - -/** - * Retrives the base folder for storing config files. - * You must add the program name yourself like this: - * @code{.cpp} - * string data_home = getConfigHome()+"/My Program Name/"; - * @endcode - * On Windows this defaults to %APPDATA% (Roaming profile) - * On Linux this defaults to ~/.config but can be configured by the user - * @return The base folder for storing config data. - */ -std::string getConfigHome(); - -/** - * Retrives the base folder for storing cache files. - * You must add the program name yourself like this: - * @code{.cpp} - * string data_home = getCacheDir()+"/My Program Name/cache/"; - * @endcode - * On Windows this defaults to %APPDATALOCAL% - * On Linux this defaults to ~/.cache but can be configured by the user - * Note that it is recommended to append "cache" after the program name to prevent conflicting with "StateDir" under Windows - * @return The base folder for storing data that do not need to be backed up and might be deleted. - */ -std::string getCacheDir(); - -/** - * Retrives the base folder used for state files. - * You must add the program name yourself like this: - * @code{.cpp} - * string data_home = getStateDir()+"/My Program Name/"; - * @endcode - * On Windows this defaults to %APPDATALOCAL% - * On Linux this defaults to ~/.local/state but can be configured by the user - * On OS X this is the same as getDataHome() - * @return The base folder for storing data that do not need to be backed up but should not be reguarly deleted either. - */ -std::string getStateDir(); - -/** - * This will append extra folders that your program should be looking for data files in. - * This does not normally include the path returned by GetDataHome(). - * If you want all the folders you should do something like: - * @code{.cpp} - * vector folders; - * folders.push_back(getDataHome()); - * appendAdditionalDataDirectories(folders); - * for (string s& : folders) { - * s+="/My Program Name/"; - * } - * @endcode - * You must apply "/My Program Name/" to all the strings. - * The string at the lowest index has the highest priority. - * @param homes A vector that extra folders will be appended to. - */ -void appendAdditionalDataDirectories(std::vector& homes); - -/** - * This will append extra folders that your program should be looking for config files in. - * This does not normally include the path returned by GetConfigHome(). - * If you want all the folders you should do something like: - * @code{.cpp} - * std::vector folders; - * folders.push_back(sago::getConfigHome()); - * sago::appendAdditionalConfigDirectories(folders); - * for (std::string s& : folders) { - * s+="/My Program Name/"; - * } - * @endcode - * You must apply "/My Program Name/" to all the strings. - * The string at the lowest index has the highest priority. - * @param homes A vector that extra folders will be appended to. - */ -void appendAdditionalConfigDirectories(std::vector& homes); - -/** - * The folder that represents the desktop. - * Normally you should try not to use this folder. - * @return Absolute path to the user's desktop - */ -std::string getDesktopFolder(); - -/** - * The folder to store user documents to - * @return Absolute path to the "Documents" folder - */ -std::string getDocumentsFolder(); - -/** - * The folder where files are downloaded. - * @return Absolute path to the folder where files are downloaded to. - */ -std::string getDownloadFolder(); - -/** - * The folder where files are downloaded. - * @note This is provided for backward compatibility. Use getDownloadFolder instead. - * @return Absolute path to the folder where files are downloaded to. - */ -std::string getDownloadFolder1(); - -/** - * The folder for storing the user's pictures. - * @return Absolute path to the "Picture" folder - */ -std::string getPicturesFolder(); - -/** - * This returns the folder that can be used for sharing files with other users on the same system. - * @return Absolute path to the "Public" folder - */ -std::string getPublicFolder(); - -/** - * The folder where music is stored - * @return Absolute path to the music folder - */ -std::string getMusicFolder(); - -/** - * The folder where video is stored - * @return Absolute path to the video folder - */ -std::string getVideoFolder(); - -/** - * A base folder for storing saved games. - * You must add the program name to it like this: - * @code{.cpp} - * string saved_games_folder = sago::getSaveGamesFolder1()+"/My Program Name/"; - * @endcode - * @note Windows: This is an XP compatible version and returns the path to "My Games" in Documents. Vista and later has an official folder. - * @note Linux: XDF does not define a folder for saved games. This will just return the same as GetDataHome() - * @return The folder base folder for storing save games. - */ -std::string getSaveGamesFolder1(); - -/** - * A base folder for storing saved games. - * You must add the program name to it like this: - * @code{.cpp} - * string saved_games_folder = sago::getSaveGamesFolder2()+"/My Program Name/"; - * @endcode - * @note PlatformFolders provide different folders to for saved games as not all operating systems has support for Saved Games yet. - * It is recommended to pick the highest number (currently getSaveGamesFolder2) at the time your product enters production and stick with it - * @note Windows: This returns the "Saved Games" folder. This folder exist in Vista and later - * @note Linux: XDF does not define a folder for saved games. This will just return the same as GetDataHome() - * @return The folder base folder for storing save games. - */ -std::string getSaveGamesFolder2(); - -#ifndef DOXYGEN_SHOULD_SKIP_THIS - -/** - * This class contains methods for finding the system depended special folders. - * For Windows these folders are either by convention or given by CSIDL. - * For Linux XDG convention is used. - * The Linux version has very little error checking and assumes that the config is correct - */ -class PlatformFolders { -public: - PlatformFolders(); - ~PlatformFolders(); - /** - * The folder that represents the desktop. - * Normally you should try not to use this folder. - * @return Absolute path to the user's desktop - */ - std::string getDesktopFolder() const; - /** - * The folder to store user documents to - * @return Absolute path to the "Documents" folder - */ - std::string getDocumentsFolder() const; - /** - * The folder for storing the user's pictures. - * @return Absolute path to the "Picture" folder - */ - std::string getPicturesFolder() const; - /** - * Use sago::getPublicFolder() instead! - */ - std::string getPublicFolder() const; - /** - * The folder where files are downloaded. - * @note Windows: This version is XP compatible and returns the Desktop. Vista and later has a dedicated folder. - * @return Absolute path to the folder where files are downloaded to. - */ - std::string getDownloadFolder1() const; - /** - * The folder where music is stored - * @return Absolute path to the music folder - */ - std::string getMusicFolder() const; - /** - * The folder where video is stored - * @return Absolute path to the video folder - */ - std::string getVideoFolder() const; - /** - * The base folder for storing saved games. - * You must add the program name to it like this: - * @code{.cpp} - * PlatformFolders pf; - * string saved_games_folder = pf.getSaveGamesFolder1()+"/My Program Name/"; - * @endcode - * @note Windows: This is an XP compatible version and returns the path to "My Games" in Documents. Vista and later has an official folder. - * @note Linux: XDF does not define a folder for saved games. This will just return the same as GetDataHome() - * @return The folder base folder for storing save games. - */ - 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 */ diff --git a/source/misc/embedded_libs/PlatformFolders-4.2.0/.gitignore b/source/misc/embedded_libs/PlatformFolders-4.2.0/.gitignore new file mode 100644 index 0000000..9682bfb --- /dev/null +++ b/source/misc/embedded_libs/PlatformFolders-4.2.0/.gitignore @@ -0,0 +1,39 @@ +# Compiled Object files +*.slo +*.lo +*.o +*.obj + +# Precompiled Headers +*.gch +*.pch + +# Compiled Dynamic libraries +*.so +*.dylib +*.dll + +# Fortran module files +*.mod + +# Compiled Static libraries +*.lai +*.la +*.a +*.lib + +# Executables +*.exe +*.out +*.app + +# Sago's files +private +.deps +doxygen +*~ +platform_folders +nbproject + +# Commonly used build dir +build diff --git a/source/misc/embedded_libs/PlatformFolders-4.2.0/CHANGELOG.md b/source/misc/embedded_libs/PlatformFolders-4.2.0/CHANGELOG.md new file mode 100644 index 0000000..5da7fab --- /dev/null +++ b/source/misc/embedded_libs/PlatformFolders-4.2.0/CHANGELOG.md @@ -0,0 +1,91 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). + +## [4.2.0] 2022-02-06 + +### Added + - Support for "state" dir aka Local Machine + +### Changed + - PlatformFolders specific CMake variables are now prefixed with "PLATFORMFOLDERS_" (Thanks @OlivierLDff) + +## [4.1.0] 2021-08-08 + +### Added + - CHANGELOG.md + - Support for CMAKE_DEBUG_POSTFIX. Makes it possible to add a postfix to debug builds + +### Changed + - README.md is now included in the Doxygen documentation + - Should now be thread safe + - Minor internal changes + +## [4.0.0] 2018-06-24 + +### Added + - Support for "Public" folder + - Support for "Saved Games 2". This will be "Saved Games" in Vista and newer + - Unit tests + + +### Changed + - The correct "Download" folder is now returned on Windows + - Now requires a C++11 compatible compiler (was C++98) + - Minimum Windows version raised from Windows XP to Windows 7. + - The Mac version no longer depends on CoreServices + - The XDG implementation are slightly more resilient to unrelated environments in user-dirs.dirs + - Improved CMake system + +### Removed + - C++98 compatibility + - Windows XP compatibility + - No longer needs CoreServices on Mac OS X + +## [3.2.0] 2018-05-28 + +### Added + - Stand-alone functions. Method calls are no longer needed or recommended. + +### Changed + - Fixed a bug in the xdg cache function that caused sago::getCacheDir() to return the wrong folder if XDG_CONFIG_HOME and/or XDG_CACHE_HOME were set + +## [3.1] 2018-04-21 + +### Added + - Now uses CMake for testing (Thanks @sum01) + - It is now possible to compile as a (static) library. (Thanks @sum01) + - Appveyor CI integration (Thanks @sum01) + +### Changed + - Optimised use of iterator. + - No longer keeps empty data structure on Mac and Windows platforms. + +## [3.0] 2016-10-08 + +### Changed + - On Windows the library now returns UTF-8 encoded paths as default. + +## [2.2] 2016-09-06 + +### Fixed + - Fixed a buffer overflow introduced in 2.1 (originally created to ensure C++03 compatibility) + - The example file no longer abuses namespaces. + + +## [2.1] 2016-02-22 + +### Changed + - Updated documentation URL + - No longer uses a variable length array internally + + +## [2.0] 2015-10-26 + +### Added +- Mac OS X support using Core Framework + +## [1.0] 2015-09-21 +Designed to work with Linux and Windows XP+ diff --git a/source/misc/embedded_libs/PlatformFolders-4.2.0/CMakeLists.txt b/source/misc/embedded_libs/PlatformFolders-4.2.0/CMakeLists.txt new file mode 100644 index 0000000..5ae2017 --- /dev/null +++ b/source/misc/embedded_libs/PlatformFolders-4.2.0/CMakeLists.txt @@ -0,0 +1,128 @@ +# For target_compile_features +cmake_minimum_required(VERSION 3.1.0 FATAL_ERROR) + +set(PLATFORMFOLDERS_MAIN_PROJECT OFF) +if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR) + set(PLATFORMFOLDERS_MAIN_PROJECT ON) +endif() + +project(platform_folders VERSION 4.2.0 LANGUAGES CXX) + +# BUILD_SHARED_LIBS is off by default, the library will be static by default +option(PLATFORMFOLDERS_BUILD_SHARED_LIBS "Build platform_folders shared library" ${BUILD_SHARED_LIBS}) +option(PLATFORMFOLDERS_BUILD_TESTING "Build platform_folders tests" ${PLATFORMFOLDERS_MAIN_PROJECT}) +option(PLATFORMFOLDERS_ENABLE_INSTALL "Enable platform_folders INSTALL target" ${PLATFORMFOLDERS_MAIN_PROJECT}) + +set(PLATFORMFOLDERS_TYPE STATIC) +if(PLATFORMFOLDERS_BUILD_SHARED_LIBS) + set(PLATFORMFOLDERS_TYPE SHARED) +endif() + +add_library(platform_folders ${PLATFORMFOLDERS_TYPE} + sago/platform_folders.cpp +) + +set_target_properties(platform_folders PROPERTIES DEBUG_POSTFIX "${CMAKE_DEBUG_POSTFIX}") + +# Creates an alias so that people building in-tree (instead of using find_package)... +# can still link against the same target +add_library(sago::platform_folders ALIAS platform_folders) + +# Defines standardized defaults for install paths +include(GNUInstallDirs) +# Where to search for the header while building +target_include_directories(platform_folders PUBLIC + $ + # Controls where #include starts to look from + # So /usr/include/ + # or C:\Program Files\platform_folders\include\ + $ +) + +# Define the header as public for installation +set_target_properties(platform_folders PROPERTIES + PUBLIC_HEADER "sago/platform_folders.h" +) + +# cxx_std_11 requires v3.8 +if(CMAKE_VERSION VERSION_LESS "3.8.0") + # Use old method of forcing C++11 + set(CMAKE_CXX_STANDARD 11) + set(CMAKE_CXX_STANDARD_REQUIRED true) +else() + # Require (minimum) C++11 when using header + # PRIVATE means only at compile time + target_compile_features(platform_folders PUBLIC cxx_std_11) +endif() + +# cxx_nullptr exists in v3.1 +target_compile_features(platform_folders PRIVATE cxx_nullptr) + +# Cmake's find_package search path is different based on the system +# See https://cmake.org/cmake/help/latest/command/find_package.html for the list +if(CMAKE_SYSTEM_NAME STREQUAL "Windows") + # You can pass these when calling Cmake, so don't override if the user does + if(NOT _WIN32_WINNT AND NOT WINVER) + target_compile_definitions(platform_folders PRIVATE + _WIN32_WINNT=0x0601 + WINVER=0x0601 + ) + endif() + # Controls where the exports, config, and configversion files install to + set(_PROJECT_INSTALL_CMAKE_DIR "${CMAKE_INSTALL_PREFIX}/cmake") +else() + # When calling find_package() + # it looks for /usr/lib/cmake//Config.cmake + set(_PROJECT_INSTALL_CMAKE_DIR "${CMAKE_INSTALL_LIBDIR}/cmake/platform_folders") +endif() + +if(PLATFORMFOLDERS_ENABLE_INSTALL) + # Gives "Make install" esque operations a location to install to... + # and creates a .cmake file to be exported + install(TARGETS platform_folders + EXPORT "platform_foldersConfig" + LIBRARY DESTINATION "${CMAKE_INSTALL_LIBDIR}" + ARCHIVE DESTINATION "${CMAKE_INSTALL_LIBDIR}" + # Tells it where to put the header files + PUBLIC_HEADER DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/sago" + ) + + # "The install(TARGETS) and install(EXPORT) commands work together to install a target and a file to help import it" + # Installs a cmake file which external projects can import. + install(EXPORT "platform_foldersConfig" + NAMESPACE sago:: + DESTINATION "${_PROJECT_INSTALL_CMAKE_DIR}" + ) + + # "The export command is used to generate a file exporting targets from a project build tree" + # Creates an import file for external projects which are aware of the build tree. + # May be useful for cross-compiling + export(TARGETS platform_folders + FILE "platform_folders-exports.cmake" + ) + + # For the config and configversion macros + include(CMakePackageConfigHelpers) + + # Creates the project's ConfigVersion.cmake file + # This allows for find_package() to use a version in the call + write_basic_package_version_file("${CMAKE_CURRENT_BINARY_DIR}/platform_foldersConfigVersion.cmake" + # This'll require versioning in the project() call + VERSION ${CMAKE_PROJECT_VERSION} + # Just assuming Semver is followed + COMPATIBILITY SameMajorVersion + ) + + # Install the ConfigVersion file, which is located in the build dir + install(FILES + "${CMAKE_CURRENT_BINARY_DIR}/platform_foldersConfigVersion.cmake" + DESTINATION "${_PROJECT_INSTALL_CMAKE_DIR}" + ) +endif() + +if(PLATFORMFOLDERS_BUILD_TESTING) + enable_testing() + add_subdirectory(test) + add_executable(platform_folders_sample platform_folders.cpp) + target_link_libraries(platform_folders_sample PRIVATE platform_folders) +endif() diff --git a/source/misc/embedded_libs/PlatformFolders-4.2.0/LICENSE b/source/misc/embedded_libs/PlatformFolders-4.2.0/LICENSE new file mode 100644 index 0000000..fe6d772 --- /dev/null +++ b/source/misc/embedded_libs/PlatformFolders-4.2.0/LICENSE @@ -0,0 +1,22 @@ +The MIT License (MIT) + +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. + diff --git a/source/misc/embedded_libs/PlatformFolders-4.2.0/README.md b/source/misc/embedded_libs/PlatformFolders-4.2.0/README.md new file mode 100644 index 0000000..e988ad5 --- /dev/null +++ b/source/misc/embedded_libs/PlatformFolders-4.2.0/README.md @@ -0,0 +1,178 @@ +# PlatformFolders [![Build Status](https://travis-ci.org/sago007/PlatformFolders.svg?branch=master)](https://travis-ci.org/sago007/PlatformFolders) [![AppVeyor](https://img.shields.io/appveyor/ci/sago007/PlatformFolders.svg?label=Windows)](https://ci.appveyor.com/project/sago007/platformfolders) [![license](https://img.shields.io/github/license/sago007/PlatformFolders.svg)](https://raw.githubusercontent.com/sago007/PlatformFolders/master/LICENSE) [![Join the chat at https://gitter.im/PlatformFolders/Lobby](https://badges.gitter.im/PlatformFolders/Lobby.svg)](https://gitter.im/PlatformFolders/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/729e36adcf5c4523bd136de1b33441cb)](https://www.codacy.com/app/github_43/PlatformFolders?utm_source=github.com&utm_medium=referral&utm_content=sago007/PlatformFolders&utm_campaign=Badge_Grade) + +A C++ library to look for directories like `My Documents`, `~/.config`, `%APPDATA%`, etc. so that you do not need to write platform-specific code + +[Source code](https://github.com/sago007/PlatformFolders) • [Latest release](https://github.com/sago007/PlatformFolders/releases/latest) • [Doxygen documentation](https://sago007.github.io/PlatformFolders/html/doxygen/) + +## Rationale + +There are a lot of platform abstraction libraries available. You can get graphics abstraction libraries, GUI abstraction libraries and file abstraction libraries. + +But folder abstraction seems to be more difficult. +My problem was that the code that found the place to save data was platform dependent. This cluttered my code and often I would not discover that it did not compile until moving it to the different platforms. + +[I have written a bit more about it here.](https://sago007.blogspot.dk/2015/10/abstraction-for-special-folders.html) + +There are some alternatives that you might consider instead: + +* [QStandardPaths](https://doc.qt.io/qt-5/qstandardpaths.html) +* [glib](https://developer.gnome.org/glib/stable/glib-Miscellaneous-Utility-Functions.html) + +Both are properly more mature than this library. However they are both parts of large frameworks and using them with libraries outside the framework may not be that simple. + +## Operating System Support + +### Windows + +For Windows, the current version fetches the folders using SHGetKnownFolderPath. This requires Vista or newer. + +### Linux + +This library uses the [XDG user-dirs.](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) + +It should work on any Unix system that has the following headers available: `pwd.h`, `unistd.h`, and `sys/types.h` + +### macOS + +Version 4.0.0 and forward uses hardcoded values for the directories on Mac OS X. Unlike the other operating systems the folders cannot be moved on a Mac and the translation is done in the UI. +The versions 2.X and 3.X uses the deprecated FSFindFolder, which requires the CoreServices framework during linking. +Version 1.X simple used the XDG specification. + +## Usage + +This project should be compatible with things like [Cmake's ExternalProject_Add](https://cmake.org/cmake/help/latest/module/ExternalProject.html?highlight=externalproject_add#command:externalproject_add) if you wish to use it in your project. + +You can also follow the [build step](#building) below to install at a system level, and use [Cmake's find_package](https://cmake.org/cmake/help/latest/command/find_package.html). + +```cmake +# Specifying a version is optional -- note it follows Semver +find_package(platform_folders 3.1.0 REQUIRED) +# Which imports the linkable library "sago::platform_folders" +# Use it like so... +target_link_libraries(EXEORLIBNAME PRIVATE sago::platform_folders) +``` + +Alternatively, you can just copy the [sago](https://github.com/sago007/PlatformFolders/tree/master/sago) folder into your program and manually link everything. +If you use the last option and are using a library version from before 4.0.0: Remember to link to the CoreServices lib when compiling on Mac. This typically means passing "-framework CoreServices" during the linking phase. + +Note that if you build in-tree, you can link against the Cmake alias `sago::platform_folders` just like if you had used find_package. + +### Building + +**Notes:** + +* Until 4.0.0 macOS required the CoreServices framework during linking. +* If you don't want to install, remove the `--target install` command. + +Linux/macOS: + +``` +mkdir -p build && cd build +cmake -DBUILD_TESTING=OFF -DCMAKE_BUILD_TYPE=Release .. +sudo cmake --build . --target install +``` + +Windows: + +``` +mkdir build && cd build +cmake -DBUILD_TESTING=OFF .. +runas /user:Administrator "cmake --build . --config Release --target install" +``` + +## Example Usage + +This sample program gets all folders from the system: + +```cpp +#include +#include +#include + +int main() +{ + std::cout << "Config: " << sago::getConfigHome() << "\n"; + std::cout << "Data: " << sago::getDataHome() << "\n"; + std::cout << "State: " << sago::getStateDir() << "\n"; + std::cout << "Cache: " << sago::getCacheDir() << "\n"; + std::cout << "Documents: " << sago::getDocumentsFolder() << "\n"; + std::cout << "Desktop: " << sago::getDesktopFolder() << "\n"; + std::cout << "Pictures: " << sago::getPicturesFolder() << "\n"; + std::cout << "Music: " << sago::getMusicFolder() << "\n"; + std::cout << "Video: " << sago::getVideoFolder() << "\n"; + std::cout << "Download: " << sago::getDownloadFolder() << "\n"; + std::cout << "Save Games 1: " << sago::getSaveGamesFolder1() << "\n"; + std::cout << "Save Games 2: " << sago::getSaveGamesFolder2() << "\n"; + return 0; +} +``` + +### Example Output + +#### On Linux + +``` +Config: /home/poul/.config +Data: /home/poul/.local/share +State: /home/poul/.local/state +Cache: /home/poul/.cache +Documents: /home/poul/Dokumenter +Desktop: /home/poul/Skrivebord +Pictures: /home/poul/Billeder +Music: /home/poul/Musik +Video: /home/poul/Videoklip +Download: /home/poul/Hentede filer +Save Games 1: /home/poul/.local/share +Save Games 2: /home/poul/.local/share +``` + +#### On Windows + +``` +Config: C:\users\poul\Application Data +Data: C:\users\poul\Application Data +State: C:\users\poul\Local Settings\Application Data +Cache: C:\users\poul\Local Settings\Application Data +Documents: C:\users\poul\Mine dokumenter +Desktop: C:\users\poul\Skrivebord +Pictures: C:\users\poul\Mine Billeder +Music: C:\users\poul\Min Musik +Video: C:\users\poul\Mine Film +Download: C:\users\poul\Downloads +Save Games 1: C:\users\poul\Mine dokumenter\My Games +Save Games 2: C:\users\poul\Saved Games +``` + +#### On macOS + +``` +Config: /Users/poul/Library/Application Support +Data: /Users/poul/Library/Application Support +State: /Users/poul/Library/Application Support +Cache: /Users/poul/Library/Caches +Documents: /Users/poul/Documents +Desktop: /Users/poul/Desktop +Pictures: /Users/poul/Pictures +Music: /Users/poul/Music +Video: /Users/poul/Movies +Download: /Users/poul/Downloads +Save Games 1: /Users/poul/Library/Application Support +Save Games 2: /Users/poul/Library/Application Support +``` + +## Compiler Compatibility + +Versions up to 3.X.X should compile with any C++98 compiler.\ +Versions from 4.0.0 and up require a C++11 compatible compiler. + +The aim is to always support the default C++ compiler on the oldest supported version of Ubuntu. This is a very basic library and it is not supposed to force you to upgrade. + +## Encoding + +From version 3.0, Windows always encodes to UTF-8, and this will be the default on almost any other system. +Before version 3.0, Windows was encoded in ANSI. +Although the user may use any characters they want, I recommend that the program should have only ASCII characters in the source code itself. + +# Licence + +Provided under the MIT license for the same reason XDG is licensed under it. So that you can quickly copy-paste the methods you need or just include the "sago"-folder. diff --git a/source/misc/embedded_libs/PlatformFolders-4.2.0/appveyor.yml b/source/misc/embedded_libs/PlatformFolders-4.2.0/appveyor.yml new file mode 100644 index 0000000..6a6ce96 --- /dev/null +++ b/source/misc/embedded_libs/PlatformFolders-4.2.0/appveyor.yml @@ -0,0 +1,75 @@ +# Notes: +# - Minimal appveyor.yml file is an empty file. All sections are optional. +# - Indent each level of configuration with 2 spaces. Do not use tabs! +# - All section names are case-sensitive. +# - Section names should be unique on each level. + +#---------------------------------# +# general configuration # +#---------------------------------# + +# version format +version: '{branch}-{build}' + +# branches to build +branches: + # blacklist + except: + - gh-pages + +#---------------------------------# +# environment configuration # +#---------------------------------# + +image: + - Visual Studio 2015 + - Visual Studio 2017 + +# build Configuration, i.e. Debug, Release, etc. +configuration: + - Debug + - Release + +platform: + - x86 + - x64 + +# clone directory +clone_folder: c:\projects\platform_folders + +# This and clone_depth speed up git cloning +# fetch repository as zip archive +shallow_clone: true + +# set clone depth +clone_depth: 1 + +# Generate the .sln file with Cmake before running MSBuild +before_build: + - cmd: mkdir "%APPVEYOR_BUILD_FOLDER%"\build + - cmd: cd "%APPVEYOR_BUILD_FOLDER%"\build + # I know this is ugly, but the matrix didn't work, and newlines seem to not be supported + - cmd: IF "%APPVEYOR_BUILD_WORKER_IMAGE%"=="Visual Studio 2015" (IF "%PLATFORM%"=="x86" (cmake -G "Visual Studio 14 2015" ..) ELSE (cmake -G "Visual Studio 14 2015 Win64" -T host=x64 ..)) ELSE (IF "%PLATFORM%"=="x86" (cmake -G "Visual Studio 15 2017" ..) ELSE (cmake -G "Visual Studio 15 2017 Win64" -T host=x64 ..)) + +# CMake generates the platform as "Win32" instead of "x86" when building 32-bit +# but 64-bit is "x64" +build_script: + - cmd: IF "%PLATFORM%"=="x86" (MSBuild.exe "%APPVEYOR_BUILD_FOLDER%"\build\platform_folders.sln /p:Configuration="%CONFIGURATION%" /p:Platform="Win32" /v:minimal /m /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll") ELSE (MSBuild.exe "%APPVEYOR_BUILD_FOLDER%"\build\platform_folders.sln /p:Configuration="%CONFIGURATION%" /p:Platform="%PLATFORM%" /v:minimal /m /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll") + +#---------------------------------# +# tests configuration # +#---------------------------------# + +# to run your custom scripts instead of automatic tests +# The %CONFIGURATION% and %PLATFORM% variables are set from Appveyor as env-vars +test_script: + - cmd: IF "%PLATFORM%"=="x86" (MSBuild.exe "%APPVEYOR_BUILD_FOLDER%"\build\RUN_TESTS.vcxproj /p:Configuration="%CONFIGURATION%" /p:Platform="Win32" /v:minimal /m) ELSE (MSBuild.exe "%APPVEYOR_BUILD_FOLDER%"\build\RUN_TESTS.vcxproj /p:Configuration="%CONFIGURATION%" /p:Platform="%PLATFORM%" /v:minimal /m) + +#---------------------------------# +# global handlers # +#---------------------------------# + +# on build failure dump cmake and test err log +on_failure: + - cmd: IF exist "%APPVEYOR_BUILD_FOLDER%"\build\CMakeFiles\CMakeError.log (type "%APPVEYOR_BUILD_FOLDER%"\build\CMakeFiles\CMakeError.log) + - cmd: IF exist "%APPVEYOR_BUILD_FOLDER%"\build\Testing\Temporary\LastTest.log (type "%APPVEYOR_BUILD_FOLDER%"\build\Testing\Temporary\LastTest.log) diff --git a/source/misc/embedded_libs/PlatformFolders-4.2.0/doxygen.conf b/source/misc/embedded_libs/PlatformFolders-4.2.0/doxygen.conf new file mode 100644 index 0000000..66b6a43 --- /dev/null +++ b/source/misc/embedded_libs/PlatformFolders-4.2.0/doxygen.conf @@ -0,0 +1,2384 @@ +# Doxyfile 1.8.9.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Platform folders" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = "4.2.0" + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = doxygen + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = NO + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = NO + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = sago + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = *.h + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +INPUT += README.md +USE_MDFILE_AS_MAINPAGE = README.md + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# compiled with the --with-libclang option. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /