gz/common/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 IGNITION_COMMON_FILESYSTEM_HH_
#define IGNITION_COMMON_FILESYSTEM_HH_
 
#include <memory>
#include <string>
 
#include <gz/common/config.hh>
#include <gz/common/Export.hh>
#include <gz/common/SuppressWarning.hh>
 
namespace ignition
{
  namespace common
  {
    enum FilesystemWarningOp
    {
      FSWO_LOG_WARNINGS = 0,
 
      FSWO_SUPPRESS_WARNINGS
    };
 
    bool IGNITION_COMMON_VISIBLE exists(const std::string &_path);
 
    bool IGNITION_COMMON_VISIBLE isDirectory(const std::string &_path);
 
    bool IGNITION_COMMON_VISIBLE isFile(const std::string &_path);
 
    bool IGNITION_COMMON_VISIBLE createDirectory(const std::string &_path);
 
    bool IGNITION_COMMON_VISIBLE createDirectories(const std::string &_path, std::ostream &_errorOut);
 
    bool IGNITION_COMMON_VISIBLE createDirectories(const std::string &_path);
 
    std::string IGNITION_COMMON_VISIBLE const separator(
        std::string const &_s);
 
    void IGNITION_COMMON_VISIBLE changeFromUnixPath(std::string &_path);
 
    std::string IGNITION_COMMON_VISIBLE copyFromUnixPath(
        const std::string &_path);
 
    void IGNITION_COMMON_VISIBLE changeToUnixPath(std::string &_path);
 
    std::string IGNITION_COMMON_VISIBLE copyToUnixPath(
        const std::string &_path);
 
    std::string IGNITION_COMMON_VISIBLE absPath(const std::string &_path);
 
    std::string IGNITION_COMMON_VISIBLE joinPaths(const std::string &_path1,
                                                  const std::string &_path2);
 
    inline std::string joinPaths(const std::string &_path)
    {
      return _path;
    }
 
    // The below is C++ variadic template magic to allow a joinPaths
    // method that takes 1-n number of arguments to append together.
 
    template<typename... Args>
    inline std::string joinPaths(const std::string &_path1,
                                 const std::string &_path2,
                                 Args const &..._args)
    {
      return joinPaths(joinPaths(_path1, _path2),
                       joinPaths(_args...));
    }
 
    std::string IGNITION_COMMON_VISIBLE cwd();
 
    bool IGNITION_COMMON_VISIBLE chdir(const std::string &_dir);
 
    std::string IGNITION_COMMON_VISIBLE basename(
        const std::string &_path);
 
    std::string IGNITION_COMMON_VISIBLE parentPath(
        const std::string &_path);
 
    bool IGNITION_COMMON_VISIBLE copyFile(
        const std::string &_existingFilename,
        const std::string &_newFilename,
        const FilesystemWarningOp _warningOp = FSWO_LOG_WARNINGS);
 
    bool IGNITION_COMMON_VISIBLE copyDirectory(
        const std::string &_existingDirname,
        const std::string &_newDirname,
        const FilesystemWarningOp _warningOp = FSWO_LOG_WARNINGS);
 
    bool IGNITION_COMMON_VISIBLE moveFile(
        const std::string &_existingFilename,
        const std::string &_newFilename,
        const FilesystemWarningOp _warningOp = FSWO_LOG_WARNINGS);
 
    bool IGNITION_COMMON_VISIBLE removeDirectory(
        const std::string &_path,
        const FilesystemWarningOp _warningOp = FSWO_LOG_WARNINGS);
 
    bool IGNITION_COMMON_VISIBLE removeFile(
        const std::string &_existingFilename,
        const FilesystemWarningOp _warningOp = FSWO_LOG_WARNINGS);
 
    bool IGNITION_COMMON_VISIBLE removeDirectoryOrFile(
        const std::string &_path,
        const FilesystemWarningOp _warningOp = FSWO_LOG_WARNINGS);
 
    bool IGNITION_COMMON_VISIBLE removeAll(
        const std::string &_path,
        const FilesystemWarningOp _warningOp = FSWO_LOG_WARNINGS);
 
    std::string IGNITION_COMMON_VISIBLE uniqueFilePath(
        const std::string &_pathAndName, const std::string &_extension);
 
    std::string IGNITION_COMMON_VISIBLE uniqueDirectoryPath(
        const std::string &_dir);
 
    class DirIterPrivate;
 
    class IGNITION_COMMON_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 SetInternalEmpty();
 
      private: void CloseHandle();
 
      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<DirIterPrivate> dataPtr;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
    };
  }
}
 
#endif