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 #include "support/lstrings.h"
  20 #include "support/filetools.h"
  21 #include "support/ExceptionMessage.h"
  22
  23 #include "debug.h"
  24 #include "gettext.h"
  25
  26 #include <boost/assert.hpp>
  27
  28 #include <cstdlib>
  29 #include <vector>
  30
  31 /* The GetLongPathName macro may be defined on the compiling machine,
  32  * but we must use a bit of trickery if the resulting executable is
  33  * to run on a Win95 machine.
  34  * Fortunately, Microsoft provide the trickery. All we need is the
  35  * NewAPIs.h header file, available for download from Microsoft as
  36  * part of the Platform SDK.
  37  */
  38 #if defined (HAVE_NEWAPIS_H)
  39 // This should be defined already to keep Boost.Filesystem happy.
  40 # if !defined (WANT_GETFILEATTRIBUTESEX_WRAPPER)
  41 #   error Expected WANT_GETFILEATTRIBUTESEX_WRAPPER to be defined!
  42 # endif
  43 # define WANT_GETLONGPATHNAME_WRAPPER 1
  44 # define COMPILE_NEWAPIS_STUBS
  45 # include <NewAPIs.h>
  46 # undef COMPILE_NEWAPIS_STUBS
  47 # undef WANT_GETLONGPATHNAME_WRAPPER
  48 #endif
  49
  50 #include <io.h>
  51 #include <direct.h> // _getdrive
  52 #include <shlobj.h>  // SHGetFolderPath
  53 #include <windef.h>
  54 #include <shellapi.h>
  55 #include <shlwapi.h>
  56
  57 // Must define SHGFP_TYPE_CURRENT for older versions of MinGW.
  58 #if defined(__MINGW32__)  || defined(__CYGWIN__) || defined(__CYGWIN32__)
  59 # include <w32api.h>
  60 # if __W32API_MAJOR_VERSION < 3 || \
  61      __W32API_MAJOR_VERSION == 3 && __W32API_MINOR_VERSION  < 2
  62 #  define SHGFP_TYPE_CURRENT 0
  63 # endif
  64 #endif
  65
  66 using std::endl;
  67 using std::string;
  68
  69
  70 namespace lyx {
  71 namespace support {
  72 namespace os {
  73
  74 namespace {
  75
  76 bool windows_style_tex_paths_ = true;
  77
  78 string cygdrive = "/cygdrive";
  79
  80 } // namespace anon
  81
  82 void init(int /* argc */, char * argv[])
  83 {
  84         /* Note from Angus, 17 Jan 2005:
  85          *
  86          * The code below is taken verbatim from Ruurd's original patch
  87          * porting LyX to Win32.
  88          *
  89          * Windows allows us to define LyX either as a console-based app
  90          * or as a GUI-based app. Ruurd decided to define LyX as a
  91          * console-based app with a "main" function rather than a "WinMain"
  92          * function as the point of entry to the program, but to
  93          * immediately close the console window that Windows helpfully
  94          * opens for us. Doing so allows the user to see all of LyX's
  95          * debug output simply by running LyX from a DOS or MSYS-shell
  96          * prompt.
  97          *
  98          * The alternative approach is to define LyX as a genuine
  99          * GUI-based app, with a "WinMain" function as the entry point to the
 100          * executable rather than a "main" function, so:
 101          *
 102          * #if defined (_WIN32)
 103          * # define WIN32_LEAN_AND_MEAN
 104          * # include <stdlib.h>  // for __argc, __argv
 105          * # include <windows.h> // for WinMain
 106          * #endif
 107          *
 108          * // This will require the "-mwindows" flag when linking with
 109          * // gcc under MinGW.
 110          * // For MSVC, use "/subsystem:windows".
 111          * #if defined (_WIN32)
 112          * int WINAPI WinMain(HINSTANCE, HINSTANCE, LPSTR, int)
 113          * {
 114          *     return mymain(__argc, __argv);
 115          * }
 116          * #endif
 117          *
 118          * where "mymain" is just a renamed "main".
 119          *
 120          * However, doing so means that the lyxerr messages would mysteriously
 121          * disappear. They could be resurrected with something like:
 122          *
 123          * #ifdef WIN32
 124          *  AllocConsole();
 125          *  freopen("conin$","r",stdin);
 126          *  freopen("conout$","w",stdout);
 127          *  freopen("conout$","w",stderr);
 128          * #endif
 129          *
 130          * This code could be invoked (say) the first time that lyxerr
 131          * is called. However, Ruurd has tried this route and found that some
 132          * shell scripts failed, for mysterious reasons...
 133          *
 134          * I've chosen for now, therefore, to simply add Ruurd's original
 135          * code as-is. A wrapper program hidecmd.c has been added to
 136          * development/Win32 which hides the console window of lyx when
 137          * lyx is invoked as a parameter of hidecmd.exe.
 138          */
 139
 140         // If cygwin is detected, query the cygdrive prefix
 141         HKEY regKey;
 142         char buf[MAX_PATH];
 143         DWORD bufSize = sizeof(buf);
 144         LONG retVal;
 145
 146         retVal = RegOpenKeyEx(HKEY_LOCAL_MACHINE,
 147                         "Software\\Cygnus Solutions\\Cygwin\\mounts v2",
 148                         0, KEY_QUERY_VALUE, &regKey);
 149         if (retVal != ERROR_SUCCESS) {
 150                 retVal = RegOpenKeyEx(HKEY_CURRENT_USER,
 151                                 "Software\\Cygnus Solutions\\Cygwin\\mounts v2",
 152                                 0, KEY_QUERY_VALUE, &regKey);
 153         }
 154         if (retVal == ERROR_SUCCESS) {
 155                 retVal = RegQueryValueEx(regKey, "cygdrive prefix", NULL, NULL,
 156                                 (LPBYTE) buf, &bufSize);
 157                 RegCloseKey(regKey);
 158                 if ((retVal == ERROR_SUCCESS) && (bufSize <= MAX_PATH))
 159                         cygdrive = buf;
 160         }
 161 }
 162
 163
 164 string current_root()
 165 {
 166         // _getdrive returns the current drive (1=A, 2=B, and so on).
 167         char const drive = ::_getdrive() + 'A' - 1;
 168         return string(1, drive) + ":/";
 169 }
 170
 171
 172 docstring::size_type common_path(docstring const & p1, docstring const & p2)
 173 {
 174         size_t i = 0;
 175         size_t const p1_len = p1.length();
 176         size_t const p2_len = p2.length();
 177         while (i < p1_len && i < p2_len && uppercase(p1[i]) == uppercase(p2[i]))
 178                 ++i;
 179         if ((i < p1_len && i < p2_len)
 180             || (i < p1_len && p1[i] != '/' && i == p2_len)
 181             || (i < p2_len && p2[i] != '/' && i == p1_len))
 182         {
 183                 if (i)
 184                         --i;     // here was the last match
 185                 while (i && p1[i] != '/')
 186                         --i;
 187         }
 188         return i;
 189 }
 190
 191
 192 string external_path(string const & p)
 193 {
 194         string const dos_path = subst(p, "/", "\\");
 195
 196         LYXERR(Debug::LATEX, "<Win32 path correction> ["
 197                 << p << "]->>[" << dos_path << ']');
 198         return dos_path;
 199 }
 200
 201
 202 static string const get_long_path(string const & short_path)
 203 {
 204         // GetLongPathName needs the path in file system encoding.
 205         // We can use to_local8bit, since file system encoding and the
 206         // local 8 bit encoding are identical on windows.
 207         std::vector<char> long_path(MAX_PATH);
 208         DWORD result = GetLongPathName(to_local8bit(from_utf8(short_path)).c_str(),
 209                                        &long_path[0], long_path.size());
 210
 211         if (result > long_path.size()) {
 212                 long_path.resize(result);
 213                 result = GetLongPathName(short_path.c_str(),
 214                                          &long_path[0], long_path.size());
 215                 BOOST_ASSERT(result <= long_path.size());
 216         }
 217
 218         return (result == 0) ? short_path : to_utf8(from_filesystem8bit(&long_path[0]));
 219 }
 220
 221
 222 string internal_path(string const & p)
 223 {
 224         return subst(get_long_path(p), "\\", "/");
 225 }
 226
 227
 228 string external_path_list(string const & p)
 229 {
 230         return subst(p, '/', '\\');
 231 }
 232
 233
 234 string internal_path_list(string const & p)
 235 {
 236         return subst(p, '\\', '/');
 237 }
 238
 239
 240 string latex_path(string const & p)
 241 {
 242         // We may need a posix style path or a windows style path (depending
 243         // on windows_style_tex_paths_), but we use always forward slashes,
 244         // since it gets written into a .tex file.
 245
 246         if (!windows_style_tex_paths_ && is_absolute_path(p)) {
 247                 string const drive = p.substr(0, 2);
 248                 string const cygprefix = cygdrive + "/" + drive.substr(0, 1);
 249                 string const cygpath = subst(subst(p, '\\', '/'), drive, cygprefix);
 250                 LYXERR(Debug::LATEX, "<Path correction for LaTeX> ["
 251                         << p << "]->>[" << cygpath << ']');
 252                 return cygpath;
 253         }
 254         return subst(p, '\\', '/');
 255 }
 256
 257
 258 // (Claus H.) On Win32 both Unix and Win32/DOS pathnames are used.
 259 // Therefore an absolute path could be either a pathname starting
 260 // with a slash (Unix) or a pathname starting with a drive letter
 261 // followed by a colon. Because a colon is not valid in pathes in Unix
 262 // and at another location in Win32 testing just for the existance
 263 // of the colon in the 2nd position seems to be enough!
 264 bool is_absolute_path(string const & p)
 265 {
 266         if (p.empty())
 267                 return false;
 268
 269         bool isDosPath = (p.length() > 1 && p[1] == ':');
 270         bool isUnixPath = (p[0] == '/');
 271
 272         return isDosPath || isUnixPath;
 273 }
 274
 275
 276 // returns a string suitable to be passed to popen when
 277 // reading a pipe
 278 char const * popen_read_mode()
 279 {
 280         return "r";
 281 }
 282
 283
 284 string const & nulldev()
 285 {
 286         static string const nulldev_ = "nul";
 287         return nulldev_;
 288 }
 289
 290
 291 shell_type shell()
 292 {
 293         return CMD_EXE;
 294 }
 295
 296
 297 char path_separator()
 298 {
 299         return ';';
 300 }
 301
 302
 303 void windows_style_tex_paths(bool use_windows_paths)
 304 {
 305         windows_style_tex_paths_ = use_windows_paths;
 306 }
 307
 308
 309 GetFolderPath::GetFolderPath()
 310         : folder_module_(0),
 311           folder_path_func_(0)
 312 {
 313         folder_module_ = LoadLibrary("shfolder.dll");
 314         if (!folder_module_) {
 315                 throw ExceptionMessage(ErrorException, _("System file not found"),
 316                         _("Unable to load shfolder.dll\nPlease install."));
 317         }
 318
 319         folder_path_func_ = reinterpret_cast<function_pointer>(::GetProcAddress(folder_module_, "SHGetFolderPathA"));
 320         if (folder_path_func_ == 0) {
 321                 throw ExceptionMessage(ErrorException, _("System function not found"),
 322                         _("Unable to find SHGetFolderPathA in shfolder.dll\n"
 323                           "Don't know how to proceed. Sorry."));
 324         }
 325 }
 326
 327
 328 GetFolderPath::~GetFolderPath()
 329 {
 330         if (folder_module_)
 331                 FreeLibrary(folder_module_);
 332 }
 333
 334
 335 // Given a folder ID, returns the folder name (in unix-style format).
 336 // Eg CSIDL_PERSONAL -> "C:/Documents and Settings/USERNAME/My Documents"
 337 string const GetFolderPath::operator()(folder_id _id) const
 338 {
 339         char folder_path[MAX_PATH];
 340
 341         int id = 0;
 342         switch (_id) {
 343         case PERSONAL:
 344                 id = CSIDL_PERSONAL;
 345                 break;
 346         case APPDATA:
 347                 id = CSIDL_APPDATA;
 348                 break;
 349         default:
 350                 BOOST_ASSERT(false);
 351         }
 352         HRESULT const result = (folder_path_func_)(0, id, 0,
 353                                                    SHGFP_TYPE_CURRENT,
 354                                                    folder_path);
 355         return (result == 0) ? os::internal_path(to_utf8(from_filesystem8bit(folder_path))) : string();
 356 }
 357
 358
 359 bool canAutoOpenFile(string const & ext, auto_open_mode const mode)
 360 {
 361         if (ext.empty())
 362                 return false;
 363
 364         string const full_ext = "." + ext;
 365
 366         DWORD bufSize = MAX_PATH + 100;
 367         TCHAR buf[MAX_PATH + 100];
 368         // reference: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/shellcc
 369         //                 /platform/shell/reference/shlwapi/registry/assocquerystring.asp
 370         char const * action = (mode == VIEW) ? "open" : "edit";
 371         return S_OK == AssocQueryString(0, ASSOCSTR_EXECUTABLE,
 372                 full_ext.c_str(), action, buf, &bufSize);
 373 }
 374
 375
 376 bool autoOpenFile(string const & filename, auto_open_mode const mode)
 377 {
 378         // reference: http://msdn.microsoft.com/library/default.asp
 379         // ?url=/library/en-us/shellcc/platform/shell/reference/functions/
 380         // shellexecute.asp
 381         char const * action = (mode == VIEW) ? "open" : "edit";
 382         return reinterpret_cast<int>(ShellExecute(NULL, action,
 383                 to_local8bit(from_utf8(filename)).c_str(), NULL, NULL, 1)) > 32;
 384 }
 385
 386 } // namespace os
 387 } // namespace support
 388 } // namespace lyx