deal with Cocoa as we do with Carbon, see #15008

[wxWidgets.git] / src / common / zstream.cpp

diff --git a/src/common/zstream.cpp b/src/common/zstream.cpp
index 8ff3bf5c60331c80bff16cc5bde9c8ef9fd645c9..ce63c07dc9135f28a41426057763ed971b5d1e36 100644 (file)
--- a/src/common/zstream.cpp
+++ b/src/common/zstream.cpp
@@ -1,195 +1,452 @@
-/////////////////////////////////////////////////////////////////////////////
-// Name:        zstream.cpp
+//////////////////////////////////////////////////////////////////////////////
+// Name:        src/common/zstream.cpp

 // Purpose:     Compressed stream classes
 // Author:      Guilhem Lavaux
 // Purpose:     Compressed stream classes
 // Author:      Guilhem Lavaux

-// Modified by:
+// Modified by: Mike Wetherell

 // Created:     11/07/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Guilhem Lavaux
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 // Created:     11/07/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Guilhem Lavaux
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////

-#ifdef __GNUG__
-#pragma implementation "zstream.h"
-#endif

 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"

-#include <wx/stream.h>
-#include <wx/zstream.h>
-#include <wx/utils.h>
-#include "zlib.h"

 
 #ifdef __BORLANDC__
 
 #ifdef __BORLANDC__

-#pragma hdrstop
+    #pragma hdrstop
+#endif
+
+#if wxUSE_ZLIB && wxUSE_STREAMS
+
+#include "wx/zstream.h"
+#include "wx/versioninfo.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/intl.h"
+    #include "wx/log.h"
+    #include "wx/utils.h"

 #endif
 
 #endif
 

+
+// normally, the compiler options should contain -I../zlib, but it is
+// apparently not the case for all MSW makefiles and so, unless we use
+// configure (which defines __WX_SETUP_H__) or it is explicitly overridden by
+// the user (who can define wxUSE_ZLIB_H_IN_PATH), we hardcode the path here
+#if defined(__WINDOWS__) && !defined(__WX_SETUP_H__) && !defined(wxUSE_ZLIB_H_IN_PATH)
+    #include "../zlib/zlib.h"
+#else
+    #include "zlib.h"
+#endif
+
+enum {
+    ZSTREAM_BUFFER_SIZE = 16384,
+    ZSTREAM_GZIP        = 0x10,     // gzip header
+    ZSTREAM_AUTO        = 0x20      // auto detect between gzip and zlib
+};
+
+
+wxVersionInfo wxGetZlibVersionInfo()
+{
+    int major,
+        minor,
+        build;
+
+    if ( sscanf(zlibVersion(), "%d.%d.%d", &major, &minor, &build) != 3 )
+    {
+        major =
+        minor =
+        build = 0;
+    }
+
+    return wxVersionInfo("zlib", major, minor, build);
+}
+
+/////////////////////////////////////////////////////////////////////////////
+// Zlib Class factory
+
+IMPLEMENT_DYNAMIC_CLASS(wxZlibClassFactory, wxFilterClassFactory)
+
+static wxZlibClassFactory g_wxZlibClassFactory;
+
+wxZlibClassFactory::wxZlibClassFactory()
+{
+    if (this == &g_wxZlibClassFactory)
+        PushFront();
+}
+
+const wxChar * const *
+wxZlibClassFactory::GetProtocols(wxStreamProtocolType type) const
+{
+    static const wxChar *mimes[] = { wxT("application/x-deflate"), NULL };
+    static const wxChar *encs[] =  { wxT("deflate"), NULL };
+    static const wxChar *empty[] = { NULL };
+
+    switch (type) {
+        case wxSTREAM_MIMETYPE:         return mimes;
+        case wxSTREAM_ENCODING:         return encs;
+        default:                        return empty;
+    }
+}
+
+
+/////////////////////////////////////////////////////////////////////////////
+// Gzip Class factory
+
+IMPLEMENT_DYNAMIC_CLASS(wxGzipClassFactory, wxFilterClassFactory)
+
+static wxGzipClassFactory g_wxGzipClassFactory;
+
+wxGzipClassFactory::wxGzipClassFactory()
+{
+    if (this == &g_wxGzipClassFactory && wxZlibInputStream::CanHandleGZip())
+        PushFront();
+}
+
+const wxChar * const *
+wxGzipClassFactory::GetProtocols(wxStreamProtocolType type) const
+{
+    static const wxChar *protos[] =
+        { wxT("gzip"), NULL };
+    static const wxChar *mimes[] =
+        { wxT("application/gzip"), wxT("application/x-gzip"), NULL };
+    static const wxChar *encs[] =
+        { wxT("gzip"), NULL };
+    static const wxChar *exts[] =
+        { wxT(".gz"), wxT(".gzip"), NULL };
+    static const wxChar *empty[] =
+        { NULL };
+
+    switch (type) {
+        case wxSTREAM_PROTOCOL: return protos;
+        case wxSTREAM_MIMETYPE: return mimes;
+        case wxSTREAM_ENCODING: return encs;
+        case wxSTREAM_FILEEXT:  return exts;
+        default:                return empty;
+    }
+}
+
+

 //////////////////////
 // wxZlibInputStream
 //////////////////////
 
 //////////////////////
 // wxZlibInputStream
 //////////////////////
 

-wxZlibInputStream::wxZlibInputStream(wxInputStream& stream)
+wxZlibInputStream::wxZlibInputStream(wxInputStream& stream, int flags)

   : wxFilterInputStream(stream)
 {
   : wxFilterInputStream(stream)
 {

-  int err;
+    Init(flags);
+}

 
 

-  m_inflate.zalloc = (alloc_func)0;
-  m_inflate.zfree = (free_func)0;
-  m_inflate.opaque = (voidpf)0;
+wxZlibInputStream::wxZlibInputStream(wxInputStream *stream, int flags)
+  : wxFilterInputStream(stream)
+{
+    Init(flags);
+}

 
 

-  err = inflateInit(&m_inflate);
-  if (err != Z_OK) {
-    inflateEnd(&m_inflate);
-    return;
+void wxZlibInputStream::Init(int flags)
+{
+  m_inflate = NULL;
+  m_z_buffer = new unsigned char[ZSTREAM_BUFFER_SIZE];
+  m_z_size = ZSTREAM_BUFFER_SIZE;
+  m_pos = 0;
+
+  // if gzip is asked for but not supported...
+  if ((flags == wxZLIB_GZIP || flags == wxZLIB_AUTO) && !CanHandleGZip()) {
+    if (flags == wxZLIB_AUTO) {
+      // an error will come later if the input turns out not to be a zlib
+      flags = wxZLIB_ZLIB;
+    }
+    else {
+      wxLogError(_("Gzip not supported by this version of zlib"));
+      m_lasterror = wxSTREAM_READ_ERROR;
+      return;
+    }
+  }
+
+  if (m_z_buffer) {
+    m_inflate = new z_stream_s;
+
+    if (m_inflate) {
+      memset(m_inflate, 0, sizeof(z_stream_s));
+
+      // see zlib.h for documentation on windowBits
+      int windowBits = MAX_WBITS;
+      switch (flags) {
+        case wxZLIB_NO_HEADER:  windowBits = -MAX_WBITS; break;
+        case wxZLIB_ZLIB:       windowBits = MAX_WBITS; break;
+        case wxZLIB_GZIP:       windowBits = MAX_WBITS | ZSTREAM_GZIP; break;
+        case wxZLIB_AUTO:       windowBits = MAX_WBITS | ZSTREAM_AUTO; break;
+        default:                wxFAIL_MSG(wxT("Invalid zlib flag"));
+      }
+
+      if (inflateInit2(m_inflate, windowBits) == Z_OK)
+        return;
+    }

   }
 
   }
 

-  m_inflate.avail_in = 0;
+  wxLogError(_("Can't initialize zlib inflate stream."));
+  m_lasterror = wxSTREAM_READ_ERROR;

 }
 
 wxZlibInputStream::~wxZlibInputStream()
 {
 }
 
 wxZlibInputStream::~wxZlibInputStream()
 {

-  inflateEnd(&m_inflate);
+  inflateEnd(m_inflate);
+  delete m_inflate;
+
+  delete [] m_z_buffer;

 }
 
 }
 

-wxInputStream& wxZlibInputStream::Read(void *buffer, size_t size)
+size_t wxZlibInputStream::OnSysRead(void *buffer, size_t size)

 {
 {

-  int err;
+  wxASSERT_MSG(m_inflate && m_z_buffer, wxT("Inflate stream not open"));

 
 

-  m_inflate.next_out = (unsigned char *)buffer;
-  m_inflate.avail_out = size;
-  m_eof = FALSE;
+  if (!m_inflate || !m_z_buffer)
+    m_lasterror = wxSTREAM_READ_ERROR;
+  if (!IsOk() || !size)
+    return 0;

 
 

-  while (m_inflate.avail_out > 0) {
-    if (m_inflate.avail_in == 0) {
-      wxFilterInputStream::Read(m_z_buffer, m_z_size);
-      m_inflate.next_in = m_z_buffer;
-      m_inflate.avail_in = wxFilterInputStream::LastRead();
-      if (wxFilterInputStream::Eof()) {
-        m_lastread = size - m_inflate.avail_out;
-        return *this;
-      }
-    }
-    err = inflate(&m_inflate, Z_FINISH);
-    if (err == Z_STREAM_END) {
-      m_lastread = size - m_inflate.avail_out;
-      m_eof = TRUE;
-      return *this;
+  int err = Z_OK;
+  m_inflate->next_out = (unsigned char *)buffer;
+  m_inflate->avail_out = size;
+
+  while (err == Z_OK && m_inflate->avail_out > 0) {
+    if (m_inflate->avail_in == 0 && m_parent_i_stream->IsOk()) {
+      m_parent_i_stream->Read(m_z_buffer, m_z_size);
+      m_inflate->next_in = m_z_buffer;
+      m_inflate->avail_in = m_parent_i_stream->LastRead();

     }
     }

+    err = inflate(m_inflate, Z_SYNC_FLUSH);

   }
 
   }
 

-  m_lastread = size;
-  return *this;
+  switch (err) {
+    case Z_OK:
+        break;
+
+    case Z_STREAM_END:
+      if (m_inflate->avail_out) {
+        // Unread any data taken from past the end of the deflate stream, so that
+        // any additional data can be read from the underlying stream (the crc
+        // in a gzip for example)
+        if (m_inflate->avail_in) {
+          m_parent_i_stream->Reset();
+          m_parent_i_stream->Ungetch(m_inflate->next_in, m_inflate->avail_in);
+          m_inflate->avail_in = 0;
+        }
+        m_lasterror = wxSTREAM_EOF;
+      }
+      break;
+
+    case Z_BUF_ERROR:
+      // Indicates that zlib was expecting more data, but the parent stream
+      // has none. Other than Eof the error will have been already reported
+      // by the parent strean,
+      m_lasterror = wxSTREAM_READ_ERROR;
+      if (m_parent_i_stream->Eof())
+      {
+          wxLogError(_("Can't read inflate stream: unexpected EOF in underlying stream."));
+      }
+      break;
+
+    default:
+      wxString msg(m_inflate->msg, *wxConvCurrent);
+      if (!msg)
+        msg = wxString::Format(_("zlib error %d"), err);
+      wxLogError(_("Can't read from inflate stream: %s"), msg.c_str());
+      m_lasterror = wxSTREAM_READ_ERROR;
+  }
+
+  size -= m_inflate->avail_out;
+  m_pos += size;
+  return size;

 }
 
 }
 

-off_t wxZlibInputStream::SeekI(off_t WXUNUSED(pos), wxSeekMode WXUNUSED(mode))
+/* static */ bool wxZlibInputStream::CanHandleGZip()

 {
 {

-  return 0;
+  const char *dot = strchr(zlibVersion(), '.');
+  int major = atoi(zlibVersion());
+  int minor = dot ? atoi(dot + 1) : 0;
+  return major > 1 || (major == 1 && minor >= 2);

 }
 
 }
 

-off_t wxZlibInputStream::TellI() const
+bool wxZlibInputStream::SetDictionary(const char *data, const size_t datalen)

 {
 {

-  return 0;
+    return (inflateSetDictionary(m_inflate, (Bytef*)data, datalen) == Z_OK);

 }
 
 }
 

-bool wxZlibInputStream::Eof() const
+bool wxZlibInputStream::SetDictionary(const wxMemoryBuffer &buf)

 {
 {

-  if (!m_eof)
-    return wxFilterInputStream::Eof();
-  return m_eof;
+    return SetDictionary((char*)buf.GetData(), buf.GetDataLen());

 }
 
 }
 

+

 //////////////////////
 // wxZlibOutputStream
 //////////////////////
 
 //////////////////////
 // wxZlibOutputStream
 //////////////////////
 

-wxZlibOutputStream::wxZlibOutputStream(wxOutputStream& stream)
+wxZlibOutputStream::wxZlibOutputStream(wxOutputStream& stream,
+                                       int level,
+                                       int flags)

  : wxFilterOutputStream(stream)
 {
  : wxFilterOutputStream(stream)
 {

-  int err;
+    Init(level, flags);
+}

 
 

-  m_deflate.zalloc = (alloc_func)0;
-  m_deflate.zfree = (free_func)0;
-  m_deflate.opaque = (voidpf)0;
+wxZlibOutputStream::wxZlibOutputStream(wxOutputStream *stream,
+                                       int level,
+                                       int flags)
+ : wxFilterOutputStream(stream)
+{
+    Init(level, flags);
+}

 
 

-  err = deflateInit(&m_deflate, Z_DEFAULT_COMPRESSION);
-  if (err != Z_OK) {
-    deflateEnd(&m_deflate);
+void wxZlibOutputStream::Init(int level, int flags)
+{
+  m_deflate = NULL;
+  m_z_buffer = new unsigned char[ZSTREAM_BUFFER_SIZE];
+  m_z_size = ZSTREAM_BUFFER_SIZE;
+  m_pos = 0;
+
+  if ( level == -1 )
+  {
+    level = Z_DEFAULT_COMPRESSION;
+  }
+  else
+  {
+    wxASSERT_MSG(level >= 0 && level <= 9, wxT("wxZlibOutputStream compression level must be between 0 and 9!"));
+  }
+
+  // if gzip is asked for but not supported...
+  if (flags == wxZLIB_GZIP && !CanHandleGZip()) {
+    wxLogError(_("Gzip not supported by this version of zlib"));
+    m_lasterror = wxSTREAM_WRITE_ERROR;

     return;
   }
     return;
   }

-  m_deflate.avail_in = 0;
-  m_deflate.next_out = m_z_buffer;
-  m_deflate.avail_out = m_z_size;
+
+  if (m_z_buffer) {
+    m_deflate = new z_stream_s;
+
+    if (m_deflate) {
+      memset(m_deflate, 0, sizeof(z_stream_s));
+      m_deflate->next_out = m_z_buffer;
+      m_deflate->avail_out = m_z_size;
+
+      // see zlib.h for documentation on windowBits
+      int windowBits = MAX_WBITS;
+      switch (flags) {
+        case wxZLIB_NO_HEADER:  windowBits = -MAX_WBITS; break;
+        case wxZLIB_ZLIB:       windowBits = MAX_WBITS; break;
+        case wxZLIB_GZIP:       windowBits = MAX_WBITS | ZSTREAM_GZIP; break;
+        default:                wxFAIL_MSG(wxT("Invalid zlib flag"));
+      }
+
+      if (deflateInit2(m_deflate, level, Z_DEFLATED, windowBits,
+                       8, Z_DEFAULT_STRATEGY) == Z_OK)
+        return;
+    }
+  }
+
+  wxLogError(_("Can't initialize zlib deflate stream."));
+  m_lasterror = wxSTREAM_WRITE_ERROR;

 }
 
 }
 

-wxZlibOutputStream::~wxZlibOutputStream()
+bool wxZlibOutputStream::Close()
+ {
+  DoFlush(true);
+   deflateEnd(m_deflate);
+   wxDELETE(m_deflate);
+   wxDELETEA(m_z_buffer);
+
+  return wxFilterOutputStream::Close() && IsOk();
+ }
+
+void wxZlibOutputStream::DoFlush(bool final)

 {
 {

-  int err;
+  if (!m_deflate || !m_z_buffer)
+    m_lasterror = wxSTREAM_WRITE_ERROR;
+  if (!IsOk())
+    return;

 
 

-  while (1) {
-    err = deflate(&m_deflate, Z_FINISH);
-    if (err == Z_STREAM_END)
-      break;
-    if (err < 0) {
-      wxDebugMsg("wxZlibOutputStream: error during final deflate");
-      break;
-    }
-    if (m_deflate.avail_out == 0) {
-      wxFilterOutputStream::Write(m_z_buffer, m_z_size);
-      if (wxFilterOutputStream::Bad()) {
-        wxDebugMsg("wxZlibOutputStream: error during final write");
+  int err = Z_OK;
+  bool done = false;
+
+  while (err == Z_OK || err == Z_STREAM_END) {
+    size_t len = m_z_size  - m_deflate->avail_out;
+    if (len) {
+      if (m_parent_o_stream->Write(m_z_buffer, len).LastWrite() != len) {
+        m_lasterror = wxSTREAM_WRITE_ERROR;
+        wxLogDebug(wxT("wxZlibOutputStream: Error writing to underlying stream"));

         break;
       }
         break;
       }

-      m_deflate.next_out = m_z_buffer;
-      m_deflate.avail_out = m_z_size;
+      m_deflate->next_out = m_z_buffer;
+      m_deflate->avail_out = m_z_size;

     }
     }

-  }
-  wxFilterOutputStream::Write(m_z_buffer, m_z_size-m_deflate.avail_out);

 
 

-  deflateEnd(&m_deflate);
+    if (done)
+      break;
+    err = deflate(m_deflate, final ? Z_FINISH : Z_FULL_FLUSH);
+    done = m_deflate->avail_out != 0 || err == Z_STREAM_END;
+  }

 }
 
 }
 

-wxOutputStream& wxZlibOutputStream::Write(const void *buffer, size_t size)
+size_t wxZlibOutputStream::OnSysWrite(const void *buffer, size_t size)

 {
 {

-  int err;
+  wxASSERT_MSG(m_deflate && m_z_buffer, wxT("Deflate stream not open"));
+
+  if (!m_deflate || !m_z_buffer)
+  {
+    // notice that this will make IsOk() test just below return false
+    m_lasterror = wxSTREAM_WRITE_ERROR;
+  }
+
+  if (!IsOk() || !size)
+    return 0;

 
 

-  m_deflate.next_in = (unsigned char *)buffer;
-  m_deflate.avail_in = size;
+  int err = Z_OK;
+  m_deflate->next_in = (unsigned char *)buffer;
+  m_deflate->avail_in = size;

 
 

-  m_bad = FALSE;
-  while (m_deflate.avail_in > 0) {
-    if (m_deflate.avail_out == 0) {
-      wxFilterOutputStream::Write(m_z_buffer, m_z_size);
-      if (wxFilterOutputStream::Bad()) {
-        m_lastwrite = size - m_deflate.avail_in;
-        return *this;
+  while (err == Z_OK && m_deflate->avail_in > 0) {
+    if (m_deflate->avail_out == 0) {
+      m_parent_o_stream->Write(m_z_buffer, m_z_size);
+      if (m_parent_o_stream->LastWrite() != m_z_size) {
+        m_lasterror = wxSTREAM_WRITE_ERROR;
+        wxLogDebug(wxT("wxZlibOutputStream: Error writing to underlying stream"));
+        break;

       }
       }

-            
-      m_deflate.next_out = m_z_buffer;
-      m_deflate.avail_out = m_z_size;
-    }
-    err = deflate(&m_deflate, Z_NO_FLUSH);
-    if (err < 0) {
-      m_bad = TRUE;
-      m_lastwrite = size - m_deflate.avail_in;
-      return *this;
+
+      m_deflate->next_out = m_z_buffer;
+      m_deflate->avail_out = m_z_size;

     }
     }

+
+    err = deflate(m_deflate, Z_NO_FLUSH);
+  }
+
+  if (err != Z_OK) {
+    m_lasterror = wxSTREAM_WRITE_ERROR;
+    wxString msg(m_deflate->msg, *wxConvCurrent);
+    if (!msg)
+      msg = wxString::Format(_("zlib error %d"), err);
+    wxLogError(_("Can't write to deflate stream: %s"), msg.c_str());

   }
   }

-  m_lastwrite = size;
-  return *this;
+
+  size -= m_deflate->avail_in;
+  m_pos += size;
+  return size;

 }
 
 }
 

-off_t wxZlibOutputStream::SeekO(off_t WXUNUSED(pos), wxSeekMode WXUNUSED(mode))
+/* static */ bool wxZlibOutputStream::CanHandleGZip()

 {
 {

-  return 0;
+  return wxZlibInputStream::CanHandleGZip();

 }
 
 }
 

-off_t wxZlibOutputStream::TellO() const
+bool wxZlibOutputStream::SetDictionary(const char *data, const size_t datalen)

 {
 {

-  return 0;
+    return (deflateSetDictionary(m_deflate, (Bytef*)data, datalen) == Z_OK);

 }
 
 }
 

-bool wxZlibOutputStream::Bad() const
+bool wxZlibOutputStream::SetDictionary(const wxMemoryBuffer &buf)

 {
 {

-  if (!m_bad)
-    return wxFilterOutputStream::Bad();
-  return m_bad;
+    return SetDictionary((char*)buf.GetData(), buf.GetDataLen());

 }
 }

+
+#endif
+  // wxUSE_ZLIB && wxUSE_STREAMS