src/support/os.h

   1 // -*- C++ -*-
   2 /**
   3  * \file os.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Ruurd A. Reitsma
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  *
  11  * wrap OS-specific stuff
  12  */
  13
  14 #ifndef OS_H
  15 #define OS_H
  16
  17 #include "support/strfwd.h"
  18 #include <cstddef>
  19
  20
  21 namespace lyx {
  22 namespace support {
  23 namespace os {
  24
  25 enum shell_type {
  26         UNIX,   // Do we have to distinguish sh and csh?
  27         CMD_EXE
  28 };
  29
  30 enum io_channel {
  31         STDIN = 0,
  32         STDOUT,
  33         STDERR
  34 };
  35
  36 enum path_case {
  37         CASE_UNCHANGED,
  38         CASE_ADJUSTED
  39 };
  40
  41 enum file_access {
  42         EXISTING,
  43         CREATE
  44 };
  45
  46 /// Do some work just once.
  47 void init(int argc, char * argv[]);
  48
  49 /// Returns the i-th program argument in utf8 encoding.
  50 std::string utf8_argv(int i);
  51
  52 /// Removes from the internal copy \p num program arguments starting from \p i.
  53 void remove_internal_args(int i, int num);
  54
  55 /// Returns the name of the NULL device (/dev/null, null).
  56 std::string const & nulldev();
  57
  58 /// Tells whether \p channel is connected to a terminal or not.
  59 bool is_terminal(io_channel channel);
  60
  61 /// Returns "/" on *nix, "C:/", etc on Windows.
  62 std::string current_root();
  63
  64 ///
  65 shell_type shell();
  66
  67 /// Name of the python interpreter
  68 std::string const python();
  69
  70 ///
  71 bool isFilesystemCaseSensitive();
  72
  73 /// Extract the path common to both @c p1 and @c p2. DBCS aware!
  74 /// \p p1 and \p p2 are encoded in ucs4, \returns the index to the end of
  75 /// the last matching path component (the index may be pointing after the
  76 /// end of @c p1 or @c p2 if their last char is not the path separator).
  77 std::size_t common_path(docstring const & p1, docstring const & p2);
  78
  79 /// Converts a unix style path to host OS style.
  80 /// \p p and the return value are encoded in utf8.
  81 std::string external_path(std::string const & p);
  82
  83 /// Converts a host OS style path to unix style.
  84 /// \p p and the return value are encoded in utf8.
  85 std::string internal_path(std::string const & p);
  86
  87 /// Converts a host OS style path to a unicode safe unix style.
  88 /// On Windows, this is achieved by using the short form of the path,
  89 /// which can be safely passed to standard I/O functions expecting narrow
  90 /// char paths even when the path contains non-ascii chars.
  91 /// As the short form is only available for existing files, if the file is
  92 /// to be accessed for writing, \param how should be set to CREATE.
  93 /// \p p and the return value are encoded in utf8.
  94 std::string safe_internal_path(std::string const & p, file_access how = EXISTING);
  95
  96 /// Converts a unix style path list to host OS style.
  97 /// \p p and the return value are encoded in utf8.
  98 std::string external_path_list(std::string const & p);
  99
 100 /// Converts a host OS style path list to unix style.
 101 /// \p p and the return value are encoded in utf8.
 102 std::string internal_path_list(std::string const & p);
 103
 104 /**
 105  * Converts a unix style path into a form suitable for inclusion in a LaTeX
 106  * document.
 107  * \p p is encoded in utf8.
 108  * Caution: This function handles only the OS specific part of that task.
 109  * Never use it directly, use lyx::support::latex_path instead.
 110  */
 111 std::string latex_path(std::string const & p);
 112
 113 /// Checks if the format string is suitable on the OS
 114 bool is_valid_strftime(std::string const & p);
 115
 116 /** Returns a string suitable to be passed to popen when
 117  *  reading a file.
 118  */
 119 char const * popen_read_mode();
 120
 121 /** The character used to separate paths returned by the
 122  *  PATH environment variable.
 123  */
 124 char path_separator();
 125
 126 /** If @c use_windows_paths is true, LyX will output Windows-style paths to
 127  *  latex files rather than posix ones. Obviously, this option is used only
 128  *  under Windows.
 129  */
 130 void windows_style_tex_paths(bool use_windows_paths);
 131
 132 enum auto_open_mode {
 133         VIEW,
 134         EDIT
 135 };
 136
 137 /** Check whether or not a file can be opened by a default viewer or editor.
 138  *  \param extension (without leading .)
 139  *  \param mode can be opened in VIEW or EDIT mode
 140  *  \returns whether or not the format can be opened according to \p mode
 141  */
 142 bool canAutoOpenFile(std::string const & ext, auto_open_mode const mode = VIEW);
 143
 144 /** View or edit a file with the default viewer or editor.
 145  *  \param filename file to open (encoded in utf8)
 146  *  \param mode open in VIEW or EDIT mode
 147  *  \returns whether or not the file is viewed (or edited) successfully.
 148  */
 149 bool autoOpenFile(std::string const & filename, auto_open_mode const mode = VIEW);
 150
 151 /** Resolves a path such that it does not contain '.', '..', or symbolic links.
 152   * \p path and the return value are encoded in utf8.
 153   */
 154 std::string real_path(std::string const & path);
 155
 156 /** Checks whether \param path starts with \param pre, accounting for case
 157   * insensitive file systems.
 158   */
 159 bool path_prefix_is(std::string const & path, std::string const & pre);
 160
 161 /** Checks whether \param path starts with \param pre, accounting for case
 162   * insensitive file systems. If true, the file system is case insensitive,
 163   * and \param how == CASE_ADJUSTED, the case of the matching prefix in
 164   * @c path is made equal to that of @c pre.
 165   */
 166 bool path_prefix_is(std::string & path, std::string const & pre, path_case how = CASE_UNCHANGED);
 167
 168 } // namespace os
 169 } // namespace support
 170 } // namespace lyx
 171
 172 #endif