mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Joshua Gross
09b9422516
Summary: Unfortunately, parsing some props requires stateful context - namely, PlatformColor on Android. We explored several different options but they all seemed inferior to the approach of using ContextContainer, and most would require using global state. By introducing this change everywhere as early as possible, we can avoid later pain. It is likely that some prop, on some platform, will require this mechanism. We'll be ready for it! Because we can pass a constref of the ContextContainer through to all props and because the context and context data is never retained by prop parsers, perf and memory hit should be ~0. This diff contains core changes only. Leaf changes to all props structs and conversions files will be in next diff(s). Changelog: [Internal] Reviewed By: mdvacca Differential Revision: D29838789 fbshipit-source-id: f5090e7f02eb6e8fbe0ef4dd201e7d12104a3e3c
147 lines
4.1 KiB
C++
147 lines
4.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 <better/mutex.h>
|
|
#include <memory>
|
|
|
|
#include <react/renderer/components/root/RootComponentDescriptor.h>
|
|
#include <react/renderer/components/root/RootShadowNode.h>
|
|
#include <react/renderer/core/LayoutConstraints.h>
|
|
#include <react/renderer/core/ReactPrimitives.h>
|
|
#include <react/renderer/core/ShadowNode.h>
|
|
#include <react/renderer/mounting/MountingCoordinator.h>
|
|
#include <react/renderer/mounting/ShadowTreeDelegate.h>
|
|
#include <react/renderer/mounting/ShadowTreeRevision.h>
|
|
#include <react/utils/ContextContainer.h>
|
|
#include "MountingOverrideDelegate.h"
|
|
|
|
namespace facebook {
|
|
namespace react {
|
|
|
|
using ShadowTreeCommitTransaction = std::function<RootShadowNode::Unshared(
|
|
RootShadowNode const &oldRootShadowNode)>;
|
|
|
|
/*
|
|
* Represents the shadow tree and its lifecycle.
|
|
*/
|
|
class ShadowTree final {
|
|
public:
|
|
using Unique = std::unique_ptr<ShadowTree>;
|
|
|
|
/*
|
|
* Represents a result of a `commit` operation.
|
|
*/
|
|
enum class CommitStatus {
|
|
Succeeded,
|
|
Failed,
|
|
Cancelled,
|
|
};
|
|
|
|
/*
|
|
* Represents commits' side-effects propagation mode.
|
|
*/
|
|
enum class CommitMode {
|
|
// Commits' side-effects are observable via `MountingCoordinator`.
|
|
// The rendering pipeline fully works end-to-end.
|
|
Normal,
|
|
|
|
// Commits' side-effects are *not* observable via `MountingCoordinator`.
|
|
// The mounting phase is skipped in the rendering pipeline.
|
|
Suspended,
|
|
};
|
|
|
|
struct CommitOptions {
|
|
bool enableStateReconciliation{false};
|
|
|
|
// Called during `tryCommit` phase. Returning true indicates current commit
|
|
// should yield to the next commit.
|
|
std::function<bool()> shouldYield;
|
|
};
|
|
|
|
/*
|
|
* Creates a new shadow tree instance.
|
|
*/
|
|
ShadowTree(
|
|
SurfaceId surfaceId,
|
|
LayoutConstraints const &layoutConstraints,
|
|
LayoutContext const &layoutContext,
|
|
ShadowTreeDelegate const &delegate,
|
|
ContextContainer const &contextContainer);
|
|
|
|
~ShadowTree();
|
|
|
|
/*
|
|
* Returns the `SurfaceId` associated with the shadow tree.
|
|
*/
|
|
SurfaceId getSurfaceId() const;
|
|
|
|
/*
|
|
* Sets and gets the commit mode.
|
|
* Changing commit mode from `Suspended` to `Normal` will flush all suspended
|
|
* changes to `MountingCoordinator`.
|
|
*/
|
|
void setCommitMode(CommitMode commitMode) const;
|
|
CommitMode getCommitMode() const;
|
|
|
|
/*
|
|
* Performs commit calling `transaction` function with a `oldRootShadowNode`
|
|
* and expecting a `newRootShadowNode` as a return value.
|
|
* The `transaction` function can cancel commit returning `nullptr`.
|
|
*/
|
|
CommitStatus tryCommit(
|
|
ShadowTreeCommitTransaction transaction,
|
|
CommitOptions commitOptions = {false}) const;
|
|
|
|
/*
|
|
* Calls `tryCommit` in a loop until it finishes successfully.
|
|
*/
|
|
CommitStatus commit(
|
|
ShadowTreeCommitTransaction transaction,
|
|
CommitOptions commitOptions = {false}) const;
|
|
|
|
/*
|
|
* Returns a `ShadowTreeRevision` representing the momentary state of
|
|
* the `ShadowTree`.
|
|
*/
|
|
ShadowTreeRevision getCurrentRevision() const;
|
|
|
|
/*
|
|
* Commit an empty tree (a new `RootShadowNode` with no children).
|
|
*/
|
|
void commitEmptyTree() const;
|
|
|
|
/**
|
|
* Forces the ShadowTree to ping its delegate that an update is available.
|
|
* Useful for animations on Android.
|
|
* @return
|
|
*/
|
|
void notifyDelegatesOfUpdates() const;
|
|
|
|
MountingCoordinator::Shared getMountingCoordinator() const;
|
|
|
|
private:
|
|
constexpr static ShadowTreeRevision::Number INITIAL_REVISION{0};
|
|
|
|
void mount(ShadowTreeRevision const &revision) const;
|
|
|
|
void emitLayoutEvents(
|
|
std::vector<LayoutableShadowNode const *> &affectedLayoutableNodes) const;
|
|
|
|
SurfaceId const surfaceId_;
|
|
ShadowTreeDelegate const &delegate_;
|
|
mutable better::shared_mutex commitMutex_;
|
|
mutable CommitMode commitMode_{
|
|
CommitMode::Normal}; // Protected by `commitMutex_`.
|
|
mutable ShadowTreeRevision currentRevision_; // Protected by `commitMutex_`.
|
|
MountingCoordinator::Shared mountingCoordinator_;
|
|
};
|
|
|
|
} // namespace react
|
|
} // namespace facebook
|