Skip to content

Commit

Permalink
Share common ShadowNode functionality in BaseTextInputShadowNode for iOS
Browse files Browse the repository at this point in the history
Summary:
[Changelog] [Internal] - Share common ShadowNode functionality in BaseTextInputShadowNode for iOS

The current Android and iOS implementations have quite some overlapping functionality. Not sharing common logic makes it also harder to reuse this [functionality] for out of tree platforms.

This change moves the current iOS implementation into a shared location.
The next change allows to reuse it for Android.

Differential Revision: D66901676
  • Loading branch information
christophpurrer authored and facebook-github-bot committed Dec 9, 2024
1 parent 0b866aa commit 56f92ac
Show file tree
Hide file tree
Showing 7 changed files with 260 additions and 226 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,33 @@ void BaseTextInputProps::setProp(
}
}

TextAttributes BaseTextInputProps::getEffectiveTextAttributes(
Float fontSizeMultiplier) const {
auto result = TextAttributes::defaultTextAttributes();
result.fontSizeMultiplier = fontSizeMultiplier;
result.apply(textAttributes);

/*
* These props are applied to `View`, therefore they must not be a part of
* base text attributes.
*/
result.backgroundColor = clearColor();
result.opacity = 1;

return result;
}

ParagraphAttributes BaseTextInputProps::getEffectiveParagraphAttributes()
const {
auto result = paragraphAttributes;

if (!multiline) {
result.maximumNumberOfLines = 1;
}

return result;
}

SubmitBehavior BaseTextInputProps::getNonDefaultSubmitBehavior() const {
if (submitBehavior == SubmitBehavior::Default) {
return multiline ? SubmitBehavior::Newline : SubmitBehavior::BlurAndSubmit;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,15 @@ class BaseTextInputProps : public ViewProps, public BaseTextProps {
const char* propName,
const RawValue& value);

SubmitBehavior getNonDefaultSubmitBehavior() const;

/*
* Accessors
*/
TextAttributes getEffectiveTextAttributes(Float fontSizeMultiplier) const;

ParagraphAttributes getEffectiveParagraphAttributes() const;

#pragma mark - Props

/*
Expand Down Expand Up @@ -71,8 +80,6 @@ class BaseTextInputProps : public ViewProps, public BaseTextProps {
SubmitBehavior submitBehavior{SubmitBehavior::Default};

bool multiline{false};

SubmitBehavior getNonDefaultSubmitBehavior() const;
};

} // namespace facebook::react
Original file line number Diff line number Diff line change
@@ -0,0 +1,213 @@
/*
* 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/attributedstring/AttributedString.h>
#include <react/renderer/attributedstring/AttributedStringBox.h>
#include <react/renderer/components/text/BaseTextShadowNode.h>
#include <react/renderer/components/textinput/BaseTextInputProps.h>
#include <react/renderer/components/textinput/TextInputState.h>
#include <react/renderer/components/view/ConcreteViewShadowNode.h>
#include <react/renderer/components/view/YogaLayoutableShadowNode.h>
#include <react/renderer/core/LayoutConstraints.h>
#include <react/renderer/core/LayoutContext.h>
#include <react/renderer/textlayoutmanager/TextLayoutContext.h>
#include <react/renderer/textlayoutmanager/TextLayoutManager.h>
#include <react/utils/ContextContainer.h>

namespace facebook::react {

/*
* Base `ShadowNode` for <TextInput> component.
*/
template <
const char* concreteComponentName,
typename ViewPropsT,
typename ViewEventEmitterT,
typename StateDataT,
bool usesMapBufferForStateData = false>
class BaseTextInputShadowNode : public ConcreteViewShadowNode<
concreteComponentName,
ViewPropsT,
ViewEventEmitterT,
StateDataT,
usesMapBufferForStateData>,
public BaseTextShadowNode {
public:
using BaseShadowNode = ConcreteViewShadowNode<
concreteComponentName,
ViewPropsT,
ViewEventEmitterT,
StateDataT,
usesMapBufferForStateData>;

using BaseShadowNode::ConcreteViewShadowNode;
virtual ~BaseTextInputShadowNode() = default;

static ShadowNodeTraits BaseTraits() {
auto traits = BaseShadowNode::BaseTraits();
traits.set(ShadowNodeTraits::Trait::LeafYogaNode);
traits.set(ShadowNodeTraits::Trait::BaselineYogaNode);
return traits;
}

/*
* Associates a shared `TextLayoutManager` with the node.
* `TextInputShadowNode` uses the manager to measure text content
* and construct `TextInputState` objects.
*/
void setTextLayoutManager(
std::shared_ptr<const TextLayoutManager> textLayoutManager) {
Sealable::ensureUnsealed();
textLayoutManager_ = std::move(textLayoutManager);
}

protected:
Size measureContent(
const LayoutContext& layoutContext,
const LayoutConstraints& layoutConstraints) const override {
const auto& props = BaseShadowNode::getConcreteProps();
TextLayoutContext textLayoutContext{
.pointScaleFactor = layoutContext.pointScaleFactor};
return textLayoutManager_
->measure(
attributedStringBoxToMeasure(layoutContext),
props.getEffectiveParagraphAttributes(),
textLayoutContext,
layoutConstraints)
.size;
}

void layout(LayoutContext layoutContext) override {
updateStateIfNeeded(layoutContext);
BaseShadowNode::layout(layoutContext);
}

Float baseline(const LayoutContext& layoutContext, Size size) const override {
const auto& props = BaseShadowNode::getConcreteProps();
auto attributedString = getAttributedString(layoutContext);

if (attributedString.isEmpty()) {
auto placeholderString = !props.placeholder.empty()
? props.placeholder
: BaseTextShadowNode::getEmptyPlaceholder();
auto textAttributes =
props.getEffectiveTextAttributes(layoutContext.fontSizeMultiplier);
attributedString.appendFragment(
{std::move(placeholderString), textAttributes, {}});
}

// Yoga expects a baseline relative to the Node's border-box edge instead of
// the content, so we need to adjust by the padding and border widths, which
// have already been set by the time of baseline alignment
auto top = YGNodeLayoutGetBorder(
&(YogaLayoutableShadowNode::yogaNode_), YGEdgeTop) +
YGNodeLayoutGetPadding(
&(YogaLayoutableShadowNode::yogaNode_), YGEdgeTop);

AttributedStringBox attributedStringBox{attributedString};
return textLayoutManager_->baseline(
attributedStringBox,
props.getEffectiveParagraphAttributes(),
size) +
top;
}

private:
/*
* Creates a `State` object if needed.
*/
void updateStateIfNeeded(const LayoutContext& layoutContext) {
Sealable::ensureUnsealed();
const auto& stateData = BaseShadowNode::getStateData();
const auto& reactTreeAttributedString = getAttributedString(layoutContext);

react_native_assert(textLayoutManager_);
if (stateData.reactTreeAttributedString.isContentEqual(
reactTreeAttributedString)) {
return;
}

const auto& props = BaseShadowNode::getConcreteProps();
TextInputState newState(
AttributedStringBox{reactTreeAttributedString},
reactTreeAttributedString,
props.paragraphAttributes,
props.mostRecentEventCount);
BaseShadowNode::setStateData(std::move(newState));
}

/*
* Returns a `AttributedString` which represents text content of the node.
*/
AttributedString getAttributedString(
const LayoutContext& layoutContext) const {
const auto& props = BaseShadowNode::getConcreteProps();
auto textAttributes =
props.getEffectiveTextAttributes(layoutContext.fontSizeMultiplier);
auto attributedString = AttributedString{};

attributedString.appendFragment(AttributedString::Fragment{
.string = props.text,
.textAttributes = textAttributes,
// TODO: Is this really meant to be by value?
.parentShadowView = ShadowView(*this)});

auto attachments = BaseTextShadowNode::Attachments{};
BaseTextShadowNode::buildAttributedString(
textAttributes, *this, attributedString, attachments);
attributedString.setBaseTextAttributes(textAttributes);

return attributedString;
}

/*
* Returns an `AttributedStringBox` which represents text content that should
* be used for measuring purposes. It might contain actual text value,
* placeholder value or some character that represents the size of the font.
*/
AttributedStringBox attributedStringBoxToMeasure(
const LayoutContext& layoutContext) const {
bool meaningfulState = BaseShadowNode::getState() &&
BaseShadowNode::getState()->getRevision() !=
State::initialRevisionValue;
if (meaningfulState) {
const auto& stateData = BaseShadowNode::getStateData();
auto attributedStringBox = stateData.attributedStringBox;
if (attributedStringBox.getMode() ==
AttributedStringBox::Mode::OpaquePointer ||
!attributedStringBox.getValue().isEmpty()) {
return stateData.attributedStringBox;
}
}

auto attributedString = meaningfulState
? AttributedString{}
: getAttributedString(layoutContext);

if (attributedString.isEmpty()) {
const auto& props = BaseShadowNode::getConcreteProps();
auto placeholder = props.placeholder;
// Note: `zero-width space` is insufficient in some cases (e.g. when we
// need to measure the "hight" of the font).
// TODO T67606511: We will redefine the measurement of empty strings as
// part of T67606511
auto string = !placeholder.empty()
? placeholder
: BaseTextShadowNode::getEmptyPlaceholder();
auto textAttributes =
props.getEffectiveTextAttributes(layoutContext.fontSizeMultiplier);
attributedString.appendFragment({string, textAttributes, {}});
}
return AttributedStringBox{attributedString};
}

std::shared_ptr<const TextLayoutManager> textLayoutManager_;
};

} // namespace facebook::react
Original file line number Diff line number Diff line change
Expand Up @@ -52,30 +52,4 @@ TextInputProps::TextInputProps(
sourceProps.onChangeSync,
{})){};

TextAttributes TextInputProps::getEffectiveTextAttributes(
Float fontSizeMultiplier) const {
auto result = TextAttributes::defaultTextAttributes();
result.fontSizeMultiplier = fontSizeMultiplier;
result.apply(textAttributes);

/*
* These props are applied to `View`, therefore they must not be a part of
* base text attributes.
*/
result.backgroundColor = clearColor();
result.opacity = 1;

return result;
}

ParagraphAttributes TextInputProps::getEffectiveParagraphAttributes() const {
auto result = paragraphAttributes;

if (!multiline) {
result.maximumNumberOfLines = 1;
}

return result;
}

} // namespace facebook::react
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,6 @@ class TextInputProps final : public BaseTextInputProps {

bool onKeyPressSync{false};
bool onChangeSync{false};

/*
* Accessors
*/
TextAttributes getEffectiveTextAttributes(Float fontSizeMultiplier) const;
ParagraphAttributes getEffectiveParagraphAttributes() const;
};

} // namespace facebook::react
Loading

0 comments on commit 56f92ac

Please sign in to comment.