Commits on Feb 22, 2023

1. Unify string parameters across the repo …

   The types of string parameters across the repo has been regularized
   according to the following rules that shall be followed from now on:
   
   - Methods during the init/registration process should take `&str` for
     things like identifiers. They may specify explicit lifetimes in their
     types if necessary, but *not* `'static`.
   - Manually written methods that abstract over, or mimic API methods should
     take `impl Into<GodotString>` or `impl Into<NodePath>` depending on the
     usage, to be consistent with their generated counterparts.
   
   Regarding the usage of `&str` in init instead of more specific conversions
   required by each method:
   
   The GDNative API isn't very consistent when it comes to the string types
   it wants during init. Sometimes, functions may want different types of
   strings even when they are concepturally similar, like for signal and
   method registration. This gets more complicated when we add our own
   library-side logic into the mix, like for the `InitHandle::add_class`
   family, where allocation is current inevitable even when they are given
   `&'static str`s.
   
   It still makes sense to avoid excessive allocation, but that should not
   get in the way of future development. `'static` in particular is
   extremely limiting, and there are very few cases of its usage throughout
   the library's history that we have not since regretted. It shouldn't be
   the norm but the rare exception.
   
   In any case, class registration is something that only run once in the
   lifecycle of a game, and for the amount of classes most people are using
   with `gdnative`, we can afford to be slightly inefficient with strings
   to make our APIs more consistent, less leaky, and easier to stablize and
   maintain.

   

   chitoyuu committed Feb 22, 2023
   Configuration menu

   • View commit details
   • Copy full SHA for 6f58d75
   • Browse repository at this point

   Copy the full SHA

   6f58d75 View commit details

   Browse the repository at this point in the history