3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Ruurd A. Reitsma
7 * \author Claus Hentschel
8 * \author Angus Leeming
9 * \author Enrico Forestieri
11 * Full author contact details are available in file CREDITS.
13 * Various OS specific functions
18 #include "support/os.h"
20 #include "support/FileName.h"
21 #include "support/lstrings.h"
22 #include "support/debug.h"
32 #include <sys/cygwin.h>
42 bool windows_style_tex_paths_ = false;
44 // In both is_posix_path() and is_windows_path() it is assumed that
45 // a valid posix or pseudo-windows path is passed. They simply tell
46 // whether the path looks posix/pseudo-windows or not.
48 bool is_posix_path(string const & p)
51 (!contains(p, '\\') && (p.length() <= 1 || p[1] != ':'));
54 // This is a test for a win32 style path with forward slashes (pseudo-windows).
56 bool is_windows_path(string const & p)
58 return p.empty() || (!contains(p, '\\') && p[0] != '/');
68 /// Convert a path to or from posix style.
69 /// \p p is encoded in local 8bit encoding or utf8.
70 /// The result is returned in the same encoding as \p p.
71 string convert_path(string const & p, PathStyle const & target)
73 char path_buf[PATH_MAX];
75 if ((target == posix && is_posix_path(p)) ||
76 (target == windows && is_windows_path(p)))
81 // cygwin_conv_to_posix_path and cygwin_conv_to_win32_path do not
82 // care about the encoding.
84 cygwin_conv_to_posix_path(p.c_str(), path_buf);
86 cygwin_conv_to_win32_path(p.c_str(), path_buf);
88 return subst(path_buf[0] ? path_buf : p, '\\', '/');
92 /// Convert a path list to or from posix style.
93 /// \p p is encoded in local 8bit encoding or utf8.
94 /// The result is returned in the same encoding as \p p.
95 string convert_path_list(string const & p, PathStyle const & target)
100 char const * const pc = p.c_str();
101 PathStyle const actual = cygwin_posix_path_list_p(pc) ? posix : windows;
103 if (target != actual) {
104 int const target_size = (target == posix) ?
105 cygwin_win32_to_posix_path_list_buf_size(pc) :
106 cygwin_posix_to_win32_path_list_buf_size(pc);
108 char * ptr = new char[target_size];
111 // FIXME: See comment in convert_path() above
113 cygwin_win32_to_posix_path_list(pc, ptr);
115 cygwin_posix_to_win32_path_list(pc, ptr);
117 string path_list = subst(ptr, '\\', '/');
123 return subst(p, '\\', '/');
128 void init(int, char *[])
130 // Make sure that the TEMP variable is set
131 // and sync the Windows environment.
133 setenv("TEMP", "/tmp", false);
134 cygwin_internal(CW_SYNC_WINENV);
138 string current_root()
144 bool isFilesystemCaseSensitive()
150 docstring::size_type common_path(docstring const & p1, docstring const & p2)
152 docstring::size_type i = 0;
153 docstring::size_type const p1_len = p1.length();
154 docstring::size_type const p2_len = p2.length();
155 while (i < p1_len && i < p2_len && uppercase(p1[i]) == uppercase(p2[i]))
157 if ((i < p1_len && i < p2_len)
158 || (i < p1_len && p1[i] != '/' && i == p2_len)
159 || (i < p2_len && p2[i] != '/' && i == p1_len))
162 --i; // here was the last match
163 while (i && p1[i] != '/')
170 bool path_prefix_is(string const & path, string const & pre)
172 return path_prefix_is(const_cast<string &>(path), pre, CASE_UNCHANGED);
176 bool path_prefix_is(string & path, string const & pre, path_case how)
178 docstring const p1 = from_utf8(path);
179 docstring const p2 = from_utf8(pre);
180 docstring::size_type const p1_len = p1.length();
181 docstring::size_type const p2_len = p2.length();
182 docstring::size_type common_len = common_path(p1, p2);
184 if (p2[p2_len - 1] == '/' && p1_len != p2_len)
187 if (common_len != p2_len)
190 if (how == CASE_ADJUSTED && !prefixIs(path, pre)) {
191 if (p1_len < common_len)
192 path = to_utf8(p2.substr(0, p1_len));
194 path = to_utf8(p2 + p1.substr(common_len,
195 p1_len - common_len));
202 string external_path(string const & p)
204 return convert_path(p, PathStyle(posix));
208 string internal_path(string const & p)
210 return convert_path(p, PathStyle(posix));
214 string external_path_list(string const & p)
216 return convert_path_list(p, PathStyle(posix));
220 string internal_path_list(string const & p)
222 return convert_path_list(p, PathStyle(posix));
226 string latex_path(string const & p)
228 // We may need a posix style path or a windows style path (depending
229 // on windows_style_tex_paths_), but we use always forward slashes,
230 // since it gets written into a .tex file.
232 if (windows_style_tex_paths_ && FileName::isAbsolute(p)) {
233 string dos_path = convert_path(p, PathStyle(windows));
234 LYXERR(Debug::LATEX, "<Path correction for LaTeX> ["
235 << p << "]->>[" << dos_path << ']');
239 return convert_path(p, PathStyle(posix));
243 bool is_valid_strftime(string const & p)
245 string::size_type pos = p.find_first_of('%');
246 while (pos != string::npos) {
247 if (pos + 1 == string::npos)
249 if (!containsOnly(p.substr(pos + 1, 1),
250 "aAbBcCdDeEFgGhHIjklmMnOpPrRsStTuUVwWxXyYzZ%+"))
252 if (pos + 2 == string::npos)
254 pos = p.find_first_of('%', pos + 2);
260 // returns a string suitable to be passed to popen when
262 char const * popen_read_mode()
268 string const & nulldev()
270 static string const nulldev_ = "/dev/null";
275 bool is_terminal(io_channel channel)
277 return isatty(channel);
287 char path_separator()
293 void windows_style_tex_paths(bool use_windows_paths)
295 windows_style_tex_paths_ = use_windows_paths;
299 bool canAutoOpenFile(string const & ext, auto_open_mode const mode)
304 string const full_ext = "." + ext;
306 DWORD bufSize = MAX_PATH + 100;
307 TCHAR buf[MAX_PATH + 100];
308 // reference: http://msdn.microsoft.com/en-us/library/bb773471.aspx
309 char const * action = (mode == VIEW) ? "open" : "edit";
310 return S_OK == AssocQueryString(ASSOCF_INIT_IGNOREUNKNOWN,
311 ASSOCSTR_EXECUTABLE, full_ext.c_str(), action, buf, &bufSize);
315 bool autoOpenFile(string const & filename, auto_open_mode const mode)
317 // reference: http://msdn.microsoft.com/en-us/library/bb762153.aspx
318 string const win_path = to_local8bit(from_utf8(convert_path(filename, PathStyle(windows))));
319 char const * action = (mode == VIEW) ? "open" : "edit";
320 return reinterpret_cast<int>(ShellExecute(NULL, action,
321 win_path.c_str(), NULL, NULL, 1)) > 32;
325 string real_path(string const & path)
327 char rpath[PATH_MAX + 1];
328 char * result = realpath(path.c_str(), rpath);
329 return FileName::fromFilesystemEncoding(result ? rpath : path).absFilename();
333 } // namespace support