Files
react-native/ReactCommon/react/renderer/timeline/TimelineController.h
T
Kevin Gozali fb39d45ed5 C++ - better => butter
Summary:
Renaming the `better` utilities to `butter`:
- to prevent claims that this library is superior to others - it really depends on use cases
- to indicate ease of use throughout the codebase, easily spread like butter

Changelog: [C++][Changed] Renaming C++ better util to butter, used by Fabric internals

Reviewed By: JoshuaGross

Differential Revision: D33242764

fbshipit-source-id: 26dc95d9597c61ce8e66708e44ed545e0fc5cff5
2021-12-20 22:25:14 -08:00

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 <butter/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 butter::shared_mutex timelinesMutex_;
/*
* Owning collection of all running `Timeline` instances.
*/
mutable butter::map<SurfaceId, std::unique_ptr<Timeline>> timelines_;
mutable UIManager const *uiManager_;
mutable SurfaceId lastUpdatedSurface_;
};
} // namespace react
} // namespace facebook