archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity

Cleanup: Use enum for return values in context callbacks

Browse Source 
Define enum `eContextResult` and use its values for returns, instead of
just returning 1, 0, or -1 (and always having some comment that explains
what -1 means).

This also cleans up the mixup between returning `0` and `false`, and `1`
and `true`. An inconsistency was discovered during this cleanup, and
marked with `TODO(sybren)`. It's not fixed here, as it would consititute
a functional change.

The enum isn't used everywhere, as enums in C and C++ can have different
storage sizes. To prevent issues, callback functions are still declared
as returning`int`. To at least make things easier to understand for
humans, I marked those with `int /*eContextResult*/`.

This is a followup of D9090, and is intended to unify how context
callbacks return values. This will make it easier to extend the approach
in D9090 to those functions.

No functional changes.

Differential Revision: https://developer.blender.org/D9095
This commit is contained in:
Sybren A. Stüvel
2020-10-02 18:56:25 +02:00
parent 0db98b214d
commit 90a27d5aa9
12 changed files with 267 additions and 229 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
source/blender/editors/space_node/space_node.c
View File

@@ -776,14 +776,15 @@ static void node_region_listener(wmWindow *UNUSED(win),
const char *node_context_dir[] = {
"selected_nodes", "active_node", "light", "material", "world", NULL};
static int node_context(const bContext *C, const char *member, bContextDataResult *result)
static int /*eContextResult*/ node_context(const bContext *C,
const char *member,
bContextDataResult *result)
{
SpaceNode *snode = CTX_wm_space_node(C);
if (CTX_data_dir(member)) {
CTX_data_dir_set(result, node_context_dir);
return 1;
return CTX_RESULT_OK;
}
if (CTX_data_equals(member, "selected_nodes")) {
bNode *node;
@@ -796,7 +797,7 @@ static int node_context(const bContext *C, const char *member, bContextDataResul
}
}
CTX_data_type_set(result, CTX_DATA_TYPE_COLLECTION);
return 1;
return CTX_RESULT_OK;
}
if (CTX_data_equals(member, "active_node")) {
if (snode->edittree) {
@@ -805,7 +806,7 @@ static int node_context(const bContext *C, const char *member, bContextDataResul
}
CTX_data_type_set(result, CTX_DATA_TYPE_POINTER);
return 1;
return CTX_RESULT_OK;
}
if (CTX_data_equals(member, "node_previews")) {
if (snode->nodetree) {
@@ -814,28 +815,28 @@ static int node_context(const bContext *C, const char *member, bContextDataResul
}
CTX_data_type_set(result, CTX_DATA_TYPE_POINTER);
return 1;
return CTX_RESULT_OK;
}
if (CTX_data_equals(member, "material")) {
if (snode->id && GS(snode->id->name) == ID_MA) {
CTX_data_id_pointer_set(result, snode->id);
}
return 1;
return CTX_RESULT_OK;
}
if (CTX_data_equals(member, "light")) {
if (snode->id && GS(snode->id->name) == ID_LA) {
CTX_data_id_pointer_set(result, snode->id);
}
return 1;
return CTX_RESULT_OK;
}
if (CTX_data_equals(member, "world")) {
if (snode->id && GS(snode->id->name) == ID_WO) {
CTX_data_id_pointer_set(result, snode->id);
}
return 1;
return CTX_RESULT_OK;
}
return 0;
return CTX_RESULT_MEMBER_NOT_FOUND;
}
static void node_widgets(void)