pipe.hpp 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476
  1. // Copyright (c) 2006, 2007 Julio M. Merino Vidal
  2. // Copyright (c) 2008 Ilya Sokolov, Boris Schaeling
  3. // Copyright (c) 2009 Boris Schaeling
  4. // Copyright (c) 2010 Felipe Tanus, Boris Schaeling
  5. // Copyright (c) 2011, 2012 Jeff Flinn, Boris Schaeling
  6. //
  7. // Distributed under the Boost Software License, Version 1.0. (See accompanying
  8. // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  9. #ifndef BOOST_PROCESS_PIPE_HPP
  10. #define BOOST_PROCESS_PIPE_HPP
  11. #include <boost/config.hpp>
  12. #include <boost/process/detail/config.hpp>
  13. #include <streambuf>
  14. #include <istream>
  15. #include <ostream>
  16. #include <vector>
  17. #if defined(BOOST_POSIX_API)
  18. #include <boost/process/detail/posix/basic_pipe.hpp>
  19. #elif defined(BOOST_WINDOWS_API)
  20. #include <boost/process/detail/windows/basic_pipe.hpp>
  21. #endif
  22. namespace boost { namespace process {
  23. using ::boost::process::detail::api::basic_pipe;
  24. #if defined(BOOST_PROCESS_DOXYGEN)
  25. /** Class implementation of a pipe.
  26. *
  27. */
  28. template<class CharT, class Traits = std::char_traits<CharT>>
  29. class basic_pipe
  30. {
  31. public:
  32. typedef CharT char_type ;
  33. typedef Traits traits_type;
  34. typedef typename Traits::int_type int_type ;
  35. typedef typename Traits::pos_type pos_type ;
  36. typedef typename Traits::off_type off_type ;
  37. typedef ::boost::detail::winapi::HANDLE_ native_handle;
  38. /// Default construct the pipe. Will be opened.
  39. basic_pipe();
  40. ///Construct a named pipe.
  41. inline explicit basic_pipe(const std::string & name);
  42. /** Copy construct the pipe.
  43. * \note Duplicated the handles.
  44. */
  45. inline basic_pipe(const basic_pipe& p);
  46. /** Move construct the pipe. */
  47. basic_pipe(basic_pipe&& lhs);
  48. /** Copy assign the pipe.
  49. * \note Duplicated the handles.
  50. */
  51. inline basic_pipe& operator=(const basic_pipe& p);
  52. /** Move assign the pipe. */
  53. basic_pipe& operator=(basic_pipe&& lhs);
  54. /** Destructor closes the handles. */
  55. ~basic_pipe();
  56. /** Get the native handle of the source. */
  57. native_handle native_source() const;
  58. /** Get the native handle of the sink. */
  59. native_handle native_sink () const;
  60. /** Assign a new value to the source */
  61. void assign_source(native_handle h);
  62. /** Assign a new value to the sink */
  63. void assign_sink (native_handle h);
  64. ///Write data to the pipe.
  65. int_type write(const char_type * data, int_type count);
  66. ///Read data from the pipe.
  67. int_type read(char_type * data, int_type count);
  68. ///Check if the pipe is open.
  69. bool is_open();
  70. ///Close the pipe
  71. void close();
  72. };
  73. #endif
  74. typedef basic_pipe<char> pipe;
  75. typedef basic_pipe<wchar_t> wpipe;
  76. /** Implementation of the stream buffer for a pipe.
  77. */
  78. template<
  79. class CharT,
  80. class Traits = std::char_traits<CharT>
  81. >
  82. struct basic_pipebuf : std::basic_streambuf<CharT, Traits>
  83. {
  84. typedef basic_pipe<CharT, Traits> pipe_type;
  85. typedef CharT char_type ;
  86. typedef Traits traits_type;
  87. typedef typename Traits::int_type int_type ;
  88. typedef typename Traits::pos_type pos_type ;
  89. typedef typename Traits::off_type off_type ;
  90. constexpr static int default_buffer_size = BOOST_PROCESS_PIPE_SIZE;
  91. ///Default constructor, will also construct the pipe.
  92. basic_pipebuf() : _write(default_buffer_size), _read(default_buffer_size)
  93. {
  94. this->setg(_read.data(), _read.data()+ 128, _read.data() + 128);
  95. this->setp(_write.data(), _write.data() + _write.size());
  96. }
  97. ///Copy Constructor.
  98. basic_pipebuf(const basic_pipebuf & ) = default;
  99. ///Move Constructor
  100. basic_pipebuf(basic_pipebuf && ) = default;
  101. ///Move construct from a pipe.
  102. basic_pipebuf(pipe_type && p) : _pipe(std::move(p)),
  103. _write(default_buffer_size),
  104. _read(default_buffer_size)
  105. {
  106. this->setg(_read.data(), _read.data()+ 128, _read.data() + 128);
  107. this->setp(_write.data(), _write.data() + _write.size());
  108. }
  109. ///Construct from a pipe.
  110. basic_pipebuf(const pipe_type & p) : _pipe(p),
  111. _write(default_buffer_size),
  112. _read(default_buffer_size)
  113. {
  114. this->setg(_read.data(), _read.data()+ 128, _read.data() + 128);
  115. this->setp(_write.data(), _write.data() + _write.size());
  116. }
  117. ///Copy assign.
  118. basic_pipebuf& operator=(const basic_pipebuf & ) = delete;
  119. ///Move assign.
  120. basic_pipebuf& operator=(basic_pipebuf && ) = default;
  121. ///Move assign a pipe.
  122. basic_pipebuf& operator=(pipe_type && p)
  123. {
  124. _pipe = std::move(p);
  125. return *this;
  126. }
  127. ///Copy assign a pipe.
  128. basic_pipebuf& operator=(const pipe_type & p)
  129. {
  130. _pipe = p;
  131. return *this;
  132. }
  133. ///Writes characters to the associated output sequence from the put area
  134. int_type overflow(int_type ch = traits_type::eof()) override
  135. {
  136. if ((ch != traits_type::eof()) && _pipe.is_open())
  137. {
  138. if (this->pptr() == this->epptr())
  139. {
  140. bool wr = this->_write_impl();
  141. *this->pptr() = ch;
  142. this->pbump(1);
  143. if (wr)
  144. return ch;
  145. }
  146. else
  147. {
  148. *this->pptr() = ch;
  149. this->pbump(1);
  150. if (this->_write_impl())
  151. return ch;
  152. }
  153. }
  154. return traits_type::eof();
  155. }
  156. ///Synchronizes the buffers with the associated character sequence
  157. int sync() override { return this->_write_impl() ? 0 : -1; }
  158. ///Reads characters from the associated input sequence to the get area
  159. int_type underflow() override
  160. {
  161. if (!_pipe.is_open())
  162. return traits_type::eof();
  163. if (this->egptr() == &_read.back()) //ok, so we're at the end of the buffer
  164. this->setg(_read.data(), _read.data()+ 10, _read.data() + 10);
  165. auto len = &_read.back() - this->egptr() ;
  166. auto res = _pipe.read(
  167. this->egptr(),
  168. static_cast<typename pipe_type::int_type>(len));
  169. if (res == 0)
  170. return traits_type::eof();
  171. this->setg(this->eback(), this->gptr(), this->egptr() + res);
  172. auto val = *this->gptr();
  173. return traits_type::to_int_type(val);
  174. }
  175. ///Set the pipe of the streambuf.
  176. void pipe(pipe_type&& p) {_pipe = std::move(p); }
  177. ///Set the pipe of the streambuf.
  178. void pipe(const pipe_type& p) {_pipe = p; }
  179. ///Get a reference to the pipe.
  180. pipe_type & pipe() & {return _pipe;}
  181. ///Get a const reference to the pipe.
  182. const pipe_type &pipe() const & {return _pipe;}
  183. ///Get a rvalue reference to the pipe. Qualified as rvalue.
  184. pipe_type && pipe() && {return std::move(_pipe);}
  185. private:
  186. pipe_type _pipe;
  187. std::vector<char_type> _write;
  188. std::vector<char_type> _read;
  189. bool _write_impl()
  190. {
  191. if (!_pipe.is_open())
  192. return false;
  193. auto base = this->pbase();
  194. auto wrt = _pipe.write(base,
  195. static_cast<typename pipe_type::int_type>(this->pptr() - base));
  196. std::ptrdiff_t diff = this->pptr() - base;
  197. if (wrt < diff)
  198. std::move(base + wrt, base + diff, base);
  199. else if (wrt == 0) //broken pipe
  200. return false;
  201. this->pbump(-wrt);
  202. return true;
  203. }
  204. };
  205. typedef basic_pipebuf<char> pipebuf;
  206. typedef basic_pipebuf<wchar_t> wpipebuf;
  207. /** Implementation of a reading pipe stream.
  208. *
  209. */
  210. template<
  211. class CharT,
  212. class Traits = std::char_traits<CharT>
  213. >
  214. class basic_ipstream : public std::basic_istream<CharT, Traits>
  215. {
  216. basic_pipebuf<CharT, Traits> _buf;
  217. public:
  218. typedef basic_pipe<CharT, Traits> pipe_type;
  219. typedef CharT char_type ;
  220. typedef Traits traits_type;
  221. typedef typename Traits::int_type int_type ;
  222. typedef typename Traits::pos_type pos_type ;
  223. typedef typename Traits::off_type off_type ;
  224. ///Get access to the underlying stream_buf
  225. basic_pipebuf<CharT, Traits>* rdbuf() {return &_buf;};
  226. ///Default constructor.
  227. basic_ipstream() : std::basic_istream<CharT, Traits>(nullptr)
  228. {
  229. std::basic_istream<CharT, Traits>::rdbuf(&_buf);
  230. };
  231. ///Copy constructor.
  232. basic_ipstream(const basic_ipstream & ) = delete;
  233. ///Move constructor.
  234. basic_ipstream(basic_ipstream && ) = default;
  235. ///Move construct from a pipe.
  236. basic_ipstream(pipe_type && p) : std::basic_istream<CharT, Traits>(nullptr), _buf(std::move(p))
  237. {
  238. std::basic_istream<CharT, Traits>::rdbuf(&_buf);
  239. }
  240. ///Copy construct from a pipe.
  241. basic_ipstream(const pipe_type & p) : std::basic_istream<CharT, Traits>(nullptr), _buf(p)
  242. {
  243. std::basic_istream<CharT, Traits>::rdbuf(&_buf);
  244. }
  245. ///Copy assignment.
  246. basic_ipstream& operator=(const basic_ipstream & ) = delete;
  247. ///Move assignment
  248. basic_ipstream& operator=(basic_ipstream && ) = default;
  249. ///Move assignment of a pipe.
  250. basic_ipstream& operator=(pipe_type && p)
  251. {
  252. _buf = std::move(p);
  253. return *this;
  254. }
  255. ///Copy assignment of a pipe.
  256. basic_ipstream& operator=(const pipe_type & p)
  257. {
  258. _buf = p;
  259. return *this;
  260. }
  261. ///Set the pipe of the streambuf.
  262. void pipe(pipe_type&& p) {_buf.pipe(std::move(p)); }
  263. ///Set the pipe of the streambuf.
  264. void pipe(const pipe_type& p) {_buf.pipe(p); }
  265. ///Get a reference to the pipe.
  266. pipe_type & pipe() & {return _buf.pipe();}
  267. ///Get a const reference to the pipe.
  268. const pipe_type &pipe() const & {return _buf.pipe();}
  269. ///Get a rvalue reference to the pipe. Qualified as rvalue.
  270. pipe_type && pipe() && {return std::move(_buf).pipe();}
  271. };
  272. typedef basic_ipstream<char> ipstream;
  273. typedef basic_ipstream<wchar_t> wipstream;
  274. /** Implementation of a write pipe stream.
  275. *
  276. */
  277. template<
  278. class CharT,
  279. class Traits = std::char_traits<CharT>
  280. >
  281. class basic_opstream : public std::basic_ostream<CharT, Traits>
  282. {
  283. basic_pipebuf<CharT, Traits> _buf;
  284. public:
  285. typedef basic_pipe<CharT, Traits> pipe_type;
  286. typedef CharT char_type ;
  287. typedef Traits traits_type;
  288. typedef typename Traits::int_type int_type ;
  289. typedef typename Traits::pos_type pos_type ;
  290. typedef typename Traits::off_type off_type ;
  291. ///Get access to the underlying stream_buf
  292. basic_pipebuf<CharT, Traits>* rdbuf() const {return _buf;};
  293. ///Default constructor.
  294. basic_opstream() : std::basic_ostream<CharT, Traits>(nullptr)
  295. {
  296. std::basic_ostream<CharT, Traits>::rdbuf(&_buf);
  297. };
  298. ///Copy constructor.
  299. basic_opstream(const basic_opstream & ) = delete;
  300. ///Move constructor.
  301. basic_opstream(basic_opstream && ) = default;
  302. ///Move construct from a pipe.
  303. basic_opstream(pipe_type && p) : std::basic_ostream<CharT, Traits>(nullptr), _buf(std::move(p))
  304. {
  305. std::basic_ostream<CharT, Traits>::rdbuf(&_buf);
  306. };
  307. ///Copy construct from a pipe.
  308. basic_opstream(const pipe_type & p) : std::basic_ostream<CharT, Traits>(nullptr), _buf(p)
  309. {
  310. std::basic_ostream<CharT, Traits>::rdbuf(&_buf);
  311. };
  312. ///Copy assignment.
  313. basic_opstream& operator=(const basic_opstream & ) = delete;
  314. ///Move assignment
  315. basic_opstream& operator=(basic_opstream && ) = default;
  316. ///Move assignment of a pipe.
  317. basic_opstream& operator=(pipe_type && p)
  318. {
  319. _buf = std::move(p);
  320. return *this;
  321. }
  322. ///Copy assignment of a pipe.
  323. basic_opstream& operator=(const pipe_type & p)
  324. {
  325. _buf = p;
  326. return *this;
  327. }
  328. ///Set the pipe of the streambuf.
  329. void pipe(pipe_type&& p) {_buf.pipe(std::move(p)); }
  330. ///Set the pipe of the streambuf.
  331. void pipe(const pipe_type& p) {_buf.pipe(p); }
  332. ///Get a reference to the pipe.
  333. pipe_type & pipe() & {return _buf.pipe();}
  334. ///Get a const reference to the pipe.
  335. const pipe_type &pipe() const & {return _buf.pipe();}
  336. ///Get a rvalue reference to the pipe. Qualified as rvalue.
  337. pipe_type && pipe() && {return std::move(_buf).pipe();}
  338. };
  339. typedef basic_opstream<char> opstream;
  340. typedef basic_opstream<wchar_t> wopstream;
  341. /** Implementation of a read-write pipe stream.
  342. *
  343. */
  344. template<
  345. class CharT,
  346. class Traits = std::char_traits<CharT>
  347. >
  348. class basic_pstream : public std::basic_iostream<CharT, Traits>
  349. {
  350. basic_pipebuf<CharT, Traits> _buf;
  351. public:
  352. typedef basic_pipe<CharT, Traits> pipe_type;
  353. typedef CharT char_type ;
  354. typedef Traits traits_type;
  355. typedef typename Traits::int_type int_type ;
  356. typedef typename Traits::pos_type pos_type ;
  357. typedef typename Traits::off_type off_type ;
  358. ///Get access to the underlying stream_buf
  359. basic_pipebuf<CharT, Traits>* rdbuf() const {return _buf;};
  360. ///Default constructor.
  361. basic_pstream() : std::basic_iostream<CharT, Traits>(nullptr)
  362. {
  363. std::basic_iostream<CharT, Traits>::rdbuf(&_buf);
  364. };
  365. ///Copy constructor.
  366. basic_pstream(const basic_pstream & ) = delete;
  367. ///Move constructor.
  368. basic_pstream(basic_pstream && ) = default;
  369. ///Move construct from a pipe.
  370. basic_pstream(pipe_type && p) : std::basic_iostream<CharT, Traits>(nullptr), _buf(std::move(p))
  371. {
  372. std::basic_iostream<CharT, Traits>::rdbuf(&_buf);
  373. };
  374. ///Copy construct from a pipe.
  375. basic_pstream(const pipe_type & p) : std::basic_iostream<CharT, Traits>(nullptr), _buf(p)
  376. {
  377. std::basic_iostream<CharT, Traits>::rdbuf(&_buf);
  378. };
  379. ///Copy assignment.
  380. basic_pstream& operator=(const basic_pstream & ) = delete;
  381. ///Move assignment
  382. basic_pstream& operator=(basic_pstream && ) = default;
  383. ///Move assignment of a pipe.
  384. basic_pstream& operator=(pipe_type && p)
  385. {
  386. _buf = std::move(p);
  387. return *this;
  388. }
  389. ///Copy assignment of a pipe.
  390. basic_pstream& operator=(const pipe_type & p)
  391. {
  392. _buf = p;
  393. return *this;
  394. }
  395. ///Set the pipe of the streambuf.
  396. void pipe(pipe_type&& p) {_buf.pipe(std::move(p)); }
  397. ///Set the pipe of the streambuf.
  398. void pipe(const pipe_type& p) {_buf.pipe(p); }
  399. ///Get a reference to the pipe.
  400. pipe_type & pipe() & {return _buf.pipe();}
  401. ///Get a const reference to the pipe.
  402. const pipe_type &pipe() const & {return _buf.pipe();}
  403. ///Get a rvalue reference to the pipe. Qualified as rvalue.
  404. pipe_type && pipe() && {return std::move(_buf).pipe();}
  405. };
  406. typedef basic_pstream<char> pstream;
  407. typedef basic_pstream<wchar_t> wpstream;
  408. }}
  409. #endif