replay/InputCursor.h

   1 /*
   2  * Copyright (C) 2011, 2012 University of Washington. All rights reserved.
   3  * Copyright (C) 2014 Apple Inc. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1.  Redistributions of source code must retain the above copyright
  10  *     notice, this list of conditions and the following disclaimer.
  11  * 2.  Redistributions in binary form must reproduce the above copyright
  12  *     notice, this list of conditions and the following disclaimer in the
  13  *     documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  16  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  17  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  18  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  19  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  21  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef InputCursor_h
  29 #define InputCursor_h
  30
  31 #if ENABLE(WEB_REPLAY)
  32
  33 #include "NondeterministicInput.h"
  34 #include <wtf/Noncopyable.h>
  35 #include <wtf/RefCounted.h>
  36
  37 namespace JSC {
  38
  39 class InputCursor : public RefCounted<InputCursor> {
  40     WTF_MAKE_NONCOPYABLE(InputCursor);
  41 public:
  42     InputCursor() { }
  43     virtual ~InputCursor() { }
  44
  45     virtual bool isCapturing() const = 0;
  46     virtual bool isReplaying() const = 0;
  47
  48     void setWithinEventLoopInputExtent(bool withinEventLoopInputExtent)
  49     {
  50         // We can be within two input extents when a nested run loop
  51         // processes additional user inputs while the debugger is paused.
  52         // However, the debugger should not pause when capturing, and we
  53         // should not replay event loop inputs while in a nested run loop.
  54         ASSERT(m_withinEventLoopInputExtent != withinEventLoopInputExtent || !(isCapturing() || isReplaying()));
  55         m_withinEventLoopInputExtent = withinEventLoopInputExtent;
  56     }
  57
  58     bool withinEventLoopInputExtent() const { return m_withinEventLoopInputExtent; }
  59
  60     template <class InputType, class... Args> inline
  61     void appendInput(Args&&... args)
  62     {
  63         InputType* rawInput = WTF::safeCast<InputType*>(new InputType(std::forward<Args>(args)...));
  64         return storeInput(std::unique_ptr<NondeterministicInputBase>(rawInput));
  65     }
  66
  67     template <class InputType> inline
  68     InputType* fetchInput()
  69     {
  70         return static_cast<InputType*>(loadInput(InputTraits<InputType>::queue(), InputTraits<InputType>::type()));
  71     }
  72
  73     virtual void storeInput(std::unique_ptr<NondeterministicInputBase>) = 0;
  74     virtual NondeterministicInputBase* uncheckedLoadInput(InputQueue) = 0;
  75 protected:
  76     virtual NondeterministicInputBase* loadInput(InputQueue, const String&) = 0;
  77
  78 private:
  79     bool m_withinEventLoopInputExtent {false};
  80 };
  81
  82 } // namespace JSC
  83
  84 using JSC::InputCursor;
  85
  86 #endif // ENABLE(WEB_REPLAY)
  87
  88 #endif // InputCursor_h