mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Valentin Shergin
336876509c
Summary: This is a core part of the Timeline feature (aka Time Travel Debugger). With these new primitives, any external library can initiate "saving" all the previous interface changes (commits) and unwind to any previous one (in order to introspect and validate visual side-effects). The next diff in the stack will implement UI for this feature integrated into Debug menu on iOS. Changelog: [Internal] Fabric-specific internal change. Reviewed By: sammy-SC Differential Revision: D25926660 fbshipit-source-id: 2e5f6892351d3053db8f64c1cf6ff445b0867ad7
81 lines
2.1 KiB
C++
81 lines
2.1 KiB
C++
/*
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <memory>
|
|
|
|
#include <better/map.h>
|
|
|
|
#include <react/renderer/core/ReactPrimitives.h>
|
|
#include <react/renderer/timeline/Timeline.h>
|
|
#include <react/renderer/timeline/TimelineHandler.h>
|
|
#include <react/renderer/uimanager/UIManagerCommitHook.h>
|
|
|
|
namespace facebook {
|
|
namespace react {
|
|
|
|
/*
|
|
* Provides tools for introspecting the series of commits and associated
|
|
* side-effects, allowing to "rewind" UI to any particular commit from the past.
|
|
*/
|
|
class TimelineController final : public UIManagerCommitHook {
|
|
public:
|
|
using Shared = std::shared_ptr<TimelineController const>;
|
|
|
|
/*
|
|
* Creates a `TimelineHandler` associated with given `SurfaceId` and starts
|
|
* the introspection process.
|
|
*/
|
|
TimelineHandler enable(SurfaceId surfaceId) const;
|
|
|
|
/*
|
|
* Consumes and destroys a `TimelineHandler` instance triggering the
|
|
* destruction of all associated resources and stoping the introspection
|
|
* process.
|
|
*/
|
|
void disable(TimelineHandler &&handler) const;
|
|
|
|
/*
|
|
* TO BE DELETED.
|
|
*/
|
|
SurfaceId lastUpdatedSurface() const {
|
|
return lastUpdatedSurface_;
|
|
}
|
|
|
|
#pragma mark - UIManagerCommitHook
|
|
|
|
RootShadowNode::Unshared shadowTreeWillCommit(
|
|
ShadowTree const &shadowTree,
|
|
RootShadowNode::Shared const &oldRootShadowNode,
|
|
RootShadowNode::Unshared const &newRootShadowNode)
|
|
const noexcept override;
|
|
|
|
void commitHookWasRegistered(
|
|
UIManager const &uiManager) const noexcept override;
|
|
|
|
void commitHookWasUnregistered(
|
|
UIManager const &uiManager) const noexcept override;
|
|
|
|
private:
|
|
/*
|
|
* Protects all the data members.
|
|
*/
|
|
mutable better::shared_mutex timelinesMutex_;
|
|
|
|
/*
|
|
* Owning collection of all running `Timeline` instances.
|
|
*/
|
|
mutable better::map<SurfaceId, std::unique_ptr<Timeline>> timelines_;
|
|
|
|
mutable UIManager const *uiManager_;
|
|
mutable SurfaceId lastUpdatedSurface_;
|
|
};
|
|
|
|
} // namespace react
|
|
} // namespace facebook
|