CMake: fix merged build, seems GCC could not handle the namespaces correctly

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

diff --git a/src/support/os.h b/src/support/os.h
index ca4bd675ec9b3031ab644365bfe2e48e15f6780c..115bfdbfaf2b1899b44dcd3a39380ac19705a5dc 100644 (file)
--- a/src/support/os.h
+++ b/src/support/os.h
@@ -14,7 +14,8 @@
 #ifndef OS_H
 #define OS_H
 
-#include <string>
+#include "support/strfwd.h"
+#include <cstddef>
 
 
 namespace lyx {
@@ -26,29 +27,71 @@ 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[]);
 
 /// Returns the name of the NULL device (/dev/null, null).
 std::string const & nulldev();
 
+/// Tells whether \p channel is connected to a terminal or not. 
+bool is_terminal(io_channel channel);
+
 /// Returns "/" on *nix, "C:/", etc on Windows.
 std::string current_root();
 
 ///
 shell_type shell();
 
+/// Name of the python interpreter
+std::string const python();
+
+///
+bool isFilesystemCaseSensitive();
+
 /// Extract the path common to both @c p1 and @c p2. DBCS aware!
-std::string::size_type common_path(std::string const & p1, std::string const & p2);
+/// \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.
+/// \p p and the return value are encoded in utf8.
 std::string external_path(std::string const & p);
 
 /// Converts a host OS style path to unix style.
+/// \p p and the return value are encoded in utf8.
 std::string internal_path(std::string const & p);
 
-/// Is the path absolute?
-bool is_absolute_path(std::string const & p);
+/// 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);
+
+/// Converts a host OS style path list to unix style.
+/// \p p and the return value are encoded in utf8.
+std::string internal_path_list(std::string const & p);
+
+/**
+ * Converts a unix style path into a form suitable for inclusion in a LaTeX
+ * document.
+ * \p p is encoded in utf8.
+ * Caution: This function handles only the OS specific part of that task.
+ * Never use it directly, use lyx::support::latex_path instead.
+ */
+std::string latex_path(std::string const & p);
+
+/// Checks if the format string is suitable on the OS
+bool is_valid_strftime(std::string const & p);
 
 /** Returns a string suitable to be passed to popen when
  *  reading a file.
@@ -60,6 +103,49 @@ char const * popen_read_mode();
  */
 char path_separator();
 
+/** 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
+ *  under Windows.
+ */
+void windows_style_tex_paths(bool use_windows_paths);
+
+enum auto_open_mode {
+       VIEW,
+       EDIT
+};
+
+/** Check whether or not a file can be opened by a default viewer or editor.
+ *  \param extension (without leading .)
+ *  \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);
+
+/** 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);
+
+/** 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.
+  */
+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