cmake/Source/cmWorkingDirectory.h

43 lines
1.4 KiB
C
Raw Normal View History

2017-07-20 19:35:53 +02:00
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
#ifndef cmWorkingDirectory_h
#define cmWorkingDirectory_h
#include "cmConfigure.h" // IWYU pragma: keep
#include <string>
/** \class cmWorkingDirectory
* \brief An RAII class to manipulate the working directory.
2018-08-09 18:06:22 +02:00
*
* 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.
2017-07-20 19:35:53 +02:00
*/
class cmWorkingDirectory
{
public:
cmWorkingDirectory(std::string const& newdir);
~cmWorkingDirectory();
2018-08-09 18:06:22 +02:00
bool SetDirectory(std::string const& newdir);
2017-07-20 19:35:53 +02:00
void Pop();
2018-08-09 18:06:22 +02:00
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; }
2017-07-20 19:35:53 +02:00
private:
std::string OldDir;
2018-08-09 18:06:22 +02:00
int ResultCode;
2017-07-20 19:35:53 +02:00
};
#endif