Stowage/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-10-19 16:03:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #110932 from Ivorforce/string-buffer-size-comment

Browse source 
Add comments to `String::size` to lead people to `length()` and explain the difference.
This commit is contained in:
Thaddeus Crews 2025-10-06 09:06:40 -05:00
commit d8df20a2e6
No known key found for this signature in database
GPG key ID: 8C6E5FEB5FC03CCC
1 changed files with 6 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
core/string/ustring.h
View file

@ -180,7 +180,10 @@ public:
_FORCE_INLINE_ const T *ptr() const { return _cowdata.ptr(); } _FORCE_INLINE_ const T *ptr() const { return _cowdata.ptr(); }
_FORCE_INLINE_ const T *get_data() const { return size() ? ptr() : &_null; } _FORCE_INLINE_ const T *get_data() const { return size() ? ptr() : &_null; }
// Returns the number of characters in the buffer, including the terminating NUL character.
// In most cases, length() should be used instead.
_FORCE_INLINE_ int size() const { return _cowdata.size(); } _FORCE_INLINE_ int size() const { return _cowdata.size(); }
// Returns the number of characters in the string (excluding terminating NUL character).
_FORCE_INLINE_ int length() const { return size() ? size() - 1 : 0; } _FORCE_INLINE_ int length() const { return size() ? size() - 1 : 0; }
_FORCE_INLINE_ bool is_empty() const { return length() == 0; } _FORCE_INLINE_ bool is_empty() const { return length() == 0; }
@ -302,7 +305,10 @@ public:
_FORCE_INLINE_ const char32_t *ptr() const { return _cowdata.ptr(); } _FORCE_INLINE_ const char32_t *ptr() const { return _cowdata.ptr(); }
_FORCE_INLINE_ const char32_t *get_data() const { return size() ? ptr() : &_null; } _FORCE_INLINE_ const char32_t *get_data() const { return size() ? ptr() : &_null; }
// Returns the number of characters in the buffer, including the terminating NUL character.
// In most cases, length() should be used instead.
_FORCE_INLINE_ int size() const { return _cowdata.size(); } _FORCE_INLINE_ int size() const { return _cowdata.size(); }
// Returns the number of characters in the string (excluding terminating NUL character).
_FORCE_INLINE_ int length() const { return size() ? size() - 1 : 0; } _FORCE_INLINE_ int length() const { return size() ? size() - 1 : 0; }
_FORCE_INLINE_ bool is_empty() const { return length() == 0; } _FORCE_INLINE_ bool is_empty() const { return length() == 0; }