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