* support/os_unix.C (canAutoOpen, autoOpenFile): on Mac OS X, use

[lyx.git] / src / support / os.h

diff --git a/src/support/os.h b/src/support/os.h
index 573010a8342a7a8efa2304322b81d943a28e159a..90cf569da2b1832709449d37204bb99021833587 100644 (file)
--- a/src/support/os.h
+++ b/src/support/os.h
@@ -1,52 +1,109 @@
-// 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
 
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include <string>
 
-#include "LString.h"
 
-/// 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 the name of the NULL device (/dev/null, null).
+std::string const & nulldev();
+
+/// Returns "/" on *nix, "C:/", etc on Windows.
+std::string current_root();
+
+///
+shell_type shell();
+
+/// Name of the python interpreter
+std::string const python();
+
+/// Extract the path common to both @c p1 and @c p2. 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);
+
+/// Converts a unix style path list to host OS style.
+std::string external_path_list(std::string const & p);
+
+/// Converts a host OS style path list to unix style.
+std::string internal_path_list(std::string const & p);
+
+/**
+ * Converts a unix style path into a form suitable for inclusion in a LaTeX
+ * document.
+ * Caution: This function handles only the OS specific part of that task.
+ * Never use it directly, use lyx::support::latex_path instead.
+ */
+std::string latex_path(std::string const & p);
+
+/// Is the path absolute?
+bool is_absolute_path(std::string const & p);
+
+/** Returns a string suitable to be passed to popen when
+ *  reading a file.
+ */
+char const * popen_read_mode();
+
+/** The character used to separate paths returned by the
+ *  PATH environment variable.
+ */
+char path_separator();
+
+/** If @c use_windows_paths is true, LyX will output Windows-style paths to
+ *  latex files rather than posix ones. Obviously, this option is used only
+ *  under Windows.
+ */
+void windows_style_tex_paths(bool use_windows_paths);
+
+enum auto_open_mode {
+       VIEW,
+       EDIT
 };
 
+/** Check whether or not a file can be opened by a default viewer or editor.
+ *  \param extension (without leading .)
+ *  \param mode can be opened in VIEW or EDIT mode
+ *  \returns whether or not the format can be opened according to \p mode
+ */
+bool canAutoOpenFile(std::string const & ext, auto_open_mode const mode = VIEW);
+
+/** View or edit a file with the default viewer or editor.
+ *  \param filename file to open
+ *  \param mode open in VIEW or EDIT mode
+ *  \returns whether or not the file is viewed (or edited) successfully.
+ */
+bool autoOpenFile(std::string const & filename, auto_open_mode const mode = VIEW);
+
+} // namespace os
+} // namespace support
+} // namespace lyx
+
 #endif