ExternalProgram.hpp

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#ifndef CA_MGM_EXTERNALPROGRAM_H
#define CA_MGM_EXTERNALPROGRAM_H

#include <map>
#include <string>
#include <vector>

#include <ca-mgm/ExternalDataSource.hpp>
#include <ca-mgm/PathName.hpp>

namespace ca_mgm {

    class ExternalProgram : public ExternalDataSource
    {

    public:

      typedef std::vector<std::string> Arguments;

      enum Stderr_Disposition {
        Normal_Stderr,
        Discard_Stderr,
        Stderr_To_Stdout,
        Stderr_To_FileDesc
      };


      typedef std::map<std::string,std::string> Environment;

      ExternalProgram (std::string commandline,
                     Stderr_Disposition stderr_disp = Normal_Stderr,
                     bool use_pty = false, int stderr_fd = -1, bool default_locale = false,
                     const path::PathName& root = "");

      ExternalProgram();

      ExternalProgram (const Arguments &argv,
                     Stderr_Disposition stderr_disp = Normal_Stderr,
                     bool use_pty = false, int stderr_fd = -1, bool default_locale = false,
                     const path::PathName& root = "");

      ExternalProgram (const Arguments &argv, const Environment & environment,
                     Stderr_Disposition stderr_disp = Normal_Stderr,
                     bool use_pty = false, int stderr_fd = -1, bool default_locale = false,
                     const path::PathName& root = "");

      ExternalProgram (const char *const *argv,
                     Stderr_Disposition stderr_disp = Normal_Stderr,
                     bool use_pty = false, int stderr_fd = -1, bool default_locale = false,
                     const path::PathName& root = "");

      ExternalProgram (const char *const *argv, const Environment & environment,
                     Stderr_Disposition stderr_disp = Normal_Stderr,
                     bool use_pty = false, int stderr_fd = -1, bool default_locale = false,
                     const path::PathName& root = "");

      ExternalProgram (const char *binpath, const char *const *argv_1,
                     bool use_pty = false);


      ExternalProgram (const char *binpath, const char *const *argv_1, const Environment & environment,
                     bool use_pty = false);


      ~ExternalProgram();

      int close();

      bool kill();

      bool running();

      pid_t getpid() { return pid; }

      const std::string & command() const
      { return _command; }

      const std::string & execError() const
      { return _execError; }

      static void renumber_fd (int origfd, int newfd);

    protected:
      int checkStatus( int );

    private:

      bool use_pty;

      pid_t pid;
      int _exitStatus;
      std::string _command;
      std::string _execError;

      void start_program (const char *const *argv, const Environment & environment,
                        Stderr_Disposition stderr_disp = Normal_Stderr,
                        int stderr_fd = -1, bool default_locale = false,
                        const char* root = NULL);

    };

} // namespace ca_mgm

#endif // CA_MGM_EXTERNALPROGRAM_H