Filesystem.hpp

/* Copyright 2018-2025 Fabian Koller, Axel Huebl, Franz Poeschel
 *
 * This file is part of openPMD-api.
 *
 * openPMD-api is free software: you can redistribute it and/or modify
 * it under the terms of of either the GNU General Public License or
 * the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * openPMD-api 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 and the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * and the GNU Lesser General Public License along with openPMD-api.
 * If not, see <http://www.gnu.org/licenses/>.
 */
#pragma once
 
#include <string>
#include <vector>
 
#include "openPMD/config.hpp"
 
#if openPMD_HAVE_MPI
#include <mpi.h>
#endif
 
namespace openPMD
{
namespace auxiliary
{
#ifdef _WIN32
    static constexpr char const directory_separator = '\\';
#else
    static constexpr char const directory_separator = '/';
#endif

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

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

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

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

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

    bool remove_file(std::string const &path);
 
#if openPMD_HAVE_MPI
 
    std::string collective_file_read(std::string const &path, MPI_Comm);
 
#endif
} // namespace auxiliary
} // namespace openPMD