Keep permissions of the saved files intact. (Backporting 04fe818b2239).

[lyx.git] / src / support / os.h

diff --git a/src/support/os.h b/src/support/os.h
index 1644ef4bf001eac42a13bae957aa28999736e720..9b38e4e44ee0272de8b5caf9be74e195ccc6ec5a 100644 (file)
--- a/src/support/os.h
+++ b/src/support/os.h
@@ -27,26 +27,27 @@ enum shell_type {
        CMD_EXE
 };
 
-enum io_channel {
-       STDIN = 0,
-       STDOUT,
-       STDERR
+enum path_case {
+       CASE_UNCHANGED,
+       CASE_ADJUSTED
 };
 
-/// Do some work just once.
-void init(int argc, char * argv[]);
+enum file_access {
+       EXISTING,
+       CREATE
+};
 
-/// Returns the name of the NULL device (/dev/null, null).
-std::string const & nulldev();
+/// Do some work just once.
+void init(int argc, char ** argv[]);
 
-/// Returns the name of the stdout device (/dev/stdout, /dev/tty, conout$).
-std::string const & stdoutdev();
+/// Returns the i-th program argument in utf8 encoding.
+std::string utf8_argv(int i);
 
-/// Returns the name of the stderr device (/dev/stderr, /dev/tty, conout$).
-std::string const & stderrdev();
+/// Removes from the internal copy \p num program arguments starting from \p i.
+void remove_internal_args(int i, int num);
 
-/// Tells whether \p channel is connected to a terminal or not. 
-bool is_terminal(io_channel channel);
+/// Returns the name of the NULL device (/dev/null, null).
+std::string const & nulldev();
 
 /// Returns "/" on *nix, "C:/", etc on Windows.
 std::string current_root();
@@ -54,14 +55,20 @@ std::string current_root();
 ///
 shell_type shell();
 
+/// Returns no. of minutes allowed for a command to complete.
+int timeout_min();
+
 /// Name of the python interpreter
-std::string const python();
+/// @param reset True if the python path should be recomputed
+std::string const python(bool reset = false);
 
 ///
 bool isFilesystemCaseSensitive();
 
 /// Extract the path common to both @c p1 and @c p2. DBCS aware!
-/// \p p1, \p p2 and the return value are encoded in utf8.
+/// \p p1 and \p p2 are encoded in ucs4, \returns the index to the end of
+/// the last matching path component (the index may be pointing after the
+/// end of @c p1 or @c p2 if their last char is not the path separator).
 std::size_t common_path(docstring const & p1, docstring const & p2);
 
 /// Converts a unix style path to host OS style.
@@ -72,6 +79,15 @@ std::string external_path(std::string const & p);
 /// \p p and the return value are encoded in utf8.
 std::string internal_path(std::string const & p);
 
+/// Converts a host OS style path to a unicode safe unix style.
+/// On Windows, this is achieved by using the short form of the path,
+/// which can be safely passed to standard I/O functions expecting narrow
+/// char paths even when the path contains non-ascii chars.
+/// As the short form is only available for existing files, if the file is
+/// to be accessed for writing, \param how should be set to CREATE.
+/// \p p and the return value are encoded in utf8.
+std::string safe_internal_path(std::string const & p, file_access how = EXISTING);
+
 /// Converts a unix style path list to host OS style.
 /// \p p and the return value are encoded in utf8.
 std::string external_path_list(std::string const & p);
@@ -89,6 +105,12 @@ std::string internal_path_list(std::string const & p);
  */
 std::string latex_path(std::string const & p);
 
+/**
+ * Converts a platform style path list into a form suitable for the TeX engine.
+ * \p p is encoded in utf8.
+ */
+std::string latex_path_list(std::string const & p);
+
 /// Checks if the format string is suitable on the OS
 bool is_valid_strftime(std::string const & p);
 
@@ -97,10 +119,15 @@ bool is_valid_strftime(std::string const & p);
  */
 char const * popen_read_mode();
 
-/** The character used to separate paths returned by the
- *  PATH environment variable.
+enum path_type {
+       PLATFORM,
+       TEXENGINE
+};
+
+/** The character used to separate paths for platform environment variables
+ *  (such as PATH) or for the TeX engine.
  */
-char path_separator();
+char path_separator(path_type type = PLATFORM);
 
 /** If @c use_windows_paths is true, LyX will output Windows-style paths to
  *  latex files rather than posix ones. Obviously, this option is used only
@@ -118,21 +145,33 @@ enum auto_open_mode {
  *  \param mode can be opened in VIEW or EDIT mode
  *  \returns whether or not the format can be opened according to \p mode
  */
-bool canAutoOpenFile(std::string const & ext, auto_open_mode const mode = VIEW);
+bool canAutoOpenFile(std::string const & ext, auto_open_mode const mode);
 
 /** View or edit a file with the default viewer or editor.
  *  \param filename file to open (encoded in utf8)
  *  \param mode open in VIEW or EDIT mode
  *  \returns whether or not the file is viewed (or edited) successfully.
  */
-bool autoOpenFile(std::string const & filename, auto_open_mode const mode = VIEW);
+bool autoOpenFile(std::string const & filename, auto_open_mode const mode,
+                 std::string const & path = empty_string());
 
 /** Resolves a path such that it does not contain '.', '..', or symbolic links.
-  * \warning the path must already be in the filesystem encoding.
-  * \returns the resolved path in utf8 encoding.
+  * \p path and the return value are encoded in utf8.
   */
 std::string real_path(std::string const & path);
 
+/** Checks whether \param path starts with \param pre, accounting for case
+  * insensitive file systems.
+  */
+bool path_prefix_is(std::string const & path, std::string const & pre);
+
+/** Checks whether \param path starts with \param pre, accounting for case
+  * insensitive file systems. If true, the file system is case insensitive,
+  * and \param how == CASE_ADJUSTED, the case of the matching prefix in
+  * @c path is made equal to that of @c pre.
+  */
+bool path_prefix_is(std::string & path, std::string const & pre, path_case how = CASE_UNCHANGED);
+
 } // namespace os
 } // namespace support
 } // namespace lyx