SDL_GetHaptics() follows the SDL_GetStringRule

slouken · slouken · commit b32c9615a748 · 2024-07-19T12:22:03.000-07:00
diff --git a/docs/README-migration.md b/docs/README-migration.md
@@ -695,7 +695,7 @@ Rather than iterating over haptic devices using device index, there is a new fun
 {
     if (SDL_InitSubSystem(SDL_INIT_HAPTIC) == 0) {
         int i, num_haptics;
-        SDL_HapticID *haptics = SDL_GetHaptics(&num_haptics);
+        const SDL_HapticID *haptics = SDL_GetHaptics(&num_haptics);
         if (haptics) {
             for (i = 0; i < num_haptics; ++i) {
                 SDL_HapticID instance_id = haptics[i];
@@ -704,7 +704,6 @@ Rather than iterating over haptic devices using device index, there is a new fun
                 SDL_Log("Haptic %" SDL_PRIu32 ": %s\n",
                         instance_id, name ? name : "Unknown");
             }
-            SDL_free(haptics);
         }
         SDL_QuitSubSystem(SDL_INIT_HAPTIC);
     }
diff --git a/include/SDL3/SDL_haptic.h b/include/SDL3/SDL_haptic.h
@@ -45,7 +45,6 @@
  *    SDL_HapticID *haptics = SDL_GetHaptics(NULL);
  *    if (haptics) {
  *        haptic = SDL_OpenHaptic(haptics[0]);
- *        SDL_free(haptics);
  *    }
  *    if (haptic == NULL)
  *       return -1;
@@ -932,17 +931,18 @@ typedef Uint32 SDL_HapticID;
 /**
  * Get a list of currently connected haptic devices.
  *
+ * The returned array follows the SDL_GetStringRule, and will be automatically freed later.
+ *
  * \param count a pointer filled in with the number of haptic devices
- *              returned.
- * \returns a 0 terminated array of haptic device instance IDs which should be
- *          freed with SDL_free(), or NULL on failure; call SDL_GetError() for
+ *              returned, may be NULL.
+ * \returns a 0 terminated array of haptic device instance IDs or NULL on failure; call SDL_GetError() for
  *          more information.
  *
  * \since This function is available since SDL 3.0.0.
  *
  * \sa SDL_OpenHaptic
  */
-extern SDL_DECLSPEC SDL_HapticID * SDLCALL SDL_GetHaptics(int *count);
+extern SDL_DECLSPEC const SDL_HapticID * SDLCALL SDL_GetHaptics(int *count);
 
 /**
  * Get the implementation dependent name of a haptic device.
diff --git a/src/dynapi/SDL_dynapi_procs.h b/src/dynapi/SDL_dynapi_procs.h
@@ -327,7 +327,7 @@ SDL_DYNAPI_PROC(SDL_Haptic*,SDL_GetHapticFromID,(SDL_HapticID a),(a),return)
 SDL_DYNAPI_PROC(SDL_HapticID,SDL_GetHapticID,(SDL_Haptic *a),(a),return)
 SDL_DYNAPI_PROC(const char*,SDL_GetHapticName,(SDL_Haptic *a),(a),return)
 SDL_DYNAPI_PROC(const char*,SDL_GetHapticNameForID,(SDL_HapticID a),(a),return)
-SDL_DYNAPI_PROC(SDL_HapticID*,SDL_GetHaptics,(int *a),(a),return)
+SDL_DYNAPI_PROC(const SDL_HapticID*,SDL_GetHaptics,(int *a),(a),return)
 SDL_DYNAPI_PROC(const char*,SDL_GetHint,(const char *a),(a),return)
 SDL_DYNAPI_PROC(SDL_bool,SDL_GetHintBoolean,(const char *a, SDL_bool b),(a,b),return)
 SDL_DYNAPI_PROC(SDL_PropertiesID,SDL_GetIOProperties,(SDL_IOStream *a),(a),return)
diff --git a/src/haptic/SDL_haptic.c b/src/haptic/SDL_haptic.c
@@ -63,7 +63,7 @@ static SDL_bool SDL_GetHapticIndex(SDL_HapticID instance_id, int *driver_index)
     return SDL_FALSE;
 }
 
-SDL_HapticID *SDL_GetHaptics(int *count)
+const SDL_HapticID *SDL_GetHaptics(int *count)
 {
     int device_index;
     int haptic_index = 0, num_haptics = 0;
@@ -89,7 +89,7 @@ SDL_HapticID *SDL_GetHaptics(int *count)
         }
     }
 
-    return haptics;
+    return SDL_FreeLater(haptics);
 }
 
 const char *SDL_GetHapticNameForID(SDL_HapticID instance_id)
diff --git a/test/testhaptic.c b/test/testhaptic.c
@@ -40,7 +40,7 @@ int main(int argc, char **argv)
     int id[9];
     int nefx;
     unsigned int supported;
-    SDL_HapticID *haptics;
+    const SDL_HapticID *haptics;
     int num_haptics;
 
     /* Initialize test framework */
@@ -91,7 +91,6 @@ int main(int argc, char **argv)
     if (haptics) {
         if (num_haptics == 0) {
             SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "No Haptic devices found!\n");
-            SDL_free(haptics);
             return 1;
         }
 
@@ -101,7 +100,6 @@ int main(int argc, char **argv)
 
             if (i >= num_haptics) {
                 SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "Index out of range, aborting.\n");
-                SDL_free(haptics);
                 return 1;
             }
         }
@@ -115,20 +113,17 @@ int main(int argc, char **argv)
 
             if (i >= num_haptics) {
                 SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "Unable to find device matching '%s', aborting.\n", name);
-                SDL_free(haptics);
                 return 1;
             }
         }
 
         haptic = SDL_OpenHaptic(haptics[i]);
         if (!haptic) {
             SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "Unable to create the haptic device: %s\n", SDL_GetError());
-            SDL_free(haptics);
             return 1;
         }
         SDL_Log("Device: %s\n", SDL_GetHapticName(haptic));
         HapticPrintSupported(haptic);
-        SDL_free(haptics);
     }
 
     /* We only want force feedback errors. */
diff --git a/test/testhotplug.c b/test/testhotplug.c
@@ -91,7 +91,7 @@ int main(int argc, char *argv[])
 
     if (enable_haptic) {
         int num_haptics;
-        SDL_free(SDL_GetHaptics(&num_haptics));
+        SDL_GetHaptics(&num_haptics);
         SDL_Log("There are %d haptic devices at startup\n", num_haptics);
     }
 
diff --git a/test/testrumble.c b/test/testrumble.c
@@ -39,7 +39,7 @@ int main(int argc, char **argv)
     char *name = NULL;
     int index;
     SDLTest_CommonState *state;
-    SDL_HapticID *haptics;
+    const SDL_HapticID *haptics;
     int num_haptics;
 
     /* Initialize test framework */
@@ -92,7 +92,6 @@ int main(int argc, char **argv)
     if (haptics) {
         if (num_haptics == 0) {
             SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "No Haptic devices found!\n");
-            SDL_free(haptics);
             return 1;
         }
 
@@ -102,7 +101,6 @@ int main(int argc, char **argv)
 
             if (i >= num_haptics) {
                 SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "Index out of range, aborting.\n");
-                SDL_free(haptics);
                 return 1;
             }
         }
@@ -116,19 +114,16 @@ int main(int argc, char **argv)
 
             if (i >= num_haptics) {
                 SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "Unable to find device matching '%s', aborting.\n", name);
-                SDL_free(haptics);
                 return 1;
             }
         }
 
         haptic = SDL_OpenHaptic(haptics[i]);
         if (!haptic) {
             SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "Unable to create the haptic device: %s\n", SDL_GetError());
-            SDL_free(haptics);
             return 1;
         }
         SDL_Log("Device: %s\n", SDL_GetHapticName(haptic));
-        SDL_free(haptics);
     }
 
     /* We only want force feedback errors. */

Original file line number	Diff line number	Diff line change
`@@ -695,7 +695,7 @@ Rather than iterating over haptic devices using device index, there is a new fun`
`695`	`695`	`{`
`696`	`696`	`if (SDL_InitSubSystem(SDL_INIT_HAPTIC) == 0) {`
`697`	`697`	`int i, num_haptics;`
`698`		`- SDL_HapticID *haptics = SDL_GetHaptics(&num_haptics);`
	`698`	`+ const SDL_HapticID *haptics = SDL_GetHaptics(&num_haptics);`
`699`	`699`	`if (haptics) {`
`700`	`700`	`for (i = 0; i < num_haptics; ++i) {`
`701`	`701`	`SDL_HapticID instance_id = haptics[i];`
`@@ -704,7 +704,6 @@ Rather than iterating over haptic devices using device index, there is a new fun`
`704`	`704`	`SDL_Log("Haptic %" SDL_PRIu32 ": %s\n",`
`705`	`705`	`instance_id, name ? name : "Unknown");`
`706`	`706`	`}`
`707`		`- SDL_free(haptics);`
`708`	`707`	`}`
`709`	`708`	`SDL_QuitSubSystem(SDL_INIT_HAPTIC);`
`710`	`709`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ static SDL_bool SDL_GetHapticIndex(SDL_HapticID instance_id, int *driver_index)`
`63`	`63`	`return SDL_FALSE;`
`64`	`64`	`}`
`65`	`65`
`66`		`-SDL_HapticID SDL_GetHaptics(int count)`
	`66`	`+const SDL_HapticID SDL_GetHaptics(int count)`
`67`	`67`	`{`
`68`	`68`	`int device_index;`
`69`	`69`	`int haptic_index = 0, num_haptics = 0;`
`@@ -89,7 +89,7 @@ SDL_HapticID SDL_GetHaptics(int count)`
`89`	`89`	`}`
`90`	`90`	`}`
`91`	`91`
`92`		`- return haptics;`
	`92`	`+ return SDL_FreeLater(haptics);`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`const char *SDL_GetHapticNameForID(SDL_HapticID instance_id)`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ int main(int argc, char **argv)`
`40`	`40`	`int id[9];`
`41`	`41`	`int nefx;`
`42`	`42`	`unsigned int supported;`
`43`		`- SDL_HapticID *haptics;`
	`43`	`+ const SDL_HapticID *haptics;`
`44`	`44`	`int num_haptics;`
`45`	`45`
`46`	`46`	`/* Initialize test framework */`
`@@ -91,7 +91,6 @@ int main(int argc, char **argv)`
`91`	`91`	`if (haptics) {`
`92`	`92`	`if (num_haptics == 0) {`
`93`	`93`	`SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "No Haptic devices found!\n");`
`94`		`- SDL_free(haptics);`
`95`	`94`	`return 1;`
`96`	`95`	`}`
`97`	`96`
`@@ -101,7 +100,6 @@ int main(int argc, char **argv)`
`101`	`100`
`102`	`101`	`if (i >= num_haptics) {`
`103`	`102`	`SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "Index out of range, aborting.\n");`
`104`		`- SDL_free(haptics);`
`105`	`103`	`return 1;`
`106`	`104`	`}`
`107`	`105`	`}`
`@@ -115,20 +113,17 @@ int main(int argc, char **argv)`
`115`	`113`
`116`	`114`	`if (i >= num_haptics) {`
`117`	`115`	`SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "Unable to find device matching '%s', aborting.\n", name);`
`118`		`- SDL_free(haptics);`
`119`	`116`	`return 1;`
`120`	`117`	`}`
`121`	`118`	`}`
`122`	`119`
`123`	`120`	`haptic = SDL_OpenHaptic(haptics[i]);`
`124`	`121`	`if (!haptic) {`
`125`	`122`	`SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "Unable to create the haptic device: %s\n", SDL_GetError());`
`126`		`- SDL_free(haptics);`
`127`	`123`	`return 1;`
`128`	`124`	`}`
`129`	`125`	`SDL_Log("Device: %s\n", SDL_GetHapticName(haptic));`
`130`	`126`	`HapticPrintSupported(haptic);`
`131`		`- SDL_free(haptics);`
`132`	`127`	`}`
`133`	`128`
`134`	`129`	`/* We only want force feedback errors. */`
Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ int main(int argc, char *argv[])`
`91`	`91`
`92`	`92`	`if (enable_haptic) {`
`93`	`93`	`int num_haptics;`
`94`		`- SDL_free(SDL_GetHaptics(&num_haptics));`
	`94`	`+ SDL_GetHaptics(&num_haptics);`
`95`	`95`	`SDL_Log("There are %d haptic devices at startup\n", num_haptics);`
`96`	`96`	`}`
`97`	`97`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ int main(int argc, char **argv)`
`39`	`39`	`char *name = NULL;`
`40`	`40`	`int index;`
`41`	`41`	`SDLTest_CommonState *state;`
`42`		`- SDL_HapticID *haptics;`
	`42`	`+ const SDL_HapticID *haptics;`
`43`	`43`	`int num_haptics;`
`44`	`44`
`45`	`45`	`/* Initialize test framework */`
`@@ -92,7 +92,6 @@ int main(int argc, char **argv)`
`92`	`92`	`if (haptics) {`
`93`	`93`	`if (num_haptics == 0) {`
`94`	`94`	`SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "No Haptic devices found!\n");`
`95`		`- SDL_free(haptics);`
`96`	`95`	`return 1;`
`97`	`96`	`}`
`98`	`97`
`@@ -102,7 +101,6 @@ int main(int argc, char **argv)`
`102`	`101`
`103`	`102`	`if (i >= num_haptics) {`
`104`	`103`	`SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "Index out of range, aborting.\n");`
`105`		`- SDL_free(haptics);`
`106`	`104`	`return 1;`
`107`	`105`	`}`
`108`	`106`	`}`
`@@ -116,19 +114,16 @@ int main(int argc, char **argv)`
`116`	`114`
`117`	`115`	`if (i >= num_haptics) {`
`118`	`116`	`SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "Unable to find device matching '%s', aborting.\n", name);`
`119`		`- SDL_free(haptics);`
`120`	`117`	`return 1;`
`121`	`118`	`}`
`122`	`119`	`}`
`123`	`120`
`124`	`121`	`haptic = SDL_OpenHaptic(haptics[i]);`
`125`	`122`	`if (!haptic) {`
`126`	`123`	`SDL_LogError(SDL_LOG_CATEGORY_APPLICATION, "Unable to create the haptic device: %s\n", SDL_GetError());`
`127`		`- SDL_free(haptics);`
`128`	`124`	`return 1;`
`129`	`125`	`}`
`130`	`126`	`SDL_Log("Device: %s\n", SDL_GetHapticName(haptic));`
`131`		`- SDL_free(haptics);`
`132`	`127`	`}`
`133`	`128`
`134`	`129`	`/* We only want force feedback errors. */`