Fix comment in gdextension_interface.h

[touilleMan]

GDExtensionInterfaceGetGodotVersion *get_godot_version = (GDExtensionInterfaceGetGodotVersion)p_get_proc_address("get_godot_version");

The comment incorrectly defines a pointer type (note the cast on the right side of the equal is correct !)

This is misleading for the unsuspecting end-user, which is tempted to "solve" this by doing a de-reference... hence leading to a segfault 😞

[touilleMan]

On top of that, I wonder if it wouldn't be better to also add an intermediary void* cast:

GDExtensionInterfaceGetGodotVersion get_godot_version = (GDExtensionInterfaceGetGodotVersion)(void*)p_get_proc_address("get_godot_version");

This is useful for some functions to avoid -Wcast-function-type errors, for instance when doing p_get_proc_address("variant_get_ptr_constructor"):

warning: cast between incompatible function types from ‘GDExtensionInterfaceFunctionPtr’ {aka ‘void (*)()’} to ‘void (* (*)(GDExtensionVariantType,  int32_t))(void *, const void * const*)’ {aka ‘void (* (*)(GDExtensionVariantType,  int))(void *, const void * const*)’} [-Wcast-function-type]

what do you think ?

[dsnopek]

Thanks! Looks good to me

(Sorry, this was probably my mistake :-))

[dsnopek]

On top of that, I wonder if it wouldn't be better to also add an intermediary void* cast

Hm, I guess so. However, I don't want to end up getting too deep into details, so it doesn't distract from what we're trying to show.

[touilleMan]

@dsnopek I've updated the PR to add the void* cast

I think it's better to have the user wonder why the void* is for then remove it and see the error, than to have him scratch his head on how to avoid this -Wcast-function-type (especially given this error has different form depending on gcc/clang/msvc)

[Bromeon]

I think it's better to have the user wonder why the void* is for then remove it and see the error, than to have him scratch his head on how to avoid this -Wcast-function-type (especially given this error has different form depending on gcc/clang/msvc)

I don't know, you trade one obscurity for another. Now the user wonders why there is an intermediate void* cast.

This is also rather compiler-specific; furthermore C++ code would likely use reinterpret_cast. I would probably omit the void* cast but add a a paragraph that mentions this workaround in case of warnings. That way, it's at least explained 🙂

[touilleMan]

@Bromeon I've udpated the PR to replace the cast in the snippet by a small explanation as you suggested