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"
19 #include "support/lstrings.h"
20 #include "support/filetools.h"
24 #include <boost/assert.hpp>
31 /* The GetLongPathName macro may be defined on the compiling machine,
32 * but we must use a bit of trickery if the resulting executable is
33 * to run on a Win95 machine.
34 * Fortunately, Microsoft provide the trickery. All we need is the
35 * NewAPIs.h header file, available for download from Microsoft as
36 * part of the Platform SDK.
38 #if defined (HAVE_NEWAPIS_H)
39 // This should be defined already to keep Boost.Filesystem happy.
40 # if !defined (WANT_GETFILEATTRIBUTESEX_WRAPPER)
41 # error Expected WANT_GETFILEATTRIBUTESEX_WRAPPER to be defined!
43 # define WANT_GETLONGPATHNAME_WRAPPER 1
44 # define COMPILE_NEWAPIS_STUBS
46 # undef COMPILE_NEWAPIS_STUBS
47 # undef WANT_GETLONGPATHNAME_WRAPPER
51 #include <direct.h> // _getdrive
52 #include <shlobj.h> // SHGetFolderPath
57 // Must define SHGFP_TYPE_CURRENT for older versions of MinGW.
58 #if defined(__MINGW32__) || defined(__CYGWIN__) || defined(__CYGWIN32__)
60 # if __W32API_MAJOR_VERSION < 3 || \
61 __W32API_MAJOR_VERSION == 3 && __W32API_MINOR_VERSION < 2
62 # define SHGFP_TYPE_CURRENT 0
69 using lyx::support::runCommand;
70 using lyx::support::split;
79 bool windows_style_tex_paths_ = true;
81 string cygdrive = "/cygdrive";
85 void init(int /* argc */, char * argv[])
87 /* Note from Angus, 17 Jan 2005:
89 * The code below is taken verbatim from Ruurd's original patch
90 * porting LyX to Win32.
92 * Windows allows us to define LyX either as a console-based app
93 * or as a GUI-based app. Ruurd decided to define LyX as a
94 * console-based app with a "main" function rather than a "WinMain"
95 * function as the point of entry to the program, but to
96 * immediately close the console window that Windows helpfully
97 * opens for us. Doing so allows the user to see all of LyX's
98 * debug output simply by running LyX from a DOS or MSYS-shell
101 * The alternative approach is to define LyX as a genuine
102 * GUI-based app, with a "WinMain" function as the entry point to the
103 * executable rather than a "main" function, so:
105 * #if defined (_WIN32)
106 * # define WIN32_LEAN_AND_MEAN
107 * # include <stdlib.h> // for __argc, __argv
108 * # include <windows.h> // for WinMain
111 * // This will require the "-mwindows" flag when linking with
112 * // gcc under MinGW.
113 * // For MSVC, use "/subsystem:windows".
114 * #if defined (_WIN32)
115 * int WINAPI WinMain(HINSTANCE, HINSTANCE, LPSTR, int)
117 * return mymain(__argc, __argv);
121 * where "mymain" is just a renamed "main".
123 * However, doing so means that the lyxerr messages would mysteriously
124 * disappear. They could be resurrected with something like:
128 * freopen("conin$","r",stdin);
129 * freopen("conout$","w",stdout);
130 * freopen("conout$","w",stderr);
133 * This code could be invoked (say) the first time that lyxerr
134 * is called. However, Ruurd has tried this route and found that some
135 * shell scripts failed, for mysterious reasons...
137 * I've chosen for now, therefore, to simply add Ruurd's original
138 * code as-is. A wrapper program hidecmd.c has been added to
139 * development/Win32 which hides the console window of lyx when
140 * lyx is invoked as a parameter of hidecmd.exe.
143 // If cygwin is detected, query the cygdrive prefix
146 DWORD bufSize = sizeof(buf);
149 retVal = RegOpenKeyEx(HKEY_LOCAL_MACHINE,
150 "Software\\Cygnus Solutions\\Cygwin\\mounts v2",
151 0, KEY_QUERY_VALUE, ®Key);
152 if (retVal != ERROR_SUCCESS) {
153 retVal = RegOpenKeyEx(HKEY_CURRENT_USER,
154 "Software\\Cygnus Solutions\\Cygwin\\mounts v2",
155 0, KEY_QUERY_VALUE, ®Key);
157 if (retVal == ERROR_SUCCESS) {
158 retVal = RegQueryValueEx(regKey, "cygdrive prefix", NULL, NULL,
159 (LPBYTE) buf, &bufSize);
161 if ((retVal == ERROR_SUCCESS) && (bufSize <= MAX_PATH))
167 string current_root()
169 // _getdrive returns the current drive (1=A, 2=B, and so on).
170 char const drive = ::_getdrive() + 'A' - 1;
171 return string(1, drive) + ":/";
175 string::size_type common_path(string const & p1, string const & p2)
177 string::size_type i = 0;
178 string::size_type p1_len = p1.length();
179 string::size_type p2_len = p2.length();
180 while (i < p1_len && i < p2_len && uppercase(p1[i]) == uppercase(p2[i]))
182 if ((i < p1_len && i < p2_len)
183 || (i < p1_len && p1[i] != '/' && i == p2_len)
184 || (i < p2_len && p2[i] != '/' && i == p1_len))
187 --i; // here was the last match
188 while (i && p1[i] != '/')
195 string external_path(string const & p)
197 string const dos_path = subst(p, "/", "\\");
200 << "<Win32 path correction> ["
202 << dos_path << ']' << endl;
209 string const get_long_path(string const & short_path)
211 std::vector<char> long_path(MAX_PATH);
212 DWORD result = GetLongPathName(short_path.c_str(),
213 &long_path[0], long_path.size());
215 if (result > long_path.size()) {
216 long_path.resize(result);
217 result = GetLongPathName(short_path.c_str(),
218 &long_path[0], long_path.size());
219 BOOST_ASSERT(result <= long_path.size());
222 return (result == 0) ? short_path : &long_path[0];
228 string internal_path(string const & p)
230 return subst(get_long_path(p), "\\", "/");
234 string external_path_list(string const & p)
236 return subst(p, '/', '\\');
240 string internal_path_list(string const & p)
242 return subst(p, '\\', '/');
246 string latex_path(string const & p)
248 // We may need a posix style path or a windows style path (depending
249 // on windows_style_tex_paths_), but we use always forward slashes,
250 // since it gets written into a .tex file.
252 if (!windows_style_tex_paths_ && is_absolute_path(p)) {
253 string const drive = p.substr(0, 2);
254 string const cygprefix = cygdrive + "/" + drive.substr(0, 1);
255 string const cygpath = subst(subst(p, '\\', '/'), drive, cygprefix);
257 << "<Path correction for LaTeX> ["
259 << cygpath << ']' << endl;
262 return subst(p, '\\', '/');
266 // (Claus H.) On Win32 both Unix and Win32/DOS pathnames are used.
267 // Therefore an absolute path could be either a pathname starting
268 // with a slash (Unix) or a pathname starting with a drive letter
269 // followed by a colon. Because a colon is not valid in pathes in Unix
270 // and at another location in Win32 testing just for the existance
271 // of the colon in the 2nd position seems to be enough!
272 bool is_absolute_path(string const & p)
277 bool isDosPath = (p.length() > 1 && p[1] == ':');
278 bool isUnixPath = (p[0] == '/');
280 return isDosPath || isUnixPath;
284 // returns a string suitable to be passed to popen when
286 char const * popen_read_mode()
292 string const & nulldev()
294 static string const nulldev_ = "nul";
305 char path_separator()
311 void windows_style_tex_paths(bool use_windows_paths)
313 windows_style_tex_paths_ = use_windows_paths;
321 #ifndef CXX_GLOBAL_CSTD
330 GetFolderPath::GetFolderPath()
334 folder_module_ = LoadLibrary("shfolder.dll");
335 if (!folder_module_) {
336 lyxerr << "Unable to load shfolder.dll\nPlease install."
341 folder_path_func_ = reinterpret_cast<function_pointer>(::GetProcAddress(folder_module_, "SHGetFolderPathA"));
342 if (folder_path_func_ == 0) {
343 lyxerr << "Unable to find SHGetFolderPathA in shfolder.dll\n"
344 "Don't know how to proceed. Sorry."
351 GetFolderPath::~GetFolderPath()
354 FreeLibrary(folder_module_);
358 // Given a folder ID, returns the folder name (in unix-style format).
359 // Eg CSIDL_PERSONAL -> "C:/Documents and Settings/USERNAME/My Documents"
360 string const GetFolderPath::operator()(folder_id _id) const
362 char folder_path[MAX_PATH];
375 HRESULT const result = (folder_path_func_)(0, id, 0,
378 return (result == 0) ? os::internal_path(folder_path) : string();
382 bool canAutoOpenFile(string const & ext, auto_open_mode const mode)
387 string const full_ext = "." + ext;
389 DWORD bufSize = MAX_PATH + 100;
390 TCHAR buf[MAX_PATH + 100];
391 // reference: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/shellcc
392 // /platform/shell/reference/shlwapi/registry/assocquerystring.asp
393 char const * action = (mode == VIEW) ? "open" : "edit";
394 return S_OK == AssocQueryString(0, ASSOCSTR_EXECUTABLE,
395 full_ext.c_str(), action, buf, &bufSize);
399 bool autoOpenFile(string const & filename, auto_open_mode const mode)
401 // reference: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/shellcc
402 // /platform/shell/reference/functions/shellexecute.asp
403 char const * action = (mode == VIEW) ? "open" : "edit";
404 return reinterpret_cast<int>(ShellExecute(NULL, action,
405 filename.c_str(), NULL, NULL, 1)) > 32;
410 } // namespace support