include/wx/unix/pipe.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/unix/pipe.h
   3 // Purpose:     wxPipe class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     24.06.2003 (extracted from src/unix/utilsunx.cpp)
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_UNIX_PIPE_H_
  13 #define _WX_UNIX_PIPE_H_
  14
  15 #include <unistd.h>
  16
  17 #include "wx/log.h"
  18 #include "wx/intl.h"
  19
  20 // ----------------------------------------------------------------------------
  21 // wxPipe: this class encapsulates pipe() system call
  22 // ----------------------------------------------------------------------------
  23
  24 class wxPipe
  25 {
  26 public:
  27     // the symbolic names for the pipe ends
  28     enum Direction
  29     {
  30         Read,
  31         Write
  32     };
  33
  34     enum
  35     {
  36         INVALID_FD = -1
  37     };
  38
  39     // default ctor doesn't do anything
  40     wxPipe() { m_fds[Read] = m_fds[Write] = INVALID_FD; }
  41
  42     // create the pipe, return TRUE if ok, FALSE on error
  43     bool Create()
  44     {
  45         if ( pipe(m_fds) == -1 )
  46         {
  47             wxLogSysError(_("Pipe creation failed"));
  48
  49             return FALSE;
  50         }
  51
  52         return TRUE;
  53     }
  54
  55     // return TRUE if we were created successfully
  56     bool IsOk() const { return m_fds[Read] != INVALID_FD; }
  57
  58     // return the descriptor for one of the pipe ends
  59     int operator[](Direction which) const
  60     {
  61         wxASSERT_MSG( which >= 0 && (size_t)which < WXSIZEOF(m_fds),
  62                       _T("invalid pipe index") );
  63
  64         return m_fds[which];
  65     }
  66
  67     // detach a descriptor, meaning that the pipe dtor won't close it, and
  68     // return it
  69     int Detach(Direction which)
  70     {
  71         wxASSERT_MSG( which >= 0 && (size_t)which < WXSIZEOF(m_fds),
  72                       _T("invalid pipe index") );
  73
  74         int fd = m_fds[which];
  75         m_fds[which] = INVALID_FD;
  76
  77         return fd;
  78     }
  79
  80     // close the pipe descriptors
  81     void Close()
  82     {
  83         for ( size_t n = 0; n < WXSIZEOF(m_fds); n++ )
  84         {
  85             if ( m_fds[n] != INVALID_FD )
  86                 close(m_fds[n]);
  87         }
  88     }
  89
  90     // dtor closes the pipe descriptors
  91     ~wxPipe() { Close(); }
  92
  93 private:
  94     int m_fds[2];
  95 };
  96
  97 #if wxUSE_STREAMS
  98
  99 #include "wx/wfstream.h"
 100
 101 // ----------------------------------------------------------------------------
 102 // wxPipeInputStream: stream for reading from a pipe
 103 // ----------------------------------------------------------------------------
 104
 105 class wxPipeInputStream : public wxFileInputStream
 106 {
 107 public:
 108     wxPipeInputStream(int fd) : wxFileInputStream(fd) { }
 109
 110     // return TRUE if the pipe is still opened
 111     bool IsOpened() const { return !Eof(); }
 112
 113     // return TRUE if we have anything to read, don't block
 114     virtual bool CanRead() const;
 115 };
 116
 117 #endif // wxUSE_STREAMS
 118
 119 #endif // _WX_UNIX_PIPE_H_
 120