author Neil Deakin <>
Tue, 04 Dec 2018 11:25:41 -0500
changeset 453075 c1cfc595892fe24cccb8989a850e6556be6a778f
parent 452248 cff5ac4f1d70ed500011f025aee86dfa6b4ff2c5
child 454680 2668f097f56dff2258bfc62de51715d3627ae4d2
permissions -rw-r--r--
Bug 1482389, remove methods of XULTreeElement that return unused nsresults. In addition, change GetView to return the nsITreeView instead of using an out-parameter, r=paolo

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at */


#include "mozilla/Attributes.h"
#include "mozilla/dom/IDTracker.h"
#include "nsSMILTimeValueSpecParams.h"
#include "nsStringFwd.h"
#include "nsIDOMEventListener.h"

class nsSMILTimeValue;
class nsSMILInstanceTime;
class nsSMILInterval;

namespace mozilla {
class SMILTimeContainer;
class SMILTimedElement;
namespace dom {
class Event;
}  // namespace dom

class EventListenerManager;
}  // namespace mozilla

// nsSMILTimeValueSpec class
// An individual element of a 'begin' or 'end' attribute, e.g. '5s', 'a.end'.
// This class handles the parsing of such specifications and performs the
// necessary event handling (for event and repeat specifications)
// and synchronisation (for syncbase specifications).
// For an overview of how this class is related to other SMIL time classes see
// the documentation in nsSMILTimeValue.h

class nsSMILTimeValueSpec {
  typedef mozilla::SMILTimeContainer SMILTimeContainer;
  typedef mozilla::SMILTimedElement SMILTimedElement;
  typedef mozilla::dom::Element Element;
  typedef mozilla::dom::Event Event;
  typedef mozilla::dom::IDTracker IDTracker;

  nsSMILTimeValueSpec(SMILTimedElement& aOwner, bool aIsBegin);

  nsresult SetSpec(const nsAString& aStringSpec, Element& aContextElement);
  void ResolveReferences(Element& aContextElement);
  bool IsEventBased() const;

  void HandleNewInterval(nsSMILInterval& aInterval,
                         const SMILTimeContainer* aSrcContainer);
  void HandleTargetElementChange(Element* aNewTarget);

  // For created nsSMILInstanceTime objects
  bool DependsOnBegin() const;
  void HandleChangedInstanceTime(const nsSMILInstanceTime& aBaseTime,
                                 const SMILTimeContainer* aSrcContainer,
                                 nsSMILInstanceTime& aInstanceTimeToUpdate,
                                 bool aObjectChanged);
  void HandleDeletedInstanceTime(nsSMILInstanceTime& aInstanceTime);

  // Cycle-collection support
  void Traverse(nsCycleCollectionTraversalCallback* aCallback);
  void Unlink();

  void UpdateReferencedElement(Element* aFrom, Element* aTo);
  void UnregisterFromReferencedElement(Element* aElement);
  SMILTimedElement* GetTimedElement(Element* aElement);
  bool IsWhitelistedEvent();
  void RegisterEventListener(Element* aElement);
  void UnregisterEventListener(Element* aElement);
  void HandleEvent(Event* aEvent);
  bool CheckRepeatEventDetail(Event* aEvent);
  nsSMILTimeValue ConvertBetweenTimeContainers(
      const nsSMILTimeValue& aSrcTime, const SMILTimeContainer* aSrcContainer);
  bool ApplyOffset(nsSMILTimeValue& aTime) const;

  SMILTimedElement* mOwner;
  bool mIsBegin;  // Indicates if *we* are a begin spec,
                  // not to be confused with
                  // mParams.mSyncBegin which indicates
                  // if we're synced with the begin of
                  // the target.
  nsSMILTimeValueSpecParams mParams;

   * If our nsSMILTimeValueSpec exists for a 'begin' or 'end' attribute with a
   * value that specifies a time that is relative to the animation of some
   * other element, it will create an instance of this class to reference and
   * track that other element.  For example, if the nsSMILTimeValueSpec is for
   * end='a.end+2s', an instance of this class will be created to track the
   * element associated with the element ID "a".  This class will notify the
   * nsSMILTimeValueSpec if the element that that ID identifies changes to a
   * different element (or none).
  class TimeReferenceTracker final : public IDTracker {
    explicit TimeReferenceTracker(nsSMILTimeValueSpec* aOwner)
        : mSpec(aOwner) {}
    void ResetWithElement(Element* aTo) {
      RefPtr<Element> from = get();
      ElementChanged(from, aTo);

    virtual void ElementChanged(Element* aFrom, Element* aTo) override {
      IDTracker::ElementChanged(aFrom, aTo);
      mSpec->UpdateReferencedElement(aFrom, aTo);
    virtual bool IsPersistent() override { return true; }

    nsSMILTimeValueSpec* mSpec;

  TimeReferenceTracker mReferencedElement;

  class EventListener final : public nsIDOMEventListener {
    ~EventListener() {}

    explicit EventListener(nsSMILTimeValueSpec* aOwner) : mSpec(aOwner) {}
    void Disconnect() { mSpec = nullptr; }


    nsSMILTimeValueSpec* mSpec;
  RefPtr<EventListener> mEventListener;