src/support/os_cygwin.cpp

   1 /**
   2  * \file os_cygwin.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  * \author Enrico Forestieri
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  *
  13  * Various OS specific functions
  14  */
  15
  16 #include <config.h>
  17
  18 #include "support/os.h"
  19
  20 #include "support/FileName.h"
  21 #include "support/lstrings.h"
  22 #include "support/debug.h"
  23
  24 #include <windows.h>
  25 #include <io.h>
  26 #include <windef.h>
  27 #include <shellapi.h>
  28 #include <shlwapi.h>
  29 #include <limits.h>
  30 #include <stdlib.h>
  31
  32 #include <sys/cygwin.h>
  33
  34 using namespace std;
  35
  36 namespace lyx {
  37 namespace support {
  38 namespace os {
  39
  40 namespace {
  41
  42 bool windows_style_tex_paths_ = false;
  43
  44 // In both is_posix_path() and is_windows_path() it is assumed that
  45 // a valid posix or pseudo-windows path is passed. They simply tell
  46 // whether the path looks posix/pseudo-windows or not.
  47
  48 bool is_posix_path(string const & p)
  49 {
  50         return  p.empty() ||
  51                 (!contains(p, '\\') && (p.length() <= 1 || p[1] != ':'));
  52 }
  53
  54 // This is a test for a win32 style path with forward slashes (pseudo-windows).
  55
  56 bool is_windows_path(string const & p)
  57 {
  58         return p.empty() || (!contains(p, '\\') && p[0] != '/');
  59 }
  60
  61
  62 enum PathStyle {
  63         posix,
  64         windows
  65 };
  66
  67
  68 /// Convert a path to or from posix style.
  69 /// \p p is encoded in local 8bit encoding or utf8.
  70 /// The result is returned in the same encoding as \p p.
  71 string convert_path(string const & p, PathStyle const & target)
  72 {
  73         char path_buf[PATH_MAX];
  74
  75         if ((target == posix && is_posix_path(p)) ||
  76             (target == windows && is_windows_path(p)))
  77                 return p;
  78
  79         path_buf[0] = '\0';
  80
  81         // cygwin_conv_to_posix_path and cygwin_conv_to_win32_path do not
  82         // care about the encoding.
  83         if (target == posix)
  84                 cygwin_conv_to_posix_path(p.c_str(), path_buf);
  85         else
  86                 cygwin_conv_to_win32_path(p.c_str(), path_buf);
  87
  88         return subst(path_buf[0] ? path_buf : p, '\\', '/');
  89 }
  90
  91
  92 /// Convert a path list to or from posix style.
  93 /// \p p is encoded in local 8bit encoding or utf8.
  94 /// The result is returned in the same encoding as \p p.
  95 string convert_path_list(string const & p, PathStyle const & target)
  96 {
  97         if (p.empty())
  98                 return p;
  99
 100         char const * const pc = p.c_str();
 101         PathStyle const actual = cygwin_posix_path_list_p(pc) ? posix : windows;
 102
 103         if (target != actual) {
 104                 int const target_size = (target == posix) ?
 105                                 cygwin_win32_to_posix_path_list_buf_size(pc) :
 106                                 cygwin_posix_to_win32_path_list_buf_size(pc);
 107
 108                 char * ptr = new char[target_size];
 109
 110                 if (ptr) {
 111                         // FIXME: See comment in convert_path() above
 112                         if (target == posix)
 113                                 cygwin_win32_to_posix_path_list(pc, ptr);
 114                         else
 115                                 cygwin_posix_to_win32_path_list(pc, ptr);
 116
 117                         string path_list = subst(ptr, '\\', '/');
 118                         delete ptr;
 119                         return path_list;
 120                 }
 121         }
 122
 123         return subst(p, '\\', '/');
 124 }
 125
 126 } // namespace anon
 127
 128 void init(int, char *[])
 129 {
 130         // Make sure that the TEMP variable is set
 131         // and sync the Windows environment.
 132
 133         setenv("TEMP", "/tmp", false);
 134         cygwin_internal(CW_SYNC_WINENV);
 135 }
 136
 137
 138 string current_root()
 139 {
 140         return string("/");
 141 }
 142
 143
 144 bool isFilesystemCaseSensitive()
 145 {
 146         return false;
 147 }
 148
 149
 150 docstring::size_type common_path(docstring const & p1, docstring const & p2)
 151 {
 152         docstring::size_type i = 0;
 153         docstring::size_type const p1_len = p1.length();
 154         docstring::size_type const p2_len = p2.length();
 155         while (i < p1_len && i < p2_len && uppercase(p1[i]) == uppercase(p2[i]))
 156                 ++i;
 157         if ((i < p1_len && i < p2_len)
 158             || (i < p1_len && p1[i] != '/' && i == p2_len)
 159             || (i < p2_len && p2[i] != '/' && i == p1_len))
 160         {
 161                 if (i)
 162                         --i;     // here was the last match
 163                 while (i && p1[i] != '/')
 164                         --i;
 165         } else
 166                 --i;
 167
 168         return i;
 169 }
 170
 171
 172 bool path_prefix_is(string const & path, string const & pre)
 173 {
 174         return path_prefix_is(const_cast<string &>(path), pre, CASE_UNCHANGED);
 175 }
 176
 177
 178 bool path_prefix_is(string & path, string const & pre, path_case how)
 179 {
 180         docstring const p1 = from_utf8(path);
 181         docstring const p2 = from_utf8(pre);
 182         docstring::size_type const p1_len = p1.length();
 183         docstring::size_type const p2_len = p2.length();
 184         docstring::size_type const common_len = common_path(p1, p2) + 1;
 185
 186         if (common_len == 1) {
 187                 if (p2_len != 1 || p1_len == 0 || p1[0] != p2[0]
 188                     || (p1_len != 1 && p1[1] != '/'))
 189                         return false;
 190         } else if (common_len != p2_len)
 191                 return false;
 192
 193         if (how == CASE_ADJUSTED && !prefixIs(path, pre))
 194                 path = to_utf8(p2 + p1.substr(common_len, p1_len - common_len));
 195
 196         return true;
 197 }
 198
 199
 200 string external_path(string const & p)
 201 {
 202         return convert_path(p, PathStyle(posix));
 203 }
 204
 205
 206 string internal_path(string const & p)
 207 {
 208         return convert_path(p, PathStyle(posix));
 209 }
 210
 211
 212 string external_path_list(string const & p)
 213 {
 214         return convert_path_list(p, PathStyle(posix));
 215 }
 216
 217
 218 string internal_path_list(string const & p)
 219 {
 220         return convert_path_list(p, PathStyle(posix));
 221 }
 222
 223
 224 string latex_path(string const & p)
 225 {
 226         // We may need a posix style path or a windows style path (depending
 227         // on windows_style_tex_paths_), but we use always forward slashes,
 228         // since it gets written into a .tex file.
 229
 230         if (windows_style_tex_paths_ && FileName::isAbsolute(p)) {
 231                 string dos_path = convert_path(p, PathStyle(windows));
 232                 LYXERR(Debug::LATEX, "<Path correction for LaTeX> ["
 233                         << p << "]->>[" << dos_path << ']');
 234                 return dos_path;
 235         }
 236
 237         return convert_path(p, PathStyle(posix));
 238 }
 239
 240
 241 bool is_valid_strftime(string const & p)
 242 {
 243         string::size_type pos = p.find_first_of('%');
 244         while (pos != string::npos) {
 245                 if (pos + 1 == string::npos)
 246                         break;
 247                 if (!containsOnly(p.substr(pos + 1, 1),
 248                         "aAbBcCdDeEFgGhHIjklmMnOpPrRsStTuUVwWxXyYzZ%+"))
 249                         return false;
 250                 if (pos + 2 == string::npos)
 251                       break;
 252                 pos = p.find_first_of('%', pos + 2);
 253         }
 254         return true;
 255 }
 256
 257
 258 // returns a string suitable to be passed to popen when
 259 // reading a pipe
 260 char const * popen_read_mode()
 261 {
 262         return "r";
 263 }
 264
 265
 266 string const & nulldev()
 267 {
 268         static string const nulldev_ = "/dev/null";
 269         return nulldev_;
 270 }
 271
 272
 273 bool is_terminal(io_channel channel)
 274 {
 275         return isatty(channel);
 276 }
 277
 278
 279 shell_type shell()
 280 {
 281         return UNIX;
 282 }
 283
 284
 285 char path_separator()
 286 {
 287         return ':';
 288 }
 289
 290
 291 void windows_style_tex_paths(bool use_windows_paths)
 292 {
 293         windows_style_tex_paths_ = use_windows_paths;
 294 }
 295
 296
 297 bool canAutoOpenFile(string const & ext, auto_open_mode const mode)
 298 {
 299         if (ext.empty())
 300                 return false;
 301
 302         string const full_ext = "." + ext;
 303
 304         DWORD bufSize = MAX_PATH + 100;
 305         TCHAR buf[MAX_PATH + 100];
 306         // reference: http://msdn.microsoft.com/en-us/library/bb773471.aspx
 307         char const * action = (mode == VIEW) ? "open" : "edit";
 308         return S_OK == AssocQueryString(ASSOCF_INIT_IGNOREUNKNOWN,
 309                 ASSOCSTR_EXECUTABLE, full_ext.c_str(), action, buf, &bufSize);
 310 }
 311
 312
 313 bool autoOpenFile(string const & filename, auto_open_mode const mode)
 314 {
 315         // reference: http://msdn.microsoft.com/en-us/library/bb762153.aspx
 316         string const win_path = to_local8bit(from_utf8(convert_path(filename, PathStyle(windows))));
 317         char const * action = (mode == VIEW) ? "open" : "edit";
 318         return reinterpret_cast<int>(ShellExecute(NULL, action,
 319                 win_path.c_str(), NULL, NULL, 1)) > 32;
 320 }
 321
 322
 323 string real_path(string const & path)
 324 {
 325         char rpath[PATH_MAX + 1];
 326         char * result = realpath(path.c_str(), rpath);
 327         return FileName::fromFilesystemEncoding(result ? rpath : path).absFilename();
 328 }
 329
 330 } // namespace os
 331 } // namespace support
 332 } // namespace lyx