Source/WebKit2/Shared/WebBackForwardListItem.h

   1 /*
   2  * Copyright (C) 2010, 2011 Apple 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
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef WebBackForwardListItem_h
  27 #define WebBackForwardListItem_h
  28
  29 #include "APIObject.h"
  30 #include <wtf/PassRefPtr.h>
  31 #include <wtf/text/WTFString.h>
  32
  33 namespace CoreIPC {
  34     class ArgumentDecoder;
  35     class ArgumentEncoder;
  36 }
  37
  38 namespace WebKit {
  39
  40 class WebBackForwardListItem : public APIObject {
  41 public:
  42     static const Type APIType = TypeBackForwardListItem;
  43
  44     static PassRefPtr<WebBackForwardListItem> create(const String& originalURL, const String& url, const String& title, const uint8_t* backForwardData, size_t backForwardDataSize, uint64_t itemID)
  45     {
  46         return adoptRef(new WebBackForwardListItem(originalURL, url, title, backForwardData, backForwardDataSize, itemID));
  47     }
  48
  49     virtual ~WebBackForwardListItem();
  50
  51     uint64_t itemID() const { return m_itemID; }
  52
  53     void setOriginalURL(const String& originalURL) { m_originalURL = originalURL; }
  54     const String& originalURL() const { return m_originalURL; }
  55
  56     void setURL(const String& url) { m_url = url; }
  57     const String& url() const { return m_url; }
  58
  59     void setTitle(const String& title) { m_title = title; }
  60     const String& title() const { return m_title; }
  61
  62     void setBackForwardData(const uint8_t* buffer, size_t size);
  63     const Vector<uint8_t>& backForwardData() const { return m_backForwardData; }
  64
  65     void encode(CoreIPC::ArgumentEncoder&) const;
  66     static PassRefPtr<WebBackForwardListItem> decode(CoreIPC::ArgumentDecoder&);
  67
  68     static uint64_t highedUsedItemID();
  69
  70 private:
  71     WebBackForwardListItem(const String& originalURL, const String& url, const String& title, const uint8_t* backForwardData, size_t backForwardDataSize, uint64_t itemID);
  72
  73     virtual Type type() const { return APIType; }
  74
  75     String m_originalURL;
  76     String m_url;
  77     String m_title;
  78     uint64_t m_itemID;
  79     Vector<uint8_t> m_backForwardData;
  80 };
  81
  82 } // namespace WebKit
  83
  84 #endif // WebBackForwardListItem_h