packages/react-native/ReactCommon/react/renderer/core/ShadowNode.h - main - githubmr/facebook-react-native

packages/react-native/ReactCommon/react/renderer/core/ShadowNode.h
337 строк11 KB
Christoph Purrer
Replace ContextContainer::Shared with std::shared_ptr<const ContextContainer> 2/2 (#52750)
22 июл 2025, 22:40
22 июл 2025, 22:407b5307d
/*
 * Copyright (c) Meta Platforms, Inc. and 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 <limits>
#include <memory>
#include <string>
#include <type_traits>
#include <vector>

#include <react/renderer/core/EventEmitter.h>
#include <react/renderer/core/Props.h>
#include <react/renderer/core/ReactPrimitives.h>
#include <react/renderer/core/Sealable.h>
#include <react/renderer/core/ShadowNodeFamily.h>
#include <react/renderer/core/ShadowNodeTraits.h>
#include <react/renderer/core/State.h>
#include <react/renderer/debug/DebugStringConvertible.h>

namespace facebook::react {

class ComponentDescriptor;
struct ShadowNodeFragment;
struct ShadowNodeWrapper;

class ShadowNode : public Sealable,
                   public DebugStringConvertible,
                   public jsi::NativeState {
 public:
  // TODO(T223558094): delete this in the next version.
  using Shared [[deprecated("Use std::shared_ptr<const ShadowNode> instead")]] =
      std::shared_ptr<const ShadowNode>;
  // TODO(T223558094): delete this in the next version.
  using Weak [[deprecated("Use std::weak_ptr<const ShadowNode> instead")]] =
      std::weak_ptr<const ShadowNode>;
  // TODO(T223558094): delete this in the next version.
  using Unshared [[deprecated("Use std::shared_ptr<ShadowNode> instead")]] =
      std::shared_ptr<ShadowNode>;
  // TODO(T223558094): delete this in the next version.
  using ListOfShared [[deprecated(
      "Use std::vector<std::shared_ptr<const ShadowNode>> instead")]] =
      std::vector<std::shared_ptr<const ShadowNode>>;
  // TODO(T223558094): delete this in the next version.
  using ListOfWeak [[deprecated(
      "Use std::vector<std::weak_ptr<const ShadowNode>> instead")]] =
      std::vector<std::weak_ptr<const ShadowNode>>;
  using SharedListOfShared =
      std::shared_ptr<const std::vector<std::shared_ptr<const ShadowNode>>>;
  using UnsharedListOfShared =
      std::shared_ptr<std::vector<std::shared_ptr<const ShadowNode>>>;
  using UnsharedListOfWeak =
      std::shared_ptr<std::vector<std::weak_ptr<const ShadowNode>>>;

  using AncestorList = std::vector<std::pair<
      std::reference_wrapper<const ShadowNode> /* parentNode */,
      int /* childIndex */>>;

  static SharedListOfShared emptySharedShadowNodeSharedList();

  /*
   * Returns `true` if nodes belong to the same family (they were cloned one
   * from each other or from the same source node).
   */
  static bool sameFamily(const ShadowNode& first, const ShadowNode& second);

  /*
   * A set of traits associated with a particular class.
   * Reimplement in subclasses to declare class-specific traits.
   */
  static ShadowNodeTraits BaseTraits() {
    return ShadowNodeTraits{};
  }

  static void setUseRuntimeShadowNodeReferenceUpdateOnThread(bool isEnabled);

#pragma mark - Constructors

  /*
   * Creates a Shadow Node based on fields specified in a `fragment`.
   */
  ShadowNode(
      const ShadowNodeFragment& fragment,
      ShadowNodeFamily::Shared family,
      ShadowNodeTraits traits);

  /*
   * Creates a Shadow Node via cloning given `sourceShadowNode` and
   * applying fields from given `fragment`.
   * Note: `tag`, `surfaceId`, and `eventEmitter` cannot be changed.
   */
  ShadowNode(
      const ShadowNode& sourceShadowNode,
      const ShadowNodeFragment& fragment);

  /*
   * Not copyable.
   */
  ShadowNode(const ShadowNode& shadowNode) noexcept = delete;
  ShadowNode& operator=(const ShadowNode& other) noexcept = delete;

  virtual ~ShadowNode() override = default;

  /*
   * Clones the shadow node using the ShadowNode's ComponentDescriptor.
   */
  std::shared_ptr<ShadowNode> clone(const ShadowNodeFragment& fragment) const;

  /*
   * Clones the node (and partially the tree starting from the node) by
   * replacing a `oldShadowNode` (which corresponds to a given
   * `shadowNodeFamily`) with a node that `callback` returns.
   *
   * Returns `nullptr` if the operation cannot be performed successfully.
   */
  std::shared_ptr<ShadowNode> cloneTree(
      const ShadowNodeFamily& shadowNodeFamily,
      const std::function<std::shared_ptr<ShadowNode>(
          const ShadowNode& oldShadowNode)>& callback) const;

  /*
   * Clones the nodes (and the subtree containing all the nodes) by
   * replacing the `oldShadowNode` for every `shadowNodeFamily` from
   * `familiesToUpdate` with a node that `callback` returns.
   *
   * Returns `nullptr` if the operation cannot be performed successfully.
   */
  std::shared_ptr<ShadowNode> cloneMultiple(
      const std::unordered_set<const ShadowNodeFamily*>& familiesToUpdate,
      const std::function<std::shared_ptr<ShadowNode>(
          const ShadowNode& oldShadowNode,
          const ShadowNodeFragment& fragment)>& callback) const;

  /**
   * Called, once a fully derived ShadowNode clone has been created via
   * ComponentDescriptor::cloneShadowNode.
   */
  virtual void completeClone(
      const ShadowNode& sourceShadowNode,
      const ShadowNodeFragment& fragment) {}

#pragma mark - Getters

  ComponentName getComponentName() const;
  ComponentHandle getComponentHandle() const;

  /*
   * Returns a stored traits.
   */
  ShadowNodeTraits getTraits() const;

  const Props::Shared& getProps() const;
  const std::vector<std::shared_ptr<const ShadowNode>>& getChildren() const;
  const SharedEventEmitter& getEventEmitter() const;
  jsi::Value getInstanceHandle(jsi::Runtime& runtime) const;
  Tag getTag() const;
  SurfaceId getSurfaceId() const;

  /*
   * Returns a concrete `ComponentDescriptor` that manages nodes of this type.
   */
  const ComponentDescriptor& getComponentDescriptor() const;

  /*
   * Returns the `ContextContainer` used by this ShadowNode.
   */
  std::shared_ptr<const ContextContainer> getContextContainer() const;

  /*
   * Returns a state associated with the particular node.
   */
  const State::Shared& getState() const;

  /*
   * Returns a momentary value of the most recently created or committed state
   * associated with a family of nodes which this node belongs to.
   * Sequential calls might return different values.
   * The method may return null pointer in case if the particular `ShadowNode`
   * does not use `State`.
   */
  State::Shared getMostRecentState() const;

  /*
   * Returns a number that specifies the order of the node.
   * A view generated from a node with a greater order index is placed before a
   * view generated from a node with a lower order index.
   */
  int getOrderIndex() const;

  void sealRecursive() const;

  const ShadowNodeFamily& getFamily() const;

  ShadowNodeFamily::Shared getFamilyShared() const;

#pragma mark - Mutating Methods

  virtual void appendChild(const std::shared_ptr<const ShadowNode>& child);
  virtual void replaceChild(
      const ShadowNode& oldChild,
      const std::shared_ptr<const ShadowNode>& newChild,
      size_t suggestedIndex = std::numeric_limits<size_t>::max());

  /*
   * Performs all side effects associated with mounting/unmounting in one place.
   * This is not `virtual` on purpose, do not override this.
   * `EventEmitter::DispatchMutex()` must be acquired before calling.
   */
  void setMounted(bool mounted) const;

  /*
   * Returns true if the shadow node has been promoted to be the next mounted
   * tree.
   */
  bool getHasBeenPromoted() const;

  /*
   * Bind the runtime reference to this `ShadowNode` with a weak pointer,
   * allowing to update the reference to this `ShadowNode` when cloned.
   */
  void setRuntimeShadowNodeReference(const std::shared_ptr<ShadowNodeWrapper>&
                                         runtimeShadowNodeReference) const;

  /*
   * Update the runtime reference to point to the provided shadow node.
   */
  void updateRuntimeShadowNodeReference(
      const std::shared_ptr<const ShadowNode>& destinationShadowNode) const;

  /*
   * Transfer the runtime reference based on the fragment instructions.
   */
  void transferRuntimeShadowNodeReference(
      const std::shared_ptr<const ShadowNode>& destinationShadowNode,
      const ShadowNodeFragment& fragment) const;

#pragma mark - DebugStringConvertible

#if RN_DEBUG_STRING_CONVERTIBLE
  std::string getDebugName() const override;
  std::string getDebugValue() const override;
  SharedDebugStringConvertibleList getDebugChildren() const override;
  SharedDebugStringConvertibleList getDebugProps() const override;

  /*
   * A number of the generation of the ShadowNode instance;
   * is used and useful for debug-printing purposes *only*.
   * Do not access this value in any circumstances.
   */
  const int revision_;
#endif

 protected:
  Props::Shared props_;
  SharedListOfShared children_;
  State::Shared state_;
  int orderIndex_;

 private:
  friend ShadowNodeFamily;

  /*
   * Clones the list of children (and creates a new `shared_ptr` to it) if
   * `childrenAreShared_` flag is `true`.
   */
  void cloneChildrenIfShared();

  /*
   * Updates the node's traits based on its children's traits.
   * Specifically, if view culling is enabled and any child has the
   * Unstable_uncullableView or Unstable_uncullableTrace trait, this node will
   * also be marked as uncullable. This ensures that if a child needs to be
   * rendered, its parent will be too.
   */
  void updateTraitsIfNeccessary();

  /*
   * Transfer the runtime reference to this `ShadowNode` to a new instance,
   * updating the reference to point to the new `ShadowNode` referencing it.
   */
  void transferRuntimeShadowNodeReference(
      const std::shared_ptr<const ShadowNode>& destinationShadowNode) const;

  /*
   * Pointer to a family object that this shadow node belongs to.
   */
  ShadowNodeFamily::Shared family_;

  /*
   * True if shadow node will be mounted shortly in the future but for all
   * intents and purposes it should be treated as mounted.
   */
  mutable std::atomic<bool> hasBeenMounted_{false};

  /*
   * True if shadow node has been promoted to be the next mounted tree.
   */
  mutable bool hasBeenPromoted_{false};

  static Props::Shared propsForClonedShadowNode(
      const ShadowNode& sourceShadowNode,
      const Props::Shared& props);

 protected:
  /*
   * Traits associated with the particular `ShadowNode` class and an instance of
   * that class.
   */
  ShadowNodeTraits traits_;

  /*
   * Weak pointer to the runtime reference to this `ShadowNode`.
   */
  mutable std::weak_ptr<ShadowNodeWrapper> runtimeShadowNodeReference_{};
};

static_assert(
    std::has_virtual_destructor<ShadowNode>::value,
    "ShadowNode must have a virtual destructor");

struct ShadowNodeWrapper : public jsi::NativeState {
  explicit ShadowNodeWrapper(std::shared_ptr<const ShadowNode> shadowNode)
      : shadowNode(std::move(shadowNode)) {}

  // The below method needs to be implemented out-of-line in order for the class
  // to have at least one "key function" (see
  // https://itanium-cxx-abi.github.io/cxx-abi/abi.html#vague-vtable)
  ~ShadowNodeWrapper() override;

  std::shared_ptr<const ShadowNode> shadowNode;
};

} // namespace facebook::react