src/third_party/WebKit/Source/platform/mhtml/MHTMLArchive.h

   1 /*
   2  * Copyright (C) 2011 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef MHTMLArchive_h
  32 #define MHTMLArchive_h
  33
  34 #include "platform/mhtml/ArchiveResource.h"
  35 #include "wtf/PassRefPtr.h"
  36 #include "wtf/RefCounted.h"
  37 #include "wtf/RefPtr.h"
  38 #include "wtf/Vector.h"
  39
  40 namespace WebCore {
  41
  42 class KURL;
  43 class MHTMLParser;
  44 class SharedBuffer;
  45
  46 struct SerializedResource;
  47
  48 class PLATFORM_EXPORT MHTMLArchive FINAL : public RefCounted<MHTMLArchive> {
  49 public:
  50     static PassRefPtr<MHTMLArchive> create();
  51     static PassRefPtr<MHTMLArchive> create(const KURL&, SharedBuffer*);
  52
  53     enum EncodingPolicy {
  54         UseDefaultEncoding,
  55         UseBinaryEncoding
  56     };
  57
  58     // Binary encoding results in smaller MHTML files but they might not work in other browsers.
  59     static PassRefPtr<SharedBuffer> generateMHTMLData(const Vector<SerializedResource>&, EncodingPolicy, const String& title, const String& mimeType);
  60
  61     ~MHTMLArchive();
  62     ArchiveResource* mainResource() { return m_mainResource.get(); }
  63     const Vector<RefPtr<ArchiveResource> >& subresources() const { return m_subresources; }
  64     const Vector<RefPtr<MHTMLArchive> >& subframeArchives() const { return m_subframeArchives; }
  65
  66 private:
  67     friend class MHTMLParser;
  68     MHTMLArchive();
  69
  70     void setMainResource(PassRefPtr<ArchiveResource> mainResource) { m_mainResource = mainResource; }
  71     void addSubresource(PassRefPtr<ArchiveResource> subResource) { m_subresources.append(subResource); }
  72     void addSubframeArchive(PassRefPtr<MHTMLArchive> subframeArchive) { m_subframeArchives.append(subframeArchive); }
  73
  74     void clearAllSubframeArchives();
  75     void clearAllSubframeArchivesImpl(Vector<RefPtr<MHTMLArchive> >* clearedArchives);
  76
  77     RefPtr<ArchiveResource> m_mainResource;
  78     Vector<RefPtr<ArchiveResource> > m_subresources;
  79     Vector<RefPtr<MHTMLArchive> > m_subframeArchives;
  80 };
  81
  82 }
  83
  84 #endif