src/support/os_win32.cpp

   1 /**
   2  * \file os_win32.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Ruurd A. Reitsma
   7  * \author Claus Hentschel
   8  * \author Angus Leeming
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  *
  12  * Various OS specific functions
  13  */
  14
  15 #include <config.h>
  16
  17 #include "support/os.h"
  18 #include "support/os_win32.h"
  19
  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"
  26
  27 #include "support/lassert.h"
  28
  29 #include <cstdlib>
  30 #include <vector>
  31
  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.
  38  */
  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!
  43 # endif
  44 # define WANT_GETLONGPATHNAME_WRAPPER 1
  45 # define COMPILE_NEWAPIS_STUBS
  46 # include <NewAPIs.h>
  47 # undef COMPILE_NEWAPIS_STUBS
  48 # undef WANT_GETLONGPATHNAME_WRAPPER
  49 #endif
  50
  51 #include <io.h>
  52 #include <direct.h> // _getdrive
  53 #include <shlobj.h>  // SHGetFolderPath
  54 #include <windef.h>
  55 #include <shellapi.h>
  56 #include <shlwapi.h>
  57
  58 // Must define SHGFP_TYPE_CURRENT for older versions of MinGW.
  59 #if defined(__MINGW32__)  || defined(__CYGWIN__) || defined(__CYGWIN32__)
  60 # include <w32api.h>
  61 # if __W32API_MAJOR_VERSION < 3 || \
  62      __W32API_MAJOR_VERSION == 3 && __W32API_MINOR_VERSION  < 2
  63 #  define SHGFP_TYPE_CURRENT 0
  64 # endif
  65 #endif
  66
  67 #if !defined(ASSOCF_INIT_IGNOREUNKNOWN) && !defined(__MINGW32__)
  68 #define ASSOCF_INIT_IGNOREUNKNOWN 0
  69 #endif
  70
  71 using namespace std;
  72
  73 namespace lyx {
  74 namespace support {
  75 namespace os {
  76
  77 namespace {
  78
  79 bool windows_style_tex_paths_ = true;
  80
  81 string cygdrive = "/cygdrive";
  82
  83 } // namespace anon
  84
  85 void init(int /* argc */, char * argv[])
  86 {
  87         /* Note from Angus, 17 Jan 2005:
  88          *
  89          * The code below is taken verbatim from Ruurd's original patch
  90          * porting LyX to Win32.
  91          *
  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
  99          * prompt.
 100          *
 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:
 104          *
 105          * #if defined (_WIN32)
 106          * # define WIN32_LEAN_AND_MEAN
 107          * # include <stdlib.h>  // for __argc, __argv
 108          * # include <windows.h> // for WinMain
 109          * #endif
 110          *
 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)
 116          * {
 117          *     return mymain(__argc, __argv);
 118          * }
 119          * #endif
 120          *
 121          * where "mymain" is just a renamed "main".
 122          *
 123          * However, doing so means that the lyxerr messages would mysteriously
 124          * disappear. They could be resurrected with something like:
 125          *
 126          * #ifdef WIN32
 127          *  AllocConsole();
 128          *  freopen("conin$","r",stdin);
 129          *  freopen("conout$","w",stdout);
 130          *  freopen("conout$","w",stderr);
 131          * #endif
 132          *
 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...
 136          *
 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.
 141          */
 142
 143         // If cygwin is detected, query the cygdrive prefix
 144         HKEY regKey;
 145         char buf[MAX_PATH];
 146         DWORD bufSize = sizeof(buf);
 147         LONG retVal;
 148
 149         retVal = RegOpenKeyEx(HKEY_LOCAL_MACHINE,
 150                         "Software\\Cygnus Solutions\\Cygwin\\mounts v2",
 151                         0, KEY_QUERY_VALUE, &regKey);
 152         if (retVal != ERROR_SUCCESS) {
 153                 retVal = RegOpenKeyEx(HKEY_CURRENT_USER,
 154                                 "Software\\Cygnus Solutions\\Cygwin\\mounts v2",
 155                                 0, KEY_QUERY_VALUE, &regKey);
 156         }
 157         if (retVal == ERROR_SUCCESS) {
 158                 retVal = RegQueryValueEx(regKey, "cygdrive prefix", NULL, NULL,
 159                                 (LPBYTE) buf, &bufSize);
 160                 RegCloseKey(regKey);
 161                 if ((retVal == ERROR_SUCCESS) && (bufSize <= MAX_PATH))
 162                         cygdrive = rtrim(string(buf), "/");
 163         }
 164 }
 165
 166
 167 string current_root()
 168 {
 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) + ":/";
 172 }
 173
 174
 175 bool isFilesystemCaseSensitive()
 176 {
 177         return false;
 178 }
 179
 180
 181 docstring::size_type common_path(docstring const & p1, docstring const & p2)
 182 {
 183         size_t i = 0;
 184         size_t const p1_len = p1.length();
 185         size_t const p2_len = p2.length();
 186         while (i < p1_len && i < p2_len && uppercase(p1[i]) == uppercase(p2[i]))
 187                 ++i;
 188         if ((i < p1_len && i < p2_len)
 189             || (i < p1_len && p1[i] != '/' && i == p2_len)
 190             || (i < p2_len && p2[i] != '/' && i == p1_len))
 191         {
 192                 if (i)
 193                         --i;     // here was the last match
 194                 while (i && p1[i] != '/')
 195                         --i;
 196         }
 197         return i;
 198 }
 199
 200
 201 bool path_prefix_is(string const & path, string const & pre)
 202 {
 203         return path_prefix_is(const_cast<string &>(path), pre, CASE_UNCHANGED);
 204 }
 205
 206
 207 bool path_prefix_is(string & path, string const & pre, path_case how)
 208 {
 209         docstring const p1 = from_utf8(path);
 210         docstring const p2 = from_utf8(pre);
 211         docstring::size_type const p1_len = p1.length();
 212         docstring::size_type const p2_len = p2.length();
 213         docstring::size_type common_len = common_path(p1, p2);
 214
 215         if (p2[p2_len - 1] == '/' && p1_len != p2_len)
 216                 ++common_len;
 217
 218         if (common_len != p2_len)
 219                 return false;
 220
 221         if (how == CASE_ADJUSTED && !prefixIs(path, pre)) {
 222                 if (p1_len < common_len)
 223                         path = to_utf8(p2.substr(0, p1_len));
 224                 else
 225                         path = to_utf8(p2 + p1.substr(common_len,
 226                                                         p1_len - common_len));
 227         }
 228
 229         return true;
 230 }
 231
 232
 233 string external_path(string const & p)
 234 {
 235         string const dos_path = subst(p, "/", "\\");
 236
 237         LYXERR(Debug::LATEX, "<Win32 path correction> ["
 238                 << p << "]->>[" << dos_path << ']');
 239         return dos_path;
 240 }
 241
 242
 243 static string const get_long_path(string const & short_path)
 244 {
 245         // GetLongPathName needs the path in file system encoding.
 246         // We can use to_local8bit, since file system encoding and the
 247         // local 8 bit encoding are identical on windows.
 248         vector<char> long_path(MAX_PATH);
 249         DWORD result = GetLongPathName(to_local8bit(from_utf8(short_path)).c_str(),
 250                                        &long_path[0], long_path.size());
 251
 252         if (result > long_path.size()) {
 253                 long_path.resize(result);
 254                 result = GetLongPathName(short_path.c_str(),
 255                                          &long_path[0], long_path.size());
 256                 LASSERT(result <= long_path.size(), /**/);
 257         }
 258
 259         return (result == 0) ? short_path : to_utf8(from_filesystem8bit(&long_path[0]));
 260 }
 261
 262
 263 string internal_path(string const & p)
 264 {
 265         return subst(get_long_path(p), "\\", "/");
 266 }
 267
 268
 269 string external_path_list(string const & p)
 270 {
 271         return subst(p, '/', '\\');
 272 }
 273
 274
 275 string internal_path_list(string const & p)
 276 {
 277         return subst(p, '\\', '/');
 278 }
 279
 280
 281 string latex_path(string const & p)
 282 {
 283         // We may need a posix style path or a windows style path (depending
 284         // on windows_style_tex_paths_), but we use always forward slashes,
 285         // since it gets written into a .tex file.
 286
 287         if (!windows_style_tex_paths_ && FileName::isAbsolute(p)) {
 288                 string const drive = p.substr(0, 2);
 289                 string const cygprefix = cygdrive + "/" + drive.substr(0, 1);
 290                 string const cygpath = subst(subst(p, '\\', '/'), drive, cygprefix);
 291                 LYXERR(Debug::LATEX, "<Path correction for LaTeX> ["
 292                         << p << "]->>[" << cygpath << ']');
 293                 return cygpath;
 294         }
 295         return subst(p, '\\', '/');
 296 }
 297
 298
 299 bool is_valid_strftime(string const & p)
 300 {
 301         string::size_type pos = p.find_first_of('%');
 302         while (pos != string::npos) {
 303                 if (pos + 1 == string::npos)
 304                         break;
 305                 if (!containsOnly(p.substr(pos + 1, 1),
 306                         "aAbBcdfHIjmMpSUwWxXyYzZ%"))
 307                         return false;
 308                 if (pos + 2 == string::npos)
 309                       break;
 310                 pos = p.find_first_of('%', pos + 2);
 311         }
 312         return true;
 313 }
 314
 315
 316 // returns a string suitable to be passed to popen when
 317 // reading a pipe
 318 char const * popen_read_mode()
 319 {
 320         return "r";
 321 }
 322
 323
 324 string const & nulldev()
 325 {
 326         static string const nulldev_ = "nul";
 327         return nulldev_;
 328 }
 329
 330
 331 bool is_terminal(io_channel channel)
 332 {
 333         switch (channel) {
 334         case STDIN:
 335                 if (GetStdHandle(STD_INPUT_HANDLE) == NULL)
 336                         return false;
 337                 break;
 338         case STDOUT:
 339                 if (GetStdHandle(STD_OUTPUT_HANDLE) == NULL)
 340                         return false;
 341                 break;
 342         case STDERR:
 343                 if (GetStdHandle(STD_ERROR_HANDLE) == NULL)
 344                         return false;
 345                 break;
 346         }
 347         return true;
 348 }
 349
 350
 351 shell_type shell()
 352 {
 353         return CMD_EXE;
 354 }
 355
 356
 357 char path_separator()
 358 {
 359         return ';';
 360 }
 361
 362
 363 void windows_style_tex_paths(bool use_windows_paths)
 364 {
 365         windows_style_tex_paths_ = use_windows_paths;
 366 }
 367
 368
 369 GetFolderPath::GetFolderPath()
 370         : folder_module_(0),
 371           folder_path_func_(0)
 372 {
 373         folder_module_ = LoadLibrary("shfolder.dll");
 374         if (!folder_module_) {
 375                 throw ExceptionMessage(ErrorException, _("System file not found"),
 376                         _("Unable to load shfolder.dll\nPlease install."));
 377         }
 378
 379         folder_path_func_ = reinterpret_cast<function_pointer>(::GetProcAddress(folder_module_, "SHGetFolderPathA"));
 380         if (folder_path_func_ == 0) {
 381                 throw ExceptionMessage(ErrorException, _("System function not found"),
 382                         _("Unable to find SHGetFolderPathA in shfolder.dll\n"
 383                           "Don't know how to proceed. Sorry."));
 384         }
 385 }
 386
 387
 388 GetFolderPath::~GetFolderPath()
 389 {
 390         if (folder_module_)
 391                 FreeLibrary(folder_module_);
 392 }
 393
 394
 395 // Given a folder ID, returns the folder name (in unix-style format).
 396 // Eg CSIDL_PERSONAL -> "C:/Documents and Settings/USERNAME/My Documents"
 397 string const GetFolderPath::operator()(folder_id _id) const
 398 {
 399         char folder_path[MAX_PATH];
 400
 401         int id = 0;
 402         switch (_id) {
 403         case PERSONAL:
 404                 id = CSIDL_PERSONAL;
 405                 break;
 406         case APPDATA:
 407                 id = CSIDL_APPDATA;
 408                 break;
 409         default:
 410                 LASSERT(false, /**/);
 411         }
 412         HRESULT const result = (folder_path_func_)(0, id, 0,
 413                                                    SHGFP_TYPE_CURRENT,
 414                                                    folder_path);
 415         return (result == 0) ? os::internal_path(to_utf8(from_filesystem8bit(folder_path))) : string();
 416 }
 417
 418
 419 bool canAutoOpenFile(string const & ext, auto_open_mode const mode)
 420 {
 421         if (ext.empty())
 422                 return false;
 423
 424         string const full_ext = "." + ext;
 425
 426         DWORD bufSize = MAX_PATH + 100;
 427         TCHAR buf[MAX_PATH + 100];
 428         // reference: http://msdn.microsoft.com/en-us/library/bb773471.aspx
 429         char const * action = (mode == VIEW) ? "open" : "edit";
 430         return S_OK == AssocQueryString(ASSOCF_INIT_IGNOREUNKNOWN,
 431                 ASSOCSTR_EXECUTABLE, full_ext.c_str(), action, buf, &bufSize);
 432 }
 433
 434
 435 bool autoOpenFile(string const & filename, auto_open_mode const mode)
 436 {
 437         // reference: http://msdn.microsoft.com/en-us/library/bb762153.aspx
 438         char const * action = (mode == VIEW) ? "open" : "edit";
 439         return reinterpret_cast<int>(ShellExecute(NULL, action,
 440                 to_local8bit(from_utf8(filename)).c_str(), NULL, NULL, 1)) > 32;
 441 }
 442
 443
 444 string real_path(string const & path)
 445 {
 446         // See http://msdn.microsoft.com/en-us/library/aa366789(VS.85).aspx
 447         HANDLE hpath = CreateFile(subst(path, '/', '\\').c_str(), GENERIC_READ,
 448                                 FILE_SHARE_READ, NULL, OPEN_EXISTING, 0, NULL);
 449
 450         if (hpath == INVALID_HANDLE_VALUE) {
 451                 // The file cannot be accessed.
 452                 return FileName::fromFilesystemEncoding(path).absFilename();
 453         }
 454
 455         // Get the file size.
 456         DWORD size_hi = 0;
 457         DWORD size_lo = GetFileSize(hpath, &size_hi);
 458
 459         if (size_lo == 0 && size_hi == 0) {
 460                 // A zero-length file cannot be mapped.
 461                 CloseHandle(hpath);
 462                 return FileName::fromFilesystemEncoding(path).absFilename();
 463         }
 464
 465         // Create a file mapping object.
 466         HANDLE hmap = CreateFileMapping(hpath, NULL, PAGE_READONLY, 0, 1, NULL);
 467
 468         if (!hmap) {
 469                 CloseHandle(hpath);
 470                 return FileName::fromFilesystemEncoding(path).absFilename();
 471         }
 472
 473         // Create a file mapping to get the file name.
 474         void * pmem = MapViewOfFile(hmap, FILE_MAP_READ, 0, 0, 1);
 475
 476         if (!pmem) {
 477                 CloseHandle(hmap);
 478                 CloseHandle(hpath);
 479                 return FileName::fromFilesystemEncoding(path).absFilename();
 480         }
 481
 482         TCHAR realpath[MAX_PATH + 1];
 483
 484         if (!GetMappedFileName(GetCurrentProcess(), pmem, realpath, MAX_PATH)) {
 485                 UnmapViewOfFile(pmem);
 486                 CloseHandle(hmap);
 487                 CloseHandle(hpath);
 488                 return FileName::fromFilesystemEncoding(path).absFilename();
 489         }
 490
 491         // Translate device name to UNC prefix or drive letters.
 492         TCHAR tmpbuf[MAX_PATH] = TEXT("\\Device\\Mup\\");
 493         UINT namelen = _tcslen(tmpbuf);
 494         if (_tcsnicmp(realpath, tmpbuf, namelen) == 0) {
 495                 // UNC path
 496                 _snprintf(tmpbuf, MAX_PATH, "\\\\%s", realpath + namelen);
 497                 strncpy(realpath, tmpbuf, MAX_PATH);
 498                 realpath[MAX_PATH] = '\0';
 499         } else if (GetLogicalDriveStrings(MAX_PATH - 1, tmpbuf)) {
 500                 // Check whether device name corresponds to some local drive.
 501                 TCHAR name[MAX_PATH];
 502                 TCHAR drive[3] = TEXT(" :");
 503                 bool found = false;
 504                 TCHAR * p = tmpbuf;
 505                 do {
 506                         // Copy the drive letter to the template string
 507                         drive[0] = *p;
 508                         // Look up each device name
 509                         if (QueryDosDevice(drive, name, MAX_PATH)) {
 510                                 namelen = _tcslen(name);
 511                                 if (namelen < MAX_PATH) {
 512                                         found = _tcsnicmp(realpath, name, namelen) == 0;
 513                                         if (found) {
 514                                                 // Repl. device spec with drive
 515                                                 TCHAR tempfile[MAX_PATH];
 516                                                 _snprintf(tempfile,
 517                                                         MAX_PATH,
 518                                                         "%s%s",
 519                                                         drive,
 520                                                         realpath + namelen);
 521                                                 strncpy(realpath,
 522                                                         tempfile,
 523                                                         MAX_PATH);
 524                                                 realpath[MAX_PATH] = '\0';
 525                                         }
 526                                 }
 527                         }
 528                         // Advance p to the next NULL character.
 529                         while (*p++) ;
 530                 } while (!found && *p);
 531         }
 532         UnmapViewOfFile(pmem);
 533         CloseHandle(hmap);
 534         CloseHandle(hpath);
 535         string const retpath = subst(string(realpath), '\\', '/');
 536         return FileName::fromFilesystemEncoding(retpath).absFilename();
 537 }
 538
 539 } // namespace os
 540 } // namespace support
 541 } // namespace lyx