]> git.lyx.org Git - lyx.git/blobdiff - src/support/os.h
CMake: fix merged build, seems GCC could not handle the namespaces correctly
[lyx.git] / src / support / os.h
index 11147e596b4f4a0cbe523684788af63c189afb89..115bfdbfaf2b1899b44dcd3a39380ac19705a5dc 100644 (file)
@@ -14,7 +14,8 @@
 #ifndef OS_H
 #define OS_H
 
-#include "support/docstring.h"
+#include "support/strfwd.h"
+#include <cstddef>
 
 
 namespace lyx {
@@ -26,12 +27,26 @@ 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();
 
@@ -41,9 +56,14 @@ 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!
-/// \p p1, \p p2 and the return value are encoded in utf8.
-docstring::size_type common_path(docstring const & p1, docstring 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.
@@ -70,9 +90,8 @@ std::string internal_path_list(std::string const & p);
  */
 std::string latex_path(std::string const & p);
 
-/// Is the path absolute?
-/// \p p is encoded in utf8.
-bool is_absolute_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.
@@ -109,6 +128,24 @@ bool canAutoOpenFile(std::string const & ext, auto_open_mode const mode = VIEW);
  */
 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