mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Samuel Susla
cc3064d394
Summary: changelog: [internal] In this diff, we delete default initialised for ShadowViewMutation to prevent accidentally creating empty ShadowViewMutation. The other initialiser is made private and all of its uses are migrated to designated initialisers. This makes for safer API. Reviewed By: RSNara Differential Revision: D30774900 fbshipit-source-id: d2064bf08409850e75e13ad06558b7980a7f5d8d
104 lines
2.7 KiB
C++
104 lines
2.7 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
|
|
|
|
#include <vector>
|
|
|
|
#include <react/renderer/mounting/ShadowView.h>
|
|
|
|
namespace facebook {
|
|
namespace react {
|
|
|
|
/*
|
|
* Describes a single native view tree mutation which may contain
|
|
* pointers to an old shadow view, a new shadow view, a parent shadow view and
|
|
* final index of inserted or updated view.
|
|
* Use static methods to instantiate mutations of different types.
|
|
*/
|
|
struct ShadowViewMutation final {
|
|
using List = std::vector<ShadowViewMutation>;
|
|
|
|
ShadowViewMutation() = delete;
|
|
|
|
#pragma mark - Designated Initializers
|
|
|
|
/*
|
|
* Creates and returns an `Create` mutation.
|
|
*/
|
|
static ShadowViewMutation CreateMutation(ShadowView shadowView);
|
|
|
|
/*
|
|
* Creates and returns an `Delete` mutation.
|
|
*/
|
|
static ShadowViewMutation DeleteMutation(ShadowView shadowView);
|
|
|
|
/*
|
|
* Creates and returns an `Insert` mutation.
|
|
*/
|
|
static ShadowViewMutation InsertMutation(
|
|
ShadowView parentShadowView,
|
|
ShadowView childShadowView,
|
|
int index);
|
|
|
|
/*
|
|
* Creates and returns a `Remove` mutation.
|
|
*/
|
|
static ShadowViewMutation RemoveMutation(
|
|
ShadowView parentShadowView,
|
|
ShadowView childShadowView,
|
|
int index);
|
|
|
|
/*
|
|
* Creates and returns an `Update` mutation.
|
|
*/
|
|
static ShadowViewMutation UpdateMutation(
|
|
ShadowView oldChildShadowView,
|
|
ShadowView newChildShadowView);
|
|
|
|
#pragma mark - Type
|
|
|
|
enum Type { Create = 1, Delete = 2, Insert = 4, Remove = 8, Update = 16 };
|
|
|
|
#pragma mark - Fields
|
|
|
|
Type type = {Create};
|
|
ShadowView parentShadowView = {};
|
|
ShadowView oldChildShadowView = {};
|
|
ShadowView newChildShadowView = {};
|
|
int index = -1;
|
|
|
|
// Some platforms can have the notion of virtual views - views that are in the
|
|
// ShadowTree hierarchy but never are on the platform. Generally this is used
|
|
// so notify the platform that a view exists so that we can keep EventEmitters
|
|
// around, to notify JS of something. This mechanism is DEPRECATED and it is
|
|
// highly recommended that you NOT make use of this in your platform!
|
|
bool mutatedViewIsVirtual() const;
|
|
|
|
private:
|
|
ShadowViewMutation(
|
|
Type type,
|
|
ShadowView parentShadowView,
|
|
ShadowView oldChildShadowView,
|
|
ShadowView newChildShadowView,
|
|
int index);
|
|
};
|
|
|
|
using ShadowViewMutationList = std::vector<ShadowViewMutation>;
|
|
|
|
#if RN_DEBUG_STRING_CONVERTIBLE
|
|
|
|
std::string getDebugName(ShadowViewMutation const &object);
|
|
std::vector<DebugStringConvertibleObject> getDebugProps(
|
|
ShadowViewMutation const &object,
|
|
DebugStringConvertibleOptions options);
|
|
|
|
#endif
|
|
|
|
} // namespace react
|
|
} // namespace facebook
|