len0rd/rockbox
1
0
Fork 1
mirror of https://github.com/Rockbox/rockbox.git synced 2025-11-09 21:22:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Buflib: Clarification about invalid handles

Browse source 
* Enhance allocation function comments to better state the return value and what an invalid value is
* Change clients to check for "< 0" instead of "<= 0" or "== 0"
* Return -1 or -2 depending on the exact failure in buflib_alloc_ex.

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@30469 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Thomas Martitz 2011-09-07 23:16:29 +00:00
parent 6a989b8d4d
commit 5296af838c
5 changed files with 15 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

11
firmware/include/buflib.h
View file

@ -153,7 +153,8 @@ size_t buflib_available(struct buflib_context *ctx);
*
* size: How many bytes to allocate
*
* Returns: An integer handle identifying this allocation
* Returns: A positive integer handle identifying this allocation, or
* a negative value on error (0 is also not a valid handle)
*/
int buflib_alloc(struct buflib_context *context, size_t size);
@ -166,7 +167,8 @@ int buflib_alloc(struct buflib_context *context, size_t size);
* size: How many bytes to allocate
* ops: a struct with pointers to callback functions (see above)
*
* Returns: An integer handle identifying this allocation
* Returns: A positive integer handle identifying this allocation, or
* a negative value on error (0 is also not a valid handle)
*/
int buflib_alloc_ex(struct buflib_context *ctx, size_t size, const char *name,
struct buflib_callbacks *ops);
@ -188,7 +190,8 @@ int buflib_alloc_ex(struct buflib_context *ctx, size_t size, const char *name,
* size: The actual size will be returned into size
* ops: a struct with pointers to callback functions
*
* Returns: An integer handle identifying this allocation
* Returns: A positive integer handle identifying this allocation, or
* a negative value on error (0 is also not a valid handle)
*/
int buflib_alloc_maximum(struct buflib_context* ctx, const char* name,
size_t *size, struct buflib_callbacks *ops);
@ -233,7 +236,7 @@ bool buflib_shrink(struct buflib_context *ctx, int handle, void* newstart, size_
/**
* Frees memory associated with the given handle
*
* Returns: 0 (to invalidate handles in one line)
* Returns: 0 (to invalidate handles in one line, 0 is not a valid handle)
*/
int buflib_free(struct buflib_context *context, int handle);