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 #ifndef ASSOCF_INIT_IGNOREUNKNOWN
  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 docstring::size_type common_path(docstring const & p1, docstring const & p2)
 176 {
 177         size_t i = 0;
 178         size_t const p1_len = p1.length();
 179         size_t const p2_len = p2.length();
 180         while (i < p1_len && i < p2_len && uppercase(p1[i]) == uppercase(p2[i]))
 181                 ++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))
 185         {
 186                 if (i)
 187                         --i;     // here was the last match
 188                 while (i && p1[i] != '/')
 189                         --i;
 190         }
 191         return i;
 192 }
 193
 194
 195 string external_path(string const & p)
 196 {
 197         string const dos_path = subst(p, "/", "\\");
 198
 199         LYXERR(Debug::LATEX, "<Win32 path correction> ["
 200                 << p << "]->>[" << dos_path << ']');
 201         return dos_path;
 202 }
 203
 204
 205 static string const get_long_path(string const & short_path)
 206 {
 207         // GetLongPathName needs the path in file system encoding.
 208         // We can use to_local8bit, since file system encoding and the
 209         // local 8 bit encoding are identical on windows.
 210         vector<char> long_path(MAX_PATH);
 211         DWORD result = GetLongPathName(to_local8bit(from_utf8(short_path)).c_str(),
 212                                        &long_path[0], long_path.size());
 213
 214         if (result > long_path.size()) {
 215                 long_path.resize(result);
 216                 result = GetLongPathName(short_path.c_str(),
 217                                          &long_path[0], long_path.size());
 218                 LASSERT(result <= long_path.size(), /**/);
 219         }
 220
 221         return (result == 0) ? short_path : to_utf8(from_filesystem8bit(&long_path[0]));
 222 }
 223
 224
 225 string internal_path(string const & p)
 226 {
 227         return subst(get_long_path(p), "\\", "/");
 228 }
 229
 230
 231 string external_path_list(string const & p)
 232 {
 233         return subst(p, '/', '\\');
 234 }
 235
 236
 237 string internal_path_list(string const & p)
 238 {
 239         return subst(p, '\\', '/');
 240 }
 241
 242
 243 string latex_path(string const & p)
 244 {
 245         // We may need a posix style path or a windows style path (depending
 246         // on windows_style_tex_paths_), but we use always forward slashes,
 247         // since it gets written into a .tex file.
 248
 249         FileName path(p);
 250         if (!windows_style_tex_paths_ && path.isAbsolute()) {
 251                 string const drive = p.substr(0, 2);
 252                 string const cygprefix = cygdrive + "/" + drive.substr(0, 1);
 253                 string const cygpath = subst(subst(p, '\\', '/'), drive, cygprefix);
 254                 LYXERR(Debug::LATEX, "<Path correction for LaTeX> ["
 255                         << p << "]->>[" << cygpath << ']');
 256                 return cygpath;
 257         }
 258         return subst(p, '\\', '/');
 259 }
 260
 261
 262 // returns a string suitable to be passed to popen when
 263 // reading a pipe
 264 char const * popen_read_mode()
 265 {
 266         return "r";
 267 }
 268
 269
 270 string const & nulldev()
 271 {
 272         static string const nulldev_ = "nul";
 273         return nulldev_;
 274 }
 275
 276
 277 shell_type shell()
 278 {
 279         return CMD_EXE;
 280 }
 281
 282
 283 char path_separator()
 284 {
 285         return ';';
 286 }
 287
 288
 289 void windows_style_tex_paths(bool use_windows_paths)
 290 {
 291         windows_style_tex_paths_ = use_windows_paths;
 292 }
 293
 294
 295 GetFolderPath::GetFolderPath()
 296         : folder_module_(0),
 297           folder_path_func_(0)
 298 {
 299         folder_module_ = LoadLibrary("shfolder.dll");
 300         if (!folder_module_) {
 301                 throw ExceptionMessage(ErrorException, _("System file not found"),
 302                         _("Unable to load shfolder.dll\nPlease install."));
 303         }
 304
 305         folder_path_func_ = reinterpret_cast<function_pointer>(::GetProcAddress(folder_module_, "SHGetFolderPathA"));
 306         if (folder_path_func_ == 0) {
 307                 throw ExceptionMessage(ErrorException, _("System function not found"),
 308                         _("Unable to find SHGetFolderPathA in shfolder.dll\n"
 309                           "Don't know how to proceed. Sorry."));
 310         }
 311 }
 312
 313
 314 GetFolderPath::~GetFolderPath()
 315 {
 316         if (folder_module_)
 317                 FreeLibrary(folder_module_);
 318 }
 319
 320
 321 // Given a folder ID, returns the folder name (in unix-style format).
 322 // Eg CSIDL_PERSONAL -> "C:/Documents and Settings/USERNAME/My Documents"
 323 string const GetFolderPath::operator()(folder_id _id) const
 324 {
 325         char folder_path[MAX_PATH];
 326
 327         int id = 0;
 328         switch (_id) {
 329         case PERSONAL:
 330                 id = CSIDL_PERSONAL;
 331                 break;
 332         case APPDATA:
 333                 id = CSIDL_APPDATA;
 334                 break;
 335         default:
 336                 LASSERT(false, /**/);
 337         }
 338         HRESULT const result = (folder_path_func_)(0, id, 0,
 339                                                    SHGFP_TYPE_CURRENT,
 340                                                    folder_path);
 341         return (result == 0) ? os::internal_path(to_utf8(from_filesystem8bit(folder_path))) : string();
 342 }
 343
 344
 345 bool canAutoOpenFile(string const & ext, auto_open_mode const mode)
 346 {
 347         if (ext.empty())
 348                 return false;
 349
 350         string const full_ext = "." + ext;
 351
 352         DWORD bufSize = MAX_PATH + 100;
 353         TCHAR buf[MAX_PATH + 100];
 354         // reference: http://msdn.microsoft.com/en-us/library/bb773471.aspx
 355         char const * action = (mode == VIEW) ? "open" : "edit";
 356         return S_OK == AssocQueryString(ASSOCF_INIT_IGNOREUNKNOWN,
 357                 ASSOCSTR_EXECUTABLE, full_ext.c_str(), action, buf, &bufSize);
 358 }
 359
 360
 361 bool autoOpenFile(string const & filename, auto_open_mode const mode)
 362 {
 363         // reference: http://msdn.microsoft.com/en-us/library/bb762153.aspx
 364         char const * action = (mode == VIEW) ? "open" : "edit";
 365         return reinterpret_cast<int>(ShellExecute(NULL, action,
 366                 to_local8bit(from_utf8(filename)).c_str(), NULL, NULL, 1)) > 32;
 367 }
 368
 369 } // namespace os
 370 } // namespace support
 371 } // namespace lyx