openPMD-api
Filesystem.hpp
1 /* Copyright 2018-2021 Fabian Koller
2  *
3  * This file is part of openPMD-api.
4  *
5  * openPMD-api is free software: you can redistribute it and/or modify
6  * it under the terms of of either the GNU General Public License or
7  * the GNU Lesser 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  * openPMD-api 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 and the GNU Lesser General Public License
15  * for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * and the GNU Lesser General Public License along with openPMD-api.
19  * If not, see <http://www.gnu.org/licenses/>.
20  */
21 #pragma once
22 
23 #include <string>
24 #include <vector>
25 
26 #include "openPMD/config.hpp"
27 
28 #if openPMD_HAVE_MPI
29 #include <mpi.h>
30 #endif
31 
32 namespace openPMD
33 {
34 namespace auxiliary
35 {
36 #ifdef _WIN32
37  static constexpr char const directory_separator = '\\';
38 #else
39  static constexpr char const directory_separator = '/';
40 #endif
41 
48  bool directory_exists(std::string const &path);
49 
56  bool file_exists(std::string const &path);
57 
67  std::vector<std::string> list_directory(std::string const &path);
68 
78  bool create_directories(std::string const &path);
79 
87  bool remove_directory(std::string const &path);
88 
96  bool remove_file(std::string const &path);
97 
98 #if openPMD_HAVE_MPI
99 
100  std::string collective_file_read(std::string const &path, MPI_Comm);
101 
102 #endif
103 } // namespace auxiliary
104 } // namespace openPMD
Public definitions of openPMD-api.
Definition: Date.cpp:28