2 The software in this package is distributed under the GNU General
3 Public License version 2 (with a special exception described below).
5 A copy of GNU General Public License (GPL) is included in this distribution,
6 in the file COPYING.GPL.
8 As a special exception, if other files instantiate templates or use macros
9 or inline functions from this file, or you compile this file and link it
10 with other works to produce a work based on this file, this file
11 does not by itself cause the resulting work to be covered
12 by the GNU General Public License.
14 However the source code for this file must still be made available
15 in accordance with section (3) of the GNU General Public License.
17 This exception does not invalidate any other reasons why a work based
18 on this file might be covered by the GNU General Public License.
20 /***************************************************************************
21 inpipestream.hxx - C++ streambuffer wrapper
23 begin : Thu Dec 27 2001
24 copyright : (C) 2001 by Intra2net AG
25 ***************************************************************************/
38 #include <stringfunc.hxx>
42 /** if the program exited normally and returned a return code */
45 /** the real return code of the program, only set when normal_exit true */
48 /** if the program was terminated by a signal */
49 bool terminated_by_signal;
51 /** number of the signal that terminated the program, only valid when terminated_by_signal true */
54 /** errormessage if we have one */
55 std::string error_message;
57 inline std::string format (void) const
59 return std::string ("(")
60 + "(normal_exit " + (this->normal_exit ? "T" : "F") + ") "
61 "(return_code '" + I2n::to_string ((int)this->return_code) + "') "
62 "(signal " + (this->terminated_by_signal
63 ? strsignal (this->signal)
68 typedef struct ExecResult ExecResult;
70 std::string capture_exec(const std::string& command, ExecResult &rescode);
71 std::string capture_exec(const char *const *command, ExecResult &rescode,
72 const bool out=true, const bool err=false);
73 std::string capture_exec(const std::vector<std::string>& command, ExecResult &rescode,
74 const bool out=true, const bool err=false);
76 inline std::string capture_exec (const std::string &command)
79 return capture_exec(command,r);
82 inline std::string capture_exec(const char *const *command)
85 return capture_exec(command,r);
88 inline std::string capture_exec(const std::vector<std::string>& command)
91 return capture_exec(command,r);
94 /** @brief runs command and provides buffered input for it through pipe
96 * opens pipe to command using popen; exit status available after destruction
97 * (use WEXITSTATUS to get the "regular" return code (lowest byte))
99 * ATTENTION: A lot of mysterious STL bugs occured
100 * with a "real" buffer (buffer larger than 1 byte and up to 100 bytes)
101 * -> Keep it slow and working!
103 class inpipebuf : public std::streambuf
111 // "callback" variables for destructor to store exit status
116 inpipebuf(const std::string& command,
117 const bool out, const bool err);
118 inpipebuf(const char *const *command,
119 const bool out, const bool err);
120 inpipebuf(const std::vector<std::string> &command,
121 const bool out, const bool err);
125 void store_exit_status(bool *_status_set, int *_exit_status);
128 virtual int_type underflow();
131 std::pair <pid_t, FILE *>
132 init_without_shell (const char *const *argv,
133 const bool out, const bool err) const;
136 /** @brief stream around inpipebuf -- see comment there */
137 class inpipestream : public std::istream
143 inpipestream(const std::string& command,
144 const bool out=true, const bool err=false)
145 : std::istream(&buf), buf(command, out, err)
148 inpipestream(const char *const command[],
149 const bool out=true, const bool err=false)
150 : std::istream(&buf), buf(command, out, err)
153 inpipestream(const std::vector<std::string> &command,
154 const bool out=true, const bool err=false)
155 : std::istream(&buf), buf(command, out, err)
158 void store_exit_status(bool *_status_set, int *_exit_status)
159 { buf.store_exit_status(_status_set, _exit_status); }
162 /** @brief runs command and provides buffered ouptput from it through pipe
164 * opens pipe to command using popen; exit status available after destruction
165 * (use WEXITSTATUS to get the "regular" return code (lowest byte))
167 class outpipebuf : public std::streambuf
172 // "callback" variables for destructor to store exit status
177 outpipebuf(const std::string& command);
181 /** note: exit status only available after destruction */
182 void store_exit_status(bool *_status_set, int *_exit_status);
185 virtual int_type overflow(int_type c);
187 virtual std::streamsize xsputn(const char* s, std::streamsize num);
191 /** @brief stream around outpipebuf -- see comment there */
192 class outpipestream : public std::ostream
197 outpipestream(const std::string& command)
198 : std::ostream(&buf), buf(command)
201 void store_exit_status(bool *_status_set, int *_exit_status)
202 { buf.store_exit_status(_status_set, _exit_status); }