Source/WebCore/page/History.h

   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 <wtf/Forward.h>
  32 #include <wtf/PassRefPtr.h>
  33 #include <wtf/RefCounted.h>
  34
  35 namespace WebCore {
  36
  37 class Frame;
  38 class ScriptExecutionContext;
  39 class SerializedScriptValue;
  40 typedef int ExceptionCode;
  41
  42 class History : public RefCounted<History>, public DOMWindowProperty {
  43 public:
  44     static PassRefPtr<History> create(Frame* frame) { return adoptRef(new History(frame)); }
  45
  46     unsigned length() const;
  47     SerializedScriptValue* state();
  48     void back();
  49     void forward();
  50     void go(int distance);
  51
  52     void back(ScriptExecutionContext*);
  53     void forward(ScriptExecutionContext*);
  54     void go(ScriptExecutionContext*, int distance);
  55
  56     bool stateChanged() const;
  57     bool isSameAsCurrentState(SerializedScriptValue*) const;
  58
  59     enum StateObjectType {
  60         StateObjectPush,
  61         StateObjectReplace
  62     };
  63     void stateObjectAdded(PassRefPtr<SerializedScriptValue>, const String& title, const String& url, StateObjectType, ExceptionCode&);
  64
  65 private:
  66     explicit History(Frame*);
  67
  68     KURL urlForState(const String& url);
  69
  70     SerializedScriptValue* stateInternal() const;
  71
  72     SerializedScriptValue* m_lastStateObjectRequested;
  73 };
  74
  75 } // namespace WebCore
  76
  77 #endif // History_h