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 "LString.h"
  19
  20 /**
  21  * An instance of Class Systemcall represents a single child process.
  22  *
  23  * Class Systemcall uses system() to launch the child process.
  24  * The user can choose to wait or not wait for the process to complete, but no
  25  * callback is invoked upon completion of the child.
  26  *
  27  * The child process is not killed when the Systemcall instance goes out of
  28  * scope.
  29  */
  30 class Systemcall {
  31 public:
  32         /// whether to wait for completion
  33         enum Starttype {
  34                 Wait, //< wait for completion before returning from startscript()
  35                 DontWait //< don't wait for completion
  36         };
  37
  38         /** Start child process.
  39          *  The string "what" contains a commandline with arguments separated
  40          *  by spaces.
  41          */
  42         int startscript(Starttype how, string const & what);
  43 };
  44
  45 #endif // SYSTEMCALL_H