Filesystem.hh

Go to the documentation of this file.

/*
 * Copyright 2017 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

#ifndef SDF_FILESYSTEM_HH_
#define SDF_FILESYSTEM_HH_

#include <memory>
#include <string>

#include <sdf/sdf_config.h>
#include "sdf/system_util.hh"

#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::unique_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif

namespace sdf
{
  // Inline bracke to help doxygen filtering.
  inline namespace SDF_VERSION_NAMESPACE {
  //

  namespace filesystem
  {
    SDFORMAT_VISIBLE
    bool exists(const std::string &_path);

    SDFORMAT_VISIBLE
    bool is_directory(const std::string &_path);

    SDFORMAT_VISIBLE
    bool create_directory(const std::string &_path);

    // The below is C++ variadic template magic to allow an append
    // method that takes 1-n number of arguments to append together.

    SDFORMAT_VISIBLE
    std::string const separator(std::string const &_s);

    template<typename... Args>
    std::string append(Args const &... args)
    {
      std::string result;
      int unpack[] {
        0, (result += separator(args), 0)...};
      static_cast<void>(unpack);
      return result.substr(0, result.length() - 1);
    }

    SDFORMAT_VISIBLE
    std::string current_path();

    SDFORMAT_VISIBLE
    std::string basename(const std::string &_path);

    class DirIterPrivate;

    class SDFORMAT_VISIBLE DirIter
    {
      public: explicit DirIter(const std::string &_in);

      public: DirIter();

      public: std::string operator*() const;

      public: const DirIter& operator++();

      public: bool operator!=(const DirIter &_other) const;

      public: ~DirIter();

      private: void next();

      private: void set_internal_empty();

      private: void close_handle();

      private: std::unique_ptr<DirIterPrivate> dataPtr;
    };
  }
  }
}

#ifdef _WIN32
#pragma warning(pop)
#endif

#endif