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 /// Do some work just once.
  31 void init(int argc, char * argv[]);
  32
  33 /// Returns the name of the NULL device (/dev/null, null).
  34 std::string const & nulldev();
  35
  36 /// Returns "/" on *nix, "C:/", etc on Windows.
  37 std::string current_root();
  38
  39 ///
  40 shell_type shell();
  41
  42 /// Name of the python interpreter
  43 std::string const python();
  44
  45 /// Extract the path common to both @c p1 and @c p2. DBCS aware!
  46 /// \p p1, \p p2 and the return value are encoded in utf8.
  47 std::size_t common_path(docstring const & p1, docstring const & p2);
  48
  49 /// Converts a unix style path to host OS style.
  50 /// \p p and the return value are encoded in utf8.
  51 std::string external_path(std::string const & p);
  52
  53 /// Converts a host OS style path to unix style.
  54 /// \p p and the return value are encoded in utf8.
  55 std::string internal_path(std::string const & p);
  56
  57 /// Converts a unix style path list to host OS style.
  58 /// \p p and the return value are encoded in utf8.
  59 std::string external_path_list(std::string const & p);
  60
  61 /// Converts a host OS style path list to unix style.
  62 /// \p p and the return value are encoded in utf8.
  63 std::string internal_path_list(std::string const & p);
  64
  65 /**
  66  * Converts a unix style path into a form suitable for inclusion in a LaTeX
  67  * document.
  68  * \p p is encoded in utf8.
  69  * Caution: This function handles only the OS specific part of that task.
  70  * Never use it directly, use lyx::support::latex_path instead.
  71  */
  72 std::string latex_path(std::string const & p);
  73
  74 /// Is the path absolute?
  75 /// \p p is encoded in utf8.
  76 bool is_absolute_path(std::string const & p);
  77
  78 /** Returns a string suitable to be passed to popen when
  79  *  reading a file.
  80  */
  81 char const * popen_read_mode();
  82
  83 /** The character used to separate paths returned by the
  84  *  PATH environment variable.
  85  */
  86 char path_separator();
  87
  88 /** If @c use_windows_paths is true, LyX will output Windows-style paths to
  89  *  latex files rather than posix ones. Obviously, this option is used only
  90  *  under Windows.
  91  */
  92 void windows_style_tex_paths(bool use_windows_paths);
  93
  94 enum auto_open_mode {
  95         VIEW,
  96         EDIT
  97 };
  98
  99 /** Check whether or not a file can be opened by a default viewer or editor.
 100  *  \param extension (without leading .)
 101  *  \param mode can be opened in VIEW or EDIT mode
 102  *  \returns whether or not the format can be opened according to \p mode
 103  */
 104 bool canAutoOpenFile(std::string const & ext, auto_open_mode const mode = VIEW);
 105
 106 /** View or edit a file with the default viewer or editor.
 107  *  \param filename file to open (encoded in utf8)
 108  *  \param mode open in VIEW or EDIT mode
 109  *  \returns whether or not the file is viewed (or edited) successfully.
 110  */
 111 bool autoOpenFile(std::string const & filename, auto_open_mode const mode = VIEW);
 112
 113 } // namespace os
 114 } // namespace support
 115 } // namespace lyx
 116
 117 #endif