*
* Full author contact details are available in file CREDITS.
*
- * wrap OS specific stuff
+ * wrap OS-specific stuff
*/
#ifndef OS_H
namespace support {
namespace os {
-//
enum shell_type {
UNIX, // Do we have to distinguish sh and csh?
CMD_EXE
};
-// do some work just once
+/// Do some work just once.
void init(int argc, char * argv[]);
-// returns path of LyX binary
-std::string binpath();
-// returns name of LyX binary
-std::string binname();
-//
-void setTmpDir(std::string const & p);
-//
-std::string getTmpDir();
-//
+
+/// 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();
-// DBCS aware!
+
+/// 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);
-// no-op on UNIX, '\\'->'/' on OS/2 and Win32, ':'->'/' on MacOS, etc.
-std::string slashify_path(std::string const & p);
-// Converts a unix style path to host OS style.
+
+/// 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.
+
+/// Converts a host OS style path to unix style.
std::string internal_path(std::string const & p);
-// is path absolute?
+
+/// 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
-// same for popen().
- char const * popen_read_mode();
-//
-void warn(std::string const & mesg);
+
+/** 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