src/support/forkedcontr.h

   1 // -*- C++ -*-
   2 /**
   3  * \file forkedcontr.h
   4  * Copyright 2001 The LyX Team
   5  * Read COPYING
   6  *
   7  * \author Asger Alstrup Nielsen
   8  * \author Angus Leeming
   9  *
  10  * A class for the control of child processes launched using
  11  * fork() and execvp().
  12  */
  13
  14 #ifndef FORKEDCONTR_H
  15 #define FORKEDCONTR_H
  16
  17 #include <list>
  18 #include <vector>
  19 #include "LString.h"
  20 #include <sigc++/signal_system.h>
  21 #include <sys/types.h> // needed for pid_t
  22
  23 #ifdef __GNUG__
  24 #pragma interface
  25 #endif
  26
  27 class Forkedcall;
  28 class Timeout;
  29
  30 class ForkedcallsController : public SigC::Object {
  31 public:
  32         /** This d-tor should really be private, but making it public
  33          *   allows egcs 1.1 to compile the class.
  34          */
  35         ~ForkedcallsController();
  36
  37         /// Get hold of the only controller that can exist inside the process.
  38         static ForkedcallsController & get();
  39
  40         /// Add a new child process to the list of controlled processes.
  41         void addCall(Forkedcall const & newcall);
  42
  43         /** This method is connected to the timer. Every XX ms it is called
  44          *  so that we can check on the status of the children. Those that
  45          *  are found to have finished are removed from the list and their
  46          *  callback function is passed the final return state.
  47          */
  48         void timer();
  49
  50         /// Return a vector of the pids of all the controlled processes.
  51         std::vector<pid_t> const getPIDs() const;
  52
  53         /// Get the command string of the process.
  54         string const getCommand(pid_t) const;
  55
  56         /** Kill this process prematurely and remove it from the list.
  57          *  The process is killed within tolerance secs.
  58          *  See forkedcall.[Ch] for details.
  59          */
  60         void kill(pid_t, int tolerance = 5);
  61
  62         /// Signal emitted when the list of current child processes changes.
  63         SigC::Signal0<void> childrenChanged;
  64
  65 private:
  66         /// Can't create multiple instances of ForkedcallsController.
  67         ForkedcallsController();
  68         ///
  69         ForkedcallsController(ForkedcallsController const &);
  70
  71         /// The child processes
  72         typedef std::list<Forkedcall *> ListType;
  73         ///
  74         ListType forkedCalls;
  75
  76         /** The timer. Enables us to check the status of the children
  77          *  every XX ms and to invoke a callback on completion.
  78          */
  79         Timeout * timeout_;
  80 };
  81
  82 #endif // FORKEDCONTR_H