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