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/strfwd.h"
26 UNIX, // Do we have to distinguish sh and csh?
46 /// Do some work just once.
47 void init(int argc, char * argv[]);
49 /// Returns the name of the NULL device (/dev/null, null).
50 std::string const & nulldev();
52 /// Tells whether \p channel is connected to a terminal or not.
53 bool is_terminal(io_channel channel);
55 /// Returns "/" on *nix, "C:/", etc on Windows.
56 std::string current_root();
61 /// Name of the python interpreter
62 std::string const python();
65 bool isFilesystemCaseSensitive();
67 /// Extract the path common to both @c p1 and @c p2. DBCS aware!
68 /// \p p1 and \p p2 are encoded in ucs4, \returns the index to the end of
69 /// the last matching path component (the index may be pointing after the
70 /// end of @c p1 or @c p2 if their last char is not the path separator).
71 std::size_t common_path(docstring const & p1, docstring const & p2);
73 /// Converts a unix style path to host OS style.
74 /// \p p and the return value are encoded in utf8.
75 std::string external_path(std::string const & p);
77 /// Converts a host OS style path to unix style.
78 /// \p p and the return value are encoded in utf8.
79 std::string internal_path(std::string const & p);
81 /// Converts a host OS style path to a unicode safe unix style.
82 /// On Windows, this is achieved by using the short form of the path,
83 /// which can be safely passed to standard I/O functions expecting narrow
84 /// char paths even when the path contains non-ascii chars.
85 /// As the short form is only available for existing files, if the file is
86 /// to be accessed for writing, \param how should be set to CREATE.
87 /// \p p and the return value are encoded in utf8.
88 std::string safe_internal_path(std::string const & p, file_access how = EXISTING);
90 /// Converts a unix style path list to host OS style.
91 /// \p p and the return value are encoded in utf8.
92 std::string external_path_list(std::string const & p);
94 /// Converts a host OS style path list to unix style.
95 /// \p p and the return value are encoded in utf8.
96 std::string internal_path_list(std::string const & p);
99 * Converts a unix style path into a form suitable for inclusion in a LaTeX
101 * \p p is encoded in utf8.
102 * Caution: This function handles only the OS specific part of that task.
103 * Never use it directly, use lyx::support::latex_path instead.
105 std::string latex_path(std::string const & p);
107 /// Checks if the format string is suitable on the OS
108 bool is_valid_strftime(std::string const & p);
110 /** Returns a string suitable to be passed to popen when
113 char const * popen_read_mode();
115 /** The character used to separate paths returned by the
116 * PATH environment variable.
118 char path_separator();
120 /** If @c use_windows_paths is true, LyX will output Windows-style paths to
121 * latex files rather than posix ones. Obviously, this option is used only
124 void windows_style_tex_paths(bool use_windows_paths);
126 enum auto_open_mode {
131 /** Check whether or not a file can be opened by a default viewer or editor.
132 * \param extension (without leading .)
133 * \param mode can be opened in VIEW or EDIT mode
134 * \returns whether or not the format can be opened according to \p mode
136 bool canAutoOpenFile(std::string const & ext, auto_open_mode const mode = VIEW);
138 /** View or edit a file with the default viewer or editor.
139 * \param filename file to open (encoded in utf8)
140 * \param mode open in VIEW or EDIT mode
141 * \returns whether or not the file is viewed (or edited) successfully.
143 bool autoOpenFile(std::string const & filename, auto_open_mode const mode = VIEW);
145 /** Resolves a path such that it does not contain '.', '..', or symbolic links.
146 * \p path and the return value are encoded in utf8.
148 std::string real_path(std::string const & path);
150 /** Checks whether \param path starts with \param pre, accounting for case
151 * insensitive file systems.
153 bool path_prefix_is(std::string const & path, std::string const & pre);
155 /** Checks whether \param path starts with \param pre, accounting for case
156 * insensitive file systems. If true, the file system is case insensitive,
157 * and \param how == CASE_ADJUSTED, the case of the matching prefix in
158 * @c path is made equal to that of @c pre.
160 bool path_prefix_is(std::string & path, std::string const & pre, path_case how = CASE_UNCHANGED);
163 } // namespace support