gz/common/TempDirectory.hh

Go to the documentation of this file.

/*
 * Copyright 2021 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_TEMPDIRECTORY_HH_
#define IGNITION_COMMON_TEMPDIRECTORY_HH_
 
#include <memory>
#include <string>
 
#include <gz/common/config.hh>
#include <gz/common/Export.hh>
#include <gz/common/Filesystem.hh>
 
namespace ignition
{
  namespace common
  {
    class TempDirectoryPrivate;
 
    std::string IGNITION_COMMON_VISIBLE tempDirectoryPath();
 
    std::string IGNITION_COMMON_VISIBLE createTempDirectory(
        const std::string &_baseName,
        const std::string &_parentPath,
        const FilesystemWarningOp _warningOp = FSWO_LOG_WARNINGS);
 
    class IGNITION_COMMON_VISIBLE TempDirectory
    {
      public: TempDirectory(const std::string &_prefix = "temp_dir",
                            const std::string &_subDir = "ignition",
                            bool _cleanup = true);
 
      public: ~TempDirectory();
 
      public: bool Valid() const;
 
      public: void DoCleanup(bool _doCleanup);
 
      public: bool DoCleanup() const;
 
      public: std::string Path() const;
 
      IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
      private: std::unique_ptr<TempDirectoryPrivate> dataPtr;
      IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
    };
  }  // namespace common
}  // namespace ignition
#endif  // IGNITION_COMMON_TEMPDIRECTORY_HH_