File.hpp 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  1. /*
  2. * Author: Patrick-Christopher Mattulat
  3. * Company: Lynar Studios
  4. * E-Mail: webmaster@lynarstudios.com
  5. * Created: 2020-08-15
  6. * Changed: 2023-02-22
  7. *
  8. * */
  9. #ifndef LS_STD_FILE_HPP
  10. #define LS_STD_FILE_HPP
  11. #include <ctime>
  12. #if defined(unix) || defined(__APPLE__)
  13. #include <dirent.h>
  14. #endif
  15. #include <list>
  16. #include <ls-std/core/Class.hpp>
  17. #include <ls-std/os/dynamic-goal.hpp>
  18. #include <string>
  19. #include <vector>
  20. #ifdef _WIN32
  21. #include <windows.h>
  22. #endif
  23. namespace ls::std::io
  24. {
  25. class LS_STD_DYNAMIC_GOAL File : public ls::std::core::Class
  26. {
  27. public:
  28. explicit File(::std::string _absoluteFilePath);
  29. ~File() noexcept override;
  30. // comparison operators
  31. bool operator==(ls::std::io::File &_file);
  32. bool operator!=(ls::std::io::File &_file);
  33. // additional functionality
  34. [[nodiscard]] bool canExecute();
  35. [[nodiscard]] bool canRead();
  36. [[nodiscard]] bool canWrite();
  37. void createNewFile();
  38. [[nodiscard]] bool exists();
  39. [[nodiscard]] ::std::string getAbsoluteFilePath();
  40. [[nodiscard]] ::std::string getName();
  41. [[nodiscard]] ::std::string getParent();
  42. [[nodiscard]] long getSize();
  43. [[nodiscard]] static ::std::string getWorkingDirectory();
  44. [[nodiscard]] bool isDirectory();
  45. [[nodiscard]] bool isFile();
  46. [[nodiscard]] time_t lastModified();
  47. [[nodiscard]] ::std::list<::std::string> list();
  48. [[nodiscard]] ::std::list<::std::string> listFiles();
  49. void makeDirectory();
  50. void makeDirectories();
  51. void remove();
  52. bool renameTo(const ::std::string &_newName); // nodiscard is optional here
  53. void reset(const ::std::string &_newPath);
  54. private:
  55. ::std::string absoluteFilePath{};
  56. #if defined(unix) || defined(__APPLE__)
  57. static void _addToFileListUnix(const ::std::string &_path, bool _withDirectories, dirent *directoryEntity, ::std::list<::std::string> &_list);
  58. #endif
  59. #ifdef _WIN32
  60. static void _addToFileListWindows(const ::std::string &_path, bool _withDirectories, WIN32_FIND_DATA _data, ::std::list<::std::string> &_list);
  61. #endif
  62. [[nodiscard]] static bool _equals(ls::std::io::File &_file, ls::std::io::File &_foreignFile);
  63. [[nodiscard]] static bool _exists(const ::std::string &_path);
  64. [[nodiscard]] static ::std::string _getParent(const ::std::string &_path);
  65. #if defined(unix) || defined(__APPLE__)
  66. [[nodiscard]] static ::std::string _getWorkingDirectoryUnix();
  67. #endif
  68. #ifdef _WIN32
  69. [[nodiscard]] static ::std::string _getWorkingDirectoryWindows();
  70. #endif
  71. [[nodiscard]] static bool _isDirectory(const ::std::string &_path);
  72. [[nodiscard]] static bool _isExecutable(const ::std::string &_path);
  73. [[nodiscard]] static bool _isFile(const ::std::string &_path);
  74. #if defined(unix) || defined(__APPLE__)
  75. [[nodiscard]] static bool _isReadableUnix(const ::std::string &_path);
  76. #endif
  77. #ifdef _WIN32
  78. [[nodiscard]] static bool _isReadableWindows(const ::std::string &_path);
  79. #endif
  80. [[nodiscard]] static bool _isWritable(const ::std::string &_path);
  81. [[nodiscard]] static time_t _lastModified(const ::std::string &_path);
  82. [[nodiscard]] static ::std::list<::std::string> _list(const ::std::string &_path);
  83. [[nodiscard]] static ::std::list<::std::string> _listFiles(const ::std::string &_path);
  84. #if defined(unix) || defined(__APPLE__)
  85. [[nodiscard]] static ::std::list<::std::string> _listUnix(const ::std::string &_path, bool withDirectories);
  86. #endif
  87. #ifdef _WIN32
  88. [[nodiscard]] static ::std::list<::std::string> _listWindows(const ::std::string &_path, bool withDirectories);
  89. #endif
  90. [[nodiscard]] static bool _makeDirectory(const ::std::string &_path);
  91. [[nodiscard]] static ::std::string _normalizePath(::std::string _path);
  92. [[nodiscard]] static ::std::string _reduceSeparators(const ::std::string &_path);
  93. static void _remove(const ::std::string &_path);
  94. #if defined(unix) || defined(__APPLE__)
  95. static void _removeUnix(const ::std::string &_path);
  96. #endif
  97. #ifdef _WIN32
  98. static void _removeWindows(const ::std::string &_path);
  99. #endif
  100. [[nodiscard]] static bool _renameTo(const ::std::string &_oldName, const ::std::string &_newName);
  101. [[nodiscard]] static ::std::string _replaceWrongSeparator(::std::string _path);
  102. [[nodiscard]] static ::std::vector<::std::string> _splitIntoSubDirectoryNames(const ::std::string &_path);
  103. };
  104. }
  105. #endif