]> Dogcows Code - chaz/yoink/blobdiff - src/stlplus/portability/subprocesses.hpp
import stlplus 3.7
[chaz/yoink] / src / stlplus / portability / subprocesses.hpp
index 50564633fae4a6a0ee67edf95a2c20459a928b37..c60aa5ee5c702f84a43e9585482400bea52b09e7 100644 (file)
-#ifndef STLPLUS_SUBPROCESSES
-#define STLPLUS_SUBPROCESSES
-////////////////////////////////////////////////////////////////////////////////
-
-//   Author:    Andy Rushton
-//   Copyright: (c) Southampton University 1999-2004
-//              (c) Andy Rushton           2004-2009
-//   License:   BSD License, see ../docs/license.html
-  
-//   Platform-independent wrapper around the very platform-specific handling of
-//   subprocesses. Uses the C++ convention that all resources must be contained in
-//   an object so that when a subprocess object goes out of scope the subprocess
-//   itself gets closed down.
-
-////////////////////////////////////////////////////////////////////////////////
-#include "portability_fixes.hpp"
-#ifdef MSWINDOWS
-#include <windows.h>
-#endif
-#include <stdexcept>
-#include <vector>
-#include <string>
-#include <map> // for std::pair - why is this not defined separately?
-
-////////////////////////////////////////////////////////////////////////////////
-
-namespace stlplus
-{
-
-  ////////////////////////////////////////////////////////////////////////////////
-  // Argument vector class
-  // allows manipulation of argv-like vectors
-  // includes splitting of command lines into argvectors as per the shell
-  // (removing quotes) and the reverse conversion (adding quotes where necessary)
-
-  class arg_vector
-  {
-  private:
-    char** m_argv;
-
-  public:
-    // create an empty vector
-    arg_vector (void);
-
-    // copy constructor (yes it copies)
-    arg_vector (const arg_vector&);
-
-    // construct from an argv
-    arg_vector (char**);
-
-    // construct from a command-line string
-    // includes de-quoting of values
-    arg_vector (const std::string&);
-    arg_vector (const char*);
-
-    ~arg_vector (void);
-
-    // assignment operators are compatible with the constructors
-    arg_vector& operator = (const arg_vector&);
-    arg_vector& operator = (char**);
-    arg_vector& operator = (const std::string&);
-    arg_vector& operator = (const char*);
-
-    // add an argument to the vector
-    arg_vector& operator += (const std::string&);
-    arg_vector& operator -= (const std::string&);
-
-    // insert/clear an argument at a certain index
-    // adding is like the other array classes - it moves the current item at index
-    // up one (and all subsequent values) to make room
-    void insert (unsigned index, const std::string&) throw(std::out_of_range);
-    void clear (unsigned index) throw(std::out_of_range);
-    void clear (void);
-
-    // number of values in the vector (including argv[0], the command itself
-    unsigned size (void) const;
-
-    // type conversion to the argv type
-    operator char** (void) const;
-    // function-based version of the above for people who don't like type conversions
-    char** argv (void) const;
-
-    // access individual values in the vector
-    char* operator [] (unsigned index) const throw(std::out_of_range);
-
-    // special-case access of the command name (e.g. to do path lookup on the command)
-    char* argv0 (void) const throw(std::out_of_range);
-
-    // get the command-line string represented by this vector
-    // includes escaping of special characters and quoting
-    std::string image (void) const;
-  };
-
-  ////////////////////////////////////////////////////////////////////////////////
-  // Environment class
-  // Allows manipulation of an environment vector
-  // This is typically used to create an environment to be used by a subprocess
-  // It does NOT modify the environment of the current process
-
-#ifdef MSWINDOWS
-#define ENVIRON_TYPE char*
-#else
-#define ENVIRON_TYPE char**
-#endif
-
-  class env_vector
-  {
-  private:
-    ENVIRON_TYPE m_env;
-
-  public:
-    // create an env_vector vector from the current process
-    env_vector (void);
-    env_vector (const env_vector&);
-    ~env_vector (void);
-
-    env_vector& operator = (const env_vector&);
-
-    void clear (void);
-
-    // manipulate the env_vector by adding or removing variables
-    // adding a name that already exists replaces its value
-    void add (const std::string& name, const std::string& value);
-    bool remove (const std::string& name);
-
-    // get the value associated with a name
-    // the first uses an indexed notation (e.g. env["PATH"] )
-    // the second is a function based form (e.g. env.get("PATH"))
-    std::string operator [] (const std::string& name) const;
-    std::string get (const std::string& name) const;
-
-    // number of name=value pairs in the env_vector
-    unsigned size (void) const;
-
-    // get the name=value pairs by index (in the range 0 to size()-1)
-    std::pair<std::string,std::string> operator [] (unsigned index) const throw(std::out_of_range);
-    std::pair<std::string,std::string> get (unsigned index) const throw(std::out_of_range);
-
-    // access the env_vector as an envp type - used for passing to subprocesses
-    ENVIRON_TYPE envp (void) const;
-  };
-
-  ////////////////////////////////////////////////////////////////////////////////
-
-#ifdef MSWINDOWS
-#define PID_TYPE PROCESS_INFORMATION
-#define PIPE_TYPE HANDLE
-#else
-#define PID_TYPE int
-#define PIPE_TYPE int
-#endif
-
-  ////////////////////////////////////////////////////////////////////////////////
-  // Synchronous subprocess
-
-  class subprocess
-  {
-  private:
-
-    PID_TYPE m_pid;
-#ifdef MSWINDOWS
-    HANDLE m_job;
-#endif
-    PIPE_TYPE m_child_in;
-    PIPE_TYPE m_child_out;
-    PIPE_TYPE m_child_err;
-    env_vector m_env;
-    int m_err;
-    int m_status;
-
-  public:
-    subprocess(void);
-    virtual ~subprocess(void);
-
-    void add_variable(const std::string& name, const std::string& value);
-    bool remove_variable(const std::string& name);
-
-    bool spawn(const std::string& path, const arg_vector& argv,
-               bool connect_stdin = false, bool connect_stdout = false, bool connect_stderr = false);
-    bool spawn(const std::string& command_line,
-               bool connect_stdin = false, bool connect_stdout = false, bool connect_stderr = false);
-
-    virtual bool callback(void);
-    bool kill(void);
-
-    int write_stdin(std::string& buffer);
-    int read_stdout(std::string& buffer);
-    int read_stderr(std::string& buffer);
-
-    void close_stdin(void);
-    void close_stdout(void);
-    void close_stderr(void);
-
-    bool error(void) const;
-    int error_number(void) const;
-    std::string error_text(void) const;
-
-    int exit_status(void) const;
-
-  private:
-    // disallow copying
-    subprocess(const subprocess&);
-    subprocess& operator=(const subprocess&);
-  };
-
-  ////////////////////////////////////////////////////////////////////////////////
-  // Preconfigured subprocess which executes a command and captures its output
-
-  class backtick_subprocess : public subprocess
-  {
-  private:
-    std::string m_text;
-  public:
-    backtick_subprocess(void);
-    virtual bool callback(void);
-    bool spawn(const std::string& path, const arg_vector& argv);
-    bool spawn(const std::string& command_line);
-    std::vector<std::string> text(void) const;
-  };
-
-  std::vector<std::string> backtick(const std::string& path, const arg_vector& argv);
-  std::vector<std::string> backtick(const std::string& command_line);
-
-  ////////////////////////////////////////////////////////////////////////////////
-  // Asynchronous subprocess
-
-  class async_subprocess
-  {
-  private:
-    PID_TYPE m_pid;
-#ifdef MSWINDOWS
-    HANDLE m_job;
-#endif
-    PIPE_TYPE m_child_in;
-    PIPE_TYPE m_child_out;
-    PIPE_TYPE m_child_err;
-    env_vector m_env;
-    int m_err;
-    int m_status;
-    void set_error(int);
-
-  public:
-    async_subprocess(void);
-    virtual ~async_subprocess(void);
-
-    void add_variable(const std::string& name, const std::string& value);
-    bool remove_variable(const std::string& name);
-
-    bool spawn(const std::string& path, const arg_vector& argv,
-               bool connect_stdin = false, bool connect_stdout = false, bool connect_stderr = false);
-    bool spawn(const std::string& command_line,
-               bool connect_stdin = false, bool connect_stdout = false, bool connect_stderr = false);
-
-    virtual bool callback(void);
-    bool tick(void);
-    bool kill(void);
-
-    int write_stdin(std::string& buffer);
-    int read_stdout(std::string& buffer);
-    int read_stderr(std::string& buffer);
-
-    void close_stdin(void);
-    void close_stdout(void);
-    void close_stderr(void);
-
-    bool error(void) const;
-    int error_number(void) const;
-    std::string error_text(void) const;
-
-    int exit_status(void) const;
-
-  private:
-    // disallow copying
-    async_subprocess(const async_subprocess&);
-    async_subprocess& operator=(const async_subprocess&);
-  };
-
-  ////////////////////////////////////////////////////////////////////////////////
-
-} // end namespace stlplus
-
-#endif
+#ifndef STLPLUS_SUBPROCESSES\r
+#define STLPLUS_SUBPROCESSES\r
+////////////////////////////////////////////////////////////////////////////////\r
+\r
+//   Author:    Andy Rushton\r
+//   Copyright: (c) Southampton University 1999-2004\r
+//              (c) Andy Rushton           2004 onwards\r
+//   License:   BSD License, see ../docs/license.html\r
+\r
+//   Platform-independent wrapper around the very platform-specific handling of\r
+//   subprocesses. Uses the C++ convention that all resources must be contained in\r
+//   an object so that when a subprocess object goes out of scope the subprocess\r
+//   itself gets closed down.\r
+\r
+////////////////////////////////////////////////////////////////////////////////\r
+#include "portability_fixes.hpp"\r
+#ifdef MSWINDOWS\r
+#include <windows.h>\r
+#endif\r
+#include <stdexcept>\r
+#include <vector>\r
+#include <string>\r
+#include <map> // for std::pair - why is this not defined separately?\r
+\r
+////////////////////////////////////////////////////////////////////////////////\r
+\r
+namespace stlplus\r
+{\r
+\r
+  ////////////////////////////////////////////////////////////////////////////////\r
+  // Argument vector class\r
+  // allows manipulation of argv-like vectors\r
+  // includes splitting of command lines into argvectors as per the shell\r
+  // (removing quotes) and the reverse conversion (adding quotes where necessary)\r
+\r
+  class arg_vector\r
+  {\r
+  private:\r
+    char** m_argv;\r
+\r
+  public:\r
+    // create an empty vector\r
+    arg_vector (void);\r
+\r
+    // copy constructor (yes it copies)\r
+    arg_vector (const arg_vector&);\r
+\r
+    // construct from an argv\r
+    arg_vector (char**);\r
+\r
+    // construct from a command-line string\r
+    // includes de-quoting of values\r
+    arg_vector (const std::string&);\r
+    arg_vector (const char*);\r
+\r
+    ~arg_vector (void);\r
+\r
+    // assignment operators are compatible with the constructors\r
+    arg_vector& operator = (const arg_vector&);\r
+    arg_vector& operator = (char**);\r
+    arg_vector& operator = (const std::string&);\r
+    arg_vector& operator = (const char*);\r
+\r
+    // add an argument to the vector\r
+    arg_vector& operator += (const std::string&);\r
+    arg_vector& operator -= (const std::string&);\r
+\r
+    // insert/clear an argument at a certain index\r
+    // adding is like the other array classes - it moves the current item at index\r
+    // up one (and all subsequent values) to make room\r
+    void insert (unsigned index, const std::string&) throw(std::out_of_range);\r
+    void clear (unsigned index) throw(std::out_of_range);\r
+    void clear (void);\r
+\r
+    // number of values in the vector (including argv[0], the command itself\r
+    unsigned size (void) const;\r
+\r
+    // type conversion to the argv type\r
+    operator char** (void) const;\r
+    // function-based version of the above for people who don't like type conversions\r
+    char** argv (void) const;\r
+\r
+    // access individual values in the vector\r
+    char* operator [] (unsigned index) const throw(std::out_of_range);\r
+\r
+    // special-case access of the command name (e.g. to do path lookup on the command)\r
+    char* argv0 (void) const throw(std::out_of_range);\r
+\r
+    // get the command-line string represented by this vector\r
+    // includes escaping of special characters and quoting\r
+    std::string image (void) const;\r
+  };\r
+\r
+  ////////////////////////////////////////////////////////////////////////////////\r
+  // Environment class\r
+  // Allows manipulation of an environment vector\r
+  // This is typically used to create an environment to be used by a subprocess\r
+  // It does NOT modify the environment of the current process\r
+\r
+#ifdef MSWINDOWS\r
+#define ENVIRON_TYPE char*\r
+#else\r
+#define ENVIRON_TYPE char**\r
+#endif\r
+  class subprocess;\r
+  class async_subprocess;\r
+\r
+  class env_vector\r
+  {\r
+  private:\r
+    ENVIRON_TYPE m_env;\r
+    friend class subprocess;\r
+    friend class async_subprocess;\r
+    // access the env_vector as an envp type - used for passing to subprocesses\r
+    ENVIRON_TYPE envp (void) const;\r
+\r
+  public:\r
+    // create an env_vector vector from the current process\r
+    env_vector (void);\r
+    env_vector (const env_vector&);\r
+    ~env_vector (void);\r
+\r
+    env_vector& operator = (const env_vector&);\r
+\r
+    // manipulate the env_vector by adding or removing variables\r
+    // adding a name that already exists replaces its value\r
+    void add (const std::string& name, const std::string& value);\r
+    bool remove (const std::string& name);\r
+    void clear (void);\r
+\r
+    // get the value associated with a name\r
+    // the first uses an indexed notation (e.g. env["PATH"] )\r
+    // the second is a function based form (e.g. env.get("PATH"))\r
+    bool present(const std::string& name) const;\r
+    std::string operator [] (const std::string& name) const;\r
+    std::string get (const std::string& name) const;\r
+\r
+    // number of name=value pairs in the env_vector\r
+    unsigned size (void) const;\r
+\r
+    // get the name=value pairs by index (in the range 0 to size()-1)\r
+    std::pair<std::string,std::string> operator [] (unsigned index) const throw(std::out_of_range);\r
+    std::pair<std::string,std::string> get (unsigned index) const throw(std::out_of_range);\r
+  };\r
+\r
+  ////////////////////////////////////////////////////////////////////////////////\r
+\r
+#ifdef MSWINDOWS\r
+#define PID_TYPE PROCESS_INFORMATION\r
+#define PIPE_TYPE HANDLE\r
+#else\r
+#define PID_TYPE int\r
+#define PIPE_TYPE int\r
+#endif\r
+\r
+  ////////////////////////////////////////////////////////////////////////////////\r
+  // Synchronous subprocess\r
+\r
+  class subprocess\r
+  {\r
+  protected:\r
+\r
+    PID_TYPE m_pid;\r
+#ifdef MSWINDOWS\r
+    HANDLE m_job;\r
+#endif\r
+    PIPE_TYPE m_child_in;\r
+    PIPE_TYPE m_child_out;\r
+    PIPE_TYPE m_child_err;\r
+    env_vector m_env;\r
+    int m_err;\r
+    int m_status;\r
+    void set_error(int);\r
+\r
+  public:\r
+    subprocess(void);\r
+    virtual ~subprocess(void);\r
+\r
+    void add_variable(const std::string& name, const std::string& value);\r
+    bool remove_variable(const std::string& name);\r
+    const env_vector& get_variables(void) const;\r
+\r
+    bool spawn(const std::string& path, const arg_vector& argv,\r
+               bool connect_stdin = false, bool connect_stdout = false, bool connect_stderr = false);\r
+    bool spawn(const std::string& command_line,\r
+               bool connect_stdin = false, bool connect_stdout = false, bool connect_stderr = false);\r
+\r
+    virtual bool callback(void);\r
+    bool kill(void);\r
+\r
+    int write_stdin(std::string& buffer);\r
+    int read_stdout(std::string& buffer);\r
+    int read_stderr(std::string& buffer);\r
+\r
+    void close_stdin(void);\r
+    void close_stdout(void);\r
+    void close_stderr(void);\r
+\r
+    bool error(void) const;\r
+    int error_number(void) const;\r
+    std::string error_text(void) const;\r
+\r
+    int exit_status(void) const;\r
+\r
+  private:\r
+    // disallow copying\r
+    subprocess(const subprocess&);\r
+    subprocess& operator=(const subprocess&);\r
+  };\r
+\r
+  ////////////////////////////////////////////////////////////////////////////////\r
+  // Preconfigured subprocess which executes a command and captures its output\r
+\r
+  class backtick_subprocess : public subprocess\r
+  {\r
+  protected:\r
+    std::string m_text;\r
+  public:\r
+    backtick_subprocess(void);\r
+    virtual bool callback(void);\r
+    bool spawn(const std::string& path, const arg_vector& argv);\r
+    bool spawn(const std::string& command_line);\r
+    std::vector<std::string> text(void) const;\r
+  };\r
+\r
+  std::vector<std::string> backtick(const std::string& path, const arg_vector& argv);\r
+  std::vector<std::string> backtick(const std::string& command_line);\r
+\r
+  ////////////////////////////////////////////////////////////////////////////////\r
+  // Asynchronous subprocess\r
+\r
+  class async_subprocess\r
+  {\r
+  protected:\r
+    PID_TYPE m_pid;\r
+#ifdef MSWINDOWS\r
+    HANDLE m_job;\r
+#endif\r
+    PIPE_TYPE m_child_in;\r
+    PIPE_TYPE m_child_out;\r
+    PIPE_TYPE m_child_err;\r
+    env_vector m_env;\r
+    int m_err;\r
+    int m_status;\r
+    void set_error(int);\r
+\r
+  public:\r
+    async_subprocess(void);\r
+    virtual ~async_subprocess(void);\r
+\r
+    void add_variable(const std::string& name, const std::string& value);\r
+    bool remove_variable(const std::string& name);\r
+    const env_vector& get_variables(void) const;\r
+\r
+    bool spawn(const std::string& path, const arg_vector& argv,\r
+               bool connect_stdin = false, bool connect_stdout = false, bool connect_stderr = false);\r
+    bool spawn(const std::string& command_line,\r
+               bool connect_stdin = false, bool connect_stdout = false, bool connect_stderr = false);\r
+\r
+    virtual bool callback(void);\r
+    bool tick(void);\r
+    bool kill(void);\r
+\r
+    int write_stdin(std::string& buffer);\r
+    int read_stdout(std::string& buffer);\r
+    int read_stderr(std::string& buffer);\r
+\r
+    void close_stdin(void);\r
+    void close_stdout(void);\r
+    void close_stderr(void);\r
+\r
+    bool error(void) const;\r
+    int error_number(void) const;\r
+    std::string error_text(void) const;\r
+\r
+    int exit_status(void) const;\r
+\r
+  private:\r
+    // disallow copying\r
+    async_subprocess(const async_subprocess&);\r
+    async_subprocess& operator=(const async_subprocess&);\r
+  };\r
+\r
+  ////////////////////////////////////////////////////////////////////////////////\r
+\r
+} // end namespace stlplus\r
+\r
+#endif\r
This page took 0.031722 seconds and 4 git commands to generate.