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 * 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 COMPUTER, INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef History_h
27#define History_h
28
29#include "DOMWindowProperty.h"
30#include "KURL.h"
31#include "ScriptWrappable.h"
32#include "SerializedScriptValue.h"
33#include <wtf/Forward.h>
34#include <wtf/PassRefPtr.h>
35#include <wtf/RefCounted.h>
36
37namespace WebCore {
38
39class Frame;
40class ScriptExecutionContext;
41typedef int ExceptionCode;
42
43class History : public ScriptWrappable, public RefCounted<History>, public DOMWindowProperty {
44public:
45    static PassRefPtr<History> create(Frame* frame) { return adoptRef(new History(frame)); }
46
47    unsigned length() const;
48    PassRefPtr<SerializedScriptValue> state();
49    void back();
50    void forward();
51    void go(int distance);
52
53    void back(ScriptExecutionContext*);
54    void forward(ScriptExecutionContext*);
55    void go(ScriptExecutionContext*, int distance);
56
57    bool stateChanged() const;
58    bool isSameAsCurrentState(SerializedScriptValue*) const;
59
60    enum StateObjectType {
61        StateObjectPush,
62        StateObjectReplace
63    };
64    void stateObjectAdded(PassRefPtr<SerializedScriptValue>, const String& title, const String& url, StateObjectType, ExceptionCode&);
65
66private:
67    explicit History(Frame*);
68
69    KURL urlForState(const String& url);
70
71    PassRefPtr<SerializedScriptValue> stateInternal() const;
72
73    RefPtr<SerializedScriptValue> m_lastStateObjectRequested;
74};
75
76} // namespace WebCore
77
78#endif // History_h
79