developer.intra2net.com Git - libi2ncommon/blob - src/pipestream.hxx

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