third_party/WebKit/Source/core/events/RegisteredEventListener.h

/*
 * Copyright (C) 2001 Peter Kelly (pmk@post.com)
 * Copyright (C) 2001 Tobias Anton (anton@stud.fbi.fh-darmstadt.de)
 * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
 * Copyright (C) 2003, 2004, 2005, 2006, 2008, 2009 Apple Inc. All rights
 * reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 */

#ifndef RegisteredEventListener_h
#define RegisteredEventListener_h

#include "base/memory/scoped_refptr.h"
#include "core/dom/events/AddEventListenerOptionsResolved.h"
#include "core/dom/events/EventListener.h"
#include "platform/bindings/TraceWrapperMember.h"

namespace blink {

class RegisteredEventListener {
  DISALLOW_NEW_EXCEPT_PLACEMENT_NEW();

 public:
  RegisteredEventListener()
      : use_capture_(false),
        passive_(false),
        once_(false),
        blocked_event_warning_emitted_(false),
        passive_forced_for_document_target_(false),
        passive_specified_(false) {}

  RegisteredEventListener(EventListener* listener,
                          const AddEventListenerOptionsResolved& options)
      : callback_(listener),
        use_capture_(options.capture()),
        passive_(options.passive()),
        once_(options.once()),
        blocked_event_warning_emitted_(false),
        passive_forced_for_document_target_(
            options.PassiveForcedForDocumentTarget()),
        passive_specified_(options.PassiveSpecified()) {}

  void Trace(blink::Visitor* visitor) { visitor->Trace(callback_); }
  void TraceWrappers(const ScriptWrappableVisitor* visitor) const {
    visitor->TraceWrappers(callback_);
  }

  AddEventListenerOptionsResolved Options() const {
    AddEventListenerOptionsResolved result;
    result.setCapture(use_capture_);
    result.setPassive(passive_);
    result.SetPassiveForcedForDocumentTarget(
        passive_forced_for_document_target_);
    result.setOnce(once_);
    result.SetPassiveSpecified(passive_specified_);
    return result;
  }

  const EventListener* Callback() const { return callback_; }

  EventListener* Callback() { return callback_; }

  void SetCallback(EventListener* listener) { callback_ = listener; }

  bool Passive() const { return passive_; }

  bool Once() const { return once_; }

  bool Capture() const { return use_capture_; }

  bool BlockedEventWarningEmitted() const {
    return blocked_event_warning_emitted_;
  }

  bool PassiveForcedForDocumentTarget() const {
    return passive_forced_for_document_target_;
  }

  bool PassiveSpecified() const { return passive_specified_; }

  void SetBlockedEventWarningEmitted() {
    blocked_event_warning_emitted_ = true;
  }

  bool Matches(const EventListener* listener,
               const EventListenerOptions& options) const {
    // Equality is soley based on the listener and useCapture flags.
    DCHECK(callback_);
    DCHECK(listener);
    return *callback_ == *listener &&
           static_cast<bool>(use_capture_) == options.capture();
  }

  bool operator==(const RegisteredEventListener& other) const {
    // Equality is soley based on the listener and useCapture flags.
    DCHECK(callback_);
    DCHECK(other.callback_);
    return *callback_ == *other.callback_ && use_capture_ == other.use_capture_;
  }

 private:
  TraceWrapperMember<EventListener> callback_;
  unsigned use_capture_ : 1;
  unsigned passive_ : 1;
  unsigned once_ : 1;
  unsigned blocked_event_warning_emitted_ : 1;
  unsigned passive_forced_for_document_target_ : 1;
  unsigned passive_specified_ : 1;
};

}  // namespace blink

WTF_ALLOW_CLEAR_UNUSED_SLOTS_WITH_MEM_FUNCTIONS(blink::RegisteredEventListener);

#endif  // RegisteredEventListener_h