]> git.lyx.org Git - lyx.git/blobdiff - src/support/os_cygwin.cpp
Remove non-copyable idioms
[lyx.git] / src / support / os_cygwin.cpp
index 5ec1d1e3d2591e3ffa0950c2e92cb80c73299603..3464c04d785142fd4a4db3e10f686747addceef8 100644 (file)
@@ -6,6 +6,7 @@
  * \author Ruurd A. Reitsma
  * \author Claus Hentschel
  * \author Angus Leeming
+ * \author Enrico Forestieri
  *
  * Full author contact details are available in file CREDITS.
  *
 
 #include <config.h>
 
+#include "LyXRC.h"
+
 #include "support/os.h"
-#include "support/lstrings.h"
 
-#include "debug.h"
+#include "support/debug.h"
+#include "support/environment.h"
+#include "support/FileName.h"
+#include "support/filetools.h"
+#include "support/lassert.h"
+#include "support/lstrings.h"
 
 #include <windows.h>
 #include <io.h>
 #include <windef.h>
 #include <shellapi.h>
 #include <shlwapi.h>
+#include <limits.h>
+#include <stdlib.h>
 
+#include <cygwin/version.h>
 #include <sys/cygwin.h>
 
-using std::endl;
-using std::string;
+#include <ostream>
 
-using lyx::support::contains;
+using namespace std;
 
-#ifdef X_DISPLAY_MISSING
-#include "support/filetools.h"
-#include "support/Package.h"
-#include "support/Path.h"
-using lyx::support::addName;
-using lyx::support::addPath;
-using lyx::support::package;
-
-// API definition for manually calling font functions on Windows 2000 and later
-typedef int (WINAPI *FONTAPI)(LPCSTR, DWORD, PVOID);
-#define FR_PRIVATE     0x10
-
-// Names of TrueType fonts to load
-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);
-#endif
+namespace lyx {
 
+void lyx_exit(int);
 
-namespace lyx {
 namespace support {
 namespace os {
 
 namespace {
 
+int argc_ = 0;
+char ** argv_ = 0;
+
 bool windows_style_tex_paths_ = false;
 
 // In both is_posix_path() and is_windows_path() it is assumed that
@@ -77,6 +73,63 @@ bool is_windows_path(string const & p)
 }
 
 
+// Starting from Cygwin 1.7, new APIs for path conversions were introduced.
+// The old ones are now deprecated, so avoid them if we detect a modern Cygwin.
+
+#if CYGWIN_VERSION_DLL_MAJOR >= 1007
+
+enum PathStyle {
+       posix = CCP_WIN_A_TO_POSIX | CCP_RELATIVE,
+       windows = CCP_POSIX_TO_WIN_A | CCP_RELATIVE
+};
+
+
+/// Convert a path to or from posix style.
+/// \p p is encoded in local 8bit encoding or utf8.
+/// The result is returned in the same encoding as \p p.
+string convert_path(string const & p, PathStyle const & target)
+{
+       if ((target == posix && is_posix_path(p)) ||
+           (target == windows && is_windows_path(p)))
+               return p;
+
+       char path_buf[PATH_MAX];
+
+       // cygwin_conv_path does not care about the encoding.
+       if (cygwin_conv_path(target, p.c_str(), path_buf, sizeof(path_buf))) {
+               lyxerr << "LyX: Cannot convert path: " << p << endl;
+               return subst(p, '\\', '/');
+       }
+       return subst(path_buf, '\\', '/');
+}
+
+
+/// Convert a path list to or from posix style.
+/// \p p is encoded in local 8bit encoding or utf8.
+/// The result is returned in the same encoding as \p p.
+string convert_path_list(string const & p, PathStyle const & target)
+{
+       if (p.empty())
+               return p;
+
+       char const * const pc = p.c_str();
+       PathStyle const actual = cygwin_posix_path_list_p(pc) ? posix : windows;
+
+       if (target != actual) {
+               int const size = cygwin_conv_path_list(target, pc, NULL, 0);
+               char * ptr = new char[size];
+               if (ptr && cygwin_conv_path_list(target, pc, ptr, size) == 0) {
+                       string const path_list = subst(ptr, '\\', '/');
+                       delete [] ptr;
+                       return path_list;
+               } else
+                       lyxerr << "LyX: Cannot convert path list: " << p << endl;
+       }
+       return subst(p, '\\', '/');
+}
+
+#else
+
 enum PathStyle {
        posix,
        windows
@@ -133,7 +186,7 @@ string convert_path_list(string const & p, PathStyle const & target)
                                cygwin_posix_to_win32_path_list(pc, ptr);
 
                        string path_list = subst(ptr, '\\', '/');
-                       delete ptr;
+                       delete [] ptr;
                        return path_list;
                }
        }
@@ -141,58 +194,64 @@ string convert_path_list(string const & p, PathStyle const & target)
        return subst(p, '\\', '/');
 }
 
-} // namespace anon
+#endif
 
-void os::init(int, char *[])
+
+BOOL terminate_handler(DWORD event)
 {
-       // Copy cygwin environment variables to the Windows environment
-       // if they're not already there.
-
-       char **envp = environ;
-       char curval[2];
-       string var;
-       string val;
-       bool temp_seen = false;
-
-       while (envp && *envp) {
-               val = split(*envp++, var, '=');
-
-               if (var == "TEMP")
-                       temp_seen = true;
-
-               if (GetEnvironmentVariable(var.c_str(), curval, 2) == 0
-                               && GetLastError() == ERROR_ENVVAR_NOT_FOUND) {
-                       /* Convert to Windows style where necessary */
-                       if (var == "PATH" || var == "LD_LIBRARY_PATH") {
-                               string const winpathlist =
-                                   convert_path_list(val, PathStyle(windows));
-                               if (!winpathlist.empty()) {
-                                       SetEnvironmentVariable(var.c_str(),
-                                               winpathlist.c_str());
-                               }
-                       } else if (var == "HOME" || var == "TMPDIR" ||
-                                       var == "TMP" || var == "TEMP") {
-                               string const winpath =
-                                       convert_path(val, PathStyle(windows));
-                               SetEnvironmentVariable(var.c_str(), winpath.c_str());
-                       } else {
-                               SetEnvironmentVariable(var.c_str(), val.c_str());
-                       }
-               }
-       }
-       if (!temp_seen) {
-               string const winpath = convert_path("/tmp", PathStyle(windows));
-               SetEnvironmentVariable("TEMP", winpath.c_str());
+       if (event == CTRL_CLOSE_EVENT
+           || event == CTRL_LOGOFF_EVENT
+           || event == CTRL_SHUTDOWN_EVENT) {
+               lyx::lyx_exit(1);
+               return TRUE;
        }
+       return FALSE;
+}
+
+} // namespace anon
+
+void init(int argc, char * argv[])
+{
+       argc_ = argc;
+       argv_ = argv;
+
+       // Set environment's default locale
+       setlocale(LC_ALL, "");
+       setlocale(LC_NUMERIC, "C");
+
+       // Make sure that the TEMP variable is set
+       // and sync the Windows environment.
+       setenv("TEMP", "/tmp", false);
+       cygwin_internal(CW_SYNC_WINENV);
+
+       // Catch shutdown events.
+       SetConsoleCtrlHandler((PHANDLER_ROUTINE)terminate_handler, TRUE);
+}
+
+
+string utf8_argv(int i)
+{
+       LASSERT(i < argc_, return "");
+       return to_utf8(from_local8bit(argv_[i]));
 }
 
 
+void remove_internal_args(int, int)
+{}
+
+
 string current_root()
 {
        return string("/");
 }
 
 
+bool isFilesystemCaseSensitive()
+{
+       return false;
+}
+
+
 docstring::size_type common_path(docstring const & p1, docstring const & p2)
 {
        docstring::size_type i = 0;
@@ -213,6 +272,38 @@ docstring::size_type common_path(docstring const & p1, docstring const & p2)
 }
 
 
+bool path_prefix_is(string const & path, string const & pre)
+{
+       return path_prefix_is(const_cast<string &>(path), pre, CASE_UNCHANGED);
+}
+
+
+bool path_prefix_is(string & path, string const & pre, path_case how)
+{
+       docstring const p1 = from_utf8(path);
+       docstring const p2 = from_utf8(pre);
+       docstring::size_type const p1_len = p1.length();
+       docstring::size_type const p2_len = p2.length();
+       docstring::size_type common_len = common_path(p1, p2);
+
+       if (p2[p2_len - 1] == '/' && p1_len != p2_len)
+               ++common_len;
+
+       if (common_len != p2_len)
+               return false;
+
+       if (how == CASE_ADJUSTED && !prefixIs(path, pre)) {
+               if (p1_len < common_len)
+                       path = to_utf8(p2.substr(0, p1_len));
+               else
+                       path = to_utf8(p2 + p1.substr(common_len,
+                                                       p1_len - common_len));
+       }
+
+       return true;
+}
+
+
 string external_path(string const & p)
 {
        return convert_path(p, PathStyle(posix));
@@ -225,6 +316,12 @@ string internal_path(string const & p)
 }
 
 
+string safe_internal_path(string const & p, file_access)
+{
+       return convert_path(p, PathStyle(posix));
+}
+
+
 string external_path_list(string const & p)
 {
        return convert_path_list(p, PathStyle(posix));
@@ -243,12 +340,10 @@ string latex_path(string const & p)
        // 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)) {
+       if (windows_style_tex_paths_ && FileName::isAbsolute(p)) {
                string dos_path = convert_path(p, PathStyle(windows));
-               LYXERR(Debug::LATEX)
-                       << "<Path correction for LaTeX> ["
-                       << p << "]->>["
-                       << dos_path << ']' << endl;
+               LYXERR(Debug::LATEX, "<Path correction for LaTeX> ["
+                       << p << "]->>[" << dos_path << ']');
                return dos_path;
        }
 
@@ -256,15 +351,33 @@ string latex_path(string const & p)
 }
 
 
-bool is_absolute_path(string const & p)
+string latex_path_list(string const & p)
 {
-       if (p.empty())
-               return false;
+       // 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 this is standard for all tex engines.
+
+       if (windows_style_tex_paths_)
+               return convert_path_list(p, PathStyle(windows));
+
+       return convert_path_list(p, PathStyle(posix));
+}
 
-       bool isDosPath = (p.length() > 1 && p[1] == ':');
-       bool isUnixPath = (p[0] == '/');
 
-       return isDosPath || isUnixPath;
+bool is_valid_strftime(string const & p)
+{
+       string::size_type pos = p.find_first_of('%');
+       while (pos != string::npos) {
+               if (pos + 1 == string::npos)
+                       break;
+               if (!containsOnly(p.substr(pos + 1, 1),
+                       "aAbBcCdDeEFgGhHIjklmMnOpPrRsStTuUVwWxXyYzZ%+"))
+                       return false;
+               if (pos + 2 == string::npos)
+                     break;
+               pos = p.find_first_of('%', pos + 2);
+       }
+       return true;
 }
 
 
@@ -289,8 +402,11 @@ shell_type shell()
 }
 
 
-char path_separator()
+char path_separator(path_type type)
 {
+       if (type == TEXENGINE)
+               return windows_style_tex_paths_ ? ';' : ':';
+
        return ':';
 }
 
@@ -310,75 +426,58 @@ bool canAutoOpenFile(string const & ext, auto_open_mode const mode)
 
        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
+       // reference: http://msdn.microsoft.com/en-us/library/bb773471.aspx
        char const * action = (mode == VIEW) ? "open" : "edit";
-       return S_OK == AssocQueryString(0, ASSOCSTR_EXECUTABLE,
-               full_ext.c_str(), action, buf, &bufSize);
+       return S_OK == AssocQueryString(ASSOCF_INIT_IGNOREUNKNOWN,
+               ASSOCSTR_EXECUTABLE, full_ext.c_str(), action, buf, &bufSize);
 }
 
 
-bool autoOpenFile(string const & filename, auto_open_mode const mode)
+bool autoOpenFile(string const & filename, auto_open_mode const mode,
+                 string const & path)
 {
-       // reference: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/shellcc
-       //                 /platform/shell/reference/functions/shellexecute.asp
+       string const texinputs = os::latex_path_list(
+                       replaceCurdirPath(path, lyxrc.texinputs_prefix));
+       string const otherinputs = os::latex_path_list(path);
+       string const sep = windows_style_tex_paths_ ? ";" : ":";
+       string const oldtexinputs = getEnv("TEXINPUTS");
+       string const newtexinputs = "." + sep + texinputs + sep + oldtexinputs;
+       string const oldbibinputs = getEnv("BIBINPUTS");
+       string const newbibinputs = "." + sep + otherinputs + sep + oldbibinputs;
+       string const oldbstinputs = getEnv("BSTINPUTS");
+       string const newbstinputs = "." + sep + otherinputs + sep + oldbstinputs;
+       string const oldtexfonts = getEnv("TEXFONTS");
+       string const newtexfonts = "." + sep + otherinputs + sep + oldtexfonts;
+       if (!path.empty() && !lyxrc.texinputs_prefix.empty()) {
+               setEnv("TEXINPUTS", newtexinputs);
+               setEnv("BIBINPUTS", newbibinputs);
+               setEnv("BSTINPUTS", newbstinputs);
+               setEnv("TEXFONTS", newtexfonts);
+               cygwin_internal(CW_SYNC_WINENV);
+       }
+
+       // reference: http://msdn.microsoft.com/en-us/library/bb762153.aspx
        string const win_path = to_local8bit(from_utf8(convert_path(filename, PathStyle(windows))));
        char const * action = (mode == VIEW) ? "open" : "edit";
-       return reinterpret_cast<int>(ShellExecute(NULL, action,
-               win_path.c_str(), NULL, NULL, 1)) > 32;
-}
-
-
-void addFontResources()
-{
-#ifdef X_DISPLAY_MISSING
-       // Windows only: Add BaKoMa TrueType font resources
-       string const fonts_dir = addPath(package().system_support().absFilename(), "fonts");
-
-       HMODULE hDLL = LoadLibrary("gdi32");
-       FONTAPI pAddFontResourceEx =
-               (FONTAPI) GetProcAddress(hDLL, "AddFontResourceExA");
-
-       for (int i = 0 ; i < num_fonts_truetype ; ++i) {
-               string const font_current = to_local8bit(from_utf8(convert_path(
-                       addName(fonts_dir, win_fonts_truetype[i] + ".ttf"),
-                       PathStyle(windows))));
-               if (pAddFontResourceEx) {
-                       // Windows 2000 and later: Use AddFontResourceEx
-                       pAddFontResourceEx(font_current.c_str(), FR_PRIVATE, 0);
-               } else {
-                       // Older Windows versions: Use AddFontResource
-                       AddFontResource(font_current.c_str());
-               }
+       bool success = reinterpret_cast<long>(ShellExecute(NULL, action,
+                                       win_path.c_str(), NULL, NULL, 1)) > 32;
+
+       if (!path.empty() && !lyxrc.texinputs_prefix.empty()) {
+               setEnv("TEXINPUTS", oldtexinputs);
+               setEnv("BIBINPUTS", oldbibinputs);
+               setEnv("BSTINPUTS", oldbstinputs);
+               setEnv("TEXFONTS", oldtexfonts);
+               cygwin_internal(CW_SYNC_WINENV);
        }
-       FreeLibrary(hDLL);
-#endif
+       return success;
 }
 
 
-void restoreFontResources()
+string real_path(string const & path)
 {
-#ifdef X_DISPLAY_MISSING
-       // Windows only: Remove BaKoMa TrueType font resources
-       string const fonts_dir = addPath(package().system_support().absFilename(), "fonts");
-
-       HMODULE hDLL = LoadLibrary("gdi32");
-       FONTAPI pRemoveFontResourceEx = (FONTAPI) GetProcAddress(hDLL, "RemoveFontResourceExA");
-
-       for(int i = 0 ; i < num_fonts_truetype ; ++i) {
-               string const font_current = to_local8bit(from_utf8(convert_path(
-                       addName(fonts_dir, win_fonts_truetype[i] + ".ttf"),
-                       PathStyle(windows))));
-               if (pRemoveFontResourceEx) {
-                       // Windows 2000 and later: Use RemoveFontResourceEx
-                       pRemoveFontResourceEx(font_current.c_str(), FR_PRIVATE, 0);
-               } else {
-                       // Older Windows versions: Use RemoveFontResource
-                       RemoveFontResource(font_current.c_str());
-               }
-       }
-       FreeLibrary(hDLL);
-#endif
+       char rpath[PATH_MAX + 1];
+       char * result = realpath(path.c_str(), rpath);
+       return FileName::fromFilesystemEncoding(result ? rpath : path).absFileName();
 }
 
 } // namespace os