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

packages/react-native/ReactCommon/react/renderer/core/Props.h

100 строк3 KB

Nick Lefever

Remove hard-coded component name listing for Props 2.0 support testing (#51633)

28 май 2025, 05:04

28 май 2025, 05:048f2e981

/*
 * 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 <react/renderer/core/PropsMacros.h>
#include <react/renderer/core/PropsParserContext.h>
#include <react/renderer/core/RawProps.h>
#include <react/renderer/core/ReactPrimitives.h>
#include <react/renderer/core/Sealable.h>
#include <react/renderer/debug/DebugStringConvertible.h>

#ifdef ANDROID
#include <folly/dynamic.h>
#include <react/renderer/mapbuffer/MapBufferBuilder.h>
#endif

namespace facebook::react {

/*
 * Represents the most generic props object.
 */
class Props : public virtual Sealable, public virtual DebugStringConvertible {
 public:
  using Shared = std::shared_ptr<const Props>;

  Props() = default;
  Props(
      const PropsParserContext& context,
      const Props& sourceProps,
      const RawProps& rawProps,
      const std::function<bool(const std::string&)>& filterObjectKeys =
          nullptr);

#if RN_DEBUG_STRING_CONVERTIBLE
  virtual ~Props() override = default;
#else
  virtual ~Props() = default;
#endif

  Props(const Props& other) = delete;
  Props& operator=(const Props& other) = delete;

  /**
   * Set a prop value via iteration (see enableIterator above).
   * If setProp is defined for a particular props struct, it /must/
   * be called every time setProp is called on the hierarchy.
   * For example, ViewProps overrides setProp and so ViewProps must
   * explicitly call Props::setProp every time ViewProps::setProp is
   * called. This is because a single prop from JS can be reused
   * multiple times for different values in the hierarchy. For example, if
   * ViewProps uses "propX", Props may also use "propX".
   */
  void setProp(
      const PropsParserContext& context,
      RawPropsPropNameHash hash,
      const char* propName,
      const RawValue& value);

  std::string nativeId;

#ifdef RN_SERIALIZABLE_STATE
  folly::dynamic rawProps = folly::dynamic::object();

  virtual ComponentName getDiffPropsImplementationTarget() const {
    return "";
  }

  virtual folly::dynamic getDiffProps(const Props* prevProps) const {
    return folly::dynamic::object();
  }
#endif

#if RN_DEBUG_STRING_CONVERTIBLE

#pragma mark - DebugStringConvertible (Partial)

  SharedDebugStringConvertibleList getDebugProps() const override;

#endif

 protected:
  /** Initialize member variables of Props instance */
  void initialize(
      const PropsParserContext& context,
      const Props& sourceProps,
      const RawProps& rawProps,
      /**
       * Filter object keys to be excluded when converting the RawProps to
       * folly::dynamic (android only)
       */
      const std::function<bool(const std::string&)>& filterObjectKeys =
          nullptr);
};

} // namespace facebook::react