Files
react-native/ReactCommon/react/renderer/core/Props.h
T
Ruslan Shestopalyuk 110b191b14 Refactor ViewPropsMapBuffer -> general MapBuffer props mechanism
Summary:
Previously, ViewPropsMapBuffer conversions were hardcoded deep in Android infrastructrue. I've generalized this into a different mechanism to allow any Props struct to support MapBuffer props.

There are still some things that need to be cleaned up and this should be treated as experimental. One thing we likely want to do is remove the hardcoded IDs (fine for codegen'd code; less so for handwritten) and use compile-time-hashed IDs instead with human-readable string names.

Changelog: [Internal]

Reviewed By: mdvacca

Differential Revision: D38708719

fbshipit-source-id: 64603dee7f21828be31346c555d99862dab304ea
2022-10-03 04:11:02 -07:00

87 lines
2.6 KiB
C++

/*
* 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 <folly/dynamic.h>
#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 <react/renderer/mapbuffer/MapBufferBuilder.h>
#endif
namespace facebook {
namespace react {
/*
* Represents the most generic props object.
*/
class Props : public virtual Sealable, public virtual DebugStringConvertible {
public:
using Shared = std::shared_ptr<Props const>;
Props() = default;
Props(
const PropsParserContext &context,
const Props &sourceProps,
RawProps const &rawProps,
bool shouldSetRawProps = true);
virtual ~Props() = default;
static bool enablePropIteratorSetter;
// This is used as a feature flag for *all* PropsX structs.
// For MapBuffer to be used for a particular component instance,
// its ShadowNode traits must set the MapBuffer trait; and this
// must be set to "true" globally.
static bool enableMapBuffer;
/**
* 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,
RawValue const &value);
std::string nativeId;
/*
* Special value that represents generation number of `Props` object, which
* increases when the object was constructed with some source `Props` object.
* Default props objects (that was constructed using default constructor) have
* revision equals `0`.
* The value might be used for optimization purposes.
*/
int const revision{0};
#ifdef ANDROID
folly::dynamic rawProps = folly::dynamic::object();
virtual void propsDiffMapBuffer(
Props const *oldProps,
MapBufferBuilder &builder) const;
#endif
};
} // namespace react
} // namespace facebook