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
10 * Full author contact details are available in file CREDITS.
12 * Various OS specific functions
17 #include "support/os.h"
18 #include "support/os_win32.h"
20 #include "support/debug.h"
21 #include "support/FileName.h"
22 #include "support/gettext.h"
23 #include "support/filetools.h"
24 #include "support/lstrings.h"
25 #include "support/ExceptionMessage.h"
27 #include "support/lassert.h"
32 /* The GetLongPathName macro may be defined on the compiling machine,
33 * but we must use a bit of trickery if the resulting executable is
34 * to run on a Win95 machine.
35 * Fortunately, Microsoft provide the trickery. All we need is the
36 * NewAPIs.h header file, available for download from Microsoft as
37 * part of the Platform SDK.
39 #if defined (HAVE_NEWAPIS_H)
40 // This should be defined already to keep Boost.Filesystem happy.
41 # if !defined (WANT_GETFILEATTRIBUTESEX_WRAPPER)
42 # error Expected WANT_GETFILEATTRIBUTESEX_WRAPPER to be defined!
44 # define WANT_GETLONGPATHNAME_WRAPPER 1
45 # define COMPILE_NEWAPIS_STUBS
47 # undef COMPILE_NEWAPIS_STUBS
48 # undef WANT_GETLONGPATHNAME_WRAPPER
52 #include <direct.h> // _getdrive
53 #include <shlobj.h> // SHGetFolderPath
58 // Must define SHGFP_TYPE_CURRENT for older versions of MinGW.
59 #if defined(__MINGW32__) || defined(__CYGWIN__) || defined(__CYGWIN32__)
61 # if __W32API_MAJOR_VERSION < 3 || \
62 __W32API_MAJOR_VERSION == 3 && __W32API_MINOR_VERSION < 2
63 # define SHGFP_TYPE_CURRENT 0
67 #if !defined(ASSOCF_INIT_IGNOREUNKNOWN) && !defined(__MINGW32__)
68 #define ASSOCF_INIT_IGNOREUNKNOWN 0
75 void emergencyCleanup();
82 bool windows_style_tex_paths_ = true;
84 string cygdrive = "/cygdrive";
86 BOOL terminate_handler(DWORD event)
88 if (event == CTRL_CLOSE_EVENT
89 || event == CTRL_LOGOFF_EVENT
90 || event == CTRL_SHUTDOWN_EVENT) {
91 lyx::emergencyCleanup();
99 void init(int /* argc */, char * argv[])
101 /* Note from Angus, 17 Jan 2005:
103 * The code below is taken verbatim from Ruurd's original patch
104 * porting LyX to Win32.
106 * Windows allows us to define LyX either as a console-based app
107 * or as a GUI-based app. Ruurd decided to define LyX as a
108 * console-based app with a "main" function rather than a "WinMain"
109 * function as the point of entry to the program, but to
110 * immediately close the console window that Windows helpfully
111 * opens for us. Doing so allows the user to see all of LyX's
112 * debug output simply by running LyX from a DOS or MSYS-shell
115 * The alternative approach is to define LyX as a genuine
116 * GUI-based app, with a "WinMain" function as the entry point to the
117 * executable rather than a "main" function, so:
119 * #if defined (_WIN32)
120 * # define WIN32_LEAN_AND_MEAN
121 * # include <stdlib.h> // for __argc, __argv
122 * # include <windows.h> // for WinMain
125 * // This will require the "-mwindows" flag when linking with
126 * // gcc under MinGW.
127 * // For MSVC, use "/subsystem:windows".
128 * #if defined (_WIN32)
129 * int WINAPI WinMain(HINSTANCE, HINSTANCE, LPSTR, int)
131 * return mymain(__argc, __argv);
135 * where "mymain" is just a renamed "main".
137 * However, doing so means that the lyxerr messages would mysteriously
138 * disappear. They could be resurrected with something like:
142 * freopen("conin$","r",stdin);
143 * freopen("conout$","w",stdout);
144 * freopen("conout$","w",stderr);
147 * This code could be invoked (say) the first time that lyxerr
148 * is called. However, Ruurd has tried this route and found that some
149 * shell scripts failed, for mysterious reasons...
151 * I've chosen for now, therefore, to simply add Ruurd's original
152 * code as-is. A wrapper program hidecmd.c has been added to
153 * development/Win32 which hides the console window of lyx when
154 * lyx is invoked as a parameter of hidecmd.exe.
157 // If cygwin is detected, query the cygdrive prefix
160 DWORD bufSize = sizeof(buf);
163 retVal = RegOpenKeyEx(HKEY_LOCAL_MACHINE,
164 "Software\\Cygnus Solutions\\Cygwin\\mounts v2",
165 0, KEY_QUERY_VALUE, ®Key);
166 if (retVal != ERROR_SUCCESS) {
167 retVal = RegOpenKeyEx(HKEY_CURRENT_USER,
168 "Software\\Cygnus Solutions\\Cygwin\\mounts v2",
169 0, KEY_QUERY_VALUE, ®Key);
171 if (retVal == ERROR_SUCCESS) {
172 retVal = RegQueryValueEx(regKey, "cygdrive prefix", NULL, NULL,
173 (LPBYTE) buf, &bufSize);
175 if ((retVal == ERROR_SUCCESS) && (bufSize <= MAX_PATH))
176 cygdrive = rtrim(string(buf), "/");
179 // Catch shutdown events.
180 SetConsoleCtrlHandler((PHANDLER_ROUTINE)terminate_handler, TRUE);
184 string current_root()
186 // _getdrive returns the current drive (1=A, 2=B, and so on).
187 char const drive = ::_getdrive() + 'A' - 1;
188 return string(1, drive) + ":/";
192 bool isFilesystemCaseSensitive()
198 docstring::size_type common_path(docstring const & p1, docstring const & p2)
201 size_t const p1_len = p1.length();
202 size_t const p2_len = p2.length();
203 while (i < p1_len && i < p2_len && uppercase(p1[i]) == uppercase(p2[i]))
205 if ((i < p1_len && i < p2_len)
206 || (i < p1_len && p1[i] != '/' && i == p2_len)
207 || (i < p2_len && p2[i] != '/' && i == p1_len))
210 --i; // here was the last match
211 while (i && p1[i] != '/')
218 bool path_prefix_is(string const & path, string const & pre)
220 return path_prefix_is(const_cast<string &>(path), pre, CASE_UNCHANGED);
224 bool path_prefix_is(string & path, string const & pre, path_case how)
226 docstring const p1 = from_utf8(path);
227 docstring const p2 = from_utf8(pre);
228 docstring::size_type const p1_len = p1.length();
229 docstring::size_type const p2_len = p2.length();
230 docstring::size_type common_len = common_path(p1, p2);
232 if (p2[p2_len - 1] == '/' && p1_len != p2_len)
235 if (common_len != p2_len)
238 if (how == CASE_ADJUSTED && !prefixIs(path, pre)) {
239 if (p1_len < common_len)
240 path = to_utf8(p2.substr(0, p1_len));
242 path = to_utf8(p2 + p1.substr(common_len,
243 p1_len - common_len));
250 string external_path(string const & p)
252 string const dos_path = subst(p, "/", "\\");
254 LYXERR(Debug::LATEX, "<Win32 path correction> ["
255 << p << "]->>[" << dos_path << ']');
260 static string const get_long_path(string const & short_path)
262 // GetLongPathName needs the path in file system encoding.
263 // We can use to_local8bit, since file system encoding and the
264 // local 8 bit encoding are identical on windows.
265 vector<char> long_path(MAX_PATH);
266 DWORD result = GetLongPathName(to_local8bit(from_utf8(short_path)).c_str(),
267 &long_path[0], long_path.size());
269 if (result > long_path.size()) {
270 long_path.resize(result);
271 result = GetLongPathName(short_path.c_str(),
272 &long_path[0], long_path.size());
273 LASSERT(result <= long_path.size(), /**/);
276 return (result == 0) ? short_path : to_utf8(from_filesystem8bit(&long_path[0]));
280 string internal_path(string const & p)
282 return subst(get_long_path(p), "\\", "/");
286 string external_path_list(string const & p)
288 return subst(p, '/', '\\');
292 string internal_path_list(string const & p)
294 return subst(p, '\\', '/');
298 string latex_path(string const & p)
300 // We may need a posix style path or a windows style path (depending
301 // on windows_style_tex_paths_), but we use always forward slashes,
302 // since it gets written into a .tex file.
304 if (!windows_style_tex_paths_ && FileName::isAbsolute(p)) {
305 string const drive = p.substr(0, 2);
306 string const cygprefix = cygdrive + "/" + drive.substr(0, 1);
307 string const cygpath = subst(subst(p, '\\', '/'), drive, cygprefix);
308 LYXERR(Debug::LATEX, "<Path correction for LaTeX> ["
309 << p << "]->>[" << cygpath << ']');
312 return subst(p, '\\', '/');
316 bool is_valid_strftime(string const & p)
318 string::size_type pos = p.find_first_of('%');
319 while (pos != string::npos) {
320 if (pos + 1 == string::npos)
322 if (!containsOnly(p.substr(pos + 1, 1),
323 "aAbBcdfHIjmMpSUwWxXyYzZ%"))
325 if (pos + 2 == string::npos)
327 pos = p.find_first_of('%', pos + 2);
333 // returns a string suitable to be passed to popen when
335 char const * popen_read_mode()
341 string const & nulldev()
343 static string const nulldev_ = "nul";
348 bool is_terminal(io_channel channel)
352 if (GetStdHandle(STD_INPUT_HANDLE) == NULL)
356 if (GetStdHandle(STD_OUTPUT_HANDLE) == NULL)
360 if (GetStdHandle(STD_ERROR_HANDLE) == NULL)
374 char path_separator()
380 void windows_style_tex_paths(bool use_windows_paths)
382 windows_style_tex_paths_ = use_windows_paths;
386 GetFolderPath::GetFolderPath()
390 folder_module_ = LoadLibrary("shfolder.dll");
391 if (!folder_module_) {
392 throw ExceptionMessage(ErrorException, _("System file not found"),
393 _("Unable to load shfolder.dll\nPlease install."));
396 folder_path_func_ = reinterpret_cast<function_pointer>(::GetProcAddress(folder_module_, "SHGetFolderPathA"));
397 if (folder_path_func_ == 0) {
398 throw ExceptionMessage(ErrorException, _("System function not found"),
399 _("Unable to find SHGetFolderPathA in shfolder.dll\n"
400 "Don't know how to proceed. Sorry."));
405 GetFolderPath::~GetFolderPath()
408 FreeLibrary(folder_module_);
412 // Given a folder ID, returns the folder name (in unix-style format).
413 // Eg CSIDL_PERSONAL -> "C:/Documents and Settings/USERNAME/My Documents"
414 string const GetFolderPath::operator()(folder_id _id) const
416 char folder_path[MAX_PATH];
427 LASSERT(false, /**/);
429 HRESULT const result = (folder_path_func_)(0, id, 0,
432 return (result == 0) ? os::internal_path(to_utf8(from_filesystem8bit(folder_path))) : string();
436 bool canAutoOpenFile(string const & ext, auto_open_mode const mode)
441 string const full_ext = "." + ext;
443 DWORD bufSize = MAX_PATH + 100;
444 TCHAR buf[MAX_PATH + 100];
445 // reference: http://msdn.microsoft.com/en-us/library/bb773471.aspx
446 char const * action = (mode == VIEW) ? "open" : "edit";
447 return S_OK == AssocQueryString(ASSOCF_INIT_IGNOREUNKNOWN,
448 ASSOCSTR_EXECUTABLE, full_ext.c_str(), action, buf, &bufSize);
452 bool autoOpenFile(string const & filename, auto_open_mode const mode)
454 // reference: http://msdn.microsoft.com/en-us/library/bb762153.aspx
455 char const * action = (mode == VIEW) ? "open" : "edit";
456 return reinterpret_cast<int>(ShellExecute(NULL, action,
457 to_local8bit(from_utf8(filename)).c_str(), NULL, NULL, 1)) > 32;
461 string real_path(string const & path)
463 // See http://msdn.microsoft.com/en-us/library/aa366789(VS.85).aspx
464 HANDLE hpath = CreateFile(subst(path, '/', '\\').c_str(), GENERIC_READ,
465 FILE_SHARE_READ, NULL, OPEN_EXISTING, 0, NULL);
467 if (hpath == INVALID_HANDLE_VALUE) {
468 // The file cannot be accessed.
469 return FileName::fromFilesystemEncoding(path).absFilename();
472 // Get the file size.
474 DWORD size_lo = GetFileSize(hpath, &size_hi);
476 if (size_lo == 0 && size_hi == 0) {
477 // A zero-length file cannot be mapped.
479 return FileName::fromFilesystemEncoding(path).absFilename();
482 // Create a file mapping object.
483 HANDLE hmap = CreateFileMapping(hpath, NULL, PAGE_READONLY, 0, 1, NULL);
487 return FileName::fromFilesystemEncoding(path).absFilename();
490 // Create a file mapping to get the file name.
491 void * pmem = MapViewOfFile(hmap, FILE_MAP_READ, 0, 0, 1);
496 return FileName::fromFilesystemEncoding(path).absFilename();
499 TCHAR realpath[MAX_PATH + 1];
501 if (!GetMappedFileName(GetCurrentProcess(), pmem, realpath, MAX_PATH)) {
502 UnmapViewOfFile(pmem);
505 return FileName::fromFilesystemEncoding(path).absFilename();
508 // Translate device name to UNC prefix or drive letters.
509 TCHAR tmpbuf[MAX_PATH] = TEXT("\\Device\\Mup\\");
510 UINT namelen = _tcslen(tmpbuf);
511 if (_tcsnicmp(realpath, tmpbuf, namelen) == 0) {
513 _snprintf(tmpbuf, MAX_PATH, "\\\\%s", realpath + namelen);
514 strncpy(realpath, tmpbuf, MAX_PATH);
515 realpath[MAX_PATH] = '\0';
516 } else if (GetLogicalDriveStrings(MAX_PATH - 1, tmpbuf)) {
517 // Check whether device name corresponds to some local drive.
518 TCHAR name[MAX_PATH];
519 TCHAR drive[3] = TEXT(" :");
523 // Copy the drive letter to the template string
525 // Look up each device name
526 if (QueryDosDevice(drive, name, MAX_PATH)) {
527 namelen = _tcslen(name);
528 if (namelen < MAX_PATH) {
529 found = _tcsnicmp(realpath, name, namelen) == 0;
531 // Repl. device spec with drive
532 TCHAR tempfile[MAX_PATH];
541 realpath[MAX_PATH] = '\0';
545 // Advance p to the next NULL character.
547 } while (!found && *p);
549 UnmapViewOfFile(pmem);
552 string const retpath = subst(string(realpath), '\\', '/');
553 return FileName::fromFilesystemEncoding(retpath).absFilename();
557 } // namespace support