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
20 #include "support/os.h"
21 #include "support/os_win32.h"
23 #include "support/debug.h"
24 #include "support/environment.h"
25 #include "support/FileName.h"
26 #include "support/gettext.h"
27 #include "support/filetools.h"
28 #include "support/lstrings.h"
29 #include "support/ExceptionMessage.h"
30 #include "support/qstring_helpers.h"
32 #include "support/lassert.h"
40 #include <direct.h> // _getdrive
41 #include <shlobj.h> // SHGetFolderPath
46 // Must define SHGFP_TYPE_CURRENT for older versions of MinGW.
47 #if defined(__MINGW32__) || defined(__CYGWIN__) || defined(__CYGWIN32__)
49 # if __W32API_MAJOR_VERSION < 3 || \
50 __W32API_MAJOR_VERSION == 3 && __W32API_MINOR_VERSION < 2
51 # define SHGFP_TYPE_CURRENT 0
55 #if !defined(ASSOCF_INIT_IGNOREUNKNOWN) && !defined(__MINGW32__)
56 #define ASSOCF_INIT_IGNOREUNKNOWN 0
59 #if defined(__MINGW32__)
63 #if defined(_MSC_VER) && (_MSC_VER >= 1900)
66 extern void __wgetmainargs(int * argc, wchar_t *** argv, wchar_t *** envp,
67 int expand_wildcards, int * new_mode);
85 bool windows_style_tex_paths_ = true;
87 string cygdrive = "/cygdrive";
89 BOOL terminate_handler(DWORD event)
91 if (event == CTRL_CLOSE_EVENT
92 || event == CTRL_LOGOFF_EVENT
93 || event == CTRL_SHUTDOWN_EVENT) {
102 void init(int argc, char ** argv[])
104 /* Note from Angus, 17 Jan 2005:
106 * The code below is taken verbatim from Ruurd's original patch
107 * porting LyX to Win32.
109 * Windows allows us to define LyX either as a console-based app
110 * or as a GUI-based app. Ruurd decided to define LyX as a
111 * console-based app with a "main" function rather than a "WinMain"
112 * function as the point of entry to the program, but to
113 * immediately close the console window that Windows helpfully
114 * opens for us. Doing so allows the user to see all of LyX's
115 * debug output simply by running LyX from a DOS or MSYS-shell
118 * The alternative approach is to define LyX as a genuine
119 * GUI-based app, with a "WinMain" function as the entry point to the
120 * executable rather than a "main" function, so:
122 * #if defined (_WIN32)
123 * # define WIN32_LEAN_AND_MEAN
124 * # include <stdlib.h> // for __argc, __argv
125 * # include <windows.h> // for WinMain
128 * // This will require the "-mwindows" flag when linking with
129 * // gcc under MinGW.
130 * // For MSVC, use "/subsystem:windows".
131 * #if defined (_WIN32)
132 * int WINAPI WinMain(HINSTANCE, HINSTANCE, LPSTR, int)
134 * return mymain(__argc, __argv);
138 * where "mymain" is just a renamed "main".
140 * However, doing so means that the lyxerr messages would mysteriously
141 * disappear. They could be resurrected with something like:
145 * freopen("conin$","r",stdin);
146 * freopen("conout$","w",stdout);
147 * freopen("conout$","w",stderr);
150 * This code could be invoked (say) the first time that lyxerr
151 * is called. However, Ruurd has tried this route and found that some
152 * shell scripts failed, for mysterious reasons...
154 * I've chosen for now, therefore, to simply add Ruurd's original
155 * code as-is. A wrapper program hidecmd.c has been added to
156 * development/Win32 which hides the console window of lyx when
157 * lyx is invoked as a parameter of hidecmd.exe.
161 // Remove PYTHONPATH from the environment as it may point to an
162 // external python installation and cause reconfigure failures.
163 unsetEnv("PYTHONPATH");
166 #if defined(_MSC_VER) && (_MSC_VER >= 1900)
167 // Removing an argument from argv leads to an assertion on Windows
168 // when compiling with MSVC 2015 in debug mode (see bug #10440).
169 // To avoid this we make a copy of the array of pointers.
170 char ** newargv = (char **) malloc((argc + 1) * sizeof(char *));
172 memcpy(newargv, *argv, (argc + 1) * sizeof(char *));
175 lyxerr << "LyX warning: Cannot make a copy of "
176 "command line arguments!"
182 // Get the wide program arguments array
183 #if defined(_MSC_VER) && (_MSC_VER >= 1900)
184 argv_ = CommandLineToArgvW(GetCommandLineW(), &argc_);
188 __wgetmainargs(&argc_, &argv_, &envp, -1, &newmode);
190 LATTEST(argc == argc_);
192 // If Cygwin is detected, query the cygdrive prefix.
193 // The cygdrive prefix is needed for translating windows style paths
194 // to posix style paths in LaTeX files when the Cygwin teTeX is used.
198 DWORD bufsize = sizeof(buf);
199 LONG retval = ERROR_FILE_NOT_FOUND;
200 HKEY const mainkey[2] = { HKEY_LOCAL_MACHINE, HKEY_CURRENT_USER };
201 char const * const subkey[2] = {
202 "Software\\Cygwin\\setup", // Cygwin 1.7
203 "Software\\Cygnus Solutions\\Cygwin\\mounts v2\\/" // Prev. ver.
205 char const * const valuename[2] = {
206 "rootdir", // Cygwin 1.7 or later
207 "native" // Previous versions
209 // Check for newer Cygwin versions first, then older ones
210 for (i = 0; i < 2 && retval != ERROR_SUCCESS; ++i) {
211 for (int k = 0; k < 2 && retval != ERROR_SUCCESS; ++k)
212 retval = RegOpenKey(mainkey[k], subkey[i], &hkey);
214 if (retval == ERROR_SUCCESS) {
215 // Query the Cygwin root directory
216 retval = RegQueryValueEx(hkey, valuename[i - 1],
217 NULL, NULL, (LPBYTE) buf, &bufsize);
219 string const mount = string(buf) + "\\bin\\mount.exe";
220 if (retval == ERROR_SUCCESS && FileName(mount).exists()) {
222 runCommand(mount + " --show-cygdrive-prefix");
223 // The output of the mount command is as follows:
225 // /cygdrive system binmode
226 // So, we use the inner split to pass the second line
227 // to the outer split which sets cygdrive with its
228 // contents until the first blank, discarding the
229 // unneeded return value.
230 if (p.first != -1 && prefixIs(p.second, "Prefix"))
231 split(split(p.second, '\n'), cygdrive, ' ');
235 // Catch shutdown events.
236 SetConsoleCtrlHandler((PHANDLER_ROUTINE)terminate_handler, TRUE);
240 string utf8_argv(int i)
242 LASSERT(i < argc_, return "");
243 return fromqstr(QString::fromWCharArray(argv_[i]));
247 void remove_internal_args(int i, int num)
250 for (int j = i; j < argc_; ++j)
251 argv_[j] = argv_[j + num];
255 string current_root()
257 // _getdrive returns the current drive (1=A, 2=B, and so on).
258 char const drive = ::_getdrive() + 'A' - 1;
259 return string(1, drive) + ":/";
263 bool isFilesystemCaseSensitive()
269 docstring::size_type common_path(docstring const & p1, docstring const & p2)
272 size_t const p1_len = p1.length();
273 size_t const p2_len = p2.length();
274 while (i < p1_len && i < p2_len && uppercase(p1[i]) == uppercase(p2[i]))
276 if ((i < p1_len && i < p2_len)
277 || (i < p1_len && p1[i] != '/' && i == p2_len)
278 || (i < p2_len && p2[i] != '/' && i == p1_len))
281 --i; // here was the last match
282 while (i && p1[i] != '/')
289 bool path_prefix_is(string const & path, string const & pre)
291 return path_prefix_is(const_cast<string &>(path), pre, CASE_UNCHANGED);
295 bool path_prefix_is(string & path, string const & pre, path_case how)
297 docstring const p1 = from_utf8(path);
298 docstring const p2 = from_utf8(pre);
299 docstring::size_type const p1_len = p1.length();
300 docstring::size_type const p2_len = p2.length();
301 docstring::size_type common_len = common_path(p1, p2);
303 if (p2[p2_len - 1] == '/' && p1_len != p2_len)
306 if (common_len != p2_len)
309 if (how == CASE_ADJUSTED && !prefixIs(path, pre)) {
310 if (p1_len < common_len)
311 path = to_utf8(p2.substr(0, p1_len));
313 path = to_utf8(p2 + p1.substr(common_len,
314 p1_len - common_len));
321 string external_path(string const & p)
323 string const dos_path = subst(p, "/", "\\");
325 LYXERR(Debug::LATEX, "<Win32 path correction> ["
326 << p << "]->>[" << dos_path << ']');
331 static QString const get_long_path(QString const & short_path)
333 // GetLongPathNameW needs the path in utf16 encoding.
334 vector<wchar_t> long_path(MAX_PATH);
335 DWORD result = GetLongPathNameW((wchar_t *) short_path.utf16(),
336 &long_path[0], long_path.size());
338 if (result > long_path.size()) {
339 long_path.resize(result);
340 result = GetLongPathNameW((wchar_t *) short_path.utf16(),
341 &long_path[0], long_path.size());
342 LATTEST(result <= long_path.size());
345 return (result == 0) ? short_path : QString::fromWCharArray(&long_path[0]);
349 static QString const get_short_path(QString const & long_path, file_access how)
351 // CreateFileW and GetShortPathNameW need the path in utf16 encoding.
353 HANDLE h = CreateFileW((wchar_t *) long_path.utf16(),
354 GENERIC_WRITE, 0, NULL, CREATE_NEW,
355 FILE_ATTRIBUTE_NORMAL, NULL);
356 if (h == INVALID_HANDLE_VALUE
357 && GetLastError() != ERROR_FILE_EXISTS)
361 vector<wchar_t> short_path(MAX_PATH);
362 DWORD result = GetShortPathNameW((wchar_t *) long_path.utf16(),
363 &short_path[0], short_path.size());
365 if (result > short_path.size()) {
366 short_path.resize(result);
367 result = GetShortPathNameW((wchar_t *) long_path.utf16(),
368 &short_path[0], short_path.size());
369 LATTEST(result <= short_path.size());
372 return (result == 0) ? long_path : QString::fromWCharArray(&short_path[0]);
376 string internal_path(string const & p)
378 return subst(fromqstr(get_long_path(toqstr(p))), "\\", "/");
382 string safe_internal_path(string const & p, file_access how)
384 return subst(fromqstr(get_short_path(toqstr(p), how)), "\\", "/");
388 string external_path_list(string const & p)
390 return subst(p, '/', '\\');
394 string internal_path_list(string const & p)
396 return subst(p, '\\', '/');
400 string latex_path(string const & p)
402 // We may need a posix style path or a windows style path (depending
403 // on windows_style_tex_paths_), but we use always forward slashes,
404 // since it gets written into a .tex file.
406 if (!windows_style_tex_paths_ && FileName::isAbsolute(p)) {
407 string const drive = p.substr(0, 2);
408 string const cygprefix = cygdrive + "/" + drive.substr(0, 1);
409 string const cygpath = subst(subst(p, '\\', '/'), drive, cygprefix);
410 LYXERR(Debug::LATEX, "<Path correction for LaTeX> ["
411 << p << "]->>[" << cygpath << ']');
414 return subst(p, '\\', '/');
418 string latex_path_list(string const & p)
423 // We may need a posix style path or a windows style path (depending
424 // on windows_style_tex_paths_), but we use always forward slashes,
425 // since this is standard for all tex engines.
427 if (!windows_style_tex_paths_) {
429 for (size_t i = 0, k = 0; i != string::npos; k = i) {
431 string path = subst(p.substr(k, i - k), '\\', '/');
432 if (FileName::isAbsolute(path)) {
433 string const drive = path.substr(0, 2);
434 string const cygprefix = cygdrive + "/"
435 + drive.substr(0, 1);
436 path = subst(path, drive, cygprefix);
439 if (i != string::npos) {
446 return subst(p, '\\', '/');
450 // returns a string suitable to be passed to popen when
452 char const * popen_read_mode()
458 string const & nulldev()
460 static string const nulldev_ = "nul";
471 char path_separator(path_type type)
473 if (type == TEXENGINE)
474 return windows_style_tex_paths_ ? ';' : ':';
480 void windows_style_tex_paths(bool use_windows_paths)
482 windows_style_tex_paths_ = use_windows_paths;
486 GetFolderPath::GetFolderPath()
490 folder_module_ = LoadLibrary("shfolder.dll");
491 if (!folder_module_) {
492 throw ExceptionMessage(ErrorException, _("System file not found"),
493 _("Unable to load shfolder.dll\nPlease install."));
496 folder_path_func_ = reinterpret_cast<function_pointer>(::GetProcAddress(folder_module_, "SHGetFolderPathA"));
497 if (folder_path_func_ == 0) {
498 throw ExceptionMessage(ErrorException, _("System function not found"),
499 _("Unable to find SHGetFolderPathA in shfolder.dll\n"
500 "Don't know how to proceed. Sorry."));
505 GetFolderPath::~GetFolderPath()
508 FreeLibrary(folder_module_);
512 // Given a folder ID, returns the folder name (in unix-style format).
513 // Eg CSIDL_PERSONAL -> "C:/Documents and Settings/USERNAME/My Documents"
514 string const GetFolderPath::operator()(folder_id _id) const
516 char folder_path[MAX_PATH];
527 LASSERT(false, return string());
529 HRESULT const result = (folder_path_func_)(0, id, 0,
532 return (result == 0) ? os::internal_path(to_utf8(from_filesystem8bit(folder_path))) : string();
536 bool canAutoOpenFile(string const & ext, auto_open_mode const mode)
541 string const full_ext = "." + ext;
543 DWORD bufSize = MAX_PATH + 100;
544 TCHAR buf[MAX_PATH + 100];
545 // reference: http://msdn.microsoft.com/en-us/library/bb773471.aspx
546 char const * action = (mode == VIEW) ? "open" : "edit";
547 return S_OK == AssocQueryString(ASSOCF_INIT_IGNOREUNKNOWN,
548 ASSOCSTR_EXECUTABLE, full_ext.c_str(), action, buf, &bufSize);
552 bool autoOpenFile(string const & filename, auto_open_mode const mode,
555 string const texinputs = os::latex_path_list(
556 replaceCurdirPath(path, lyxrc.texinputs_prefix));
557 string const otherinputs = os::latex_path_list(path);
558 string const sep = windows_style_tex_paths_ ? ";" : ":";
559 string const oldtexinputs = getEnv("TEXINPUTS");
560 string const newtexinputs = "." + sep + texinputs + sep + oldtexinputs;
561 string const oldbibinputs = getEnv("BIBINPUTS");
562 string const newbibinputs = "." + sep + otherinputs + sep + oldbibinputs;
563 string const oldbstinputs = getEnv("BSTINPUTS");
564 string const newbstinputs = "." + sep + otherinputs + sep + oldbstinputs;
565 string const oldtexfonts = getEnv("TEXFONTS");
566 string const newtexfonts = "." + sep + otherinputs + sep + oldtexfonts;
567 if (!path.empty() && !lyxrc.texinputs_prefix.empty()) {
568 setEnv("TEXINPUTS", newtexinputs);
569 setEnv("BIBINPUTS", newbibinputs);
570 setEnv("BSTINPUTS", newbstinputs);
571 setEnv("TEXFONTS", newtexfonts);
574 QString const wname = toqstr(filename);
576 // reference: http://msdn.microsoft.com/en-us/library/bb762153.aspx
577 wchar_t const * action = (mode == VIEW) ? L"open" : L"edit";
578 bool success = reinterpret_cast<intptr_t>(ShellExecuteW(NULL, action,
579 reinterpret_cast<wchar_t const *>(wname.utf16()),
580 NULL, NULL, 1)) > 32;
582 if (!path.empty() && !lyxrc.texinputs_prefix.empty()) {
583 setEnv("TEXINPUTS", oldtexinputs);
584 setEnv("BIBINPUTS", oldbibinputs);
585 setEnv("BSTINPUTS", oldbstinputs);
586 setEnv("TEXFONTS", oldtexfonts);
592 string real_path(string const & path)
594 // See http://msdn.microsoft.com/en-us/library/aa366789(VS.85).aspx
595 QString const qpath = get_long_path(toqstr(path));
596 HANDLE hpath = CreateFileW((wchar_t *) qpath.utf16(), GENERIC_READ,
597 FILE_SHARE_READ, NULL, OPEN_EXISTING, 0, NULL);
599 if (hpath == INVALID_HANDLE_VALUE) {
600 // The file cannot be accessed.
604 // Get the file size.
606 DWORD size_lo = GetFileSize(hpath, &size_hi);
608 if (size_lo == 0 && size_hi == 0) {
609 // A zero-length file cannot be mapped.
614 // Create a file mapping object.
615 HANDLE hmap = CreateFileMapping(hpath, NULL, PAGE_READONLY, 0, 1, NULL);
622 // Create a file mapping to get the file name.
623 void * pmem = MapViewOfFile(hmap, FILE_MAP_READ, 0, 0, 1);
631 TCHAR realpath[MAX_PATH + 1];
633 if (!GetMappedFileName(GetCurrentProcess(), pmem, realpath, MAX_PATH)) {
634 UnmapViewOfFile(pmem);
640 // Translate device name to UNC prefix or drive letters.
641 TCHAR tmpbuf[MAX_PATH] = TEXT("\\Device\\Mup\\");
642 UINT namelen = _tcslen(tmpbuf);
643 if (_tcsnicmp(realpath, tmpbuf, namelen) == 0) {
645 _snprintf(tmpbuf, MAX_PATH, "\\\\%s", realpath + namelen);
646 strncpy(realpath, tmpbuf, MAX_PATH);
647 realpath[MAX_PATH] = '\0';
648 } else if (GetLogicalDriveStrings(MAX_PATH - 1, tmpbuf)) {
649 // Check whether device name corresponds to some local drive.
650 TCHAR name[MAX_PATH];
651 TCHAR drive[3] = TEXT(" :");
655 // Copy the drive letter to the template string
657 // Look up each device name
658 if (QueryDosDevice(drive, name, MAX_PATH)) {
659 namelen = _tcslen(name);
660 if (namelen < MAX_PATH) {
661 found = _tcsnicmp(realpath, name, namelen) == 0;
663 // Repl. device spec with drive
664 TCHAR tempfile[MAX_PATH];
673 realpath[MAX_PATH] = '\0';
677 // Advance p to the next NULL character.
679 } while (!found && *p);
681 UnmapViewOfFile(pmem);
684 string const retpath = subst(string(realpath), '\\', '/');
685 return FileName::fromFilesystemEncoding(retpath).absFileName();
689 } // namespace support