C++ Cleanup 2/N: Reorganize YGConfig (#1348)
Summary: X-link: https://github.com/facebook/react-native/pull/39169 Pull Request resolved: https://github.com/facebook/yoga/pull/1348 ## This diff This diff adds a top level `config` directory for code related to configuring Yoga and Yoga Nodes. The public API for config handles is `YGConfigRef`, which is forward declared to be a pointer to a struct named `YGConfig`. The existing `YGConfig` is split into `yoga::Config`, as the private C++ implementation, inheriting from `YGConfig`, a marker type represented as an empty struct. The public API continues to accept `YGConfigRef`, which continues to be `YGConfig *`, but it must be cast to its concrete internal representation at the API boundary before doing work on it. ## This stack The organization of the C++ internals of Yoga are in need of attention. 1. Some of the C++ internals are namespaced, but others not. 2. Some of the namespaces include `detail`, but are meant to be used outside of the translation unit (FB Clang Tidy rules warn on any usage of these) 2. Most of the files are in a flat hierarchy, except for event tracing in its own folder 3. Some files and functions begin with YG, others don’t 4. Some functions are uppercase, others are not 5. Almost all of the interesting logic is in Yoga.cpp, and the file is too large to reason about 6. There are multiple grab bag files where folks put random functions they need in (Utils, BitUtils, Yoga-Internal.h) 7. There is no clear indication from file structure or type naming what is private vs not 8. Handles like `YGNodeRef` and `YGConfigRef` can be used to access internals just by importing headers This stack does some much needed spring cleaning: 1. All non-public headers and C++ implementation details are in separate folders from the root level `yoga`. This will give us room to split up logic and add more files without too large a flat hierarchy 3. All private C++ internals are under the `facebook::yoga` namespace. Details namespaces are only ever used within the same header, as they are intended 4. Utils files are split 5. Most C++ internals drop the YG prefix 6. Most C++ internal function names are all lower camel case 7. We start to split up Yoga.cpp 8. Every header beginning with YG or at the top-level directory is public and C only, with the exception of Yoga-Internal.h which has non-public functions for bindings 9. It is not possible to use private APIs without static casting handles to internal classes This will give us more leeway to continue splitting monolithic files, and consistent guidelines for style in new files as well. These changes should not be breaking to any project using only public Yoga headers. This includes every usage of Yoga in fbsource except for RN Fabric which is currently tied to internals. This refactor should make that boundary clearer. Changelog: [Internal] Reviewed By: rshest Differential Revision: D48710796 fbshipit-source-id: d548553f7ce872488ebdd697e0aceaa9a625df62
This commit is contained in:
committed by
Facebook GitHub Bot
parent
b289d12248
commit
5af3a5d1d9
@@ -9,14 +9,16 @@
|
||||
|
||||
#include <gtest/gtest.h>
|
||||
#include <yoga/Yoga.h>
|
||||
#include <yoga/YGConfig.h>
|
||||
#include <yoga/config/Config.h>
|
||||
#include <yoga/YGNode.h>
|
||||
|
||||
#include <functional>
|
||||
#include <memory>
|
||||
|
||||
using namespace facebook;
|
||||
|
||||
struct ConfigCloningTest : public ::testing::Test {
|
||||
std::unique_ptr<YGConfig, std::function<void(YGConfig*)>> config;
|
||||
std::unique_ptr<yoga::Config, std::function<void(yoga::Config*)>> config;
|
||||
void SetUp() override;
|
||||
void TearDown() override;
|
||||
|
||||
@@ -56,7 +58,7 @@ TEST_F(ConfigCloningTest, can_clone_with_context) {
|
||||
}
|
||||
|
||||
void ConfigCloningTest::SetUp() {
|
||||
config = {YGConfigNew(), YGConfigFree};
|
||||
config = {static_cast<yoga::Config*>(YGConfigNew()), YGConfigFree};
|
||||
}
|
||||
|
||||
void ConfigCloningTest::TearDown() {
|
||||
|
Reference in New Issue
Block a user