-// os_win32.C copyright "Ruurd A. Reitsma" <R.A.Reitsma@wbmt.tudelft.nl>
+/**
+ * \file os_win32.C
+ * This file is part of LyX, the document processor.
+ * 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.
+ *
+ * Various OS specific functions
+ */
-// Various OS specific functions
#include <config.h>
-#include "os.h"
-#include "support/filetools.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 <sys/cygwin.h>
+#include <boost/assert.hpp>
+#include <cstdlib>
+#include <vector>
+
+/* 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
+
+#include <io.h>
+#include <direct.h> // _getdrive
+#include <shlobj.h> // SHGetFolderPath
+#include <windef.h>
+#include <shellapi.h>
+#include <shlwapi.h>
-string os::binpath_ = string();
-string os::binname_ = string();
-string os::tmpdir_ = string();
-os::shell_type os::_shell = os::UNIX;
-unsigned long os::cp_ = 0;
+// 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;
-void os::init(int * /* argc */, char ** argv[]) {
- static bool initialized = false;
- if (initialized) return;
- initialized = true;
- string tmp = *argv[0];
- binname_ = OnlyFilename(tmp);
- tmp = ExpandPath(tmp); // This expands ./ and ~/
-
- if (!is_absolute_path(tmp)) {
- string binsearchpath = GetEnvPath("PATH");
- // This will make "src/lyx" work always :-)
- binsearchpath += ";.";
- tmp = *argv[0];
- tmp = FileOpenSearch(binsearchpath, tmp);
- }
+using lyx::support::runCommand;
+using lyx::support::split;
+using lyx::support::addName;
+using lyx::support::addPath;
+using lyx::support::package;
- tmp = MakeAbsPath(OnlyPath(tmp));
+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);
- // In case we are running in place and compiled with shared libraries
- if (suffixIs(tmp, "/.libs/"))
- tmp.erase(tmp.length()-6, string::npos);
- binpath_ = tmp;
-}
-void os::warn(string mesg) {
- MessageBox(0, mesg.c_str(), "LyX error",
- MB_OK|MB_ICONSTOP|MB_SYSTEMMODAL);
+namespace lyx {
+namespace support {
+namespace os {
+
+namespace {
+
+bool windows_style_tex_paths_ = true;
+
+string cygdrive = "/cygdrive";
+
+} // namespace anon
+
+void init(int /* argc */, char * argv[])
+{
+ /* Note from Angus, 17 Jan 2005:
+ *
+ * The code below is taken verbatim from Ruurd's original patch
+ * porting LyX to Win32.
+ *
+ * Windows allows us to define LyX either as a console-based app
+ * or as a GUI-based app. Ruurd decided to define LyX as a
+ * console-based app with a "main" function rather than a "WinMain"
+ * function as the point of entry to the program, but to
+ * immediately close the console window that Windows helpfully
+ * opens for us. Doing so allows the user to see all of LyX's
+ * debug output simply by running LyX from a DOS or MSYS-shell
+ * prompt.
+ *
+ * The alternative approach is to define LyX as a genuine
+ * GUI-based app, with a "WinMain" function as the entry point to the
+ * executable rather than a "main" function, so:
+ *
+ * #if defined (_WIN32)
+ * # define WIN32_LEAN_AND_MEAN
+ * # include <stdlib.h> // for __argc, __argv
+ * # include <windows.h> // for WinMain
+ * #endif
+ *
+ * // This will require the "-mwindows" flag when linking with
+ * // gcc under MinGW.
+ * // For MSVC, use "/subsystem:windows".
+ * #if defined (_WIN32)
+ * int WINAPI WinMain(HINSTANCE, HINSTANCE, LPSTR, int)
+ * {
+ * return mymain(__argc, __argv);
+ * }
+ * #endif
+ *
+ * where "mymain" is just a renamed "main".
+ *
+ * However, doing so means that the lyxerr messages would mysteriously
+ * disappear. They could be resurrected with something like:
+ *
+ * #ifdef WIN32
+ * AllocConsole();
+ * freopen("conin$","r",stdin);
+ * freopen("conout$","w",stdout);
+ * freopen("conout$","w",stderr);
+ * #endif
+ *
+ * This code could be invoked (say) the first time that lyxerr
+ * is called. However, Ruurd has tried this route and found that some
+ * shell scripts failed, for mysterious reasons...
+ *
+ * I've chosen for now, therefore, to simply add Ruurd's original
+ * 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.
+ */
+
+ // 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, ®Key);
+ if (retVal != ERROR_SUCCESS) {
+ retVal = RegOpenKeyEx(HKEY_CURRENT_USER,
+ "Software\\Cygnus Solutions\\Cygwin\\mounts v2",
+ 0, KEY_QUERY_VALUE, ®Key);
+ }
+ 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;
}
+}
+
-string os::current_root() {
- return string("/");
+string current_root()
+{
+ // _getdrive returns the current drive (1=A, 2=B, and so on).
+ char const drive = ::_getdrive() + 'A' - 1;
+ return string(1, drive) + ":/";
}
-string::size_type os::common_path(string const &p1, string const &p2) {
- string::size_type i = 0,
- p1_len = p1.length(),
- p2_len = p2.length();
- while (i < p1_len && i < p2_len && uppercase(p1[i]) == uppercase(p2[i])) ++i;
+
+string::size_type common_path(string const & p1, string const & p2)
+{
+ string::size_type i = 0;
+ string::size_type p1_len = p1.length();
+ string::size_type p2_len = p2.length();
+ while (i < p1_len && i < p2_len && uppercase(p1[i]) == uppercase(p2[i]))
+ ++i;
if ((i < p1_len && i < p2_len)
|| (i < p1_len && p1[i] != '/' && i == p2_len)
- || (i < p2_len && p2[i] != '/' && i == p1_len)) {
- if (i) --i; // here was the last match
- while (i && p1[i] != '/') --i;
+ || (i < p2_len && p2[i] != '/' && i == p1_len))
+ {
+ if (i)
+ --i; // here was the last match
+ while (i && p1[i] != '/')
+ --i;
}
return i;
}
-string os::slashify_path(string p) {
- return subst(p, '\\', '/');
-}
-string os::external_path(string const & p) {
- string dos_path=p;
- if (is_absolute_path(p)) {
- char dp[255];
- cygwin_conv_to_full_win32_path(p.c_str(), dp);
- dos_path=subst(dp,'\\','/');
- }
+string external_path(string const & p)
+{
+ string const dos_path = subst(p, "/", "\\");
+
lyxerr[Debug::LATEX]
<< "<Win32 path correction> ["
<< p << "]->>["
- << dos_path << "]" << endl;
+ << dos_path << ']' << endl;
return dos_path;
}
-// (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 os::internal_path(string const &p) {
- char pp[256];
- cygwin_conv_to_posix_path(p.c_str(), pp);
- string const posix_path = MakeLatexName(pp);
- lyxerr[Debug::DEPEND]
- << "<Win32 path correction> ["
- << p << "]->>["
- << posix_path << "]" << endl;
- return posix_path;
+namespace {
+
+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
+
+
+string internal_path(string const & p)
+{
+ return subst(get_long_path(p), "\\", "/");
+}
+
+
+string external_path_list(string const & p)
+{
+ return subst(p, '/', '\\');
+}
+
+
+string internal_path_list(string const & p)
+{
+ return subst(p, '\\', '/');
+}
+
+
+string latex_path(string const & p)
+{
+ // 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, '\\', '/');
}
+
// (Claus H.) On Win32 both Unix and Win32/DOS pathnames are used.
// Therefore an absolute path could be either a pathname starting
// with a slash (Unix) or a pathname starting with a drive letter
// followed by a colon. Because a colon is not valid in pathes in Unix
// and at another location in Win32 testing just for the existance
// of the colon in the 2nd position seems to be enough!
-bool os::is_absolute_path(string const & p)
+bool is_absolute_path(string const & p)
{
if (p.empty())
return false;
bool isDosPath = (p.length() > 1 && p[1] == ':');
bool isUnixPath = (p[0] == '/');
- return isDosPath | isUnixPath;
+ return isDosPath || isUnixPath;
}
-// returns a string suitable to be passed to fopen when
-// reading a file
-char const * os::read_mode()
-{
- return "rb";
-}
// returns a string suitable to be passed to popen when
// reading a pipe
-char const * os::popen_read_mode()
+char const * popen_read_mode()
{
return "r";
}
+
+
+string const & nulldev()
+{
+ static string const nulldev_ = "nul";
+ return nulldev_;
+}
+
+
+shell_type shell()
+{
+ return CMD_EXE;
+}
+
+
+char path_separator()
+{
+ return ';';
+}
+
+
+void windows_style_tex_paths(bool use_windows_paths)
+{
+ 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
+} // namespace support
+} // namespace lyx
projects / lyx.git / blobdiff