4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Ruurd A. Reitsma
9 * Full author contact details are available in file CREDITS.
11 * wrap OS-specific stuff
17 #include "support/docstring.h"
25 UNIX, // Do we have to distinguish sh and csh?
29 /// Do some work just once.
30 void init(int argc, char * argv[]);
32 /// Returns the name of the NULL device (/dev/null, null).
33 std::string const & nulldev();
35 /// Returns "/" on *nix, "C:/", etc on Windows.
36 std::string current_root();
41 /// Name of the python interpreter
42 std::string const python();
44 /// Extract the path common to both @c p1 and @c p2. DBCS aware!
45 /// \p p1, \p p2 and the return value are encoded in utf8.
46 docstring::size_type common_path(docstring const & p1, docstring const & p2);
48 /// Converts a unix style path to host OS style.
49 /// \p p and the return value are encoded in utf8.
50 std::string external_path(std::string const & p);
52 /// Converts a host OS style path to unix style.
53 /// \p p and the return value are encoded in utf8.
54 std::string internal_path(std::string const & p);
56 /// Converts a unix style path list to host OS style.
57 /// \p p and the return value are encoded in utf8.
58 std::string external_path_list(std::string const & p);
60 /// Converts a host OS style path list to unix style.
61 /// \p p and the return value are encoded in utf8.
62 std::string internal_path_list(std::string const & p);
65 * Converts a unix style path into a form suitable for inclusion in a LaTeX
67 * \p p is encoded in utf8.
68 * Caution: This function handles only the OS specific part of that task.
69 * Never use it directly, use lyx::support::latex_path instead.
71 std::string latex_path(std::string const & p);
73 /// Is the path absolute?
74 /// \p p is encoded in utf8.
75 bool is_absolute_path(std::string const & p);
77 /** Returns a string suitable to be passed to popen when
80 char const * popen_read_mode();
82 /** The character used to separate paths returned by the
83 * PATH environment variable.
85 char path_separator();
87 /** If @c use_windows_paths is true, LyX will output Windows-style paths to
88 * latex files rather than posix ones. Obviously, this option is used only
91 void windows_style_tex_paths(bool use_windows_paths);
98 /** Check whether or not a file can be opened by a default viewer or editor.
99 * \param extension (without leading .)
100 * \param mode can be opened in VIEW or EDIT mode
101 * \returns whether or not the format can be opened according to \p mode
103 bool canAutoOpenFile(std::string const & ext, auto_open_mode const mode = VIEW);
105 /** View or edit a file with the default viewer or editor.
106 * \param filename file to open (encoded in utf8)
107 * \param mode open in VIEW or EDIT mode
108 * \returns whether or not the file is viewed (or edited) successfully.
110 bool autoOpenFile(std::string const & filename, auto_open_mode const mode = VIEW);
113 } // namespace support