src/third_party/WebKit/Source/core/frame/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 "bindings/core/v8/ScriptWrappable.h"
  30 #include "bindings/core/v8/SerializedScriptValue.h"
  31 #include "core/loader/FrameLoaderTypes.h"
  32 #include "core/frame/DOMWindowProperty.h"
  33 #include "platform/heap/Handle.h"
  34 #include "wtf/Forward.h"
  35 #include "wtf/PassRefPtr.h"
  36 #include "wtf/RefCounted.h"
  37
  38 namespace blink {
  39
  40 class LocalFrame;
  41 class KURL;
  42 class ExecutionContext;
  43 class ExceptionState;
  44
  45 class History final : public RefCountedWillBeGarbageCollectedFinalized<History>, public ScriptWrappable, public DOMWindowProperty {
  46     DEFINE_WRAPPERTYPEINFO();
  47     WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(History);
  48 public:
  49     static PassRefPtrWillBeRawPtr<History> create(LocalFrame* frame)
  50     {
  51         return adoptRefWillBeNoop(new History(frame));
  52     }
  53
  54     unsigned length() const;
  55     SerializedScriptValue* state();
  56
  57     void back(ExecutionContext*);
  58     void forward(ExecutionContext*);
  59     void go(ExecutionContext*, int distance);
  60
  61     bool stateChanged() const;
  62     bool isSameAsCurrentState(SerializedScriptValue*) const;
  63
  64     void stateObjectAdded(PassRefPtr<SerializedScriptValue>, const String& title, const String& url, FrameLoadType, ExceptionState&);
  65
  66     virtual void trace(Visitor*) override;
  67
  68 private:
  69     explicit History(LocalFrame*);
  70
  71     KURL urlForState(const String& url);
  72
  73     SerializedScriptValue* stateInternal() const;
  74
  75     RefPtr<SerializedScriptValue> m_lastStateObjectRequested;
  76 };
  77
  78 } // namespace blink
  79
  80 #endif // History_h