// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef THIRD_PARTY_BLINK_RENDERER_PLATFORM_WIDGET_INPUT_ELASTIC_OVERSCROLL_CONTROLLER_H_
#define THIRD_PARTY_BLINK_RENDERER_PLATFORM_WIDGET_INPUT_ELASTIC_OVERSCROLL_CONTROLLER_H_

#include "base/containers/flat_map.h"
#include "base/gtest_prod_util.h"
#include "base/memory/raw_ptr.h"
#include "base/time/time.h"
#include "cc/input/overscroll_behavior.h"
#include "cc/input/scroll_elasticity_helper.h"
#include "cc/paint/element_id.h"
#include "third_party/blink/public/common/input/web_gesture_event.h"
#include "third_party/blink/public/common/input/web_input_event.h"
#include "third_party/blink/renderer/platform/platform_export.h"

/*
 * Copyright (C) 2011 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

namespace cc {
struct InputHandlerScrollResult;
}  // namespace cc

namespace blink {
// This serves as a base class for handling overscroll. Most of the basic
// overscroll functionality is contained in this class. The customization
// details like the stretch distance, the bounce animations etc will be
// implemented by the subclasses.
class PLATFORM_EXPORT ElasticOverscrollController {
 public:
  explicit ElasticOverscrollController(cc::ScrollElasticityHelper* helper);
  virtual ~ElasticOverscrollController() = default;

  enum State {
    // The initial state, during which the overscroll amount is zero and
    // there are no active or momentum scroll events coming in. This state
    // is briefly returned to between the active and momentum phases of a
    // scroll (if there is no overscroll).
    kStateInactive,
    // The state between receiving PhaseBegan/MayBegin and PhaseEnd/Cancelled,
    // corresponding to the period during which the user has fingers on the
    // trackpad. The overscroll amount is updated as input events are received.
    // When PhaseEnd is received, the state transitions to Inactive if there is
    // no overscroll and MomentumAnimated if there is non-zero overscroll.
    kStateActiveScroll,
    // The state between receiving a momentum PhaseBegan and PhaseEnd, while
    // there is no overscroll. The overscroll amount is updated as input events
    // are received. If the overscroll is ever non-zero then the state
    // immediately transitions to kStateMomentumAnimated.
    kStateMomentumScroll,
    // The state while the overscroll amount is updated by an animation. If
    // the user places fingers on the trackpad (a PhaseMayBegin is received)
    // then the state transition to kStateActiveScroll. Otherwise the state
    // transitions to Inactive when the overscroll amount becomes zero.
    kStateMomentumAnimated,
  };

  class OverscrollEntry {
   public:
    explicit OverscrollEntry(cc::ElementId target_scroller_id)
        : target_scroller_id(target_scroller_id) {}
    virtual ~OverscrollEntry() = default;
    OverscrollEntry(const OverscrollEntry&) = delete;
    OverscrollEntry(OverscrollEntry&&) = default;
    OverscrollEntry& operator=(const OverscrollEntry&) = delete;
    OverscrollEntry& operator=(OverscrollEntry&&) = default;

    // The stable id of the scroller that is being overscrolled.
    cc::ElementId target_scroller_id;

    base::TimeTicks momentum_animation_start_time;
    State state = kStateInactive;

    // If there is no overscroll, require a minimum overscroll delta before
    // starting the rubber-band effect. Track the amount of scrolling that has
    // has occurred but has not yet caused rubber-band stretching in
    // |pending_overscroll_delta|.
    gfx::Vector2dF pending_overscroll_delta;

    // Maintain a calculation of the velocity of the scroll, based on the input
    // scroll delta divide by the time between input events. Track this velocity
    // in |scroll_velocity| and the previous input event timestamp for finite
    // differencing in |last_scroll_event_timestamp|.
    gfx::Vector2dF scroll_velocity;
    base::TimeTicks last_scroll_event_timestamp;

    // The force of the rubber-band spring. This is equal to the cumulative sum
    // of all overscroll offsets since entering a non-Inactive state. This is
    // reset to zero only when entering the Inactive state.
    gfx::Vector2dF stretch_scroll_force;

    bool received_overscroll_update = false;
    cc::OverscrollBehavior overscroll_behavior;

    // TODO (gastonr): Need to be cleared when we leave MomentumAnimated.
    // Momentum animation state. This state is valid only while the state is
    // MomentumAnimated, and is initialized in EnterStateMomentumAnimated.
    gfx::Vector2dF momentum_animation_initial_stretch;
    gfx::Vector2dF momentum_animation_initial_velocity;

    // Whether this entry is currently receiving momentum events.
    bool is_in_momentum_phase = false;
  };

  // These methods that are "real" should only be called if the associated event
  // is not a synthetic phase change, e.g. generated by the MouseWheelEventQueue
  // or FlingController. Otherwise, calling them will disrupt elastic scrolling.
  void ObserveRealScrollBegin(OverscrollEntry& entry,
                              bool enter_momentum,
                              bool leave_momentum);
  void ObserveScrollUpdate(OverscrollEntry& entry,
                           const gfx::Vector2dF& event_delta,
                           const gfx::Vector2dF& unused_scroll_delta,
                           const base::TimeTicks& event_timestamp,
                           const cc::OverscrollBehavior overscroll_behavior,
                           bool has_momentum);
  void ObserveRealScrollEnd(OverscrollEntry& entry,
                            const base::TimeTicks event_timestamp);

  // Update the overscroll state based a gesture event that has been processed.
  // Note that this assumes that all events are coming from a single input
  // device. If the user simultaneously uses multiple input devices, Cocoa may
  // not correctly pass all the gesture begin and end events. In this case,
  // this class may disregard some scrolls that come in at unexpected times.
  void ObserveGestureEventAndResult(
      cc::ElementId,
      const blink::WebGestureEvent& gesture_event,
      const cc::InputHandlerScrollResult& scroll_result);

  void Animate(base::TimeTicks time);
  void ReconcileStretchAndScroll();
  static std::unique_ptr<ElasticOverscrollController> Create(
      cc::ScrollElasticityHelper* helper);

  gfx::Vector2dF StretchAmount(cc::ElementId) const;

  // Whether or not the given scroller can have an elastic overscroll effect
  // applied to it.
  bool CanOverscroll(cc::ElementId) const;

  // Gets an `OverscrollEntry`. Returns nullptr if it does not exist.
  const OverscrollEntry* GetEntry(cc::ElementId) const;
  OverscrollEntry* GetEntry(cc::ElementId);

 protected:
  virtual std::unique_ptr<OverscrollEntry> CreateOverscrollEntry(
      cc::ElementId target_scroller_id);

  virtual void DidEnterMomentumAnimatedState(OverscrollEntry& entry) = 0;

  // The parameter "delta" is the difference between the time "Animate" is
  // called and `momentum_animation_start_time`. Using this information, the
  // stretch amount for a scroller is determined. This is how the bounce
  // animation basically "ticks".
  virtual gfx::Vector2d StretchAmountForTimeDelta(
      const OverscrollEntry& entry,
      const base::TimeDelta& delta) const = 0;

  // Maps the distance the user has scrolled past the boundary into the distance
  // to actually scroll the elastic scroller.
  virtual gfx::Vector2d StretchAmountForAccumulatedOverscroll(
      const OverscrollEntry& entry,
      const gfx::Vector2dF& accumulated_overscroll) const = 0;

  // Does the inverse of `StretchAmountForAccumulatedOverscroll`. As in, takes
  // in the bounce distance and calculates how much is actually overscrolled.
  virtual gfx::Vector2d AccumulatedOverscrollForStretchAmount(
      const OverscrollEntry& entry,
      const gfx::Vector2dF& stretch_amount) const = 0;

  gfx::Size ScrollBounds(cc::ElementId) const;

 private:
  FRIEND_TEST_ALL_PREFIXES(ElasticOverscrollControllerBezierTest,
                           VerifyBackwardAnimationTick);
  FRIEND_TEST_ALL_PREFIXES(ElasticOverscrollControllerBezierTest,
                           VerifyForwardAnimationTick);
  FRIEND_TEST_ALL_PREFIXES(ElasticOverscrollControllerBezierTest,
                           VerifyForwardAnimationIsNotPlayed);
  FRIEND_TEST_ALL_PREFIXES(ElasticOverscrollControllerBezierTest,
                           VerifyInitialStretchDelta);
  FRIEND_TEST_ALL_PREFIXES(ElasticOverscrollControllerBezierTest,
                           NoSyntheticEventsOverscroll);
  FRIEND_TEST_ALL_PREFIXES(ElasticOverscrollControllerBezierTest,
                           VerifyDifferentDurationForwardAnimations);
  FRIEND_TEST_ALL_PREFIXES(ElasticOverscrollControllerBezierTest,
                           VerifyOneAxisForwardAnimation);

  void UpdateVelocity(OverscrollEntry&,
                      const gfx::Vector2dF& event_delta,
                      const base::TimeTicks& event_timestamp);
  void Overscroll(OverscrollEntry&,
                  const gfx::Vector2dF& overscroll_delta,
                  const gfx::Vector2dF& event_delta);
  void EnterStateMomentumAnimated(
      OverscrollEntry&,
      const base::TimeTicks& triggering_event_timestamp);
  void EnterStateInactive(OverscrollEntry&);

  // Returns true if |direction| is pointing in a direction in which it is not
  // possible to scroll any farther horizontally (or vertically). It is only in
  // this circumstance that an overscroll in that direction may begin.
  bool PinnedHorizontally(cc::ElementId, float direction) const;
  bool PinnedVertically(cc::ElementId, float direction) const;

  // Whether or not the content of the page is scrollable horizontaly (or
  // vertically).
  bool CanScrollHorizontally(cc::ElementId) const;
  bool CanScrollVertically(cc::ElementId) const;

  // Gets or creates an `OverscrollEntry`.
  OverscrollEntry& EnsureEntry(cc::ElementId);

  raw_ptr<cc::ScrollElasticityHelper> helper_;
  base::flat_map<cc::ElementId, std::unique_ptr<OverscrollEntry>> entries_;
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_PLATFORM_WIDGET_INPUT_ELASTIC_OVERSCROLL_CONTROLLER_H_