src/support/forkedcall.h

   1 // -*- C++ -*-
   2 /**
   3  *  \file forkedcall.h
   4  *  Copyright 2002 the LyX Team
   5  *  Read the file COPYING
   6  *
   7  * \author Asger Alstrup
   8  *
   9  * Interface cleaned up by
  10  * \author Angus Leeming <a.leeming@ic.ac.uk>
  11  *
  12  * An instance of Class Forkedcall represents a single child process.
  13  *
  14  * Class Forkedcall uses fork() and execvp() to lauch the child process.
  15  *
  16  * Once launched, control is returned immediately to the parent process
  17  * but a Signal can be emitted upon completion of the child.
  18  *
  19  * The child process is not killed when the Forkedcall instance goes out of
  20  * scope, but it can be killed by an explicit invocation of the kill() member
  21  * function.
  22  */
  23
  24 #ifndef FORKEDCALL_H
  25 #define FORKEDCALL_H
  26
  27 #ifdef __GNUG__
  28 #pragma interface
  29 #endif
  30
  31 #include "LString.h"
  32 #include <sys/types.h>
  33 #include <boost/smart_ptr.hpp>
  34 #include <sigc++/signal_system.h>
  35
  36
  37 class Forkedcall {
  38 public:
  39         ///
  40         enum Starttype {
  41                 ///
  42                 Wait,
  43                 ///
  44                 DontWait
  45         };
  46
  47         ///
  48         Forkedcall();
  49
  50         /** Start the child process.
  51          *
  52          *  The command "what" is passed to fork() for execution.
  53          *
  54          *  There are two startscript commands available. They differ in that
  55          *  the second receives a signal that is executed on completion of
  56          *  the command. This makes sense only for a command executed
  57          *  in the background, ie DontWait.
  58          *
  59          *  The other startscript command can be executed either blocking
  60          *  or non-blocking, but no signal will be emitted on finishing.
  61          */
  62         int startscript(Starttype, string const & what);
  63
  64         /** A SignalType signal is can be emitted once the forked process
  65          *  has finished. It passes:
  66          *  the commandline string;
  67          *  the PID of the child and;
  68          *  the return value from the child.
  69          *
  70          *  We use a signal rather than simply a callback function so that
  71          *  we can return easily to C++ methods, rather than just globally
  72          *  accessible functions.
  73          */
  74         typedef SigC::Signal3<void, string const &, pid_t, int> SignalType;
  75
  76         /** The signal is connected in the calling routine to the desired
  77          *  slot. We pass a shared_ptr rather than a reference to the signal
  78          *  because it is eminently possible for the instance of the calling
  79          *  class (and hence the signal) to be destructed before the forked
  80          *  call is complete.
  81          *
  82          *  It doesn't matter if the slot disappears, SigC takes care of that.
  83          */
  84         typedef boost::shared_ptr<SignalType> SignalTypePtr;
  85
  86         ///
  87         int startscript(string const & what, SignalTypePtr);
  88
  89         /** Invoking the following methods makes sense only if the command
  90          *  is running asynchronously!
  91          */
  92
  93         /** gets the PID of the child process.
  94          *  Used by the timer.
  95          */
  96         pid_t pid() const { return pid_; }
  97
  98         /** Emit the signal.
  99          *  Used by the timer.
 100          */
 101         void emitSignal();
 102
 103         /** Set the return value of the child process.
 104          *  Used by the timer.
 105          */
 106         void setRetValue(int r) { retval_ = r; }
 107
 108         /** Kill child prematurely.
 109          *  First, a SIGHUP is sent to the child.
 110          *  If that does not end the child process within "tolerance"
 111          *  seconds, the SIGKILL signal is sent to the child.
 112          *  When the child is dead, the callback is called.
 113          */
 114         void kill(int tolerance = 5);
 115         ///
 116         string const & command() const { return command_; }
 117
 118 private:
 119         /// Callback function
 120         SignalTypePtr signal_;
 121
 122         /// Commmand line
 123         string command_;
 124
 125         /// Process ID of child
 126         pid_t pid_;
 127
 128         /// Return value from child
 129         int retval_;
 130
 131         ///
 132         pid_t generateChild();
 133
 134         /// Wait for child process to finish. Updates returncode from child.
 135         int waitForChild();
 136 };
 137
 138 #endif // FORKEDCALL_H