Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Commit bad568f

Browse files
Allow GTK style enum naming (#56731)
Remove the linting overrides for enum names and set this in the clang-format file.
1 parent 69c3255 commit bad568f

24 files changed

+72
-89
lines changed

shell/platform/linux/.clang-tidy

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,9 @@ InheritParentConfig: true
33
# EnumCastOutOfRange warns about some common usages of GTK macros
44
Checks: >-
55
-clang-analyzer-optin.core.EnumCastOutOfRange
6+
7+
CheckOptions:
8+
- key: readability-identifier-naming.EnumConstantCase
9+
value: "UPPER_CASE"
10+
- key: readability-identifier-naming.EnumConstantPrefix
11+
value: ""

shell/platform/linux/fl_accessible_node.cc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ struct FlAccessibleNodePrivate {
8181
FlutterSemanticsFlag flags;
8282
};
8383

84-
enum { kProp0, kPropEngine, kPropId, kPropLast };
84+
enum { PROP_0, PROP_ENGINE, PROP_ID, PROP_LAST };
8585

8686
#define FL_ACCESSIBLE_NODE_GET_PRIVATE(node) \
8787
((FlAccessibleNodePrivate*)fl_accessible_node_get_instance_private( \
@@ -145,13 +145,13 @@ static void fl_accessible_node_set_property(GObject* object,
145145
GParamSpec* pspec) {
146146
FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(object);
147147
switch (prop_id) {
148-
case kPropEngine:
148+
case PROP_ENGINE:
149149
g_assert(priv->engine == nullptr);
150150
priv->engine = FL_ENGINE(g_value_get_object(value));
151151
g_object_add_weak_pointer(object,
152152
reinterpret_cast<gpointer*>(&priv->engine));
153153
break;
154-
case kPropId:
154+
case PROP_ID:
155155
priv->id = g_value_get_int(value);
156156
break;
157157
default:
@@ -448,13 +448,13 @@ static void fl_accessible_node_class_init(FlAccessibleNodeClass* klass) {
448448
fl_accessible_node_perform_action_impl;
449449

450450
g_object_class_install_property(
451-
G_OBJECT_CLASS(klass), kPropEngine,
451+
G_OBJECT_CLASS(klass), PROP_ENGINE,
452452
g_param_spec_object(
453453
"engine", "engine", "Flutter engine", fl_engine_get_type(),
454454
static_cast<GParamFlags>(G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY |
455455
G_PARAM_STATIC_STRINGS)));
456456
g_object_class_install_property(
457-
G_OBJECT_CLASS(klass), kPropId,
457+
G_OBJECT_CLASS(klass), PROP_ID,
458458
g_param_spec_int(
459459
"id", "id", "Accessibility node ID", 0, G_MAXINT, 0,
460460
static_cast<GParamFlags>(G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY |

shell/platform/linux/fl_application.cc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ struct FlApplicationPrivate {
2222
((FlApplicationPrivate*)fl_application_get_instance_private( \
2323
FL_APPLICATION(app)))
2424

25-
enum { kSignalRegisterPlugins, kSignalCreateWindow, kSignalLastSignal };
25+
enum { SIGNAL_REGISTER_PLUGINS, SIGNAL_CREATE_WINDOW, LAST_SIGNAL };
2626

27-
static guint fl_application_signals[kSignalLastSignal];
27+
static guint fl_application_signals[LAST_SIGNAL];
2828

2929
G_DEFINE_TYPE_WITH_CODE(FlApplication,
3030
fl_application,
@@ -95,14 +95,14 @@ static void fl_application_activate(GApplication* application) {
9595
gtk_widget_show(GTK_WIDGET(view));
9696

9797
GtkWindow* window;
98-
g_signal_emit(self, fl_application_signals[kSignalCreateWindow], 0, view,
98+
g_signal_emit(self, fl_application_signals[SIGNAL_CREATE_WINDOW], 0, view,
9999
&window);
100100

101101
// Make the resources for the view so rendering can start.
102102
// We'll show the view when we have the first frame.
103103
gtk_widget_realize(GTK_WIDGET(view));
104104

105-
g_signal_emit(self, fl_application_signals[kSignalRegisterPlugins], 0,
105+
g_signal_emit(self, fl_application_signals[SIGNAL_REGISTER_PLUGINS], 0,
106106
FL_PLUGIN_REGISTRY(view));
107107
}
108108

@@ -150,11 +150,11 @@ static void fl_application_class_init(FlApplicationClass* klass) {
150150
klass->register_plugins = fl_application_register_plugins;
151151
klass->create_window = fl_application_create_window;
152152

153-
fl_application_signals[kSignalRegisterPlugins] = g_signal_new(
153+
fl_application_signals[SIGNAL_REGISTER_PLUGINS] = g_signal_new(
154154
"register-plugins", fl_application_get_type(), G_SIGNAL_RUN_LAST,
155155
G_STRUCT_OFFSET(FlApplicationClass, register_plugins), nullptr, nullptr,
156156
nullptr, G_TYPE_NONE, 1, fl_plugin_registry_get_type());
157-
fl_application_signals[kSignalCreateWindow] = g_signal_new(
157+
fl_application_signals[SIGNAL_CREATE_WINDOW] = g_signal_new(
158158
"create-window", fl_application_get_type(), G_SIGNAL_RUN_LAST,
159159
G_STRUCT_OFFSET(FlApplicationClass, create_window),
160160
g_signal_accumulator_first_wins, nullptr, nullptr, GTK_TYPE_WINDOW, 1,

shell/platform/linux/fl_engine.cc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,9 @@ G_DEFINE_QUARK(fl_engine_error_quark, fl_engine_error)
9292
static void fl_engine_plugin_registry_iface_init(
9393
FlPluginRegistryInterface* iface);
9494

95-
enum { kSignalOnPreEngineRestart, kSignalLastSignal };
95+
enum { SIGNAL_ON_PRE_ENGINE_RESTART, LAST_SIGNAL };
9696

97-
static guint fl_engine_signals[kSignalLastSignal];
97+
static guint fl_engine_signals[LAST_SIGNAL];
9898

9999
G_DEFINE_TYPE_WITH_CODE(
100100
FlEngine,
@@ -103,7 +103,7 @@ G_DEFINE_TYPE_WITH_CODE(
103103
G_IMPLEMENT_INTERFACE(fl_plugin_registry_get_type(),
104104
fl_engine_plugin_registry_iface_init))
105105

106-
enum { kProp0, kPropBinaryMessenger, kPropLast };
106+
enum { PROP_0, PROP_BINARY_MESSENGER, PROP_LAST };
107107

108108
// Parse a locale into its components.
109109
static void parse_locale(const gchar* locale,
@@ -386,7 +386,7 @@ static void fl_engine_update_semantics_cb(const FlutterSemanticsUpdate2* update,
386386
static void fl_engine_on_pre_engine_restart_cb(void* user_data) {
387387
FlEngine* self = FL_ENGINE(user_data);
388388

389-
g_signal_emit(self, fl_engine_signals[kSignalOnPreEngineRestart], 0);
389+
g_signal_emit(self, fl_engine_signals[SIGNAL_ON_PRE_ENGINE_RESTART], 0);
390390
}
391391

392392
// Called when a response to a sent platform message is received from the
@@ -420,7 +420,7 @@ static void fl_engine_set_property(GObject* object,
420420
GParamSpec* pspec) {
421421
FlEngine* self = FL_ENGINE(object);
422422
switch (prop_id) {
423-
case kPropBinaryMessenger:
423+
case PROP_BINARY_MESSENGER:
424424
g_set_object(&self->binary_messenger,
425425
FL_BINARY_MESSENGER(g_value_get_object(value)));
426426
break;
@@ -477,14 +477,14 @@ static void fl_engine_class_init(FlEngineClass* klass) {
477477
G_OBJECT_CLASS(klass)->set_property = fl_engine_set_property;
478478

479479
g_object_class_install_property(
480-
G_OBJECT_CLASS(klass), kPropBinaryMessenger,
480+
G_OBJECT_CLASS(klass), PROP_BINARY_MESSENGER,
481481
g_param_spec_object(
482482
"binary-messenger", "messenger", "Binary messenger",
483483
fl_binary_messenger_get_type(),
484484
static_cast<GParamFlags>(G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY |
485485
G_PARAM_STATIC_STRINGS)));
486486

487-
fl_engine_signals[kSignalOnPreEngineRestart] = g_signal_new(
487+
fl_engine_signals[SIGNAL_ON_PRE_ENGINE_RESTART] = g_signal_new(
488488
"on-pre-engine-restart", fl_engine_get_type(), G_SIGNAL_RUN_LAST, 0,
489489
nullptr, nullptr, nullptr, G_TYPE_NONE, 0);
490490
}

shell/platform/linux/fl_engine_private.h

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,7 @@ G_BEGIN_DECLS
2222
*/
2323

2424
typedef enum {
25-
// NOLINTBEGIN(readability-identifier-naming)
2625
FL_ENGINE_ERROR_FAILED,
27-
// NOLINTEND(readability-identifier-naming)
2826
} FlEngineError;
2927

3028
GQuark fl_engine_error_quark(void) G_GNUC_CONST;

shell/platform/linux/fl_gnome_settings.cc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ struct _FlGnomeSettings {
2222
GSettings* interface_settings;
2323
};
2424

25-
enum { kProp0, kPropInterfaceSettings, kPropLast };
25+
enum { PROP_0, PROP_INTERFACE_SETTINGS, PROP_LAST };
2626

2727
static void fl_gnome_settings_iface_init(FlSettingsInterface* iface);
2828

@@ -106,7 +106,7 @@ static void fl_gnome_settings_set_property(GObject* object,
106106
GParamSpec* pspec) {
107107
FlGnomeSettings* self = FL_GNOME_SETTINGS(object);
108108
switch (prop_id) {
109-
case kPropInterfaceSettings:
109+
case PROP_INTERFACE_SETTINGS:
110110
fl_gnome_settings_set_interface_settings(
111111
self, G_SETTINGS(g_value_get_object(value)));
112112
break;
@@ -130,7 +130,7 @@ static void fl_gnome_settings_class_init(FlGnomeSettingsClass* klass) {
130130
object_class->set_property = fl_gnome_settings_set_property;
131131

132132
g_object_class_install_property(
133-
object_class, kPropInterfaceSettings,
133+
object_class, PROP_INTERFACE_SETTINGS,
134134
g_param_spec_object(
135135
kInterfaceSettings, kInterfaceSettings, kDesktopInterfaceSchema,
136136
g_settings_get_type(),

shell/platform/linux/fl_key_embedder_responder.cc

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -125,9 +125,9 @@ static FlKeyEmbedderUserData* fl_key_embedder_user_data_new(
125125
namespace {
126126

127127
typedef enum {
128-
kStateLogicUndecided,
129-
kStateLogicNormal,
130-
kStateLogicReversed,
128+
STATE_LOGIC_INFERRENCE_UNDECIDED,
129+
STATE_LOGIC_INFERRENCE_NORMAL,
130+
STATE_LOGIC_INFERRENCE_REVERSED,
131131
} StateLogicInferrence;
132132

133133
}
@@ -246,7 +246,7 @@ FlKeyEmbedderResponder* fl_key_embedder_responder_new(
246246
self->pressing_records = g_hash_table_new(g_direct_hash, g_direct_equal);
247247
self->mapping_records = g_hash_table_new(g_direct_hash, g_direct_equal);
248248
self->lock_records = 0;
249-
self->caps_lock_state_logic_inferrence = kStateLogicUndecided;
249+
self->caps_lock_state_logic_inferrence = STATE_LOGIC_INFERRENCE_UNDECIDED;
250250

251251
self->modifier_bit_to_checked_keys =
252252
g_hash_table_new_full(g_direct_hash, g_direct_equal, NULL, g_free);
@@ -557,7 +557,8 @@ static void update_caps_lock_state_logic_inferrence(
557557
bool is_down_event,
558558
bool enabled_by_state,
559559
int stage_by_record) {
560-
if (self->caps_lock_state_logic_inferrence != kStateLogicUndecided) {
560+
if (self->caps_lock_state_logic_inferrence !=
561+
STATE_LOGIC_INFERRENCE_UNDECIDED) {
561562
return;
562563
}
563564
if (!is_down_event) {
@@ -567,9 +568,9 @@ static void update_caps_lock_state_logic_inferrence(
567568
stage_by_record, is_down_event, enabled_by_state, false);
568569
if ((stage_by_event == 0 && stage_by_record == 2) ||
569570
(stage_by_event == 2 && stage_by_record == 0)) {
570-
self->caps_lock_state_logic_inferrence = kStateLogicReversed;
571+
self->caps_lock_state_logic_inferrence = STATE_LOGIC_INFERRENCE_REVERSED;
571572
} else {
572-
self->caps_lock_state_logic_inferrence = kStateLogicNormal;
573+
self->caps_lock_state_logic_inferrence = STATE_LOGIC_INFERRENCE_NORMAL;
573574
}
574575
}
575576

@@ -639,11 +640,11 @@ static void synchronize_lock_states_loop_body(gpointer key,
639640
update_caps_lock_state_logic_inferrence(self, context->is_down,
640641
enabled_by_state, stage_by_record);
641642
g_return_if_fail(self->caps_lock_state_logic_inferrence !=
642-
kStateLogicUndecided);
643+
STATE_LOGIC_INFERRENCE_UNDECIDED);
643644
}
644645
const bool reverse_state_logic =
645646
checked_key->is_caps_lock &&
646-
self->caps_lock_state_logic_inferrence == kStateLogicReversed;
647+
self->caps_lock_state_logic_inferrence == STATE_LOGIC_INFERRENCE_REVERSED;
647648
const int stage_by_event =
648649
this_key_is_event_key
649650
? find_stage_by_self_event(stage_by_record, context->is_down,

shell/platform/linux/fl_keyboard_manager_test.cc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@
2525
// stacktrace wouldn't print where the function is called in the unit tests.
2626

2727
#define EXPECT_KEY_EVENT(RECORD, TYPE, PHYSICAL, LOGICAL, CHAR, SYNTHESIZED) \
28-
EXPECT_EQ((RECORD).type, CallRecord::kKeyCallEmbedder); \
28+
EXPECT_EQ((RECORD).type, CallRecord::KEY_CALL_EMBEDDER); \
2929
EXPECT_EQ((RECORD).event->type, (TYPE)); \
3030
EXPECT_EQ((RECORD).event->physical, (PHYSICAL)); \
3131
EXPECT_EQ((RECORD).event->logical, (LOGICAL)); \
3232
EXPECT_STREQ((RECORD).event->character, (CHAR)); \
3333
EXPECT_EQ((RECORD).event->synthesized, (SYNTHESIZED));
3434

3535
#define VERIFY_DOWN(OUT_LOGICAL, OUT_CHAR) \
36-
EXPECT_EQ(call_records[0].type, CallRecord::kKeyCallEmbedder); \
36+
EXPECT_EQ(call_records[0].type, CallRecord::KEY_CALL_EMBEDDER); \
3737
EXPECT_EQ(call_records[0].event->type, kFlutterKeyEventTypeDown); \
3838
EXPECT_EQ(call_records[0].event->logical, (OUT_LOGICAL)); \
3939
EXPECT_STREQ(call_records[0].event->character, (OUT_CHAR)); \
@@ -78,8 +78,8 @@ typedef std::function<void(FlKeyEvent*)> RedispatchHandler;
7878
// An instance of `CallRecord` might not have all the fields filled.
7979
typedef struct {
8080
enum {
81-
kKeyCallEmbedder,
82-
kKeyCallChannel,
81+
KEY_CALL_EMBEDDER,
82+
KEY_CALL_CHANNEL,
8383
} type;
8484

8585
AsyncKeyCallback callback;
@@ -436,7 +436,7 @@ class KeyboardTester {
436436
char* new_event_character = cloneString(event->character);
437437
new_event->character = new_event_character;
438438
storage.push_back(CallRecord{
439-
.type = CallRecord::kKeyCallEmbedder,
439+
.type = CallRecord::KEY_CALL_EMBEDDER,
440440
.callback = std::move(callback),
441441
.event = std::move(new_event),
442442
.event_character = std::unique_ptr<char[]>(new_event_character),
@@ -455,7 +455,7 @@ class KeyboardTester {
455455
char* new_event_character = cloneString(event->character);
456456
new_event->character = new_event_character;
457457
storage.push_back(CallRecord{
458-
.type = CallRecord::kKeyCallEmbedder,
458+
.type = CallRecord::KEY_CALL_EMBEDDER,
459459
.event = std::move(new_event),
460460
.event_character = std::unique_ptr<char[]>(new_event_character),
461461
});
@@ -476,7 +476,7 @@ class KeyboardTester {
476476
messenger_, [&storage, this](AsyncKeyCallback callback) {
477477
EXPECT_FALSE(during_redispatch_);
478478
storage.push_back(CallRecord{
479-
.type = CallRecord::kKeyCallChannel,
479+
.type = CallRecord::KEY_CALL_CHANNEL,
480480
.callback = std::move(callback),
481481
});
482482
});
@@ -703,8 +703,8 @@ TEST(FlKeyboardManagerTest, WithTwoAsyncDelegates) {
703703
EXPECT_EQ(redispatched->len, 0u);
704704
EXPECT_EQ(call_records.size(), 2u);
705705

706-
EXPECT_EQ(call_records[0].type, CallRecord::kKeyCallEmbedder);
707-
EXPECT_EQ(call_records[1].type, CallRecord::kKeyCallChannel);
706+
EXPECT_EQ(call_records[0].type, CallRecord::KEY_CALL_EMBEDDER);
707+
EXPECT_EQ(call_records[1].type, CallRecord::KEY_CALL_CHANNEL);
708708

709709
call_records[0].callback(true);
710710
call_records[1].callback(false);
@@ -723,8 +723,8 @@ TEST(FlKeyboardManagerTest, WithTwoAsyncDelegates) {
723723
EXPECT_EQ(redispatched->len, 0u);
724724
EXPECT_EQ(call_records.size(), 2u);
725725

726-
EXPECT_EQ(call_records[0].type, CallRecord::kKeyCallEmbedder);
727-
EXPECT_EQ(call_records[1].type, CallRecord::kKeyCallChannel);
726+
EXPECT_EQ(call_records[0].type, CallRecord::KEY_CALL_EMBEDDER);
727+
EXPECT_EQ(call_records[1].type, CallRecord::KEY_CALL_CHANNEL);
728728

729729
call_records[0].callback(false);
730730
call_records[1].callback(false);

shell/platform/linux/fl_mouse_cursor_handler.cc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ struct _FlMouseCursorHandler {
2121
gchar* cursor_name;
2222
};
2323

24-
enum { kSignalCursorChanged, kSignalLastSignal };
24+
enum { SIGNAL_CURSOR_CHANGED, LAST_SIGNAL };
2525

26-
static guint fl_mouse_cursor_handler_signals[kSignalLastSignal];
26+
static guint fl_mouse_cursor_handler_signals[LAST_SIGNAL];
2727

2828
G_DEFINE_TYPE(FlMouseCursorHandler, fl_mouse_cursor_handler, G_TYPE_OBJECT)
2929

@@ -100,7 +100,8 @@ static void activate_system_cursor(const gchar* kind, gpointer user_data) {
100100
g_free(self->cursor_name);
101101
self->cursor_name = g_strdup(cursor_name);
102102

103-
g_signal_emit(self, fl_mouse_cursor_handler_signals[kSignalCursorChanged], 0);
103+
g_signal_emit(self, fl_mouse_cursor_handler_signals[SIGNAL_CURSOR_CHANGED],
104+
0);
104105
}
105106

106107
static void fl_mouse_cursor_handler_dispose(GObject* object) {
@@ -117,7 +118,7 @@ static void fl_mouse_cursor_handler_class_init(
117118
FlMouseCursorHandlerClass* klass) {
118119
G_OBJECT_CLASS(klass)->dispose = fl_mouse_cursor_handler_dispose;
119120

120-
fl_mouse_cursor_handler_signals[kSignalCursorChanged] =
121+
fl_mouse_cursor_handler_signals[SIGNAL_CURSOR_CHANGED] =
121122
g_signal_new("cursor-changed", fl_mouse_cursor_handler_get_type(),
122123
G_SIGNAL_RUN_LAST, 0, NULL, NULL, NULL, G_TYPE_NONE, 0);
123124
}

shell/platform/linux/fl_platform_channel.h

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,13 @@
1111
G_BEGIN_DECLS
1212

1313
typedef enum {
14-
// NOLINTBEGIN(readability-identifier-naming)
1514
FL_PLATFORM_CHANNEL_EXIT_TYPE_CANCELABLE,
1615
FL_PLATFORM_CHANNEL_EXIT_TYPE_REQUIRED,
17-
// NOLINTEND(readability-identifier-naming)
1816
} FlPlatformChannelExitType;
1917

2018
typedef enum {
21-
// NOLINTBEGIN(readability-identifier-naming)
2219
FL_PLATFORM_CHANNEL_EXIT_RESPONSE_CANCEL,
2320
FL_PLATFORM_CHANNEL_EXIT_RESPONSE_EXIT,
24-
// NOLINTEND(readability-identifier-naming)
2521
} FlPlatformChannelExitResponse;
2622

2723
G_DECLARE_FINAL_TYPE(FlPlatformChannel,

0 commit comments

Comments
 (0)