Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add optional count argument to Semaphore::post #93605

Merged
merged 1 commit into from
Aug 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions core/core_bind.compat.inc
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/**************************************************************************/
/* core_bind.compat.inc */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/

#ifndef DISABLE_DEPRECATED

namespace core_bind {

void Semaphore::_post_bind_compat_93605() {
post(1);
}

void Semaphore::_bind_compatibility_methods() {
ClassDB::bind_compatibility_method(D_METHOD("post"), &Semaphore::_post_bind_compat_93605);
}

}; // namespace core_bind
RadiantUwU marked this conversation as resolved.
Show resolved Hide resolved

#endif
8 changes: 5 additions & 3 deletions core/core_bind.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
/**************************************************************************/

#include "core_bind.h"
RadiantUwU marked this conversation as resolved.
Show resolved Hide resolved
#include "core_bind.compat.inc"
RadiantUwU marked this conversation as resolved.
Show resolved Hide resolved

#include "core/config/project_settings.h"
#include "core/crypto/crypto_core.h"
Expand Down Expand Up @@ -1210,14 +1211,15 @@ bool Semaphore::try_wait() {
return semaphore.try_wait();
}

void Semaphore::post() {
semaphore.post();
void Semaphore::post(int p_count) {
ERR_FAIL_COND(p_count <= 0);
semaphore.post(p_count);
}

void Semaphore::_bind_methods() {
ClassDB::bind_method(D_METHOD("wait"), &Semaphore::wait);
ClassDB::bind_method(D_METHOD("try_wait"), &Semaphore::try_wait);
ClassDB::bind_method(D_METHOD("post"), &Semaphore::post);
ClassDB::bind_method(D_METHOD("post", "count"), &Semaphore::post, DEFVAL(1));
}

////// Mutex //////
Expand Down
7 changes: 6 additions & 1 deletion core/core_bind.h
Original file line number Diff line number Diff line change
Expand Up @@ -390,12 +390,17 @@ class Semaphore : public RefCounted {
GDCLASS(Semaphore, RefCounted);
::Semaphore semaphore;

protected:
static void _bind_methods();
#ifndef DISABLE_DEPRECATED
void _post_bind_compat_93605();
RadiantUwU marked this conversation as resolved.
Show resolved Hide resolved
static void _bind_compatibility_methods();
RadiantUwU marked this conversation as resolved.
Show resolved Hide resolved
#endif // DISABLE_DEPRECATED

public:
void wait();
bool try_wait();
void post();
void post(int p_count = 1);
};

class Thread : public RefCounted {
Expand Down
3 changes: 2 additions & 1 deletion doc/classes/Semaphore.xml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@
<methods>
<method name="post">
<return type="void" />
<param index="0" name="count" type="int" default="1" />
<description>
Lowers the [Semaphore], allowing one more thread in.
Lowers the [Semaphore], allowing one thread in, or more if [param count] is specified.
</description>
</method>
<method name="try_wait">
Expand Down
7 changes: 7 additions & 0 deletions misc/extension_api_validation/4.3-stable.expected
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,10 @@ Validate extension JSON: Error: Field 'classes/VisualShaderNodeTexture2DArray/pr

Allow setting a cubemap as default parameter to shader.
Compatibility methods registered.


GH-93605
--------
Validate extension JSON: JSON file: Field was added in a way that breaks compatibility 'classes/Semaphore/methods/post': arguments

Optional arguments added. Compatibility methods registered.
Loading