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"
23 #include <boost/assert.hpp>
30 /* The GetLongPathName macro may be defined on the compiling machine,
31 * but we must use a bit of trickery if the resulting executable is
32 * to run on a Win95 machine.
33 * Fortunately, Microsoft provide the trickery. All we need is the
34 * NewAPIs.h header file, available for download from Microsoft as
35 * part of the Platform SDK.
37 #if defined (HAVE_NEWAPIS_H)
38 // This should be defined already to keep Boost.Filesystem happy.
39 # if !defined (WANT_GETFILEATTRIBUTESEX_WRAPPER)
40 # error Expected WANT_GETFILEATTRIBUTESEX_WRAPPER to be defined!
42 # define WANT_GETLONGPATHNAME_WRAPPER 1
43 # define COMPILE_NEWAPIS_STUBS
45 # undef COMPILE_NEWAPIS_STUBS
46 # undef WANT_GETLONGPATHNAME_WRAPPER
50 #include <direct.h> // _getdrive
51 #include <shlobj.h> // SHGetFolderPath
53 // Must define SHGFP_TYPE_CURRENT for older versions of MinGW.
54 #if defined(__MINGW32__) || defined(__CYGWIN__) || defined(__CYGWIN32__)
56 # if __W32API_MAJOR_VERSION < 3 || \
57 __W32API_MAJOR_VERSION == 3 && __W32API_MINOR_VERSION < 2
58 # define SHGFP_TYPE_CURRENT 0
70 void init(int /* argc */, char * argv[])
72 /* Note from Angus, 17 Jan 2005:
74 * The code below is taken verbatim from Ruurd's original patch
75 * porting LyX to Win32.
77 * Windows allows us to define LyX either as a console-based app
78 * or as a GUI-based app. Ruurd decided to define LyX as a
79 * console-based app with a "main" function rather than a "WinMain"
80 * function as the point of entry to the program, but to
81 * immediately close the console window that Windows helpfully
82 * opens for us. Doing so allows the user to see all of LyX's
83 * debug output simply by running LyX from a DOS or MSYS-shell
86 * The alternative approach is to define LyX as a genuine
87 * GUI-based app, with a "WinMain" function as the entry point to the
88 * executable rather than a "main" function, so:
90 * #if defined (_WIN32)
91 * # define WIN32_LEAN_AND_MEAN
92 * # include <stdlib.h> // for __argc, __argv
93 * # include <windows.h> // for WinMain
96 * // This will require the "-mwindows" flag when linking with
98 * // For MSVC, use "/subsystem:windows".
99 * #if defined (_WIN32)
100 * int WINAPI WinMain(HINSTANCE, HINSTANCE, LPSTR, int)
102 * return mymain(__argc, __argv);
106 * where "mymain" is just a renamed "main".
108 * However, doing so means that the lyxerr messages would mysteriously
109 * disappear. They could be resurrected with something like:
113 * freopen("conin$","r",stdin);
114 * freopen("conout$","w",stdout);
115 * freopen("conout$","w",stderr);
118 * This code could be invoked (say) the first time that lyxerr
119 * is called. However, Ruurd has tried this route and found that some
120 * shell scripts failed, for mysterious reasons...
122 * I've chosen for now, therefore, to simply add Ruurd's original
125 // Close the console when run (probably)
126 // not run from command prompt
127 char WindowTitle[1024];
128 if (GetConsoleTitle(WindowTitle, sizeof(WindowTitle)) == 0) {
129 // Could not get the title, so we just leave things as they are
133 if ((strcmp(WindowTitle, argv[0]) == 0) ||
134 (strcmp(WindowTitle, "LyX") == 0)) {
135 // format a "unique" newWindowTitle
136 wsprintf(WindowTitle, "%d/%d",
138 GetCurrentProcessId());
139 // change current window title
140 SetConsoleTitle(WindowTitle);
141 // ensure window title has been updated
143 // look for newWindowTitle
144 HWND const hwndFound = FindWindow(NULL, WindowTitle);
146 if (hwndFound != NULL)
147 ShowWindow( hwndFound, SW_HIDE);
152 string current_root()
154 // _getdrive returns the current drive (1=A, 2=B, and so on).
155 char const drive = ::_getdrive() + 'A' - 1;
156 return string(1, drive) + ":/";
160 string::size_type common_path(string const & p1, string const & p2)
162 string::size_type i = 0;
163 string::size_type p1_len = p1.length();
164 string::size_type p2_len = p2.length();
165 while (i < p1_len && i < p2_len && uppercase(p1[i]) == uppercase(p2[i]))
167 if ((i < p1_len && i < p2_len)
168 || (i < p1_len && p1[i] != '/' && i == p2_len)
169 || (i < p2_len && p2[i] != '/' && i == p1_len))
172 --i; // here was the last match
173 while (i && p1[i] != '/')
180 string external_path(string const & p)
182 string const dos_path = subst(p, "/", "\\");
185 << "<Win32 path correction> ["
187 << dos_path << ']' << endl;
194 string const get_long_path(string const & short_path)
196 std::vector<char> long_path(MAX_PATH);
197 DWORD result = GetLongPathName(short_path.c_str(),
198 &long_path[0], long_path.size());
200 if (result > long_path.size()) {
201 long_path.resize(result);
202 result = GetLongPathName(short_path.c_str(),
203 &long_path[0], long_path.size());
204 BOOST_ASSERT(result <= long_path.size());
207 return (result == 0) ? short_path : &long_path[0];
213 string internal_path(string const & p)
215 return subst(get_long_path(p), "\\", "/");
219 string external_path_list(string const & p)
221 return subst(p, '/', '\\');
225 string internal_path_list(string const & p)
227 return subst(p, '\\', '/');
231 string latex_path(string const & p)
233 return subst(p, '\\', '/');
237 // (Claus H.) On Win32 both Unix and Win32/DOS pathnames are used.
238 // Therefore an absolute path could be either a pathname starting
239 // with a slash (Unix) or a pathname starting with a drive letter
240 // followed by a colon. Because a colon is not valid in pathes in Unix
241 // and at another location in Win32 testing just for the existance
242 // of the colon in the 2nd position seems to be enough!
243 bool is_absolute_path(string const & p)
248 bool isDosPath = (p.length() > 1 && p[1] == ':');
249 bool isUnixPath = (p[0] == '/');
251 return isDosPath || isUnixPath;
255 // returns a string suitable to be passed to popen when
257 char const * popen_read_mode()
263 string const & nulldev()
265 static string const nulldev_ = "nul";
276 char path_separator()
282 void cygwin_path_fix(bool)
290 #ifndef CXX_GLOBAL_CSTD
299 GetFolderPath::GetFolderPath()
303 folder_module_ = LoadLibrary("shfolder.dll");
304 if (!folder_module_) {
305 lyxerr << "Unable to load shfolder.dll\nPlease install."
310 folder_path_func_ = reinterpret_cast<function_pointer>(::GetProcAddress(folder_module_, "SHGetFolderPathA"));
311 if (folder_path_func_ == 0) {
312 lyxerr << "Unable to find SHGetFolderPathA in shfolder.dll\n"
313 "Don't know how to proceed. Sorry."
320 GetFolderPath::~GetFolderPath()
323 FreeLibrary(folder_module_);
327 // Given a folder ID, returns the folder name (in unix-style format).
328 // Eg CSIDL_PERSONAL -> "C:/Documents and Settings/USERNAME/My Documents"
329 string const GetFolderPath::operator()(folder_id _id) const
331 char folder_path[MAX_PATH];
344 HRESULT const result = (folder_path_func_)(0, id, 0,
347 return (result == 0) ? os::internal_path(folder_path) : string();
351 } // namespace support