bump version to 0.80 and prepare for release

[catagits/fcgi2.git] / include / fcgio.h

diff --git a/include/fcgio.h b/include/fcgio.h
index dc344f9..20d222a 100644 (file)
--- a/include/fcgio.h
+++ b/include/fcgio.h
@@ -1,21 +1,21 @@
 //
-// Provides support for FastCGI via C++ iostreams.\r
-//\r
-// $Id: fcgio.h,v 1.7 2001/11/20 03:24:18 robs Exp $
+// Provides support for FastCGI via C++ iostreams.
+//
+// $Id: fcgio.h,v 1.15 2002/02/25 13:16:11 robs Exp $
 //
 // This work is based on routines written by George Feinberg. They
 // have been mostly re-written and extensively changed by
 // Michael Richards.
 //
 // Rewritten again with bug fixes and numerous enhancements by
-// Michael Shell.\r
-// \r
+// Michael Shell.
+// 
 // And rewritten again by Rob Saccoccio. 
 //
 // Special Thanks to Dietmar Kuehl for his help and the numerous custom
 // streambuf examples on his web site.
 //
-// Copyright (c) 2000 Tux the Linux Penguin\r
+// Copyright (c) 2000 Tux the Linux Penguin
 // Copyright (c) 2001 Rob Saccoccio and Chelsea Networks
 //
 // You are free to use this software without charge or royalty
@@ -24,13 +24,13 @@
 //
 // This code is offered as-is without any warranty either expressed or
 // implied; without even the implied warranty of MERCHANTABILITY or
-// FITNESS FOR A PARTICULAR PURPOSE.  If it breaks, you get to keep \r
+// FITNESS FOR A PARTICULAR PURPOSE.  If it breaks, you get to keep 
 // both halves.
 
 #ifndef FCGIO_H
 #define FCGIO_H
 
-#include <iostream.h>
+#include <iostream>
 
 #include "fcgiapp.h"
 
@@ -42,67 +42,85 @@
 #endif
 #endif
 
+#if ! HAVE_STREAMBUF_CHAR_TYPE
+typedef char char_type;
+#endif
+
 /*
  *  fcgi_streambuf
  */
-class fcgi_streambuf : public streambuf
+class DLLAPI fcgi_streambuf : public std::streambuf
 {
 public:
 
-    DLLAPI fcgi_streambuf(FCGX_Stream * strm = NULL);
+    // Note that if no buf is assigned (the default), iostream methods
+    // such as peek(), unget() and putback() will fail.  If a buf is
+    // assigned, I/O is a bit less effecient and output streams will
+    // have to be flushed (or the streambuf destroyed) before the next 
+    // call to "accept".
+    fcgi_streambuf(FCGX_Stream * fcgx, char * buf, int len);
+    
+    fcgi_streambuf(char_type * buf, std::streamsize len);
+    
+    fcgi_streambuf(FCGX_Stream * fcgx = 0);
+
+    ~fcgi_streambuf(void);
 
-    DLLAPI ~fcgi_streambuf(void);
+    int attach(FCGX_Stream * fcgx);
 
-    DLLAPI int attach(FCGX_Stream * strm);
+protected:
 
     // Consume the put area (if buffered) and c (if c is not EOF).
-    DLLAPI virtual int overflow(int);
+    virtual int overflow(int);
+
+    // Flush the put area (if buffered) and the FCGX buffer to the client.
+    virtual int sync();
 
-    // Flush the put area (if buffered) and the FCGX buffer to the client.\r
-    // Note: sync() is protected in some implementations.
-    DLLAPI virtual int sync();
+    // Remove and return the current character.
+    virtual int uflow();
 
-    // Fill the get area (if buffered) and return the next character.
-    DLLAPI virtual int underflow();
+    // Fill the get area (if buffered) and return the current character.
+    virtual int underflow();
 
-    // Use a buffer.  The only reasons that a buffer would be useful is\r
-    // to support the use of the unget()/putback() or seek() methods.  Using\r
-    // a buffer will result in less efficient I/O.  Note: the underlying\r
-    // FastCGI library (FCGX) maintains its own input and output buffers.  \r
-    // Note: setbuf() is protected in some implementations.
-    DLLAPI virtual streambuf * setbuf(char * buf, int len);
+    // Use a buffer.  The only reasons that a buffer would be useful is
+    // to support the use of the unget()/putback() or seek() methods.  Using
+    // a buffer will result in less efficient I/O.  Note: the underlying
+    // FastCGI library (FCGX) maintains its own input and output buffers.  
+    virtual std::streambuf * setbuf(char_type * buf, std::streamsize len);
 
-    DLLAPI virtual int xsgetn(char * s, int n);\r
-    DLLAPI virtual int xsputn(const char * s, int n);\r
+    virtual std::streamsize xsgetn(char_type * s, std::streamsize n);
+    virtual std::streamsize xsputn(const char_type * s, std::streamsize n);
 
 private:
 
     FCGX_Stream * fcgx;
 
-    // buf is just handy to have around\r
-    char * buf;\r
-\r
-    // this isn't kept by the base class\r
-    int bufsize;
-    \r
-    void reset(void);\r
+    // buf is just handy to have around
+    char_type * buf;
+
+    // this isn't kept by the base class
+    std::streamsize bufsize;
+    
+    void init(FCGX_Stream * fcgx, char_type * buf, std::streamsize bufsize);
+
+    void reset(void);
 };
 
 /*
  *  fcgi_istream - deprecated
  */
-class fcgi_istream : public istream
+class DLLAPI fcgi_istream : public std::istream
 {
 public:
 
     // deprecated
-    DLLAPI fcgi_istream(FCGX_Stream * strm = NULL);
+    fcgi_istream(FCGX_Stream * fcgx = 0);
     
     // deprecated
-    DLLAPI ~fcgi_istream(void) {}
+    ~fcgi_istream(void) {}
 
     // deprecated
-    DLLAPI virtual void attach(FCGX_Stream * strm);
+    virtual void attach(FCGX_Stream * fcgx);
 
 private:
 
@@ -112,18 +130,18 @@ private:
 /*
  *  fcgi_ostream - deprecated
  */
-class fcgi_ostream : public ostream
+class DLLAPI fcgi_ostream : public std::ostream
 {
 public:
     
     // deprecated
-    DLLAPI fcgi_ostream(FCGX_Stream * strm = NULL);
+    fcgi_ostream(FCGX_Stream * fcgx = 0);
     
     // deprecated
-    DLLAPI ~fcgi_ostream(void) {}
+    ~fcgi_ostream(void) {}
 
     // deprecated
-    DLLAPI virtual void attach(FCGX_Stream *str);
+    virtual void attach(FCGX_Stream *fcgx);
 
 private: