// -*- 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 <unistd.h>
#include "LString.h"
-#include "gettext.h"
-#include "support/filetools.h"
-#include "lyx_gui_misc.h"
#include "lyxlib.h"
+#include <boost/utility.hpp>
+
+namespace lyx {
+namespace support {
-class Path {
+/**
+ * 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_ = GetCWD();
- if (pushedDir_.empty() || lyx::chdir(path.c_str())) {
- WriteFSAlert(_("Error: Could not change to directory: "),
- path);
- }
+ if (!path.empty()) {
+ pushedDir_ = getcwd();
+ if (pushedDir_.empty() || chdir(path))
+ /* FIXME: throw */;
} else {
popped_ = true;
}
}
- ///
+
+ /// set cwd to the previous value if needed
~Path()
{
if (!popped_) pop();
}
- ///
- int pop()
- {
- if (popped_) {
- WriteFSAlert(_("Error: Dir already popped: "),
- pushedDir_);
- return 0;
- }
- if (lyx::chdir(pushedDir_.c_str())) {
- WriteFSAlert(
- _("Error: Could not change to directory: "),
- pushedDir_);
- }
- popped_ = true;
- return 0;
- }
+
+ /// 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_;
};
-#endif
+// To avoid the wrong usage:
+// Path("/tmp"); // wrong
+// Path p("/tmp"); // right
+// we add this macro:
+///
+#define Path(x) unnamed_Path;
+// Tip gotten from Bobby Schmidt's column in C/C++ Users Journal
+
+} // namespace support
+} // namespace lyx
+
+#endif // PATH_H