]> git.lyx.org Git - lyx.git/blobdiff - src/support/os.h
Replace the text class shared ptr by good old index-into-global-list.
[lyx.git] / src / support / os.h
index 3b23b0ee2272f725af75edac5d8347c74ecd0fa1..2d41dd76267a6d2f377ed44c55de3a01ab455453 100644 (file)
@@ -14,7 +14,8 @@
 #ifndef OS_H
 #define OS_H
 
-#include <string>
+#include "support/strfwd.h"
+#include <cstddef>
 
 
 namespace lyx {
@@ -38,32 +39,38 @@ std::string current_root();
 ///
 shell_type shell();
 
+/// Name of the python interpreter
+std::string const python();
+
 /// 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, \p p2 and the return value are encoded in utf8.
+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);
 
 /// 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);
 
-/// Is the path absolute?
-bool is_absolute_path(std::string const & p);
-
 /** Returns a string suitable to be passed to popen when
  *  reading a file.
  */
@@ -74,11 +81,11 @@ char const * popen_read_mode();
  */
 char path_separator();
 
-/** If @c use_cygwin_paths is true, LyX will output cygwin style paths
- *  rather than native Win32 ones. Obviously, this option is used only
- *  under Cygwin.
+/** 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 cygwin_path_fix(bool use_cygwin_paths);
+void windows_style_tex_paths(bool use_windows_paths);
 
 enum auto_open_mode {
        VIEW,
@@ -93,7 +100,7 @@ enum auto_open_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
+ *  \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.
  */