]> git.lyx.org Git - lyx.git/blobdiff - src/support/os_win32.C
fix compiler warnings about unused parameter
[lyx.git] / src / support / os_win32.C
index 3ab477b41b1f83860d837b143985045a53517154..b5545b85e689db5926d21b8a7ac7e8198d2c6f10 100644 (file)
@@ -4,6 +4,8 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Ruurd A. Reitsma
+ * \author Claus Hentschel
+ * \author Angus Leeming
  *
  * Full author contact details are available in file CREDITS.
  *
 #include <config.h>
 
 #include "support/os.h"
+#include "support/os_win32.h"
 #include "support/lstrings.h"
+#include "support/filetools.h"
+#include "support/ExceptionMessage.h"
+#include "support/package.h"
+#include "support/path.h"
 
 #include "debug.h"
+#include "gettext.h"
 
-#include <windows.h>
-#include <io.h>
+#include <boost/assert.hpp>
+
+#include <cstdlib>
+#include <vector>
 
-#if defined(__CYGWIN__) || defined(__CYGWIN32__)
-# include <sys/cygwin.h>
+/* The GetLongPathName macro may be defined on the compiling machine,
+ * but we must use a bit of trickery if the resulting executable is
+ * to run on a Win95 machine.
+ * Fortunately, Microsoft provide the trickery. All we need is the
+ * NewAPIs.h header file, available for download from Microsoft as
+ * part of the Platform SDK.
+ */
+#if defined (HAVE_NEWAPIS_H)
+// This should be defined already to keep Boost.Filesystem happy.
+# if !defined (WANT_GETFILEATTRIBUTESEX_WRAPPER)
+#   error Expected WANT_GETFILEATTRIBUTESEX_WRAPPER to be defined!
+# endif
+# define WANT_GETLONGPATHNAME_WRAPPER 1
+# define COMPILE_NEWAPIS_STUBS
+# include <NewAPIs.h>
+# undef COMPILE_NEWAPIS_STUBS
+# undef WANT_GETLONGPATHNAME_WRAPPER
+#endif
 
-#elif defined(_WIN32)
-# include <direct.h> // _getdrive
+#include <io.h>
+#include <direct.h> // _getdrive
+#include <shlobj.h>  // SHGetFolderPath
+#include <windef.h>
+#include <shellapi.h>  
+#include <shlwapi.h>
+
+// Must define SHGFP_TYPE_CURRENT for older versions of MinGW.
+#if defined(__MINGW32__)  || defined(__CYGWIN__) || defined(__CYGWIN32__)
+# include <w32api.h>
+# if __W32API_MAJOR_VERSION < 3 || \
+     __W32API_MAJOR_VERSION == 3 && __W32API_MINOR_VERSION  < 2
+#  define SHGFP_TYPE_CURRENT 0
+# endif
 #endif
 
 using std::endl;
 using std::string;
 
+using lyx::support::runCommand;
+using lyx::support::split;
+using lyx::support::addName;
+using lyx::support::addPath;
+using lyx::support::package;
+
+string const win_fonts_truetype[] = {"cmex10", "cmmi10", "cmr10", "cmsy10",
+       "eufm10", "msam10", "msbm10", "wasy10", "esint10"};
+const int num_fonts_truetype = sizeof(win_fonts_truetype) / sizeof(*win_fonts_truetype);
+
 
 namespace lyx {
 namespace support {
 namespace os {
 
-void os::init(int /* argc */, char * argv[])
+namespace {
+
+bool windows_style_tex_paths_ = true;
+
+string cygdrive = "/cygdrive";
+
+} // namespace anon
+
+void init(int /* argc */, char * argv[])
 {
-#ifdef _WIN32
        /* Note from Angus, 17 Jan 2005:
         *
         * The code below is taken verbatim from Ruurd's original patch
@@ -58,7 +113,7 @@ void os::init(int /* argc */, char * argv[])
         *
         * #if defined (_WIN32)
         * # define WIN32_LEAN_AND_MEAN
-        * # include <stdlib.h>  // for __argc,__argv
+        * # include <stdlib.h>  // for __argc, __argv
         * # include <windows.h> // for WinMain
         * #endif
         *
@@ -68,7 +123,7 @@ void os::init(int /* argc */, char * argv[])
         * #if defined (_WIN32)
         * int WINAPI WinMain(HINSTANCE, HINSTANCE, LPSTR, int)
         * {
-        *     return mymain(__argc, __argv);
+        *     return mymain(__argc, __argv);
         * }
         * #endif
         *
@@ -89,43 +144,40 @@ void os::init(int /* argc */, char * argv[])
         * shell scripts failed, for mysterious reasons...
         *
         * I've chosen for now, therefore, to simply add Ruurd's original
-        * code as-is.
+        * code as-is. A wrapper program hidecmd.c has been added to 
+        * development/Win32 which hides the console window of lyx when
+        * lyx is invoked as a parameter of hidecmd.exe.
         */
-       // Close the console when run (probably)
-       // not run from command prompt
-       char WindowTitle[1024];
-       HWND hwndFound;
-       GetConsoleTitle(WindowTitle,1024);
-       if ((strcmp(WindowTitle, argv[0]) == 0) ||
-               (strcmp(WindowTitle,"LyX") == 0)) {
-               // format a "unique" newWindowTitle
-               wsprintf(WindowTitle,"%d/%d",
-                       GetTickCount(),
-                       GetCurrentProcessId());
-               // change current window title
-               SetConsoleTitle(WindowTitle);
-               // ensure window title has been updated
-               Sleep(40);
-               // look for newWindowTitle
-               hwndFound=FindWindow(NULL, WindowTitle);
-               // If found, hide it
-               if ( hwndFound != NULL)
-                       ShowWindow( hwndFound, SW_HIDE);
+
+       // If cygwin is detected, query the cygdrive prefix
+       HKEY regKey;
+       char buf[MAX_PATH];
+       DWORD bufSize = sizeof(buf);
+       LONG retVal;
+
+       retVal = RegOpenKeyEx(HKEY_LOCAL_MACHINE,
+                       "Software\\Cygnus Solutions\\Cygwin\\mounts v2",
+                       0, KEY_QUERY_VALUE, &regKey);
+       if (retVal != ERROR_SUCCESS) {
+               retVal = RegOpenKeyEx(HKEY_CURRENT_USER,
+                               "Software\\Cygnus Solutions\\Cygwin\\mounts v2",
+                               0, KEY_QUERY_VALUE, &regKey);
+       }
+       if (retVal == ERROR_SUCCESS) {
+               retVal = RegQueryValueEx(regKey, "cygdrive prefix", NULL, NULL,
+                               (LPBYTE) buf, &bufSize);
+               RegCloseKey(regKey);
+               if ((retVal == ERROR_SUCCESS) && (bufSize <= MAX_PATH))
+                       cygdrive = buf;
        }
-#endif
 }
 
 
 string current_root()
 {
-#if defined(__CYGWIN__) || defined(__CYGWIN32__)
-       return string("/");
-
-#else
        // _getdrive returns the current drive (1=A, 2=B, and so on).
        char const drive = ::_getdrive() + 'A' - 1;
        return string(1, drive) + ":/";
-#endif
 }
 
 
@@ -149,57 +201,77 @@ string::size_type common_path(string const & p1, string const & p2)
 }
 
 
-#if defined(__CYGWIN__) || defined(__CYGWIN32__)
+string external_path(string const & p)
+{
+       string const dos_path = subst(p, "/", "\\");
+
+       lyxerr[Debug::LATEX]
+               << "<Win32 path correction> ["
+               << p << "]->>["
+               << dos_path << ']' << endl;
+       return dos_path;
+}
+
+
 namespace {
 
-bool cygwin_path_fix_ = false;
+string const get_long_path(string const & short_path)
+{
+       // GetLongPathName needs the path in file system encoding.
+       // We can use to_local8bit, since file system encoding and the
+       // local 8 bit encoding are identical on windows.
+       std::vector<char> long_path(MAX_PATH);
+       DWORD result = GetLongPathName(to_local8bit(from_utf8(short_path)).c_str(),
+                                      &long_path[0], long_path.size());
+
+       if (result > long_path.size()) {
+               long_path.resize(result);
+               result = GetLongPathName(short_path.c_str(),
+                                        &long_path[0], long_path.size());
+               BOOST_ASSERT(result <= long_path.size());
+       }
+
+       return (result == 0) ? short_path : to_utf8(from_filesystem8bit(&long_path[0]));
+}
 
 } // namespace anon
-#endif
 
 
-string external_path(string const & p)
+string internal_path(string const & p)
 {
-       string dos_path;
-
-#if defined(__CYGWIN__) || defined(__CYGWIN32__)
-       // Translate from cygwin path syntax to dos path syntax
-       if (cygwin_path_fix_ && is_absolute_path(p)) {
-               char dp[PATH_MAX];
-               cygwin_conv_to_full_win32_path(p.c_str(), dp);
-               dos_path = !dp ? "" : dp;
-       }
+       return subst(get_long_path(p), "\\", "/");
+}
 
-       else return p;
-#else // regular Win32
-       dos_path = p;
-#endif
 
-       //No backslashes in LaTeX files
-       dos_path = subst(dos_path,'\\','/');
+string external_path_list(string const & p)
+{
+       return subst(p, '/', '\\');
+}
 
-       lyxerr[Debug::LATEX]
-               << "<Win32 path correction> ["
-               << p << "]->>["
-               << dos_path << ']' << endl;
-       return dos_path;
+
+string internal_path_list(string const & p)
+{
+       return subst(p, '\\', '/');
 }
 
 
-// (Claus H.) Parsing the latex log file in an Win32 environment all
-// files are mentioned in Win32/DOS syntax. Because LyX uses the dep file
-// entries to check if any file has been changed we must retranslate
-// the Win32/DOS pathnames into Cygwin pathnames.
-string internal_path(string const & p)
+string latex_path(string const & p)
 {
-#if defined(__CYGWIN__) || defined(__CYGWIN32__)
-       char posix_path[PATH_MAX];
-       posix_path[0] = '\0';
-       cygwin_conv_to_posix_path(p.c_str(), posix_path);
-       return posix_path;
-#else
-       return subst(p,"\\","/");
-#endif
+       // We may need a posix style path or a windows style path (depending
+       // on windows_style_tex_paths_), but we use always forward slashes,
+       // since it gets written into a .tex file.
+
+       if (!windows_style_tex_paths_ && is_absolute_path(p)) {
+               string const drive = p.substr(0, 2);
+               string const cygprefix = cygdrive + "/" + drive.substr(0, 1);
+               string const cygpath = subst(subst(p, '\\', '/'), drive, cygprefix);
+               lyxerr[Debug::LATEX]
+                       << "<Path correction for LaTeX> ["
+                       << p << "]->>["
+                       << cygpath << ']' << endl;
+               return cygpath;
+       }
+       return subst(p, '\\', '/');
 }
 
 
@@ -231,43 +303,129 @@ char const * popen_read_mode()
 
 string const & nulldev()
 {
-#if defined(__CYGWIN__) || defined(__CYGWIN32__)
-       static string const nulldev_ = "/dev/null";
-#else
        static string const nulldev_ = "nul";
-#endif
        return nulldev_;
 }
 
 
 shell_type shell()
 {
-#if defined(__CYGWIN__) || defined(__CYGWIN32__)
-       return UNIX;
-#else
        return CMD_EXE;
-#endif
 }
 
 
 char path_separator()
 {
-#if defined (_WIN32)
        return ';';
-#else // Cygwin
-       return ':';
-#endif
 }
 
 
-void cygwin_path_fix(bool use_cygwin_paths)
+void windows_style_tex_paths(bool use_windows_paths)
 {
-#if defined (_WIN32)
-       // Silence warning.
-       (void)use_cygwin_paths;
-#else // Cygwin
-       use_cygwin_paths_ = use_cygwin_paths;
-#endif
+       windows_style_tex_paths_ = use_windows_paths;
+}
+
+
+GetFolderPath::GetFolderPath()
+       : folder_module_(0),
+         folder_path_func_(0)
+{
+       folder_module_ = LoadLibrary("shfolder.dll");
+       if (!folder_module_) {
+               throw ExceptionMessage(ErrorException, _("System file not found"),
+                       _("Unable to load shfolder.dll\nPlease install."));
+       }
+
+       folder_path_func_ = reinterpret_cast<function_pointer>(::GetProcAddress(folder_module_, "SHGetFolderPathA"));
+       if (folder_path_func_ == 0) {
+               throw ExceptionMessage(ErrorException, _("System function not found"),
+                       _("Unable to find SHGetFolderPathA in shfolder.dll\n"
+                         "Don't know how to proceed. Sorry."));
+       }
+}
+
+
+GetFolderPath::~GetFolderPath()
+{
+       if (folder_module_)
+               FreeLibrary(folder_module_);
+}
+
+
+// Given a folder ID, returns the folder name (in unix-style format).
+// Eg CSIDL_PERSONAL -> "C:/Documents and Settings/USERNAME/My Documents"
+string const GetFolderPath::operator()(folder_id _id) const
+{
+       char folder_path[MAX_PATH];
+
+       int id = 0;
+       switch (_id) {
+       case PERSONAL:
+               id = CSIDL_PERSONAL;
+               break;
+       case APPDATA:
+               id = CSIDL_APPDATA;
+               break;
+       default:
+               BOOST_ASSERT(false);
+       }
+       HRESULT const result = (folder_path_func_)(0, id, 0,
+                                                  SHGFP_TYPE_CURRENT,
+                                                  folder_path);
+       return (result == 0) ? os::internal_path(to_utf8(from_filesystem8bit(folder_path))) : string();
+}
+
+
+bool canAutoOpenFile(string const & ext, auto_open_mode const mode)
+{
+       if (ext.empty())
+               return false;
+
+       string const full_ext = "." + ext;
+
+       DWORD bufSize = MAX_PATH + 100;
+       TCHAR buf[MAX_PATH + 100];
+       // reference: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/shellcc
+       //                 /platform/shell/reference/shlwapi/registry/assocquerystring.asp
+       char const * action = (mode == VIEW) ? "open" : "edit";
+       return S_OK == AssocQueryString(0, ASSOCSTR_EXECUTABLE,
+               full_ext.c_str(), action, buf, &bufSize);
+}
+
+
+bool autoOpenFile(string const & filename, auto_open_mode const mode)
+{
+       // reference: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/shellcc
+       //                 /platform/shell/reference/functions/shellexecute.asp
+       char const * action = (mode == VIEW) ? "open" : "edit";
+       return reinterpret_cast<int>(ShellExecute(NULL, action,
+               to_local8bit(from_utf8(filename)).c_str(), NULL, NULL, 1)) > 32;
+}
+
+
+void addFontResources()
+{
+       // Windows only: Add BaKoMa TrueType font resources
+       string const fonts_dir = addPath(package().system_support(), "fonts");
+       
+       for (int i = 0 ; i < num_fonts_truetype ; ++i) {
+               string const font_current =
+                       addName(fonts_dir, win_fonts_truetype[i] + ".ttf");
+               AddFontResource(to_local8bit(from_utf8(external_path(font_current))).c_str());
+       }
+}
+
+
+void restoreFontResources()
+{
+       // Windows only: Remove BaKoMa TrueType font resources
+       string const fonts_dir = addPath(package().system_support(), "fonts");
+       
+       for(int i = 0 ; i < num_fonts_truetype ; ++i) {
+               string const font_current =
+                       addName(fonts_dir, win_fonts_truetype[i] + ".ttf");
+               RemoveFontResource(to_local8bit(from_utf8(external_path(font_current))).c_str());
+       }
 }
 
 } // namespace os