mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Joshua Gross
774dec1e17
Summary: iOS will need to be implemented separately, but the shared C++ bits are in place. Explanation: there is currently no way for the View layer to /know/ if an UpdateState call has succeeded or failed. Generally we just assume it succeeds, but if it fails we have no way of knowing or retrying. This can cause some UI bugs. To mitigate this, I'm introducing a "failure" notification callback mechanism. The JNI bridging for this is a little complicated to avoid passing Runnable across the JNI, but it should be much simpler on iOS. In development this seems to make View components much more reliable. Changelog: [Internal] Reviewed By: mdvacca Differential Revision: D22940187 fbshipit-source-id: 917f2932ae22d421f91fe8f4fca3f07dc089f820
114 lines
2.9 KiB
C++
114 lines
2.9 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
|
||
|
||
#ifdef ANDROID
|
||
#include <folly/dynamic.h>
|
||
#endif
|
||
|
||
#include <react/renderer/core/ShadowNodeFamily.h>
|
||
|
||
namespace facebook {
|
||
namespace react {
|
||
|
||
/*
|
||
* An abstract interface of State.
|
||
* State is used to control and continuously advance a single vision of some
|
||
* state (arbitrary data) associated with a family of shadow nodes.
|
||
*/
|
||
class State {
|
||
public:
|
||
using Shared = std::shared_ptr<const State>;
|
||
|
||
static size_t constexpr initialRevisionValue = 1;
|
||
|
||
protected:
|
||
/*
|
||
* Constructors are protected to make calling them directly with
|
||
* type-erasured arguments impossible.
|
||
*/
|
||
explicit State(StateData::Shared const &data, State const &state);
|
||
explicit State(
|
||
StateData::Shared const &data,
|
||
ShadowNodeFamily::Shared const &family);
|
||
|
||
public:
|
||
virtual ~State() = default;
|
||
|
||
/*
|
||
* Returns a momentary value of the most recently committed state
|
||
* associated with a family of nodes which this state belongs to.
|
||
* Sequential calls might return different values.
|
||
*/
|
||
State::Shared getMostRecentState() const;
|
||
|
||
/*
|
||
* Returns the most recent state (same as `getMostRecentState()` method)
|
||
* if this state is obsolete, otherwise returns `nullptr`.
|
||
*/
|
||
State::Shared getMostRecentStateIfObsolete() const;
|
||
|
||
/*
|
||
* Returns a revision number of the `State` object.
|
||
* The number is being automatically assigned during the creation of `State`
|
||
* objects.
|
||
* Revision `0` represents a case when we don't have any info about state
|
||
* object (actual State instances cannot have it).
|
||
* Revision `1` represents a newly created initial state object.
|
||
*/
|
||
size_t getRevision() const;
|
||
|
||
#ifdef ANDROID
|
||
virtual folly::dynamic getDynamic() const = 0;
|
||
virtual void updateState(
|
||
folly::dynamic data,
|
||
std::function<void()> failureCallback) const = 0;
|
||
#endif
|
||
|
||
protected:
|
||
friend class ShadowNodeFamily;
|
||
friend class UIManager;
|
||
|
||
/*
|
||
* Returns a shared pointer to data.
|
||
* To be used by `UIManager` only.
|
||
*/
|
||
StateData::Shared const &getDataPointer() const {
|
||
return data_;
|
||
}
|
||
|
||
/*
|
||
* A family of a node with this state is associated.
|
||
* Must be a weak pointer to avoid retain cycle among `State`, `ShadowNode`,
|
||
* and `ShadowNodeFamily` instances.
|
||
*/
|
||
ShadowNodeFamily::Weak family_;
|
||
|
||
/*
|
||
* Type-erasured pointer to arbitrary component-specific data held by the
|
||
* `State`.
|
||
*/
|
||
StateData::Shared data_;
|
||
|
||
/*
|
||
* Indicates that the state was committed once and then was replaced by a
|
||
* newer one.
|
||
* To be used by `StateCoordinator` only.
|
||
* Protected by mutex inside `StateCoordinator`.
|
||
*/
|
||
mutable bool isObsolete_{false};
|
||
|
||
/*
|
||
* Revision of the State object.
|
||
*/
|
||
size_t revision_;
|
||
};
|
||
|
||
} // namespace react
|
||
} // namespace facebook
|