CMD_EXE
};
-enum io_channel {
- STDIN = 0,
- STDOUT,
- STDERR
+enum path_case {
+ CASE_UNCHANGED,
+ CASE_ADJUSTED
+};
+
+enum file_access {
+ EXISTING,
+ CREATE
};
/// Do some work just once.
void init(int argc, char * argv[]);
+/// Returns the i-th program argument in utf8 encoding.
+std::string utf8_argv(int i);
+
+/// Removes from the internal copy \p num program arguments starting from \p i.
+void remove_internal_args(int i, int num);
+
/// 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();
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.
/// \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);
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.
+ * \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