💿🐜 Antkeeper source code https://antkeeper.com
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

61 lines
1.9 KiB

5 years ago
  1. /*
  2. * Copyright (C) 2017-2019 Christopher J. Howard
  3. *
  4. * This file is part of Antkeeper Source Code.
  5. *
  6. * Antkeeper Source Code is free software: you can redistribute it and/or modify
  7. * it under the terms of the GNU General Public License as published by
  8. * the Free Software Foundation, either version 3 of the License, or
  9. * (at your option) any later version.
  10. *
  11. * Antkeeper Source Code is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU General Public License
  17. * along with Antkeeper Source Code. If not, see <http://www.gnu.org/licenses/>.
  18. */
  19. #ifndef FILESYSTEM_HPP
  20. #define FILESYSTEM_HPP
  21. #include <string>
  22. /**
  23. * Returns the absolute path to the current executable.
  24. *
  25. * @return Path to the application's executable.
  26. */
  27. std::string getExecutablePath();
  28. /**
  29. * Returns the absolute path to the directory containing application data.
  30. *
  31. * Windows: executableDirectory
  32. * GNU/Linux: executableDirectory/../share/applicationName/
  33. *
  34. * @param applicationName Name of the application.
  35. * @return Path to the application's data directory.
  36. */
  37. std::string getDataPath(const std::string& applicationName);
  38. /**
  39. * Returns the absolute path to the directory containing user-specific application data.
  40. *
  41. * Windows: %LOCALAPPDATA%\applicationName\
  42. * GNU/Linux: $XDG_CONFIG_HOME/applicationName/ or ~/.config/applicationName/ if $XDG_CONFIG_HOME is not set.
  43. *
  44. * @param applicationName Name of the application.
  45. * @return Path to the application's config directory.
  46. */
  47. std::string getConfigPath(const std::string& applicationName);
  48. /// Checks if a file or directory exists
  49. bool pathExists(const std::string& path);
  50. /// Creates a directory
  51. bool createDirectory(const std::string& path);
  52. #endif // FILESYSTEM_HPP