// -*- C++ -*-
+/**
+ * \file path.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Lars Gullik Bjønnes
+ *
+ * Full author contact details are available in file CREDITS.
+ */
+
#ifndef PATH_H
#define PATH_H
-#include "LString.h"
-#include "support/filetools.h"
-#include "lyxlib.h"
+#include <boost/utility.hpp>
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include <string>
-///
-class Path {
+namespace lyx {
+namespace support {
+
+/**
+ * Path - utility closs for stackable working directories
+ *
+ * You can use a local variable of this type to temporarily
+ * change to a directory as the cwd, for example :
+ *
+ * if (blah) {
+ * Path p("/tmp/blah");
+ * ...
+ * }
+ *
+ * At the end of p's scope the cwd is reset to its previous value.
+ */
+class Path : boost::noncopyable {
public:
- ///
- Path(string const & path)
- : popped_(false)
- {
- if (!path.empty()) {
- pushedDir_ = GetCWD();
- if (pushedDir_.empty() || lyx::chdir(path.c_str())) {
- // should throw an exception
- // throw DirChangeError();
- // The use of WriteFSAlert makes this
- // impossible to inline.
- //WriteFSAlert(_("Error: Could not change to directory: "),
- // path);
- }
- } else {
- popped_ = true;
- }
- }
- ///
- ~Path()
- {
- if (!popped_) pop();
- }
- ///
+ /// change to the given directory
+ explicit Path(std::string const & path);
+
+ /// set cwd to the previous value if needed
+ ~Path();
+
+ /// set cwd to the previous value if needed
int pop();
private:
- ///
+ /// whether we are in the new cwd or not
bool popped_;
- ///
- string pushedDir_;
+ /// the previous cwd
+ std::string pushedDir_;
};
// To avoid the wrong usage:
// Path("/tmp"); // wrong
// Path p("/tmp"); // right
// we add this macro:
-#define Path(x) unnamed_Path;
+///
+// With boost 1.34 this is not usable anymore
+//#ifndef PATH_C
+//#define Path(x) unnamed_Path;
+//#endif
// Tip gotten from Bobby Schmidt's column in C/C++ Users Journal
-#endif
+} // namespace support
+} // namespace lyx
+
+#endif // PATH_H