Program Listing for File filesystem_helper.hpp

↰ Return to documentation for file (include/rcpputils/filesystem_helper.hpp)

// Copyright (c) 2019, Open Source Robotics Foundation, Inc.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//    * Redistributions of source code must retain the above copyright
//      notice, this list of conditions and the following disclaimer.
//
//    * Redistributions in binary form must reproduce the above copyright
//      notice, this list of conditions and the following disclaimer in the
//      documentation and/or other materials provided with the distribution.
//
//    * Neither the name of the copyright holder nor the names of its
//      contributors may be used to endorse or promote products derived from
//      this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

// This file is originally from:
// https://github.com/ros/pluginlib/blob/1a4de29fa55173e9b897ca8ff57ebc88c047e0b3/pluginlib/include/pluginlib/impl/filesystem_helper.hpp

#ifndef RCPPUTILS__FILESYSTEM_HELPER_HPP_
#define RCPPUTILS__FILESYSTEM_HELPER_HPP_

#include <cstdint>
#include <filesystem>
#include <string>
#include <vector>

#include "rcpputils/visibility_control.hpp"

namespace rcpputils
{
namespace fs
{

#ifdef _WIN32
#  define RCPPUTILS_IMPL_OS_DIRSEP '\\'
#else
#  define RCPPUTILS_IMPL_OS_DIRSEP '/'
#endif

static constexpr const char kPreferredSeparator = RCPPUTILS_IMPL_OS_DIRSEP;

#undef RCPPUTILS_IMPL_OS_DIRSEP

// TODO(ahcorde): Remove deprecated class on the next release.
#if !defined(_WIN32)
# pragma GCC diagnostic push
# pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#else  // !defined(_WIN32)
# pragma warning(push)
# pragma warning(disable: 4996)
#endif
class [[deprecated("use std::filesystem instead of rcpputils::path")]] path
{
public:
  RCPPUTILS_PUBLIC
  path() = default;

  RCPPUTILS_PUBLIC
  path(const std::string & p);  // NOLINT(runtime/explicit): this is a conversion constructor

  RCPPUTILS_PUBLIC path(const path & p) = default;

  RCPPUTILS_PUBLIC path & operator=(const path &) = default;

  RCPPUTILS_PUBLIC std::string string() const;

  RCPPUTILS_PUBLIC bool exists() const;

  RCPPUTILS_PUBLIC bool is_directory() const noexcept;

  RCPPUTILS_PUBLIC bool is_regular_file() const noexcept;

  RCPPUTILS_PUBLIC uint64_t file_size() const;

  RCPPUTILS_PUBLIC bool empty() const;

  RCPPUTILS_PUBLIC bool is_absolute() const;

  RCPPUTILS_PUBLIC std::vector<std::string>::const_iterator cbegin() const;

  RCPPUTILS_PUBLIC std::vector<std::string>::const_iterator cend() const;

  RCPPUTILS_PUBLIC path parent_path() const;

  RCPPUTILS_PUBLIC path filename() const;

  RCPPUTILS_PUBLIC path extension() const;

  RCPPUTILS_PUBLIC path operator/(const std::string & other) const;

  RCPPUTILS_PUBLIC path & operator/=(const std::string & other);

  RCPPUTILS_PUBLIC path operator/(const path & other) const;

  RCPPUTILS_PUBLIC path & operator/=(const path & other);

private:
  std::string path_;
  std::vector<std::string> path_as_vector_;
};

[[deprecated("Please use std::filesystem::is_regular_file(..) instead")]]
RCPPUTILS_PUBLIC bool is_regular_file(const path & p) noexcept;

[[deprecated("Please use std::filesystem::is_directory(..) instead")]]
RCPPUTILS_PUBLIC bool is_directory(const path & p) noexcept;

[[deprecated("Please use std::filesystem::file_size(..) instead")]]
RCPPUTILS_PUBLIC uint64_t file_size(const path & p);

[[deprecated("Please use std::filesystem::exists(..) instead")]]
RCPPUTILS_PUBLIC bool exists(const path & path_to_check);


[[deprecated("Please use std::filesystem::temp_directory_path() instead")]]
RCPPUTILS_PUBLIC path temp_directory_path();

[[deprecated("Please use rcpputils::fs::create_temporary_directory(..) instead")]]
RCPPUTILS_PUBLIC path create_temp_directory(
  const std::string & base_name,
  const path & parent_path = path(std::filesystem::temp_directory_path().generic_string()));

RCPPUTILS_PUBLIC std::filesystem::path create_temporary_directory(
  const std::string & base_name,
  const std::filesystem::path & parent_path = std::filesystem::temp_directory_path(),
  size_t max_tries = 1000);

[[deprecated("Please use std::filesystem::current_path(..) instead")]]
RCPPUTILS_PUBLIC path current_path();

[[deprecated("Please use std::filesystem::create_directories(..) instead")]]
RCPPUTILS_PUBLIC bool create_directories(const path & p);

[[deprecated("Please use std::filesystem::remove(..) instead")]]
RCPPUTILS_PUBLIC bool remove(const path & p);

[[deprecated("Please use std::filesystem::remove_all(..) instead")]]
RCPPUTILS_PUBLIC bool remove_all(const path & p);

RCPPUTILS_PUBLIC path remove_extension(const path & file_path, int n_times = 1);

[[deprecated("This operator will be remove with the deprecated path class")]]
RCPPUTILS_PUBLIC bool operator==(const path & a, const path & b);
[[deprecated("This operator will be remove with the deprecated path class")]]
RCPPUTILS_PUBLIC bool operator!=(const path & a, const path & b);

[[deprecated("This operator will be remove with the deprecated path class")]]
RCPPUTILS_PUBLIC std::ostream & operator<<(std::ostream & os, const path & p);

// remove warning suppression
#if !defined(_WIN32)
# pragma GCC diagnostic pop
#else  // !defined(_WIN32)
# pragma warning(pop)
#endif
}  // namespace fs
}  // namespace rcpputils

#endif  // RCPPUTILS__FILESYSTEM_HELPER_HPP_