Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / zipstrm.h

diff --git a/include/wx/zipstrm.h b/include/wx/zipstrm.h
index 47995d9bac89c8db4e52a0e5bc6a781b15d704e0..618403f95c9a16288f94b60821e38a230154f368 100644 (file)
--- a/include/wx/zipstrm.h
+++ b/include/wx/zipstrm.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        zipstrm.h
+// Name:        wx/zipstrm.h

 // Purpose:     Streams for Zip files
 // Author:      Mike Wetherell
 // RCS-ID:      $Id$
 // Purpose:     Streams for Zip files
 // Author:      Mike Wetherell
 // RCS-ID:      $Id$


@@ -10,18 +10,25 @@
 #ifndef _WX_WXZIPSTREAM_H__
 #define _WX_WXZIPSTREAM_H__
 
 #ifndef _WX_WXZIPSTREAM_H__
 #define _WX_WXZIPSTREAM_H__
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "zipstrm.h"
-#endif
-

 #include "wx/defs.h"
 
 #include "wx/defs.h"
 

-#if wxUSE_ZLIB && wxUSE_STREAMS && wxUSE_ZIPSTREAM
+#if wxUSE_ZIPSTREAM

 
 #include "wx/archive.h"
 
 #include "wx/archive.h"

-#include "wx/hashmap.h"

 #include "wx/filename.h"
 
 #include "wx/filename.h"
 

+// some methods from wxZipInputStream and wxZipOutputStream stream do not get
+// exported/imported when compiled with Mingw versions before 3.4.2. So they
+// are imported/exported individually as a workaround
+#if (defined(__GNUWIN32__) || defined(__MINGW32__)) \
+    && (!defined __GNUC__ \
+       || !defined __GNUC_MINOR__ \
+       || !defined __GNUC_PATCHLEVEL__ \
+       || __GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__ < 30402)
+#define WXZIPFIX WXDLLIMPEXP_BASE
+#else
+#define WXZIPFIX
+#endif

 
 /////////////////////////////////////////////////////////////////////////////
 // constants
 
 /////////////////////////////////////////////////////////////////////////////
 // constants


@@ -45,7 +52,7 @@ enum wxZipMethod
 };
 
 // Originating File-System.
 };
 
 // Originating File-System.

-// 
+//

 // These are Pkware's values. Note that Info-zip disagree on some of them,
 // most notably NTFS.
 //
 // These are Pkware's values. Note that Info-zip disagree on some of them,
 // most notably NTFS.
 //


@@ -105,8 +112,8 @@ enum wxZipFlags
 
 // Forward decls
 //
 
 // Forward decls
 //

-class WXDLLIMPEXP_BASE wxZipEntry;
-class WXDLLIMPEXP_BASE wxZipInputStream;
+class WXDLLIMPEXP_FWD_BASE wxZipEntry;
+class WXDLLIMPEXP_FWD_BASE wxZipInputStream;

 
 
 /////////////////////////////////////////////////////////////////////////////
 
 
 /////////////////////////////////////////////////////////////////////////////


@@ -260,9 +267,9 @@ private:
 
 
 /////////////////////////////////////////////////////////////////////////////
 
 
 /////////////////////////////////////////////////////////////////////////////

-// wxZipOutputStream 
+// wxZipOutputStream

 
 

-WX_DECLARE_LIST_WITH_DECL(wxZipEntry, wx__ZipEntryList, class WXDLLIMPEXP_BASE);
+WX_DECLARE_LIST_WITH_DECL(wxZipEntry, wxZipEntryList_, class WXDLLIMPEXP_BASE);

 
 class WXDLLIMPEXP_BASE wxZipOutputStream : public wxArchiveOutputStream
 {
 
 class WXDLLIMPEXP_BASE wxZipOutputStream : public wxArchiveOutputStream
 {


@@ -270,48 +277,54 @@ public:
     wxZipOutputStream(wxOutputStream& stream,
                       int level = -1,
                       wxMBConv& conv = wxConvLocal);
     wxZipOutputStream(wxOutputStream& stream,
                       int level = -1,
                       wxMBConv& conv = wxConvLocal);

-    virtual ~wxZipOutputStream();
+    wxZipOutputStream(wxOutputStream *stream,
+                      int level = -1,
+                      wxMBConv& conv = wxConvLocal);
+    virtual WXZIPFIX ~wxZipOutputStream();

 
     bool PutNextEntry(wxZipEntry *entry)        { return DoCreate(entry); }
 
 
     bool PutNextEntry(wxZipEntry *entry)        { return DoCreate(entry); }
 

-    bool PutNextEntry(const wxString& name,
-                      const wxDateTime& dt = wxDateTime::Now(),
-                      wxFileOffset size = wxInvalidOffset);
+    bool WXZIPFIX PutNextEntry(const wxString& name,
+                               const wxDateTime& dt = wxDateTime::Now(),
+                               wxFileOffset size = wxInvalidOffset);

 
 

-    bool PutNextDirEntry(const wxString& name,
-                         const wxDateTime& dt = wxDateTime::Now());
+    bool WXZIPFIX PutNextDirEntry(const wxString& name,
+                                  const wxDateTime& dt = wxDateTime::Now());

 
 

-    bool CopyEntry(wxZipEntry *entry, wxZipInputStream& inputStream);
-    bool CopyArchiveMetaData(wxZipInputStream& inputStream);
+    bool WXZIPFIX CopyEntry(wxZipEntry *entry, wxZipInputStream& inputStream);
+    bool WXZIPFIX CopyArchiveMetaData(wxZipInputStream& inputStream);

 
 

-    void Sync();
-    bool CloseEntry();
-    bool Close();
+    void WXZIPFIX Sync();
+    bool WXZIPFIX CloseEntry();
+    bool WXZIPFIX Close();

 
     void SetComment(const wxString& comment)    { m_Comment = comment; }
 
     int  GetLevel() const                       { return m_level; }
 
     void SetComment(const wxString& comment)    { m_Comment = comment; }
 
     int  GetLevel() const                       { return m_level; }

-    void SetLevel(int level);
-    
+    void WXZIPFIX SetLevel(int level);
+

 protected:
 protected:

-    virtual size_t OnSysWrite(const void *buffer, size_t size);
+    virtual size_t WXZIPFIX OnSysWrite(const void *buffer, size_t size);

     virtual wxFileOffset OnSysTell() const      { return m_entrySize; }
 
     virtual wxFileOffset OnSysTell() const      { return m_entrySize; }
 

+    // this protected interface isn't yet finalised

     struct Buffer { const char *m_data; size_t m_size; };
     struct Buffer { const char *m_data; size_t m_size; };

-    virtual wxOutputStream *OpenCompressor(wxOutputStream& stream,
-                                           wxZipEntry& entry,
-                                           const Buffer bufs[]);
-    virtual bool CloseCompressor(wxOutputStream *comp);
+    virtual wxOutputStream* WXZIPFIX OpenCompressor(wxOutputStream& stream,
+                                                    wxZipEntry& entry,
+                                                    const Buffer bufs[]);
+    virtual bool WXZIPFIX CloseCompressor(wxOutputStream *comp);

 
 

-    bool IsParentSeekable() const               { return m_offsetAdjustment
-                                                        != wxInvalidOffset; }
+    bool IsParentSeekable() const
+        { return m_offsetAdjustment != wxInvalidOffset; }

 
 private:
 
 private:

-    bool PutNextEntry(wxArchiveEntry *entry);
-    bool CopyEntry(wxArchiveEntry *entry, wxArchiveInputStream& stream);
-    bool CopyArchiveMetaData(wxArchiveInputStream& stream);
+    void Init(int level);
+
+    bool WXZIPFIX PutNextEntry(wxArchiveEntry *entry);
+    bool WXZIPFIX CopyEntry(wxArchiveEntry *entry, wxArchiveInputStream& stream);
+    bool WXZIPFIX CopyArchiveMetaData(wxArchiveInputStream& stream);

 
 

-    bool IsOpened() const                       { return m_comp || m_pending; }
+    bool IsOpened() const { return m_comp || m_pending; }

 
     bool DoCreate(wxZipEntry *entry, bool raw = false);
     void CreatePendingEntry(const void *buffer, size_t size);
 
     bool DoCreate(wxZipEntry *entry, bool raw = false);
     void CreatePendingEntry(const void *buffer, size_t size);


@@ -320,7 +333,7 @@ private:
     class wxStoredOutputStream *m_store;
     class wxZlibOutputStream2 *m_deflate;
     class wxZipStreamLink *m_backlink;
     class wxStoredOutputStream *m_store;
     class wxZlibOutputStream2 *m_deflate;
     class wxZipStreamLink *m_backlink;

-    wx__ZipEntryList m_entries;
+    wxZipEntryList_ m_entries;

     char *m_initialData;
     size_t m_initialSize;
     wxZipEntry *m_pending;
     char *m_initialData;
     size_t m_initialSize;
     wxZipEntry *m_pending;


@@ -333,13 +346,14 @@ private:
     int m_level;
     wxFileOffset m_offsetAdjustment;
     wxString m_Comment;
     int m_level;
     wxFileOffset m_offsetAdjustment;
     wxString m_Comment;

+    bool m_endrecWritten;

 
 

-    DECLARE_NO_COPY_CLASS(wxZipOutputStream)
+    wxDECLARE_NO_COPY_CLASS(wxZipOutputStream);

 };
 
 
 /////////////////////////////////////////////////////////////////////////////
 };
 
 
 /////////////////////////////////////////////////////////////////////////////

-// wxZipInputStream 
+// wxZipInputStream

 
 class WXDLLIMPEXP_BASE wxZipInputStream : public wxArchiveInputStream
 {
 
 class WXDLLIMPEXP_BASE wxZipInputStream : public wxArchiveInputStream
 {


@@ -347,42 +361,47 @@ public:
     typedef wxZipEntry entry_type;
 
     wxZipInputStream(wxInputStream& stream, wxMBConv& conv = wxConvLocal);
     typedef wxZipEntry entry_type;
 
     wxZipInputStream(wxInputStream& stream, wxMBConv& conv = wxConvLocal);

+    wxZipInputStream(wxInputStream *stream, wxMBConv& conv = wxConvLocal);

 
 

-#if 1 //WXWIN_COMPATIBILITY_2_6
-    wxZipInputStream(const wxString& archive, const wxString& file);
+#if WXWIN_COMPATIBILITY_2_6 && wxUSE_FFILE
+    wxZipInputStream(const wxString& archive, const wxString& file)
+     : wxArchiveInputStream(OpenFile(archive), wxConvLocal) { Init(file); }

 #endif
 
 #endif
 

-    virtual ~wxZipInputStream();
+    virtual WXZIPFIX ~wxZipInputStream();

 
     bool OpenEntry(wxZipEntry& entry)   { return DoOpen(&entry); }
 
     bool OpenEntry(wxZipEntry& entry)   { return DoOpen(&entry); }

-    bool CloseEntry();
+    bool WXZIPFIX CloseEntry();

 
     wxZipEntry *GetNextEntry();
 
 
     wxZipEntry *GetNextEntry();
 

-    wxString GetComment();
-    int GetTotalEntries();
+    wxString WXZIPFIX GetComment();
+    int WXZIPFIX GetTotalEntries();

 
     virtual wxFileOffset GetLength() const { return m_entry.GetSize(); }
 
 protected:
 
     virtual wxFileOffset GetLength() const { return m_entry.GetSize(); }
 
 protected:

-    size_t OnSysRead(void *buffer, size_t size);
+    size_t WXZIPFIX OnSysRead(void *buffer, size_t size);

     wxFileOffset OnSysTell() const { return m_decomp ? m_decomp->TellI() : 0; }
 
     wxFileOffset OnSysTell() const { return m_decomp ? m_decomp->TellI() : 0; }
 

-#if 1 //WXWIN_COMPATIBILITY_2_6
-    wxFileOffset OnSysSeek(wxFileOffset seek, wxSeekMode mode);
+#if WXWIN_COMPATIBILITY_2_6
+    wxFileOffset WXZIPFIX OnSysSeek(wxFileOffset seek, wxSeekMode mode);

 #endif
 
     // this protected interface isn't yet finalised
 #endif
 
     // this protected interface isn't yet finalised

-    virtual wxInputStream *OpenDecompressor(wxInputStream& stream);
-    virtual bool CloseDecompressor(wxInputStream *decomp);
+    virtual wxInputStream* WXZIPFIX OpenDecompressor(wxInputStream& stream);
+    virtual bool WXZIPFIX CloseDecompressor(wxInputStream *decomp);

 
 private:
     void Init();
 
 private:
     void Init();

-    wxInputStream& OpenFile(const wxString& archive);
+    void Init(const wxString& file);
+#if WXWIN_COMPATIBILITY_2_6 && wxUSE_FFILE
+    static wxInputStream *OpenFile(const wxString& archive);
+#endif

 
     wxArchiveEntry *DoGetNextEntry()    { return GetNextEntry(); }
 
 
     wxArchiveEntry *DoGetNextEntry()    { return GetNextEntry(); }
 

-    bool OpenEntry(wxArchiveEntry& entry);
+    bool WXZIPFIX OpenEntry(wxArchiveEntry& entry);

 
     wxStreamError ReadLocal(bool readEndRec = false);
     wxStreamError ReadCentral();
 
     wxStreamError ReadLocal(bool readEndRec = false);
     wxStreamError ReadCentral();


@@ -390,7 +409,7 @@ private:
     wxUint32 ReadSignature();
     bool FindEndRecord();
     bool LoadEndRecord();
     wxUint32 ReadSignature();
     bool FindEndRecord();
     bool LoadEndRecord();

-    
+

     bool AtHeader() const       { return m_headerSize == 0; }
     bool AfterHeader() const    { return m_headerSize > 0 && !m_decomp; }
     bool IsOpened() const       { return m_decomp != NULL; }
     bool AtHeader() const       { return m_headerSize == 0; }
     bool AfterHeader() const    { return m_headerSize > 0 && !m_decomp; }
     bool IsOpened() const       { return m_decomp != NULL; }


@@ -403,7 +422,6 @@ private:
     class wxStoredInputStream *m_store;
     class wxZlibInputStream2 *m_inflate;
     class wxRawInputStream *m_rawin;
     class wxStoredInputStream *m_store;
     class wxZlibInputStream2 *m_inflate;
     class wxRawInputStream *m_rawin;

-    class wxFFileInputStream *m_ffile;

     wxZipEntry m_entry;
     bool m_raw;
     size_t m_headerSize;
     wxZipEntry m_entry;
     bool m_raw;
     size_t m_headerSize;


@@ -423,12 +441,12 @@ private:
     friend bool wxZipOutputStream::CopyArchiveMetaData(
                     wxZipInputStream& inputStream);
 
     friend bool wxZipOutputStream::CopyArchiveMetaData(
                     wxZipInputStream& inputStream);
 

-#if 1 //WXWIN_COMPATIBILITY_2_6
+#if WXWIN_COMPATIBILITY_2_6

     bool m_allowSeeking;
     bool m_allowSeeking;

-    friend class wxZipFSInputStream;
+    friend class wxArchiveFSHandler;

 #endif
 
 #endif
 

-    DECLARE_NO_COPY_CLASS(wxZipInputStream)
+    wxDECLARE_NO_COPY_CLASS(wxZipInputStream);

 };
 
 
 };
 
 


@@ -457,17 +475,26 @@ public:
     typedef wxZipPairIter     pairiter_type;
 #endif
 
     typedef wxZipPairIter     pairiter_type;
 #endif
 

+    wxZipClassFactory();
+

     wxZipEntry *NewEntry() const
         { return new wxZipEntry; }
     wxZipInputStream *NewStream(wxInputStream& stream) const
         { return new wxZipInputStream(stream, GetConv()); }
     wxZipOutputStream *NewStream(wxOutputStream& stream) const
         { return new wxZipOutputStream(stream, -1, GetConv()); }
     wxZipEntry *NewEntry() const
         { return new wxZipEntry; }
     wxZipInputStream *NewStream(wxInputStream& stream) const
         { return new wxZipInputStream(stream, GetConv()); }
     wxZipOutputStream *NewStream(wxOutputStream& stream) const
         { return new wxZipOutputStream(stream, -1, GetConv()); }

+    wxZipInputStream *NewStream(wxInputStream *stream) const
+        { return new wxZipInputStream(stream, GetConv()); }
+    wxZipOutputStream *NewStream(wxOutputStream *stream) const
+        { return new wxZipOutputStream(stream, -1, GetConv()); }

 
     wxString GetInternalName(const wxString& name,
                              wxPathFormat format = wxPATH_NATIVE) const
         { return wxZipEntry::GetInternalName(name, format); }
 
 
     wxString GetInternalName(const wxString& name,
                              wxPathFormat format = wxPATH_NATIVE) const
         { return wxZipEntry::GetInternalName(name, format); }
 

+    const wxChar * const *GetProtocols(wxStreamProtocolType type
+                                       = wxSTREAM_PROTOCOL) const;
+

 protected:
     wxArchiveEntry *DoNewEntry() const
         { return NewEntry(); }
 protected:
     wxArchiveEntry *DoNewEntry() const
         { return NewEntry(); }


@@ -475,6 +502,10 @@ protected:
         { return NewStream(stream); }
     wxArchiveOutputStream *DoNewStream(wxOutputStream& stream) const
         { return NewStream(stream); }
         { return NewStream(stream); }
     wxArchiveOutputStream *DoNewStream(wxOutputStream& stream) const
         { return NewStream(stream); }

+    wxArchiveInputStream *DoNewStream(wxInputStream *stream) const
+        { return NewStream(stream); }
+    wxArchiveOutputStream *DoNewStream(wxOutputStream *stream) const
+        { return NewStream(stream); }

 
 private:
     DECLARE_DYNAMIC_CLASS(wxZipClassFactory)
 
 private:
     DECLARE_DYNAMIC_CLASS(wxZipClassFactory)


@@ -539,6 +570,6 @@ inline void wxZipEntry::SetName(const wxString& name,
 }
 
 
 }
 
 

-#endif // wxUSE_ZLIB && wxUSE_STREAMS && wxUSE_ZIPSTREAM
+#endif // wxUSE_ZIPSTREAM

 
 #endif // _WX_WXZIPSTREAM_H__
 
 #endif // _WX_WXZIPSTREAM_H__