4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Ruurd A. Reitsma
9 * Full author contact details are available in file CREDITS.
11 * wrap OS-specific stuff
17 #include "support/docstring.h"
27 UNIX, // Do we have to distinguish sh and csh?
31 /// Do some work just once.
32 void init(int argc, char * argv[]);
34 /// Returns the name of the NULL device (/dev/null, null).
35 std::string const & nulldev();
37 /// Returns "/" on *nix, "C:/", etc on Windows.
38 std::string current_root();
43 /// Name of the python interpreter
44 std::string const python();
46 /// Extract the path common to both @c p1 and @c p2. DBCS aware!
47 /// \p p1, \p p2 and the return value are encoded in utf8.
48 std::string::size_type common_path(std::string const & p1, std::string const & p2);
50 /// Converts a unix style path to host OS style.
51 /// \p p and the return value are encoded in utf8.
52 std::string external_path(std::string const & p);
54 /// Converts a host OS style path to unix style.
55 /// \p p and the return value are encoded in utf8.
56 std::string internal_path(std::string const & p);
58 /// Converts a unix style path list to host OS style.
59 /// \p p and the return value are encoded in utf8.
60 std::string external_path_list(std::string const & p);
62 /// Converts a host OS style path list to unix style.
63 /// \p p and the return value are encoded in utf8.
64 std::string internal_path_list(std::string const & p);
67 * Converts a unix style path into a form suitable for inclusion in a LaTeX
69 * \p p is encoded in utf8.
70 * Caution: This function handles only the OS specific part of that task.
71 * Never use it directly, use lyx::support::latex_path instead.
73 std::string latex_path(std::string const & p);
75 /// Is the path absolute?
76 /// \p p is encoded in utf8.
77 bool is_absolute_path(std::string const & p);
79 /** Returns a string suitable to be passed to popen when
82 char const * popen_read_mode();
84 /** The character used to separate paths returned by the
85 * PATH environment variable.
87 char path_separator();
89 /** If @c use_windows_paths is true, LyX will output Windows-style paths to
90 * latex files rather than posix ones. Obviously, this option is used only
93 void windows_style_tex_paths(bool use_windows_paths);
100 /** Check whether or not a file can be opened by a default viewer or editor.
101 * \param extension (without leading .)
102 * \param mode can be opened in VIEW or EDIT mode
103 * \returns whether or not the format can be opened according to \p mode
105 bool canAutoOpenFile(std::string const & ext, auto_open_mode const mode = VIEW);
107 /** View or edit a file with the default viewer or editor.
108 * \param filename file to open (encoded in utf8)
109 * \param mode open in VIEW or EDIT mode
110 * \returns whether or not the file is viewed (or edited) successfully.
112 bool autoOpenFile(std::string const & filename, auto_open_mode const mode = VIEW);
114 /** General font utilities.
115 * FIXME: only MAC and WIN32 for now but it would be nice to convince
116 * fontconfig to do the same for linux.
119 /// Add fonts to the font subsystem, must be called before Application
121 void addFontResources();
123 /// Restore original font resources, must be called after Application
125 void restoreFontResources();
128 } // namespace support