lyx_mirror/src/support/os.h
Angus Leeming 627f2c70fa Fix a bunch of doxygen warnings.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@7879 a592a061-630c-0410-9148-cb99ea01b6c8
2003-10-08 11:31:51 +00:00

65 lines
1.4 KiB
C++

// -*- C++ -*-
/**
* \file os.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Ruurd A. Reitsma
*
* Full author contact details are available in file CREDITS.
*
* wrap OS specific stuff
*/
#ifndef OS_H
#define OS_H
#include <string>
namespace lyx {
namespace support {
namespace os {
//
enum shell_type {
UNIX, // Do we have to distinguish sh and csh?
CMD_EXE
};
// do some work just once
void init(int * argc, char ** argv[]);
// returns path of LyX binary
std::string binpath();
// returns name of LyX binary
std::string binname();
//
void setTmpDir(std::string const & p);
//
std::string getTmpDir();
//
std::string current_root();
//
shell_type shell();
// DBCS aware!
std::string::size_type common_path(std::string const & p1, std::string const & p2);
// no-op on UNIX, '\\'->'/' on OS/2 and Win32, ':'->'/' on MacOS, etc.
std::string slashify_path(std::string const & p);
// converts a host OS path to unix style
std::string external_path(std::string const & p);
// converts a unix path to host OS style
std::string internal_path(std::string const & p);
// is path absolute?
bool is_absolute_path(std::string const & p);
// returns a string suitable to be passed to popen when
// same for popen().
char const * popen_read_mode();
//
void warn(std::string const & mesg);
} // namespace os
} // namespace support
} // namespace lyx
#endif