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 //
  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 // returns path of LyX binary
  33 std::string const & binpath();
  34 // returns name of LyX binary
  35 std::string const & binname();
  36 //
  37 void setTmpDir(std::string const & p);
  38 //
  39 std::string const & getTmpDir();
  40 // Returns the user's home directory ($HOME in the unix world).
  41 std::string const & homepath();
  42 // Returns the name of the NULL device (/dev/null, null).
  43 std::string const & nulldev();
  44 //
  45 std::string current_root();
  46 //
  47 shell_type shell();
  48 // DBCS aware!
  49 std::string::size_type common_path(std::string const & p1, std::string const & p2);
  50 // no-op on UNIX, '\\'->'/' on OS/2 and Win32, ':'->'/' on MacOS, etc.
  51 std::string slashify_path(std::string const & p);
  52 // Converts a unix style path to host OS style.
  53 std::string external_path(std::string const & p);
  54 // Converts a host OS style path to unix style.
  55 std::string internal_path(std::string const & p);
  56 // is path absolute?
  57 bool is_absolute_path(std::string const & p);
  58 // returns a string suitable to be passed to popen when
  59 // same for popen().
  60         char const * popen_read_mode();
  61 //
  62 void warn(std::string const & mesg);
  63
  64 } // namespace os
  65 } // namespace support
  66 } // namespace lyx
  67
  68 #endif