Files
CMake/Source/cmWorkingDirectory.h
Kitware Robot bdca8b01d2 Modernize: Use #pragma once in all header files
#pragma once is a widely supported compiler pragma, even though it is
not part of the C++ standard. Many of the issues keeping #pragma once
from being standardized (distributed filesystems, build farms, hard
links, etc.) do not apply to CMake - it is easy to build CMake on a
single machine. CMake also does not install any header files which can
be consumed by other projects (though cmCPluginAPI.h has been
deliberately omitted from this conversion in case anyone is still using
it.) Finally, #pragma once has been required to build CMake since at
least August 2017 (7f29bbe6 enabled server mode unconditionally, which
had been using #pragma once since September 2016 (b13d3e0d)). The fact
that we now require C++11 filters out old compilers, and it is unlikely
that there is a compiler which supports C++11 but does not support
#pragma once.
2020-09-03 09:30:21 -04:00

45 lines
1.5 KiB
C++

/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
#pragma once
#include "cmConfigure.h" // IWYU pragma: keep
#include <string>
/** \class cmWorkingDirectory
* \brief An RAII class to manipulate the working directory.
*
* The current working directory is set to the location given to the
* constructor. The working directory can be changed again as needed
* by calling SetDirectory(). When the object is destroyed, the destructor
* will restore the working directory to what it was when the object was
* created, regardless of any calls to SetDirectory() in the meantime.
*/
class cmWorkingDirectory
{
public:
cmWorkingDirectory(std::string const& newdir);
~cmWorkingDirectory();
cmWorkingDirectory(const cmWorkingDirectory&) = delete;
cmWorkingDirectory& operator=(const cmWorkingDirectory&) = delete;
bool SetDirectory(std::string const& newdir);
void Pop();
bool Failed() const { return ResultCode != 0; }
/** \return 0 if the last attempt to set the working directory was
* successful. If it failed, the value returned will be the
* \c errno value associated with the failure. A description
* of the error code can be obtained by passing the result
* to \c std::strerror().
*/
int GetLastResult() const { return ResultCode; }
std::string const& GetOldDirectory() const { return this->OldDir; }
private:
std::string OldDir;
int ResultCode;
};