eden-emu/SDL
15
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-05-29 07:59:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Property query functions don't set an error if they return the default value

Browse source 
You can call SDL_HasProperty() if you want to check to see if a property exists.

Fixes https://github.com/libsdl-org/SDL/issues/9067
This commit is contained in:
Sam Lantinga 2024-02-17 07:59:04 -08:00
parent 202886f873
commit 8ce786d2b6
5 changed files with 30 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

24
include/SDL3/SDL_properties.h
View file

@ -248,6 +248,21 @@ extern DECLSPEC int SDLCALL SDL_SetFloatProperty(SDL_PropertiesID props, const c
*/ */
extern DECLSPEC int SDLCALL SDL_SetBooleanProperty(SDL_PropertiesID props, const char *name, SDL_bool value); extern DECLSPEC int SDLCALL SDL_SetBooleanProperty(SDL_PropertiesID props, const char *name, SDL_bool value);
/**
* Return whether a property exists in a set of properties.
*
* \param props the properties to query
* \param name the name of the property to query
* \returns SDL_TRUE if the property exists, or SDL_FALSE if it doesn't.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetPropertyType
*/
extern DECLSPEC SDL_bool SDLCALL SDL_HasProperty(SDL_PropertiesID props, const char *name);
/** /**
* Get the type of a property on a set of properties * Get the type of a property on a set of properties
* *
@ -259,6 +274,8 @@ extern DECLSPEC int SDLCALL SDL_SetBooleanProperty(SDL_PropertiesID props, const
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
*
* \sa SDL_HasProperty
*/ */
extern DECLSPEC SDL_PropertyType SDLCALL SDL_GetPropertyType(SDL_PropertiesID props, const char *name); extern DECLSPEC SDL_PropertyType SDLCALL SDL_GetPropertyType(SDL_PropertiesID props, const char *name);
@ -285,6 +302,7 @@ extern DECLSPEC SDL_PropertyType SDLCALL SDL_GetPropertyType(SDL_PropertiesID pr
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
* *
* \sa SDL_GetPropertyType * \sa SDL_GetPropertyType
* \sa SDL_HasProperty
* \sa SDL_SetProperty * \sa SDL_SetProperty
*/ */
extern DECLSPEC void *SDLCALL SDL_GetProperty(SDL_PropertiesID props, const char *name, void *default_value); extern DECLSPEC void *SDLCALL SDL_GetProperty(SDL_PropertiesID props, const char *name, void *default_value);
@ -303,6 +321,7 @@ extern DECLSPEC void *SDLCALL SDL_GetProperty(SDL_PropertiesID props, const char
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
* *
* \sa SDL_GetPropertyType * \sa SDL_GetPropertyType
* \sa SDL_HasProperty
* \sa SDL_SetStringProperty * \sa SDL_SetStringProperty
*/ */
extern DECLSPEC const char *SDLCALL SDL_GetStringProperty(SDL_PropertiesID props, const char *name, const char *default_value); extern DECLSPEC const char *SDLCALL SDL_GetStringProperty(SDL_PropertiesID props, const char *name, const char *default_value);
@ -324,6 +343,7 @@ extern DECLSPEC const char *SDLCALL SDL_GetStringProperty(SDL_PropertiesID props
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
* *
* \sa SDL_GetPropertyType * \sa SDL_GetPropertyType
* \sa SDL_HasProperty
* \sa SDL_SetNumberProperty * \sa SDL_SetNumberProperty
*/ */
extern DECLSPEC Sint64 SDLCALL SDL_GetNumberProperty(SDL_PropertiesID props, const char *name, Sint64 default_value); extern DECLSPEC Sint64 SDLCALL SDL_GetNumberProperty(SDL_PropertiesID props, const char *name, Sint64 default_value);
@ -345,6 +365,7 @@ extern DECLSPEC Sint64 SDLCALL SDL_GetNumberProperty(SDL_PropertiesID props, con
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
* *
* \sa SDL_GetPropertyType * \sa SDL_GetPropertyType
* \sa SDL_HasProperty
* \sa SDL_SetFloatProperty * \sa SDL_SetFloatProperty
*/ */
extern DECLSPEC float SDLCALL SDL_GetFloatProperty(SDL_PropertiesID props, const char *name, float default_value); extern DECLSPEC float SDLCALL SDL_GetFloatProperty(SDL_PropertiesID props, const char *name, float default_value);
@ -366,6 +387,7 @@ extern DECLSPEC float SDLCALL SDL_GetFloatProperty(SDL_PropertiesID props, const
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
* *
* \sa SDL_GetPropertyType * \sa SDL_GetPropertyType
* \sa SDL_HasProperty
* \sa SDL_SetBooleanProperty * \sa SDL_SetBooleanProperty
*/ */
extern DECLSPEC SDL_bool SDLCALL SDL_GetBooleanProperty(SDL_PropertiesID props, const char *name, SDL_bool default_value); extern DECLSPEC SDL_bool SDLCALL SDL_GetBooleanProperty(SDL_PropertiesID props, const char *name, SDL_bool default_value);
@ -381,8 +403,6 @@ extern DECLSPEC SDL_bool SDLCALL SDL_GetBooleanProperty(SDL_PropertiesID props,
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
*
* \sa SDL_GetProperty
*/ */
extern DECLSPEC int SDLCALL SDL_ClearProperty(SDL_PropertiesID props, const char *name); extern DECLSPEC int SDLCALL SDL_ClearProperty(SDL_PropertiesID props, const char *name);

41
src/SDL_properties.c
View file

@ -451,17 +451,20 @@ int SDL_SetBooleanProperty(SDL_PropertiesID props, const char *name, SDL_bool va
return SDL_PrivateSetProperty(props, name, property); return SDL_PrivateSetProperty(props, name, property);
} }
SDL_bool SDL_HasProperty(SDL_PropertiesID props, const char *name)
{
return (SDL_GetPropertyType(props, name) != SDL_PROPERTY_TYPE_INVALID);
}
SDL_PropertyType SDL_GetPropertyType(SDL_PropertiesID props, const char *name) SDL_PropertyType SDL_GetPropertyType(SDL_PropertiesID props, const char *name)
{ {
SDL_Properties *properties = NULL; SDL_Properties *properties = NULL;
SDL_PropertyType type = SDL_PROPERTY_TYPE_INVALID; SDL_PropertyType type = SDL_PROPERTY_TYPE_INVALID;
if (!props) { if (!props) {
SDL_InvalidParamError("props");
return SDL_PROPERTY_TYPE_INVALID; return SDL_PROPERTY_TYPE_INVALID;
} }
if (!name || !*name) { if (!name || !*name) {
SDL_InvalidParamError("name");
return SDL_PROPERTY_TYPE_INVALID; return SDL_PROPERTY_TYPE_INVALID;
} }
@ -470,7 +473,6 @@ SDL_PropertyType SDL_GetPropertyType(SDL_PropertiesID props, const char *name)
SDL_UnlockMutex(SDL_properties_lock); SDL_UnlockMutex(SDL_properties_lock);
if (!properties) { if (!properties) {
SDL_InvalidParamError("props");
return SDL_PROPERTY_TYPE_INVALID; return SDL_PROPERTY_TYPE_INVALID;
} }
@ -479,8 +481,6 @@ SDL_PropertyType SDL_GetPropertyType(SDL_PropertiesID props, const char *name)
SDL_Property *property = NULL; SDL_Property *property = NULL;
if (SDL_FindInHashTable(properties->props, name, (const void **)&property)) { if (SDL_FindInHashTable(properties->props, name, (const void **)&property)) {
type = property->type; type = property->type;
} else {
SDL_SetError("Couldn't find property named %s", name);
} }
} }
SDL_UnlockMutex(properties->lock); SDL_UnlockMutex(properties->lock);
@ -494,11 +494,9 @@ void *SDL_GetProperty(SDL_PropertiesID props, const char *name, void *default_va
void *value = default_value; void *value = default_value;
if (!props) { if (!props) {
SDL_InvalidParamError("props");
return value; return value;
} }
if (!name || !*name) { if (!name || !*name) {
SDL_InvalidParamError("name");
return value; return value;
} }
@ -507,7 +505,6 @@ void *SDL_GetProperty(SDL_PropertiesID props, const char *name, void *default_va
SDL_UnlockMutex(SDL_properties_lock); SDL_UnlockMutex(SDL_properties_lock);
if (!properties) { if (!properties) {
SDL_InvalidParamError("props");
return value; return value;
} }
@ -521,11 +518,7 @@ void *SDL_GetProperty(SDL_PropertiesID props, const char *name, void *default_va
if (SDL_FindInHashTable(properties->props, name, (const void **)&property)) { if (SDL_FindInHashTable(properties->props, name, (const void **)&property)) {
if (property->type == SDL_PROPERTY_TYPE_POINTER) { if (property->type == SDL_PROPERTY_TYPE_POINTER) {
value = property->value.pointer_value; value = property->value.pointer_value;
} else {
SDL_SetError("Property %s isn't a pointer value", name);
} }
} else {
SDL_SetError("Couldn't find property named %s", name);
} }
} }
SDL_UnlockMutex(properties->lock); SDL_UnlockMutex(properties->lock);
@ -539,11 +532,9 @@ const char *SDL_GetStringProperty(SDL_PropertiesID props, const char *name, cons
const char *value = default_value; const char *value = default_value;
if (!props) { if (!props) {
SDL_InvalidParamError("props");
return value; return value;
} }
if (!name || !*name) { if (!name || !*name) {
SDL_InvalidParamError("name");
return value; return value;
} }
@ -552,7 +543,6 @@ const char *SDL_GetStringProperty(SDL_PropertiesID props, const char *name, cons
SDL_UnlockMutex(SDL_properties_lock); SDL_UnlockMutex(SDL_properties_lock);
if (!properties) { if (!properties) {
SDL_InvalidParamError("props");
return value; return value;
} }
@ -594,11 +584,8 @@ const char *SDL_GetStringProperty(SDL_PropertiesID props, const char *name, cons
value = property->value.boolean_value ? "true" : "false"; value = property->value.boolean_value ? "true" : "false";
break; break;
default: default:
SDL_SetError("Property %s isn't a string value", name);
break; break;
} }
} else {
SDL_SetError("Couldn't find property named %s", name);
} }
} }
SDL_UnlockMutex(properties->lock); SDL_UnlockMutex(properties->lock);
@ -612,11 +599,9 @@ Sint64 SDL_GetNumberProperty(SDL_PropertiesID props, const char *name, Sint64 de
Sint64 value = default_value; Sint64 value = default_value;
if (!props) { if (!props) {
SDL_InvalidParamError("props");
return value; return value;
} }
if (!name || !*name) { if (!name || !*name) {
SDL_InvalidParamError("name");
return value; return value;
} }
@ -625,7 +610,6 @@ Sint64 SDL_GetNumberProperty(SDL_PropertiesID props, const char *name, Sint64 de
SDL_UnlockMutex(SDL_properties_lock); SDL_UnlockMutex(SDL_properties_lock);
if (!properties) { if (!properties) {
SDL_InvalidParamError("props");
return value; return value;
} }
@ -647,11 +631,8 @@ Sint64 SDL_GetNumberProperty(SDL_PropertiesID props, const char *name, Sint64 de
value = property->value.boolean_value; value = property->value.boolean_value;
break; break;
default: default:
SDL_SetError("Property %s isn't a number value", name);
break; break;
} }
} else {
SDL_SetError("Couldn't find property named %s", name);
} }
} }
SDL_UnlockMutex(properties->lock); SDL_UnlockMutex(properties->lock);
@ -665,11 +646,9 @@ float SDL_GetFloatProperty(SDL_PropertiesID props, const char *name, float defau
float value = default_value; float value = default_value;
if (!props) { if (!props) {
SDL_InvalidParamError("props");
return value; return value;
} }
if (!name || !*name) { if (!name || !*name) {
SDL_InvalidParamError("name");
return value; return value;
} }
@ -678,7 +657,6 @@ float SDL_GetFloatProperty(SDL_PropertiesID props, const char *name, float defau
SDL_UnlockMutex(SDL_properties_lock); SDL_UnlockMutex(SDL_properties_lock);
if (!properties) { if (!properties) {
SDL_InvalidParamError("props");
return value; return value;
} }
@ -700,11 +678,8 @@ float SDL_GetFloatProperty(SDL_PropertiesID props, const char *name, float defau
value = (float)property->value.boolean_value; value = (float)property->value.boolean_value;
break; break;
default: default:
SDL_SetError("Property %s isn't a float value", name);
break; break;
} }
} else {
SDL_SetError("Couldn't find property named %s", name);
} }
} }
SDL_UnlockMutex(properties->lock); SDL_UnlockMutex(properties->lock);
@ -718,11 +693,9 @@ SDL_bool SDL_GetBooleanProperty(SDL_PropertiesID props, const char *name, SDL_bo
SDL_bool value = default_value; SDL_bool value = default_value;
if (!props) { if (!props) {
SDL_InvalidParamError("props");
return value; return value;
} }
if (!name || !*name) { if (!name || !*name) {
SDL_InvalidParamError("name");
return value; return value;
} }
@ -731,7 +704,6 @@ SDL_bool SDL_GetBooleanProperty(SDL_PropertiesID props, const char *name, SDL_bo
SDL_UnlockMutex(SDL_properties_lock); SDL_UnlockMutex(SDL_properties_lock);
if (!properties) { if (!properties) {
SDL_InvalidParamError("props");
return value; return value;
} }
@ -753,11 +725,8 @@ SDL_bool SDL_GetBooleanProperty(SDL_PropertiesID props, const char *name, SDL_bo
value = property->value.boolean_value; value = property->value.boolean_value;
break; break;
default: default:
SDL_SetError("Property %s isn't a boolean value", name);
break; break;
} }
} else {
SDL_SetError("Couldn't find property named %s", name);
} }
} }
SDL_UnlockMutex(properties->lock); SDL_UnlockMutex(properties->lock);

1
src/dynapi/SDL_dynapi.sym
View file

@ -972,6 +972,7 @@ SDL3_0.0.0 {
SDL_RenderGeometryRawFloat; SDL_RenderGeometryRawFloat;
SDL_SetWindowShape; SDL_SetWindowShape;
SDL_RenderViewportSet; SDL_RenderViewportSet;
SDL_HasProperty;
# extra symbols go here (don't modify this line) # extra symbols go here (don't modify this line)
local: *; local: *;
}; };

1
src/dynapi/SDL_dynapi_overrides.h
View file

@ -997,3 +997,4 @@
#define SDL_RenderGeometryRawFloat SDL_RenderGeometryRawFloat_REAL #define SDL_RenderGeometryRawFloat SDL_RenderGeometryRawFloat_REAL
#define SDL_SetWindowShape SDL_SetWindowShape_REAL #define SDL_SetWindowShape SDL_SetWindowShape_REAL
#define SDL_RenderViewportSet SDL_RenderViewportSet_REAL #define SDL_RenderViewportSet SDL_RenderViewportSet_REAL
#define SDL_HasProperty SDL_HasProperty_REAL

1
src/dynapi/SDL_dynapi_procs.h
View file

@ -1022,3 +1022,4 @@ SDL_DYNAPI_PROC(int,SDL_GetRenderColorScale,(SDL_Renderer *a, float *b),(a,b),re
SDL_DYNAPI_PROC(int,SDL_RenderGeometryRawFloat,(SDL_Renderer *a, SDL_Texture *b, const float *c, int d, const SDL_FColor *e, int f, const float *g, int h, int i, const void *j, int k, int l),(a,b,c,d,e,f,g,h,i,j,k,l),return) SDL_DYNAPI_PROC(int,SDL_RenderGeometryRawFloat,(SDL_Renderer *a, SDL_Texture *b, const float *c, int d, const SDL_FColor *e, int f, const float *g, int h, int i, const void *j, int k, int l),(a,b,c,d,e,f,g,h,i,j,k,l),return)
SDL_DYNAPI_PROC(int,SDL_SetWindowShape,(SDL_Window *a, SDL_Surface *b),(a,b),return) SDL_DYNAPI_PROC(int,SDL_SetWindowShape,(SDL_Window *a, SDL_Surface *b),(a,b),return)
SDL_DYNAPI_PROC(SDL_bool,SDL_RenderViewportSet,(SDL_Renderer *a),(a),return) SDL_DYNAPI_PROC(SDL_bool,SDL_RenderViewportSet,(SDL_Renderer *a),(a),return)
SDL_DYNAPI_PROC(SDL_bool,SDL_HasProperty,(SDL_PropertiesID a, const char *b),(a,b),return)