mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-09-21 23:51:25 +00:00
96ee270933
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@22187 a592a061-630c-0410-9148-cb99ea01b6c8
114 lines
3.1 KiB
C++
114 lines
3.1 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 "support/strfwd.h"
|
|
#include <cstddef>
|
|
|
|
|
|
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 the name of the NULL device (/dev/null, null).
|
|
std::string const & nulldev();
|
|
|
|
/// Returns "/" on *nix, "C:/", etc on Windows.
|
|
std::string current_root();
|
|
|
|
///
|
|
shell_type shell();
|
|
|
|
/// Name of the python interpreter
|
|
std::string const python();
|
|
|
|
/// Extract the path common to both @c p1 and @c p2. DBCS aware!
|
|
/// \p p1, \p p2 and the return value are encoded in utf8.
|
|
std::size_t common_path(docstring const & p1, docstring const & p2);
|
|
|
|
/// Converts a unix style path to host OS style.
|
|
/// \p p and the return value are encoded in utf8.
|
|
std::string external_path(std::string const & p);
|
|
|
|
/// Converts a host OS style path to unix style.
|
|
/// \p p and the return value are encoded in utf8.
|
|
std::string internal_path(std::string const & p);
|
|
|
|
/// Converts a unix style path list to host OS style.
|
|
/// \p p and the return value are encoded in utf8.
|
|
std::string external_path_list(std::string const & p);
|
|
|
|
/// Converts a host OS style path list to unix style.
|
|
/// \p p and the return value are encoded in utf8.
|
|
std::string internal_path_list(std::string const & p);
|
|
|
|
/**
|
|
* Converts a unix style path into a form suitable for inclusion in a LaTeX
|
|
* document.
|
|
* \p p is encoded in utf8.
|
|
* Caution: This function handles only the OS specific part of that task.
|
|
* Never use it directly, use lyx::support::latex_path instead.
|
|
*/
|
|
std::string latex_path(std::string const & p);
|
|
|
|
/** Returns a string suitable to be passed to popen when
|
|
* reading a file.
|
|
*/
|
|
char const * popen_read_mode();
|
|
|
|
/** The character used to separate paths returned by the
|
|
* PATH environment variable.
|
|
*/
|
|
char path_separator();
|
|
|
|
/** If @c use_windows_paths is true, LyX will output Windows-style paths to
|
|
* latex files rather than posix ones. Obviously, this option is used only
|
|
* under Windows.
|
|
*/
|
|
void windows_style_tex_paths(bool use_windows_paths);
|
|
|
|
enum auto_open_mode {
|
|
VIEW,
|
|
EDIT
|
|
};
|
|
|
|
/** Check whether or not a file can be opened by a default viewer or editor.
|
|
* \param extension (without leading .)
|
|
* \param mode can be opened in VIEW or EDIT mode
|
|
* \returns whether or not the format can be opened according to \p mode
|
|
*/
|
|
bool canAutoOpenFile(std::string const & ext, auto_open_mode const mode = VIEW);
|
|
|
|
/** View or edit a file with the default viewer or editor.
|
|
* \param filename file to open (encoded in utf8)
|
|
* \param mode open in VIEW or EDIT mode
|
|
* \returns whether or not the file is viewed (or edited) successfully.
|
|
*/
|
|
bool autoOpenFile(std::string const & filename, auto_open_mode const mode = VIEW);
|
|
|
|
} // namespace os
|
|
} // namespace support
|
|
} // namespace lyx
|
|
|
|
#endif
|