1/*
2 * Copyright (C) 2007 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 *
8 * 1.  Redistributions of source code must retain the above copyright
9 *     notice, this list of conditions and the following disclaimer.
10 * 2.  Redistributions in binary form must reproduce the above copyright
11 *     notice, this list of conditions and the following disclaimer in the
12 *     documentation and/or other materials provided with the distribution.
13 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14 *     its contributors may be used to endorse or promote products derived
15 *     from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#ifndef PageURLRecord_h
30#define PageURLRecord_h
31
32#include <wtf/Noncopyable.h>
33#include <wtf/RefPtr.h>
34#include <wtf/text/WTFString.h>
35
36namespace WebCore {
37
38class IconRecord;
39
40class PageURLSnapshot {
41public:
42    PageURLSnapshot() { }
43
44    PageURLSnapshot(const String& pageURL, const String& iconURL)
45        : m_pageURL(pageURL)
46        , m_iconURL(iconURL)
47    { }
48
49    const String& pageURL() const { return m_pageURL; }
50    const String& iconURL() const { return m_iconURL; }
51
52private:
53    String m_pageURL;
54    String m_iconURL;
55};
56
57class PageURLRecord {
58    WTF_MAKE_NONCOPYABLE(PageURLRecord); WTF_MAKE_FAST_ALLOCATED;
59public:
60    PageURLRecord(const String& pageURL);
61    ~PageURLRecord();
62
63    inline String url() const { return m_pageURL; }
64
65    void setIconRecord(PassRefPtr<IconRecord>);
66    IconRecord* iconRecord() { return m_iconRecord.get(); }
67
68    PageURLSnapshot snapshot(bool forDeletion = false) const;
69
70    // Returns false if the page wasn't retained beforehand, true if the retain count was already 1 or higher
71    bool retain(int count)
72    {
73        bool wasRetained = m_retainCount > 0;
74        m_retainCount += count;
75        return wasRetained;
76    }
77
78    // Returns true if the page is still retained after the call.  False if the retain count just dropped to 0
79    bool release(int count)
80    {
81        ASSERT(m_retainCount >= count);
82        m_retainCount -= count;
83        return m_retainCount > 0;
84    }
85
86    inline int retainCount() const { return m_retainCount; }
87private:
88    String m_pageURL;
89    RefPtr<IconRecord> m_iconRecord;
90    int m_retainCount;
91};
92
93}
94
95#endif // PageURLRecord_h
96