* support/qstring_helpers.h: erase ucs4_to_qstring() method.

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

diff --git a/src/support/os.h b/src/support/os.h
index 1c29d57a20261e9229355434bbb18599721a224c..c42cfedbff89bda470a9862aebae92f13b577267 100644 (file)
--- a/src/support/os.h
+++ b/src/support/os.h
@@ -14,6 +14,8 @@
 #ifndef OS_H
 #define OS_H
 
+#include "support/docstring.h"
+
 #include <string>
 
 
@@ -38,30 +40,40 @@ 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!
+/// \p p1, \p p2 and the return value are encoded in utf8.
 std::string::size_type common_path(std::string const & p1, std::string 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?
+/// \p p is encoded in utf8.
 bool is_absolute_path(std::string const & p);
 
 /** Returns a string suitable to be passed to popen when
@@ -93,12 +105,25 @@ 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.
  */
 bool autoOpenFile(std::string const & filename, auto_open_mode const mode = VIEW);
 
+/** General font utilities.
+ *  FIXME: only MAC and WIN32 for now but it would be nice to convince
+ *  fontconfig to do the same for linux.
+ */
+
+/// Add fonts to the font subsystem, must be called before Application
+/// is initialized.
+void addFontResources();
+
+/// Restore original font resources, must be called after Application
+/// is destroyed.
+void restoreFontResources();
+
 } // namespace os
 } // namespace support
 } // namespace lyx