src/support/Systemcall.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Systemcall.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Asger Alstrup
   8  *
   9  * Interface cleaned up by
  10  * \author Angus Leeming
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #ifndef SYSTEMCALL_H
  16 #define SYSTEMCALL_H
  17
  18 #include <string>
  19
  20 namespace lyx {
  21 namespace support {
  22
  23 /**
  24  * An instance of Class Systemcall represents a single child process.
  25  *
  26  * Class Systemcall uses system() to launch the child process.
  27  * The user can choose to wait or not wait for the process to complete, but no
  28  * callback is invoked upon completion of the child.
  29  *
  30  * The child process is not killed when the Systemcall instance goes out of
  31  * scope.
  32  */
  33 class Systemcall {
  34 public:
  35         /// whether to wait for completion
  36         enum Starttype {
  37                 Wait, //< wait for completion before returning from startscript()
  38                 DontWait //< don't wait for completion
  39         };
  40
  41         /** Start child process.
  42          *  The string "what" contains a commandline with arguments separated
  43          *  by spaces.
  44          */
  45         int startscript(Starttype how, std::string const & what, bool process_events = true);
  46 };
  47
  48 } // namespace support
  49 } // namespace lyx
  50
  51 #endif // SYSTEMCALL_H