]> git.lyx.org Git - lyx.git/blobdiff - src/support/os.h
Remove executable status info from typeIndicator.
[lyx.git] / src / support / os.h
index 0364f724a4200263fc616d55cb55cb8338be5c88..bb4a0231391a7b11a0709704ab1de049a2405448 100644 (file)
@@ -1,48 +1,66 @@
-// os.h copyright "Ruurd A. Reitsma" <R.A.Reitsma@wbmt.tudelft.nl>
+// -*- C++ -*-
+/**
+ * \file os.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Ruurd A. Reitsma
+ *
+ * Full author contact details are available in file CREDITS.
+ *
+ * wrap OS-specific stuff
+ */
 
 #ifndef OS_H
 #define OS_H
 
-#include "LString.h"
+#include <string>
 
-/// wrap OS specific stuff
+
+namespace lyx {
+namespace support {
 namespace os {
-       //
-       enum shell_type {
-               UNIX,   // Do we have to distinguish sh and csh?
-               CMD_EXE
-       };
-
-       // do some work just once
-       void init(int * argc, char ** argv[]);
-       // returns path of LyX binary
-       string binpath();
-       // returns name of LyX binary
-       string binname();
-       // system_tempdir actually doesn't belong here
-       // I put it here only to avoid a global variable.
-       void setTmpDir(string const & p);
-       // 
-       string getTmpDir();
-       //
-       string current_root();
-       //
-       shell_type shell();
-       // DBCS aware!
-       string::size_type common_path(string const & p1, string const & p2);
-       // no-op on UNIX, '\\'->'/' on OS/2 and Win32, ':'->'/' on MacOS, etc.
-       string slashify_path(string const & p);
-       // converts a host OS path to unix style
-       string external_path(string const & p);
-       // converts a unix path to host OS style
-       string internal_path(string const & p);
-       // is path absolute?
-       bool is_absolute_path(string const & p);
-       // returns a string suitable to be passed to popen when
-       // same for popen().
-       char const * popen_read_mode();
-       //
-       void warn(string const & mesg);
+
+//
+enum shell_type {
+       UNIX,   // Do we have to distinguish sh and csh?
+       CMD_EXE
 };
 
+// do some work just once
+void init(int argc, char * argv[]);
+// returns path of LyX binary
+std::string const & binpath();
+// returns name of LyX binary
+std::string const & binname();
+//
+void setTmpDir(std::string const & p);
+//
+std::string const & getTmpDir();
+// Returns the user's home directory ($HOME in the unix world).
+std::string const & homepath();
+// Returns the name of the NULL device (/dev/null, null).
+std::string const & nulldev();
+//
+std::string current_root();
+//
+shell_type shell();
+// DBCS aware!
+std::string::size_type common_path(std::string const & p1, std::string const & p2);
+// Converts a unix style path to host OS style.
+std::string external_path(std::string const & p);
+// Converts a host OS style path to unix style.
+std::string internal_path(std::string const & p);
+// is path absolute?
+bool is_absolute_path(std::string const & p);
+// returns a string suitable to be passed to popen when
+// same for popen().
+       char const * popen_read_mode();
+//
+void warn(std::string const & mesg);
+
+} // namespace os
+} // namespace support
+} // namespace lyx
+
 #endif