headers/cpp/pfstream.h

   1 /* This is part of libio/iostream, providing -*- C++ -*- input/output.
   2 Copyright (C) 1993 Free Software Foundation
   3
   4 This file is part of the GNU IO Library.  This library is free
   5 software; you can redistribute it and/or modify it under the
   6 terms of the GNU General Public License as published by the
   7 Free Software Foundation; either version 2, or (at your option)
   8 any later version.
   9
  10 This library is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this library; see the file COPYING.  If not, write to the Free
  17 Software Foundation, 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18
  19 As a special exception, if you link this library with files
  20 compiled with a GNU compiler to produce an executable, this does not cause
  21 the resulting executable to be covered by the GNU General Public License.
  22 This exception does not however invalidate any other reasons why
  23 the executable file might be covered by the GNU General Public License. */
  24
  25 /* Written by Per Bothner (bothner@cygnus.com). */
  26
  27 #ifndef _PFSTREAM_H
  28 #define _PFSTREAM_H
  29 #ifdef __GNUG__
  30 #pragma interface
  31 #endif
  32 #include <fstream.h>
  33
  34 extern "C++" {
  35 // ipfstream foo("NAME") is like: ifstream foo("NAME").  However,
  36 // if NAME starts *or ends* with a '|', the remainder of NAME is
  37 // evaluated as a shell command (using a procbuf), and all input
  38 // read from foo is whatever that shell writes to its standard output.
  39 // E.g. ipfstream foo("|zcat foo.Z") or ipfstream foo("zcat foo.Z|")
  40 // (These two forms are equivalent.)
  41
  42 class ipfstream : public ifstream {
  43   public:
  44     ipfstream(const char *name, int mode=ios::in, int prot=0664);
  45 };
  46
  47 // opfstream foo("NAME") is like: ofstream foo("NAME").
  48 // However, if NAME starts with a '|', the remainder of NAME is
  49 // evaluated as a shell command (using a procbuf), and all output
  50 // written to foo is piped to the standard input of that shell.
  51 // E.g. opfstream foo("|more");
  52
  53 class opfstream : public ofstream {
  54   public:
  55     opfstream(const char *name, int mode=ios::out, int prot=0664);
  56 };
  57 } // extern "C++"
  58 #endif /*!_PFSTREAM_H*/
  59