blame: source/code/os.hpp

/*

===========================================================================

blockattack - Block Attack - Rise of the Blocks

Copyright (C) 2005-2015 Poul Sander

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 2 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program.  If not, see http://www.gnu.org/licenses/

Source information and contacts persons can be found at

https://blockattack.net

===========================================================================

*/

#ifndef OS_HPP

#define OS_HPP

#if defined(_WIN32)

#include "windows.h"

#include "shlobj.h"

#endif

#include <string>

#include <vector>

std::string getPathToSaveFiles();

std::string defaultPlayerName();

void setPathToSaveFiles(const std::string& path);

void OsCreateSaveFolder();

bool OsPathIsRelative(const std::string& path);

/**

 * Create a folder

 * The folder path is created recursively

 * Fails silently if failing to create the path

 * @param path The folder to create

 */

void OsCreateFolder(const std::string& path);

/**

 * Lists the content of a directory.

 * Ignores files starting with a dot (".")

 *

 * @param path The path to list

 * @return std::vector<std::string> Files names in directory

 */

std::vector<std::string> OsGetDirFileList(const std::string& path);

#endif  /* OS_HPP */