// -*- 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
#pragma interface
#endif
-///
+
+/**
+ * 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:
- ///
+ /// change to the given directory
explicit
Path(string const & path)
: popped_(false)
{
- if (!path.empty()) {
- pushedDir_ = lyx::getcwd(); // GetCWD();
- if (pushedDir_.empty() || lyx::chdir(path)) {
- // should throw an exception
- // throw DirChangeError();
- // The use of WriteFSAlert makes this
- // impossible to inline.
- //WriteFSAlert(_("Error: Could not change to directory: "),
- // path);
- }
+ if (!path.empty()) {
+ pushedDir_ = lyx::getcwd();
+ if (pushedDir_.empty() || lyx::chdir(path))
+ /* FIXME: throw */;
} else {
popped_ = true;
}
}
- ///
+
+ /// set cwd to the previous value if needed
~Path()
{
if (!popped_) pop();
}
- ///
+
+ /// set cwd to the previous value if needed
int pop();
private:
- ///
+ /// whether we are in the new cwd or not
bool popped_;
- ///
+ /// the previous cwd
string pushedDir_;
};
#define Path(x) unnamed_Path;
// Tip gotten from Bobby Schmidt's column in C/C++ Users Journal
-#endif
+#endif // PATH_H