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         } else
 197                 --i;
 198
 199         return i;
 200 }
 201
 202
 203 bool path_prefix_is(string const & path, string const & pre)
 204 {
 205         return path_prefix_is(const_cast<string &>(path), pre, CASE_UNCHANGED);
 206 }
 207
 208
 209 bool path_prefix_is(string & path, string const & pre, path_case how)
 210 {
 211         docstring const p1 = from_utf8(path);
 212         docstring const p2 = from_utf8(pre);
 213         docstring::size_type const p1_len = p1.length();
 214         docstring::size_type const p2_len = p2.length();
 215         docstring::size_type const common_len = common_path(p1, p2) + 1;
 216
 217         if (common_len == 1) {
 218                 if (p2_len != 1 || p1_len == 0 || p1[0] != p2[0]
 219                     || (p1_len != 1 && p1[1] != '/'))
 220                         return false;
 221         } else if (common_len != p2_len)
 222                 return false;
 223
 224         if (how == CASE_ADJUSTED && !prefixIs(path, pre))
 225                 path = to_utf8(p2 + p1.substr(common_len, p1_len - common_len));
 226
 227         return true;
 228 }
 229
 230
 231 string external_path(string const & p)
 232 {
 233         string const dos_path = subst(p, "/", "\\");
 234
 235         LYXERR(Debug::LATEX, "<Win32 path correction> ["
 236                 << p << "]->>[" << dos_path << ']');
 237         return dos_path;
 238 }
 239
 240
 241 static string const get_long_path(string const & short_path)
 242 {
 243         // GetLongPathName needs the path in file system encoding.
 244         // We can use to_local8bit, since file system encoding and the
 245         // local 8 bit encoding are identical on windows.
 246         vector<char> long_path(MAX_PATH);
 247         DWORD result = GetLongPathName(to_local8bit(from_utf8(short_path)).c_str(),
 248                                        &long_path[0], long_path.size());
 249
 250         if (result > long_path.size()) {
 251                 long_path.resize(result);
 252                 result = GetLongPathName(short_path.c_str(),
 253                                          &long_path[0], long_path.size());
 254                 LASSERT(result <= long_path.size(), /**/);
 255         }
 256
 257         return (result == 0) ? short_path : to_utf8(from_filesystem8bit(&long_path[0]));
 258 }
 259
 260
 261 string internal_path(string const & p)
 262 {
 263         return subst(get_long_path(p), "\\", "/");
 264 }
 265
 266
 267 string external_path_list(string const & p)
 268 {
 269         return subst(p, '/', '\\');
 270 }
 271
 272
 273 string internal_path_list(string const & p)
 274 {
 275         return subst(p, '\\', '/');
 276 }
 277
 278
 279 string latex_path(string const & p)
 280 {
 281         // We may need a posix style path or a windows style path (depending
 282         // on windows_style_tex_paths_), but we use always forward slashes,
 283         // since it gets written into a .tex file.
 284
 285         if (!windows_style_tex_paths_ && FileName::isAbsolute(p)) {
 286                 string const drive = p.substr(0, 2);
 287                 string const cygprefix = cygdrive + "/" + drive.substr(0, 1);
 288                 string const cygpath = subst(subst(p, '\\', '/'), drive, cygprefix);
 289                 LYXERR(Debug::LATEX, "<Path correction for LaTeX> ["
 290                         << p << "]->>[" << cygpath << ']');
 291                 return cygpath;
 292         }
 293         return subst(p, '\\', '/');
 294 }
 295
 296
 297 bool is_valid_strftime(string const & p)
 298 {
 299         string::size_type pos = p.find_first_of('%');
 300         while (pos != string::npos) {
 301                 if (pos + 1 == string::npos)
 302                         break;
 303                 if (!containsOnly(p.substr(pos + 1, 1),
 304                         "aAbBcdfHIjmMpSUwWxXyYzZ%"))
 305                         return false;
 306                 if (pos + 2 == string::npos)
 307                       break;
 308                 pos = p.find_first_of('%', pos + 2);
 309         }
 310         return true;
 311 }
 312
 313
 314 // returns a string suitable to be passed to popen when
 315 // reading a pipe
 316 char const * popen_read_mode()
 317 {
 318         return "r";
 319 }
 320
 321
 322 string const & nulldev()
 323 {
 324         static string const nulldev_ = "nul";
 325         return nulldev_;
 326 }
 327
 328
 329 bool is_terminal(io_channel channel)
 330 {
 331         switch (channel) {
 332         case STDIN:
 333                 if (GetStdHandle(STD_INPUT_HANDLE) == NULL)
 334                         return false;
 335                 break;
 336         case STDOUT:
 337                 if (GetStdHandle(STD_OUTPUT_HANDLE) == NULL)
 338                         return false;
 339                 break;
 340         case STDERR:
 341                 if (GetStdHandle(STD_ERROR_HANDLE) == NULL)
 342                         return false;
 343                 break;
 344         }
 345         return true;
 346 }
 347
 348
 349 shell_type shell()
 350 {
 351         return CMD_EXE;
 352 }
 353
 354
 355 char path_separator()
 356 {
 357         return ';';
 358 }
 359
 360
 361 void windows_style_tex_paths(bool use_windows_paths)
 362 {
 363         windows_style_tex_paths_ = use_windows_paths;
 364 }
 365
 366
 367 GetFolderPath::GetFolderPath()
 368         : folder_module_(0),
 369           folder_path_func_(0)
 370 {
 371         folder_module_ = LoadLibrary("shfolder.dll");
 372         if (!folder_module_) {
 373                 throw ExceptionMessage(ErrorException, _("System file not found"),
 374                         _("Unable to load shfolder.dll\nPlease install."));
 375         }
 376
 377         folder_path_func_ = reinterpret_cast<function_pointer>(::GetProcAddress(folder_module_, "SHGetFolderPathA"));
 378         if (folder_path_func_ == 0) {
 379                 throw ExceptionMessage(ErrorException, _("System function not found"),
 380                         _("Unable to find SHGetFolderPathA in shfolder.dll\n"
 381                           "Don't know how to proceed. Sorry."));
 382         }
 383 }
 384
 385
 386 GetFolderPath::~GetFolderPath()
 387 {
 388         if (folder_module_)
 389                 FreeLibrary(folder_module_);
 390 }
 391
 392
 393 // Given a folder ID, returns the folder name (in unix-style format).
 394 // Eg CSIDL_PERSONAL -> "C:/Documents and Settings/USERNAME/My Documents"
 395 string const GetFolderPath::operator()(folder_id _id) const
 396 {
 397         char folder_path[MAX_PATH];
 398
 399         int id = 0;
 400         switch (_id) {
 401         case PERSONAL:
 402                 id = CSIDL_PERSONAL;
 403                 break;
 404         case APPDATA:
 405                 id = CSIDL_APPDATA;
 406                 break;
 407         default:
 408                 LASSERT(false, /**/);
 409         }
 410         HRESULT const result = (folder_path_func_)(0, id, 0,
 411                                                    SHGFP_TYPE_CURRENT,
 412                                                    folder_path);
 413         return (result == 0) ? os::internal_path(to_utf8(from_filesystem8bit(folder_path))) : string();
 414 }
 415
 416
 417 bool canAutoOpenFile(string const & ext, auto_open_mode const mode)
 418 {
 419         if (ext.empty())
 420                 return false;
 421
 422         string const full_ext = "." + ext;
 423
 424         DWORD bufSize = MAX_PATH + 100;
 425         TCHAR buf[MAX_PATH + 100];
 426         // reference: http://msdn.microsoft.com/en-us/library/bb773471.aspx
 427         char const * action = (mode == VIEW) ? "open" : "edit";
 428         return S_OK == AssocQueryString(ASSOCF_INIT_IGNOREUNKNOWN,
 429                 ASSOCSTR_EXECUTABLE, full_ext.c_str(), action, buf, &bufSize);
 430 }
 431
 432
 433 bool autoOpenFile(string const & filename, auto_open_mode const mode)
 434 {
 435         // reference: http://msdn.microsoft.com/en-us/library/bb762153.aspx
 436         char const * action = (mode == VIEW) ? "open" : "edit";
 437         return reinterpret_cast<int>(ShellExecute(NULL, action,
 438                 to_local8bit(from_utf8(filename)).c_str(), NULL, NULL, 1)) > 32;
 439 }
 440
 441
 442 string real_path(string const & path)
 443 {
 444         // See http://msdn.microsoft.com/en-us/library/aa366789(VS.85).aspx
 445         HANDLE hpath = CreateFile(subst(path, '/', '\\').c_str(), GENERIC_READ,
 446                                 FILE_SHARE_READ, NULL, OPEN_EXISTING, 0, NULL);
 447
 448         if (hpath == INVALID_HANDLE_VALUE) {
 449                 // The file cannot be accessed.
 450                 return FileName::fromFilesystemEncoding(path).absFilename();
 451         }
 452
 453         // Get the file size.
 454         DWORD size_hi = 0;
 455         DWORD size_lo = GetFileSize(hpath, &size_hi);
 456
 457         if (size_lo == 0 && size_hi == 0) {
 458                 // A zero-length file cannot be mapped.
 459                 CloseHandle(hpath);
 460                 return FileName::fromFilesystemEncoding(path).absFilename();
 461         }
 462
 463         // Create a file mapping object.
 464         HANDLE hmap = CreateFileMapping(hpath, NULL, PAGE_READONLY, 0, 1, NULL);
 465
 466         if (!hmap) {
 467                 CloseHandle(hpath);
 468                 return FileName::fromFilesystemEncoding(path).absFilename();
 469         }
 470
 471         // Create a file mapping to get the file name.
 472         void * pmem = MapViewOfFile(hmap, FILE_MAP_READ, 0, 0, 1);
 473
 474         if (!pmem) {
 475                 CloseHandle(hmap);
 476                 CloseHandle(hpath);
 477                 return FileName::fromFilesystemEncoding(path).absFilename();
 478         }
 479
 480         TCHAR realpath[MAX_PATH + 1];
 481
 482         if (!GetMappedFileName(GetCurrentProcess(), pmem, realpath, MAX_PATH)) {
 483                 UnmapViewOfFile(pmem);
 484                 CloseHandle(hmap);
 485                 CloseHandle(hpath);
 486                 return FileName::fromFilesystemEncoding(path).absFilename();
 487         }
 488
 489         // Translate device name to UNC prefix or drive letters.
 490         TCHAR tmpbuf[MAX_PATH] = TEXT("\\Device\\Mup\\");
 491         UINT namelen = _tcslen(tmpbuf);
 492         if (_tcsnicmp(realpath, tmpbuf, namelen) == 0) {
 493                 // UNC path
 494                 _snprintf(tmpbuf, MAX_PATH, "\\\\%s", realpath + namelen);
 495                 strncpy(realpath, tmpbuf, MAX_PATH);
 496                 realpath[MAX_PATH] = '\0';
 497         } else if (GetLogicalDriveStrings(MAX_PATH - 1, tmpbuf)) {
 498                 // Check whether device name corresponds to some local drive.
 499                 TCHAR name[MAX_PATH];
 500                 TCHAR drive[3] = TEXT(" :");
 501                 bool found = false;
 502                 TCHAR * p = tmpbuf;
 503                 do {
 504                         // Copy the drive letter to the template string
 505                         drive[0] = *p;
 506                         // Look up each device name
 507                         if (QueryDosDevice(drive, name, MAX_PATH)) {
 508                                 namelen = _tcslen(name);
 509                                 if (namelen < MAX_PATH) {
 510                                         found = _tcsnicmp(realpath, name, namelen) == 0;
 511                                         if (found) {
 512                                                 // Repl. device spec with drive
 513                                                 TCHAR tempfile[MAX_PATH];
 514                                                 _snprintf(tempfile,
 515                                                         MAX_PATH,
 516                                                         "%s%s",
 517                                                         drive,
 518                                                         realpath + namelen);
 519                                                 strncpy(realpath,
 520                                                         tempfile,
 521                                                         MAX_PATH);
 522                                                 realpath[MAX_PATH] = '\0';
 523                                         }
 524                                 }
 525                         }
 526                         // Advance p to the next NULL character.
 527                         while (*p++) ;
 528                 } while (!found && *p);
 529         }
 530         UnmapViewOfFile(pmem);
 531         CloseHandle(hmap);
 532         CloseHandle(hpath);
 533         string const retpath = subst(string(realpath), '\\', '/');
 534         return FileName::fromFilesystemEncoding(retpath).absFilename();
 535 }
 536
 537 } // namespace os
 538 } // namespace support
 539 } // namespace lyx