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 /// Returns the name of the NULL device (/dev/null, null).
  53 std::string const & nulldev();
  54
  55 /// Tells whether \p channel is connected to a terminal or not.
  56 bool is_terminal(io_channel channel);
  57
  58 /// Returns "/" on *nix, "C:/", etc on Windows.
  59 std::string current_root();
  60
  61 ///
  62 shell_type shell();
  63
  64 /// Name of the python interpreter
  65 std::string const python();
  66
  67 ///
  68 bool isFilesystemCaseSensitive();
  69
  70 /// Extract the path common to both @c p1 and @c p2. DBCS aware!
  71 /// \p p1 and \p p2 are encoded in ucs4, \returns the index to the end of
  72 /// the last matching path component (the index may be pointing after the
  73 /// end of @c p1 or @c p2 if their last char is not the path separator).
  74 std::size_t common_path(docstring const & p1, docstring const & p2);
  75
  76 /// Converts a unix style path to host OS style.
  77 /// \p p and the return value are encoded in utf8.
  78 std::string external_path(std::string const & p);
  79
  80 /// Converts a host OS style path to unix style.
  81 /// \p p and the return value are encoded in utf8.
  82 std::string internal_path(std::string const & p);
  83
  84 /// Converts a host OS style path to a unicode safe unix style.
  85 /// On Windows, this is achieved by using the short form of the path,
  86 /// which can be safely passed to standard I/O functions expecting narrow
  87 /// char paths even when the path contains non-ascii chars.
  88 /// As the short form is only available for existing files, if the file is
  89 /// to be accessed for writing, \param how should be set to CREATE.
  90 /// \p p and the return value are encoded in utf8.
  91 std::string safe_internal_path(std::string const & p, file_access how = EXISTING);
  92
  93 /// Converts a unix style path list to host OS style.
  94 /// \p p and the return value are encoded in utf8.
  95 std::string external_path_list(std::string const & p);
  96
  97 /// Converts a host OS style path list to unix style.
  98 /// \p p and the return value are encoded in utf8.
  99 std::string internal_path_list(std::string const & p);
 100
 101 /**
 102  * Converts a unix style path into a form suitable for inclusion in a LaTeX
 103  * document.
 104  * \p p is encoded in utf8.
 105  * Caution: This function handles only the OS specific part of that task.
 106  * Never use it directly, use lyx::support::latex_path instead.
 107  */
 108 std::string latex_path(std::string const & p);
 109
 110 /// Checks if the format string is suitable on the OS
 111 bool is_valid_strftime(std::string const & p);
 112
 113 /** Returns a string suitable to be passed to popen when
 114  *  reading a file.
 115  */
 116 char const * popen_read_mode();
 117
 118 /** The character used to separate paths returned by the
 119  *  PATH environment variable.
 120  */
 121 char path_separator();
 122
 123 /** If @c use_windows_paths is true, LyX will output Windows-style paths to
 124  *  latex files rather than posix ones. Obviously, this option is used only
 125  *  under Windows.
 126  */
 127 void windows_style_tex_paths(bool use_windows_paths);
 128
 129 enum auto_open_mode {
 130         VIEW,
 131         EDIT
 132 };
 133
 134 /** Check whether or not a file can be opened by a default viewer or editor.
 135  *  \param extension (without leading .)
 136  *  \param mode can be opened in VIEW or EDIT mode
 137  *  \returns whether or not the format can be opened according to \p mode
 138  */
 139 bool canAutoOpenFile(std::string const & ext, auto_open_mode const mode = VIEW);
 140
 141 /** View or edit a file with the default viewer or editor.
 142  *  \param filename file to open (encoded in utf8)
 143  *  \param mode open in VIEW or EDIT mode
 144  *  \returns whether or not the file is viewed (or edited) successfully.
 145  */
 146 bool autoOpenFile(std::string const & filename, auto_open_mode const mode = VIEW);
 147
 148 /** Resolves a path such that it does not contain '.', '..', or symbolic links.
 149   * \p path and the return value are encoded in utf8.
 150   */
 151 std::string real_path(std::string const & path);
 152
 153 /** Checks whether \param path starts with \param pre, accounting for case
 154   * insensitive file systems.
 155   */
 156 bool path_prefix_is(std::string const & path, std::string const & pre);
 157
 158 /** Checks whether \param path starts with \param pre, accounting for case
 159   * insensitive file systems. If true, the file system is case insensitive,
 160   * and \param how == CASE_ADJUSTED, the case of the matching prefix in
 161   * @c path is made equal to that of @c pre.
 162   */
 163 bool path_prefix_is(std::string & path, std::string const & pre, path_case how = CASE_UNCHANGED);
 164
 165 } // namespace os
 166 } // namespace support
 167 } // namespace lyx
 168
 169 #endif