Skip to content

Commit b558298

Browse files
stuartmorgan-gstuartmorgan-g
authored
Rename Registrar to PluginRegistrar in Win/GLFW C API (flutter#21058)
1 parent e4f84f1 commit b558298

14 files changed

+43
-39
lines changed

‎shell/platform/common/cpp/client_wrapper/include/flutter/plugin_registrar.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ class PluginRegistrarManager {
9191
auto insert_result =
9292
registrars_.emplace(registrar_ref, std::make_unique<T>(registrar_ref));
9393
auto& registrar_pair = *(insert_result.first);
94-
FlutterDesktopRegistrarSetDestructionHandler(registrar_pair.first,
95-
OnRegistrarDestroyed);
94+
FlutterDesktopPluginRegistrarSetDestructionHandler(registrar_pair.first,
95+
OnRegistrarDestroyed);
9696
return static_cast<T*>(registrar_pair.second.get());
9797
}
9898

‎shell/platform/common/cpp/client_wrapper/plugin_registrar.cc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ namespace flutter {
1717

1818
PluginRegistrar::PluginRegistrar(FlutterDesktopPluginRegistrarRef registrar)
1919
: registrar_(registrar) {
20-
auto core_messenger = FlutterDesktopRegistrarGetMessenger(registrar_);
20+
auto core_messenger = FlutterDesktopPluginRegistrarGetMessenger(registrar_);
2121
messenger_ = std::make_unique<BinaryMessengerImpl>(core_messenger);
2222
}
2323

‎shell/platform/common/cpp/client_wrapper/plugin_registrar_unittests.cc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,23 +39,24 @@ class TestApi : public testing::StubFlutterApi {
3939
last_message_callback_set_ = callback;
4040
}
4141

42-
void RegistrarSetDestructionHandler(
43-
FlutterDesktopOnRegistrarDestroyed callback) override {
42+
void PluginRegistrarSetDestructionHandler(
43+
FlutterDesktopOnPluginRegistrarDestroyed callback) override {
4444
last_destruction_callback_set_ = callback;
4545
}
4646

4747
const uint8_t* last_data_sent() { return last_data_sent_; }
4848
FlutterDesktopMessageCallback last_message_callback_set() {
4949
return last_message_callback_set_;
5050
}
51-
FlutterDesktopOnRegistrarDestroyed last_destruction_callback_set() {
51+
FlutterDesktopOnPluginRegistrarDestroyed last_destruction_callback_set() {
5252
return last_destruction_callback_set_;
5353
}
5454

5555
private:
5656
const uint8_t* last_data_sent_ = nullptr;
5757
FlutterDesktopMessageCallback last_message_callback_set_ = nullptr;
58-
FlutterDesktopOnRegistrarDestroyed last_destruction_callback_set_ = nullptr;
58+
FlutterDesktopOnPluginRegistrarDestroyed last_destruction_callback_set_ =
59+
nullptr;
5960
};
6061

6162
// A PluginRegistrar whose destruction can be watched for by tests.

‎shell/platform/common/cpp/client_wrapper/testing/stub_flutter_api.cc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,17 @@ ScopedStubFlutterApi::~ScopedStubFlutterApi() {
3838

3939
// Forwarding dummy implementations of the C API.
4040

41-
FlutterDesktopMessengerRef FlutterDesktopRegistrarGetMessenger(
41+
FlutterDesktopMessengerRef FlutterDesktopPluginRegistrarGetMessenger(
4242
FlutterDesktopPluginRegistrarRef registrar) {
4343
// The stub ignores this, so just return an arbitrary non-zero value.
4444
return reinterpret_cast<FlutterDesktopMessengerRef>(1);
4545
}
4646

47-
void FlutterDesktopRegistrarSetDestructionHandler(
47+
void FlutterDesktopPluginRegistrarSetDestructionHandler(
4848
FlutterDesktopPluginRegistrarRef registrar,
49-
FlutterDesktopOnRegistrarDestroyed callback) {
49+
FlutterDesktopOnPluginRegistrarDestroyed callback) {
5050
if (s_stub_implementation) {
51-
s_stub_implementation->RegistrarSetDestructionHandler(callback);
51+
s_stub_implementation->PluginRegistrarSetDestructionHandler(callback);
5252
}
5353
}
5454

‎shell/platform/common/cpp/client_wrapper/testing/stub_flutter_api.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ class StubFlutterApi {
3434

3535
virtual ~StubFlutterApi() {}
3636

37-
// Called for FlutterDesktopRegistrarSetDestructionHandler.
38-
virtual void RegistrarSetDestructionHandler(
39-
FlutterDesktopOnRegistrarDestroyed callback) {}
37+
// Called for FlutterDesktopPluginRegistrarSetDestructionHandler.
38+
virtual void PluginRegistrarSetDestructionHandler(
39+
FlutterDesktopOnPluginRegistrarDestroyed callback) {}
4040

4141
// Called for FlutterDesktopMessengerSend.
4242
virtual bool MessengerSend(const char* channel,

‎shell/platform/common/cpp/public/flutter_plugin_registrar.h

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,18 @@ extern "C" {
1919
typedef struct FlutterDesktopPluginRegistrar* FlutterDesktopPluginRegistrarRef;
2020

2121
// Function pointer type for registrar destruction callback.
22-
typedef void (*FlutterDesktopOnRegistrarDestroyed)(
22+
typedef void (*FlutterDesktopOnPluginRegistrarDestroyed)(
2323
FlutterDesktopPluginRegistrarRef);
2424

2525
// Returns the engine messenger associated with this registrar.
2626
FLUTTER_EXPORT FlutterDesktopMessengerRef
27-
FlutterDesktopRegistrarGetMessenger(FlutterDesktopPluginRegistrarRef registrar);
27+
FlutterDesktopPluginRegistrarGetMessenger(
28+
FlutterDesktopPluginRegistrarRef registrar);
2829

2930
// Registers a callback to be called when the plugin registrar is destroyed.
30-
FLUTTER_EXPORT void FlutterDesktopRegistrarSetDestructionHandler(
31+
FLUTTER_EXPORT void FlutterDesktopPluginRegistrarSetDestructionHandler(
3132
FlutterDesktopPluginRegistrarRef registrar,
32-
FlutterDesktopOnRegistrarDestroyed callback);
33+
FlutterDesktopOnPluginRegistrarDestroyed callback);
3334

3435
#if defined(__cplusplus)
3536
} // extern "C"

‎shell/platform/glfw/client_wrapper/include/flutter/plugin_registrar_glfw.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ class PluginRegistrarGlfw : public PluginRegistrar {
2323
explicit PluginRegistrarGlfw(FlutterDesktopPluginRegistrarRef core_registrar)
2424
: PluginRegistrar(core_registrar) {
2525
window_ = std::make_unique<FlutterWindow>(
26-
FlutterDesktopRegistrarGetWindow(core_registrar));
26+
FlutterDesktopPluginRegistrarGetWindow(core_registrar));
2727
}
2828

2929
virtual ~PluginRegistrarGlfw() = default;
@@ -39,7 +39,8 @@ class PluginRegistrarGlfw : public PluginRegistrar {
3939
// If set, then the parent window should disable input callbacks
4040
// while waiting for the handler for messages on that channel to run.
4141
void EnableInputBlockingForChannel(const std::string& channel) {
42-
FlutterDesktopRegistrarEnableInputBlocking(registrar(), channel.c_str());
42+
FlutterDesktopPluginRegistrarEnableInputBlocking(registrar(),
43+
channel.c_str());
4344
}
4445

4546
private:

‎shell/platform/glfw/client_wrapper/testing/stub_flutter_glfw_api.cc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,10 +183,10 @@ FlutterDesktopPluginRegistrarRef FlutterDesktopGetPluginRegistrar(
183183
return reinterpret_cast<FlutterDesktopPluginRegistrarRef>(2);
184184
}
185185

186-
void FlutterDesktopRegistrarEnableInputBlocking(
186+
void FlutterDesktopPluginRegistrarEnableInputBlocking(
187187
FlutterDesktopPluginRegistrarRef registrar,
188188
const char* channel) {
189189
if (s_stub_implementation) {
190-
s_stub_implementation->RegistrarEnableInputBlocking(channel);
190+
s_stub_implementation->PluginRegistrarEnableInputBlocking(channel);
191191
}
192192
}

‎shell/platform/glfw/client_wrapper/testing/stub_flutter_glfw_api.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ class StubFlutterGlfwApi {
8989
// Called for FlutterDesktopShutDownEngine.
9090
virtual bool ShutDownEngine() { return true; }
9191

92-
// Called for FlutterDesktopRegistrarEnableInputBlocking.
93-
virtual void RegistrarEnableInputBlocking(const char* channel) {}
92+
// Called for FlutterDesktopPluginRegistrarEnableInputBlocking.
93+
virtual void PluginRegistrarEnableInputBlocking(const char* channel) {}
9494
};
9595

9696
// A test helper that owns a stub implementation, making it the test stub for

‎shell/platform/glfw/flutter_glfw.cc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ struct FlutterDesktopPluginRegistrar {
138138
FlutterDesktopEngineState* engine;
139139

140140
// Callback to be called on registrar destruction.
141-
FlutterDesktopOnRegistrarDestroyed destruction_handler;
141+
FlutterDesktopOnPluginRegistrarDestroyed destruction_handler;
142142
};
143143

144144
// State associated with the messenger used to communicate with the engine.
@@ -963,24 +963,24 @@ bool FlutterDesktopShutDownEngine(FlutterDesktopEngineRef engine) {
963963
return (result == kSuccess);
964964
}
965965

966-
void FlutterDesktopRegistrarEnableInputBlocking(
966+
void FlutterDesktopPluginRegistrarEnableInputBlocking(
967967
FlutterDesktopPluginRegistrarRef registrar,
968968
const char* channel) {
969969
registrar->engine->message_dispatcher->EnableInputBlockingForChannel(channel);
970970
}
971971

972-
FlutterDesktopMessengerRef FlutterDesktopRegistrarGetMessenger(
972+
FlutterDesktopMessengerRef FlutterDesktopPluginRegistrarGetMessenger(
973973
FlutterDesktopPluginRegistrarRef registrar) {
974974
return registrar->engine->messenger.get();
975975
}
976976

977-
void FlutterDesktopRegistrarSetDestructionHandler(
977+
void FlutterDesktopPluginRegistrarSetDestructionHandler(
978978
FlutterDesktopPluginRegistrarRef registrar,
979-
FlutterDesktopOnRegistrarDestroyed callback) {
979+
FlutterDesktopOnPluginRegistrarDestroyed callback) {
980980
registrar->destruction_handler = callback;
981981
}
982982

983-
FlutterDesktopWindowRef FlutterDesktopRegistrarGetWindow(
983+
FlutterDesktopWindowRef FlutterDesktopPluginRegistrarGetWindow(
984984
FlutterDesktopPluginRegistrarRef registrar) {
985985
FlutterDesktopWindowControllerState* controller =
986986
registrar->engine->window_controller;

‎shell/platform/glfw/public/flutter_glfw.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -221,8 +221,8 @@ FLUTTER_EXPORT bool FlutterDesktopShutDownEngine(
221221
// Returns the window associated with this registrar's engine instance.
222222
//
223223
// This is a GLFW shell-specific extension to flutter_plugin_registrar.h
224-
FLUTTER_EXPORT FlutterDesktopWindowRef
225-
FlutterDesktopRegistrarGetWindow(FlutterDesktopPluginRegistrarRef registrar);
224+
FLUTTER_EXPORT FlutterDesktopWindowRef FlutterDesktopPluginRegistrarGetWindow(
225+
FlutterDesktopPluginRegistrarRef registrar);
226226

227227
// Enables input blocking on the given channel.
228228
//
@@ -235,7 +235,7 @@ FlutterDesktopRegistrarGetWindow(FlutterDesktopPluginRegistrarRef registrar);
235235
// default of disabled.
236236
//
237237
// This is a GLFW shell-specific extension to flutter_plugin_registrar.h
238-
FLUTTER_EXPORT void FlutterDesktopRegistrarEnableInputBlocking(
238+
FLUTTER_EXPORT void FlutterDesktopPluginRegistrarEnableInputBlocking(
239239
FlutterDesktopPluginRegistrarRef registrar,
240240
const char* channel);
241241

‎shell/platform/windows/flutter_windows.cc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -196,14 +196,14 @@ void FlutterDesktopResyncOutputStreams() {
196196

197197
// Implementations of common/cpp/ API methods.
198198

199-
FlutterDesktopMessengerRef FlutterDesktopRegistrarGetMessenger(
199+
FlutterDesktopMessengerRef FlutterDesktopPluginRegistrarGetMessenger(
200200
FlutterDesktopPluginRegistrarRef registrar) {
201201
return registrar->engine->messenger();
202202
}
203203

204-
void FlutterDesktopRegistrarSetDestructionHandler(
204+
void FlutterDesktopPluginRegistrarSetDestructionHandler(
205205
FlutterDesktopPluginRegistrarRef registrar,
206-
FlutterDesktopOnRegistrarDestroyed callback) {
206+
FlutterDesktopOnPluginRegistrarDestroyed callback) {
207207
registrar->engine->SetPluginRegistrarDestructionCallback(callback);
208208
}
209209

‎shell/platform/windows/flutter_windows_engine.cc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ FlutterDesktopPluginRegistrarRef FlutterWindowsEngine::GetRegistrar() {
217217
}
218218

219219
void FlutterWindowsEngine::SetPluginRegistrarDestructionCallback(
220-
FlutterDesktopOnRegistrarDestroyed callback) {
220+
FlutterDesktopOnPluginRegistrarDestroyed callback) {
221221
plugin_registrar_destruction_callback_ = callback;
222222
}
223223

‎shell/platform/windows/flutter_windows_engine.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ class FlutterWindowsEngine {
6363

6464
// Sets |callback| to be called when the plugin registrar is destroyed.
6565
void SetPluginRegistrarDestructionCallback(
66-
FlutterDesktopOnRegistrarDestroyed callback);
66+
FlutterDesktopOnPluginRegistrarDestroyed callback);
6767

6868
FLUTTER_API_SYMBOL(FlutterEngine) engine() { return engine_; }
6969

@@ -115,7 +115,8 @@ class FlutterWindowsEngine {
115115

116116
// A callback to be called when the engine (and thus the plugin registrar)
117117
// is being destroyed.
118-
FlutterDesktopOnRegistrarDestroyed plugin_registrar_destruction_callback_;
118+
FlutterDesktopOnPluginRegistrarDestroyed
119+
plugin_registrar_destruction_callback_;
119120

120121
// The manager for WindowProc delegate registration and callbacks.
121122
std::unique_ptr<Win32WindowProcDelegateManager> window_proc_delegate_manager_;

0 commit comments

Comments
 (0)