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/heap/Handle.h"
  35 #include "wtf/PassRefPtr.h"
  36 #include "wtf/RefCounted.h"
  37 #include "wtf/RefPtr.h"
  38 #include "wtf/Vector.h"
  39
  40 namespace blink {
  41
  42 class ArchiveResource;
  43 class KURL;
  44 class MHTMLParser;
  45 class SharedBuffer;
  46
  47 struct SerializedResource;
  48
  49 class PLATFORM_EXPORT MHTMLArchive FINAL : public RefCountedWillBeGarbageCollectedFinalized<MHTMLArchive> {
  50 public:
  51     static PassRefPtrWillBeRawPtr<MHTMLArchive> create();
  52     static PassRefPtrWillBeRawPtr<MHTMLArchive> create(const KURL&, SharedBuffer*);
  53     ~MHTMLArchive();
  54
  55     enum EncodingPolicy {
  56         UseDefaultEncoding,
  57         UseBinaryEncoding
  58     };
  59
  60     // Binary encoding results in smaller MHTML files but they might not work in other browsers.
  61     static PassRefPtr<SharedBuffer> generateMHTMLData(const Vector<SerializedResource>&, EncodingPolicy, const String& title, const String& mimeType);
  62
  63     typedef WillBeHeapVector<RefPtrWillBeMember<ArchiveResource> > SubArchiveResources;
  64     typedef WillBeHeapVector<RefPtrWillBeMember<MHTMLArchive> > SubFrameArchives;
  65
  66     ArchiveResource* mainResource() { return m_mainResource.get(); }
  67     const SubArchiveResources& subresources() const { return m_subresources; }
  68     const SubFrameArchives& subframeArchives() const { return m_subframeArchives; }
  69
  70     void trace(Visitor*);
  71
  72 private:
  73     friend class MHTMLParser;
  74     MHTMLArchive();
  75
  76     void setMainResource(PassRefPtrWillBeRawPtr<ArchiveResource>);
  77     void addSubresource(PassRefPtrWillBeRawPtr<ArchiveResource>);
  78     void addSubframeArchive(PassRefPtrWillBeRawPtr<MHTMLArchive>);
  79
  80 #if !ENABLE(OILPAN)
  81     void clearAllSubframeArchives();
  82     void clearAllSubframeArchivesImpl(SubFrameArchives* clearedArchives);
  83 #endif
  84
  85     RefPtrWillBeMember<ArchiveResource> m_mainResource;
  86     SubArchiveResources m_subresources;
  87     SubFrameArchives m_subframeArchives;
  88 };
  89
  90 }
  91
  92 #endif