lyx_mirror/src/support/Systemcall.h
Enrico Forestieri a749b73d95 The second argument of Systemcall::startscript is supposed to be encoded
in the filesystem encoding, i.e., the local 8 bit encoding.


git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@39760 a592a061-630c-0410-9148-cb99ea01b6c8
2011-09-25 16:38:51 +00:00

57 lines
1.5 KiB
C++

// -*- C++ -*-
/**
* \file Systemcall.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Asger Alstrup
*
* Interface cleaned up by
* \author Angus Leeming
*
* Full author contact details are available in file CREDITS.
*/
#ifndef SYSTEMCALL_H
#define SYSTEMCALL_H
#include <string>
namespace lyx {
namespace support {
/**
* An instance of Class Systemcall represents a single child process.
*
* Class Systemcall uses system() to launch the child process.
* The user can choose to wait or not wait for the process to complete, but no
* callback is invoked upon completion of the child.
*
* The child process is not killed when the Systemcall instance goes out of
* scope.
*/
class Systemcall {
public:
/// whether to wait for completion
enum Starttype {
Wait, //< wait for completion before returning from startscript()
DontWait //< don't wait for completion
};
/** Start child process.
* The string "what" contains a commandline with arguments separated
* by spaces and encoded in the filesystem encoding. The string "path"
* contains the path to be prepended to the TEXINPUTS environment
* variable and encoded in utf-8. Unset "process_events" in case
* UI should be blocked while processing the external command.
*/
int startscript(Starttype how, std::string const & what,
std::string const & path = empty_string(),
bool process_events = false);
};
} // namespace support
} // namespace lyx
#endif // SYSTEMCALL_H