Skip to content

Stop suppressing the for-frameworks guard inside umbrella context #58850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
coado wants to merge 1 commit into from
Closed

Stop suppressing the for-frameworks guard inside umbrella context #58850

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions packages/react-native/ReactCommon/react/cxxstableapi/FrameworksGuard.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,25 @@
// #include <react/cxxstableapi/FrameworksGuard.h>
//
// "For frameworks" headers are APIs intended for framework authors integrating
// React Native, not for ordinary app code. Including one directly emits a
// SUPPRESSIBLE warning under enforcement. A framework author acknowledges the
// usage by defining `RN_ALLOW_FRAMEWORKS`, which silences the warning.
// React Native, not for ordinary app code. Including one, directly or
// transitively, emits a SUPPRESSIBLE warning under enforcement. A framework
// author acknowledges the usage by defining `RN_ALLOW_FRAMEWORKS`, which
// silences the warning. Module umbrellas never re-export these headers, so
// `RN_UMBRELLA_CONTEXT` does not suppress the warning: a public header that
// includes a for-frameworks header leaks it, and is reported.
//
// See <react/cxxstableapi/UmbrellaGuard.h> for the full `RN_*` macro contract.
// In short:
// RN_STRICT_API Consumer opt-in master switch; the guard is inert
// without it.
// RN_ALLOW_FRAMEWORKS Consumer opt-out acknowledging framework-tier usage.
// RN_UMBRELLA_CONTEXT Internal marker set by an umbrella around its includes.
// RN_BUILDING Set by React Native's own build.
//
// This header is intentionally NOT `#pragma once`-guarded: it must be
// re-evaluated on every inclusion so each direct include is checked.
// re-evaluated on every inclusion so each include is checked.
// =============================================================================

#if defined(RN_STRICT_API) && !defined(RN_ALLOW_FRAMEWORKS) && !defined(RN_UMBRELLA_CONTEXT) && !defined(RN_BUILDING)
#if defined(RN_STRICT_API) && !defined(RN_ALLOW_FRAMEWORKS) && !defined(RN_BUILDING)
#warning \
"This is a 'for frameworks' React Native API, intended for framework authors rather than app code. Include it via the module umbrella <React/<Module>.h>, or define RN_ALLOW_FRAMEWORKS to acknowledge framework-tier usage and silence this warning."
"This is a 'for frameworks' React Native API, intended for framework authors rather than app code. Define RN_ALLOW_FRAMEWORKS to acknowledge framework-tier usage and silence this warning."
#endif
Loading