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 <boost/assert.hpp>
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
75 bool windows_style_tex_paths_ = true;
77 string cygdrive = "/cygdrive";
81 void init(int /* argc */, char * argv[])
83 /* Note from Angus, 17 Jan 2005:
85 * The code below is taken verbatim from Ruurd's original patch
86 * porting LyX to Win32.
88 * Windows allows us to define LyX either as a console-based app
89 * or as a GUI-based app. Ruurd decided to define LyX as a
90 * console-based app with a "main" function rather than a "WinMain"
91 * function as the point of entry to the program, but to
92 * immediately close the console window that Windows helpfully
93 * opens for us. Doing so allows the user to see all of LyX's
94 * debug output simply by running LyX from a DOS or MSYS-shell
97 * The alternative approach is to define LyX as a genuine
98 * GUI-based app, with a "WinMain" function as the entry point to the
99 * executable rather than a "main" function, so:
101 * #if defined (_WIN32)
102 * # define WIN32_LEAN_AND_MEAN
103 * # include <stdlib.h> // for __argc, __argv
104 * # include <windows.h> // for WinMain
107 * // This will require the "-mwindows" flag when linking with
108 * // gcc under MinGW.
109 * // For MSVC, use "/subsystem:windows".
110 * #if defined (_WIN32)
111 * int WINAPI WinMain(HINSTANCE, HINSTANCE, LPSTR, int)
113 * return mymain(__argc, __argv);
117 * where "mymain" is just a renamed "main".
119 * However, doing so means that the lyxerr messages would mysteriously
120 * disappear. They could be resurrected with something like:
124 * freopen("conin$","r",stdin);
125 * freopen("conout$","w",stdout);
126 * freopen("conout$","w",stderr);
129 * This code could be invoked (say) the first time that lyxerr
130 * is called. However, Ruurd has tried this route and found that some
131 * shell scripts failed, for mysterious reasons...
133 * I've chosen for now, therefore, to simply add Ruurd's original
134 * code as-is. A wrapper program hidecmd.c has been added to
135 * development/Win32 which hides the console window of lyx when
136 * lyx is invoked as a parameter of hidecmd.exe.
139 // If cygwin is detected, query the cygdrive prefix
142 DWORD bufSize = sizeof(buf);
145 retVal = RegOpenKeyEx(HKEY_LOCAL_MACHINE,
146 "Software\\Cygnus Solutions\\Cygwin\\mounts v2",
147 0, KEY_QUERY_VALUE, ®Key);
148 if (retVal != ERROR_SUCCESS) {
149 retVal = RegOpenKeyEx(HKEY_CURRENT_USER,
150 "Software\\Cygnus Solutions\\Cygwin\\mounts v2",
151 0, KEY_QUERY_VALUE, ®Key);
153 if (retVal == ERROR_SUCCESS) {
154 retVal = RegQueryValueEx(regKey, "cygdrive prefix", NULL, NULL,
155 (LPBYTE) buf, &bufSize);
157 if ((retVal == ERROR_SUCCESS) && (bufSize <= MAX_PATH))
163 string current_root()
165 // _getdrive returns the current drive (1=A, 2=B, and so on).
166 char const drive = ::_getdrive() + 'A' - 1;
167 return string(1, drive) + ":/";
171 docstring::size_type common_path(docstring const & p1, docstring const & p2)
174 size_t const p1_len = p1.length();
175 size_t const p2_len = p2.length();
176 while (i < p1_len && i < p2_len && uppercase(p1[i]) == uppercase(p2[i]))
178 if ((i < p1_len && i < p2_len)
179 || (i < p1_len && p1[i] != '/' && i == p2_len)
180 || (i < p2_len && p2[i] != '/' && i == p1_len))
183 --i; // here was the last match
184 while (i && p1[i] != '/')
191 string external_path(string const & p)
193 string const dos_path = subst(p, "/", "\\");
195 LYXERR(Debug::LATEX, "<Win32 path correction> ["
196 << p << "]->>[" << dos_path << ']');
201 static string const get_long_path(string const & short_path)
203 // GetLongPathName needs the path in file system encoding.
204 // We can use to_local8bit, since file system encoding and the
205 // local 8 bit encoding are identical on windows.
206 vector<char> long_path(MAX_PATH);
207 DWORD result = GetLongPathName(to_local8bit(from_utf8(short_path)).c_str(),
208 &long_path[0], long_path.size());
210 if (result > long_path.size()) {
211 long_path.resize(result);
212 result = GetLongPathName(short_path.c_str(),
213 &long_path[0], long_path.size());
214 BOOST_ASSERT(result <= long_path.size());
217 return (result == 0) ? short_path : to_utf8(from_filesystem8bit(&long_path[0]));
221 string internal_path(string const & p)
223 return subst(get_long_path(p), "\\", "/");
227 string external_path_list(string const & p)
229 return subst(p, '/', '\\');
233 string internal_path_list(string const & p)
235 return subst(p, '\\', '/');
239 string latex_path(string const & p)
241 // We may need a posix style path or a windows style path (depending
242 // on windows_style_tex_paths_), but we use always forward slashes,
243 // since it gets written into a .tex file.
246 if (!windows_style_tex_paths_ && path.isAbsolute()) {
247 string const drive = p.substr(0, 2);
248 string const cygprefix = cygdrive + "/" + drive.substr(0, 1);
249 string const cygpath = subst(subst(p, '\\', '/'), drive, cygprefix);
250 LYXERR(Debug::LATEX, "<Path correction for LaTeX> ["
251 << p << "]->>[" << cygpath << ']');
254 return subst(p, '\\', '/');
258 // returns a string suitable to be passed to popen when
260 char const * popen_read_mode()
266 string const & nulldev()
268 static string const nulldev_ = "nul";
279 char path_separator()
285 void windows_style_tex_paths(bool use_windows_paths)
287 windows_style_tex_paths_ = use_windows_paths;
291 GetFolderPath::GetFolderPath()
295 folder_module_ = LoadLibrary("shfolder.dll");
296 if (!folder_module_) {
297 throw ExceptionMessage(ErrorException, _("System file not found"),
298 _("Unable to load shfolder.dll\nPlease install."));
301 folder_path_func_ = reinterpret_cast<function_pointer>(::GetProcAddress(folder_module_, "SHGetFolderPathA"));
302 if (folder_path_func_ == 0) {
303 throw ExceptionMessage(ErrorException, _("System function not found"),
304 _("Unable to find SHGetFolderPathA in shfolder.dll\n"
305 "Don't know how to proceed. Sorry."));
310 GetFolderPath::~GetFolderPath()
313 FreeLibrary(folder_module_);
317 // Given a folder ID, returns the folder name (in unix-style format).
318 // Eg CSIDL_PERSONAL -> "C:/Documents and Settings/USERNAME/My Documents"
319 string const GetFolderPath::operator()(folder_id _id) const
321 char folder_path[MAX_PATH];
334 HRESULT const result = (folder_path_func_)(0, id, 0,
337 return (result == 0) ? os::internal_path(to_utf8(from_filesystem8bit(folder_path))) : string();
341 bool canAutoOpenFile(string const & ext, auto_open_mode const mode)
346 string const full_ext = "." + ext;
348 DWORD bufSize = MAX_PATH + 100;
349 TCHAR buf[MAX_PATH + 100];
350 // reference: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/shellcc
351 // /platform/shell/reference/shlwapi/registry/assocquerystring.asp
352 char const * action = (mode == VIEW) ? "open" : "edit";
353 return S_OK == AssocQueryString(0, ASSOCSTR_EXECUTABLE,
354 full_ext.c_str(), action, buf, &bufSize);
358 bool autoOpenFile(string const & filename, auto_open_mode const mode)
360 // reference: http://msdn.microsoft.com/library/default.asp
361 // ?url=/library/en-us/shellcc/platform/shell/reference/functions/
363 char const * action = (mode == VIEW) ? "open" : "edit";
364 return reinterpret_cast<int>(ShellExecute(NULL, action,
365 to_local8bit(from_utf8(filename)).c_str(), NULL, NULL, 1)) > 32;
369 } // namespace support