Commit | Line | Data |
---|---|---|
0e23f538 TJ |
1 | /* |
2 | The software in this package is distributed under the GNU General | |
3 | Public License version 2 (with a special exception described below). | |
4 | ||
5 | A copy of GNU General Public License (GPL) is included in this distribution, | |
6 | in the file COPYING.GPL. | |
7 | ||
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. | |
13 | ||
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. | |
16 | ||
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. | |
19 | */ | |
e93545dd GE |
20 | /*************************************************************************** |
21 | inpipestream.hxx - C++ streambuffer wrapper | |
22 | ------------------- | |
23 | begin : Thu Dec 27 2001 | |
24 | copyright : (C) 2001 by Intra2net AG | |
e93545dd GE |
25 | ***************************************************************************/ |
26 | ||
27 | #ifndef _PIPESTREAM | |
28 | #define _PIPESTREAM | |
29 | ||
be3dbe32 TJ |
30 | #include <stdio.h> |
31 | ||
e93545dd GE |
32 | #include <string> |
33 | #include <streambuf> | |
4a56f9ac GE |
34 | #include <istream> |
35 | #include <ostream> | |
c2c29997 | 36 | #include <vector> |
e93545dd | 37 | |
f8f119bf GE |
38 | struct ExecResult |
39 | { | |
40 | /** if the program exited normally and returned a return code */ | |
41 | bool normal_exit; | |
42 | ||
43 | /** the real return code of the program, only set when normal_exit true */ | |
44 | char return_code; | |
45 | ||
46 | /** if the program was terminated by a signal */ | |
47 | bool terminated_by_signal; | |
48 | ||
49 | /** number of the signal that terminated the program, only valid when terminated_by_signal true */ | |
50 | int signal; | |
51 | ||
52 | /** errormessage if we have one */ | |
53 | std::string error_message; | |
54 | }; | |
55 | typedef struct ExecResult ExecResult; | |
56 | ||
57 | std::string capture_exec(const std::string& command, ExecResult &rescode); | |
9e322fb7 | 58 | std::string capture_exec(const char *const *command, ExecResult &rescode); |
c2c29997 | 59 | std::string capture_exec(const std::vector<std::string>& command, ExecResult &rescode); |
f8f119bf | 60 | |
9e322fb7 PG |
61 | inline std::string capture_exec (const std::string &command) |
62 | { | |
63 | ExecResult r; | |
64 | return capture_exec(command,r); | |
65 | } | |
66 | ||
67 | inline std::string capture_exec(const char *const *command) | |
f8f119bf GE |
68 | { |
69 | ExecResult r; | |
70 | return capture_exec(command,r); | |
71 | } | |
72 | ||
c2c29997 PG |
73 | inline std::string capture_exec(const std::vector<std::string>& command) |
74 | { | |
75 | ExecResult r; | |
76 | return capture_exec(command,r); | |
77 | } | |
78 | ||
bf4c487c CH |
79 | /** @brief runs command and provides buffered input for it through pipe |
80 | * | |
81 | * opens pipe to command using popen; exit status available after destruction | |
82 | * (use WEXITSTATUS to get the "regular" return code (lowest byte)) | |
83 | * | |
84 | * ATTENTION: A lot of mysterious STL bugs occured | |
85 | * with a "real" buffer (buffer larger than 1 byte and up to 100 bytes) | |
86 | * -> Keep it slow and working! | |
87 | */ | |
e93545dd GE |
88 | class inpipebuf : public std::streambuf |
89 | { | |
20a79471 TJ |
90 | protected: |
91 | char buffer; | |
9e322fb7 | 92 | |
20a79471 TJ |
93 | FILE *pipe; |
94 | ||
95 | // "callback" variables for destructor to store exit status | |
96 | bool *status_set; | |
97 | int *exit_status; | |
98 | ||
99 | public: | |
7e606af5 | 100 | inpipebuf(const std::string& command); |
9e322fb7 | 101 | inpipebuf(const char *const *command); |
c2c29997 | 102 | inpipebuf(const std::vector<std::string> &command); |
20a79471 | 103 | |
7e606af5 | 104 | ~inpipebuf(); |
20a79471 | 105 | |
7e606af5 | 106 | void store_exit_status(bool *_status_set, int *_exit_status); |
20a79471 TJ |
107 | |
108 | protected: | |
7e606af5 | 109 | virtual int_type underflow(); |
9e322fb7 PG |
110 | |
111 | private: | |
112 | FILE *init_without_shell (const char *const *argv) const; | |
20a79471 | 113 | }; |
e93545dd | 114 | |
bf4c487c | 115 | /** @brief stream around inpipebuf -- see comment there */ |
e93545dd GE |
116 | class inpipestream : public std::istream |
117 | { | |
20a79471 TJ |
118 | protected: |
119 | inpipebuf buf; | |
120 | ||
121 | public: | |
122 | inpipestream(const std::string& command) | |
d8ffcdb0 | 123 | : std::istream(&buf), buf(command) |
20a79471 | 124 | {} |
9e322fb7 PG |
125 | inpipestream(const char *const command[]) |
126 | : std::istream(&buf), buf(command) | |
127 | {} | |
20a79471 | 128 | |
c2c29997 PG |
129 | inpipestream(const std::vector<std::string> &command) |
130 | : std::istream(&buf), buf(command) | |
131 | {} | |
132 | ||
20a79471 TJ |
133 | void store_exit_status(bool *_status_set, int *_exit_status) |
134 | { buf.store_exit_status(_status_set, _exit_status); } | |
e93545dd GE |
135 | }; |
136 | ||
bf4c487c CH |
137 | /** @brief runs command and provides buffered ouptput from it through pipe |
138 | * | |
139 | * opens pipe to command using popen; exit status available after destruction | |
140 | * (use WEXITSTATUS to get the "regular" return code (lowest byte)) | |
141 | */ | |
e93545dd GE |
142 | class outpipebuf : public std::streambuf |
143 | { | |
20a79471 TJ |
144 | protected: |
145 | FILE *pipe; | |
146 | ||
147 | // "callback" variables for destructor to store exit status | |
148 | bool *status_set; | |
149 | int *exit_status; | |
150 | ||
151 | public: | |
7e606af5 GE |
152 | outpipebuf(const std::string& command); |
153 | ||
154 | ~outpipebuf(); | |
20a79471 | 155 | |
bf4c487c | 156 | /** note: exit status only available after destruction */ |
7e606af5 | 157 | void store_exit_status(bool *_status_set, int *_exit_status); |
20a79471 TJ |
158 | |
159 | protected: | |
7e606af5 GE |
160 | virtual int_type overflow(int_type c); |
161 | ||
162 | virtual std::streamsize xsputn(const char* s, std::streamsize num); | |
e93545dd GE |
163 | }; |
164 | ||
bf4c487c CH |
165 | |
166 | /** @brief stream around outpipebuf -- see comment there */ | |
e93545dd GE |
167 | class outpipestream : public std::ostream |
168 | { | |
20a79471 TJ |
169 | protected: |
170 | outpipebuf buf; | |
171 | public: | |
172 | outpipestream(const std::string& command) | |
d8ffcdb0 | 173 | : std::ostream(&buf), buf(command) |
20a79471 TJ |
174 | {} |
175 | ||
176 | void store_exit_status(bool *_status_set, int *_exit_status) | |
177 | { buf.store_exit_status(_status_set, _exit_status); } | |
e93545dd GE |
178 | }; |
179 | ||
180 | #endif |