From f1bde7104b04d5254d1d1d7dcc8de790a43a416f Mon Sep 17 00:00:00 2001 From: Martin Mares Date: Thu, 9 Apr 2015 15:49:56 +0200 Subject: [PATCH] Mempools: Renamed mp_append_[v]printf() back to its original name --- maint/libucw.abi | 4 ++-- ucw/doc/relnotes.txt | 8 ++++++++ ucw/mempool-fmt.c | 6 +++--- ucw/mempool.h | 28 ++++++++++++++++------------ 4 files changed, 29 insertions(+), 17 deletions(-) diff --git a/maint/libucw.abi b/maint/libucw.abi index 299c06d4..b103e584 100644 --- a/maint/libucw.abi +++ b/maint/libucw.abi @@ -389,8 +389,8 @@ mp_strjoin mp_str_from_mem mp_printf mp_vprintf -mp_append_printf -mp_append_vprintf +mp_printf_append +mp_vprintf_append # ucw/opt-internal.h opt_precompute # ucw/opt.h diff --git a/ucw/doc/relnotes.txt b/ucw/doc/relnotes.txt index 888edf96..1098499e 100644 --- a/ucw/doc/relnotes.txt +++ b/ucw/doc/relnotes.txt @@ -1,6 +1,14 @@ Release notes ============= +FIXME +----- +* The naming of memory pool functions mp_append_printf() and mp_append_vprintf() + turned out to be unfortunate as they have differently from all other functions + operating on growing buffers. They have been renamed to mp_printf_append() + and mp_vprintf_append() with the old names kept as aliases for backward + compatibility. + 6.4 (2015-04-08) ---------------- * Fixed several minor bugs in the <> module. diff --git a/ucw/mempool-fmt.c b/ucw/mempool-fmt.c index 1b98a2d3..7dc7a10d 100644 --- a/ucw/mempool-fmt.c +++ b/ucw/mempool-fmt.c @@ -65,7 +65,7 @@ mp_printf(struct mempool *p, const char *fmt, ...) } char * -mp_append_vprintf(struct mempool *mp, char *ptr, const char *fmt, va_list args) +mp_vprintf_append(struct mempool *mp, char *ptr, const char *fmt, va_list args) { size_t ofs = mp_open(mp, ptr); ASSERT(ofs && !ptr[ofs - 1]); @@ -73,7 +73,7 @@ mp_append_vprintf(struct mempool *mp, char *ptr, const char *fmt, va_list args) } char * -mp_append_printf(struct mempool *mp, char *ptr, const char *fmt, ...) +mp_printf_append(struct mempool *mp, char *ptr, const char *fmt, ...) { va_list args; va_start(args, fmt); @@ -89,7 +89,7 @@ int main(void) struct mempool *mp = mp_new(64); char *x = mp_printf(mp, "", "World"); fputs(x, stdout); - x = mp_append_printf(mp, x, ""); + x = mp_printf_append(mp, x, ""); fputs(x, stdout); x = mp_printf(mp, "\n", "World"); fputs(x, stdout); diff --git a/ucw/mempool.h b/ucw/mempool.h index 0f043d60..44595ea7 100644 --- a/ucw/mempool.h +++ b/ucw/mempool.h @@ -1,7 +1,7 @@ /* * UCW Library -- Memory Pools * - * (c) 1997--2014 Martin Mares + * (c) 1997--2015 Martin Mares * (c) 2007 Pavel Charvat * * This software may be freely distributed and used according to the terms @@ -19,8 +19,6 @@ #define mp_alloc_internal ucw_mp_alloc_internal #define mp_alloc_noalign ucw_mp_alloc_noalign #define mp_alloc_zero ucw_mp_alloc_zero -#define mp_append_printf ucw_mp_append_printf -#define mp_append_vprintf ucw_mp_append_vprintf #define mp_delete ucw_mp_delete #define mp_flush ucw_mp_flush #define mp_grow_internal ucw_mp_grow_internal @@ -31,6 +29,7 @@ #define mp_open ucw_mp_open #define mp_pop ucw_mp_pop #define mp_printf ucw_mp_printf +#define mp_printf_append ucw_mp_printf_append #define mp_push ucw_mp_push #define mp_realloc ucw_mp_realloc #define mp_realloc_zero ucw_mp_realloc_zero @@ -46,6 +45,7 @@ #define mp_strjoin ucw_mp_strjoin #define mp_total_size ucw_mp_total_size #define mp_vprintf ucw_mp_vprintf +#define mp_vprintf_append ucw_mp_vprintf_append #endif /*** @@ -542,18 +542,22 @@ char *mp_vprintf(struct mempool *mp, const char *fmt, va_list args) LIKE_MALLOC; * Returns pointer to the beginning of the string (the pointer may have * changed due to reallocation). * - * Alternatively, this function may be called mp_printf_append() for compatibility with - * previous releases of LibUCW. + * In some versions of LibUCW, this function was called mp_append_printf(). However, + * this name turned out to be confusing -- unlike other appending functions, this one is + * not called on an opened growing buffer. The old name will be preserved for backward + * compatibility for the time being. **/ -char *mp_append_printf(struct mempool *mp, char *ptr, const char *fmt, ...) FORMAT_CHECK(printf,3,4); -#define mp_printf_append mp_append_printf +char *mp_printf_append(struct mempool *mp, char *ptr, const char *fmt, ...) FORMAT_CHECK(printf,3,4); +#define mp_append_printf mp_printf_append /** - * Like @mp_append_printf(), but uses `va_list` for parameters. + * Like @mp_printf_append(), but uses `va_list` for parameters. * - * Alternatively, this function may be called mp_vprintf_append() for compatibility with - * previous releases of LibUCW. + * In some versions of LibUCW, this function was called mp_append_vprintf(). However, + * this name turned out to be confusing -- unlike other appending functions, this one is + * not called on an opened growing buffer. The old name will be preserved for backward + * compatibility for the time being. **/ -char *mp_append_vprintf(struct mempool *mp, char *ptr, const char *fmt, va_list args); -#define mp_vprintf_append mp_append_vprintf +char *mp_vprintf_append(struct mempool *mp, char *ptr, const char *fmt, va_list args); +#define mp_append_vprintf mp_vprintf_append #endif -- 2.39.2