1 Version 4.0 - 2025-12-31
2 ------------------------
3
4 * adds cx_system_page_size() to allocator.h
5 * adds cx_compare_func2 function pointer that supports compare functions with custom data
6 * adds a new (optional) capacity parameter to cxJsonCreateArr() and cxJsonObjPutArr()
7 * adds cxJsonFromString(), cxJsonToString(), and cxJsonToPrettyString()
8 * adds cxJsonClone()
9 * adds cxJsonCompare()
10 * adds cxMapCompare()
11 * adds line continuation support to CxProperties / CxPropertiesConfig
12 * adds cx_hash_key_as_string()
13 * adds support for CxHashKey pointers in CX_HASH_KEY() and all map functions
14 * adds CX_NULLSTR convenience macro
15 * adds cx_strcast_m()
16 * adds cx_strat()
17 * adds cx_bstr() and cx_bstr_m()
18 * adds cxBufferMaximumCapacity()
19 * adds cxBufferAppendString()
20 * adds CX_BUFFER_DO_NOT_FREE buffer flag
21 * changes the parameter order of cxBufferInit() and cxBufferCreate()
22 * changes cxBufferReserve() to allow reducing the capacity
23 * changes cxBufferTerminate() to automatically shrink the buffer
24 * changes cxBufferTerminate() so that position and size are equal after a successful operation
25 * changes cxBufferPutString() to accept any kind of string that cx_strcast() supports
26 * changes that multiple string.h functions now also automatically apply cx_strcast() where possible
27 * changes the names of cxDefineDestructor() and cxDefineAdvancedDestructor() to
28 cxSetDestructor() and cxSetdvancedDestructor()
29 * changes the name of cxCollectionCompareFunc() to cxSetCompareFunc()
30 * changes the entire low-level array-list API by making it much simpler
31 * changes the tree API towards a more simple design
32 * changes the members of CxJson and CxJsonValue
33 * changes the return value of cxJsonObjIter() to CxMapIterator
34 * changes CxTree structure so that it now inherits CX_COLLECTION_BASE
35 * changes cxPropertiesLoad() to directly load properties from a file to a CxMap
36 * changes cxFreeDefault() from a macro to a function so that it can be used as a simple destructor
37 * fixes cxJsonWrite() incorrectly returning non-zero when strings needed to be escaped
38 * fixes cxJsonNext() incorrectly returning CX_JSON_INCOMPLETE_DATA when the input ends with trailing spaces
39 * fixes critical memory leak when using cxMapFree() on a kv-list that is using destructors
40 * fixes critical use-after-free with keys stored in kv-lists
41 * fixes that overwriting items with cxMapPut() in a kv-list did not work
42 * fixes that cxReallocate(), cxReallocateArray(), cx_reallocate(), and cx_reallocatearray()
43 were not returning zero after freeing the memory when passed a size of zero
44 * fixes that cx_list_default_insert_array() has the wrong nonnull attribute when used for cxListEmplaceArray()
45 * removes the CX_STR() macro and instead makes the cx_str() inlinable
46 * removes the cx_str*_m() functions
47 * removes the sort_members feature from CxJsonWriter
48 * removes the source and sink API from properties.h
49 * removes the flush feature from CxBuffer
50 * removes the ability to remove elements from the iterators created with cxIterator() and cxIteratorPtr()
51 * removes several unnecessary convenience functions
52 * removes the complicated wrapping of pointer lists
53 * removes cxIteratorRef()
54
55 Version 3.2 - 2025-11-30
56 ------------------------
57
58 * adds cxMempoolTransfer() and cxMempoolTransferObject()
59 * adds support for different destruction strategies in CxMempool
60 * adds new key-value-based list implementation
61 + adds support for integer keys to CxHashKey
62 * adds support for comparing arbitrary strings without explicit call to cx_strcast()
63 * adds clone, union, difference, and intersection functions for CxList and CxMap
64 * adds cxListContains() and cxMapContains()
65 * adds cxListReserve() and cxListShrink()
66 * adds cxListSet()
67 * adds cxListFirst() and cxListLast()
68 * adds cxListRemoveAndGetFirst() and cxListRemoveAndGetLast(),
69 and corresponding macro aliases cxListPopFront() and cxListPop()
70 * adds cxListEmplace(), cxListEmplaceAt(), cxListEmplaceArray(), cxListEmplaceArrayAt(), and cxMapEmplace()
71 * adds cxListInsertUnique() and cxListInsertUniqueArray()
72 * adds cx_array_insert_unique() and various convenience macros
73 * adds cx_linked_list_insert_unique() and cx_linked_list_insert_unique_chain()
74 * adds cxCollectionCompareFunc() to conveniently set a compare function for a collection
75 without needing to access the base struct manually
76 * adds cxBufferShrink()
77 * adds cxBufferPop()
78 * adds cxTreeSize()
79 * adds CX_PRIstr and CX_SFMT macros for formatting UCX strings
80 * adds cx_strcpy() and cx_strcpy_a()
81 * adds cxJsonArrRemove() and cxJsonObjRemove()
82 * adds cxStdlibAllocator and allows changes of cxDefaultAllocator
83 * improves performance of the CxList array list implementation
84 * changes over-aggressively declaring functions as static inline
85 * changes cx_str() and cx_mutstr() to allow NULL strings
86 * changes cx_strcast() to also accept C-strings as input
87 * changes grow strategy for the memory pool to reduce reallocations
88 * changes grow strategy for CxBuffer, which does now take the page size into account
89 * changes the implementation of cx_strreplacen() for improved efficiency
90 * changes all cxListIterator() and cxMapIterator() families of functions to also accept NULL as argument
91 * changes insert_element member function of CxList to accept NULL source and return a pointer to the inserted element
92 * changes the compare function wrapper for pointer lists so that it no longer invokes the actual compare function for NULL pointers
93 * changes struct cx_array_reallocator_s by replacing the four generic data members with two specifically named members
94 * changes cx_array_reserve() so that it reserves exactly the requested capacity (i.e., without overallocation)
95 * changes all other array functions to perform smart overallocation to avoid too many subsequent allocations
96 * changes that binary search and infimum always report the largest index, and supremum always reports the smallest index
97 when the found element appears more than once in the array
98 * fixes critical memory overflow in the stack-based array reallocator (this unfortunately breaks the function signature)
99 * fixes critical bug in cx_array_insert_sorted() that caused an infinite loop when inserting duplicates
100 * fixes mempool implementation not supporting NULL as argument for realloc
101 * fixes mempool implementation not supporting zero as size for realloc
102 * fixes that the elem_count member of an iterator was not updated after removing an element flagged by cxIteratorFlagRemoval()
103 * fixes that starting an iteration in a non-root node incorrectly continues iteration with the siblings of that node
104 * fixes unnecessary allocations in cx_strcat() family of functions
105 * fixes ineffective overflow check in cx_strcat() family of functions
106 * fixes errno value after failing cxBufferSeek() to be consistently EINVAL
107 * fixes implementation of cxBufferTerminate()
108 * fixes that cxBufferWrite() could auto-extend the buffer beyond the configured threshold
109 * fixes allocator arguments for some printf.h functions not being const
110 * fixes that cx_tree_search() did not investigate subtrees with equally good distance
111 * fixes that memory was freed by the wrong allocator in cx_vasprintf_a() when the underlying vsnprintf() failed
112 * removes all functions that create mutating iterators in favor of making all iterators possibly mutating
113 * removes the use of C23 attributes because they don't mix well with GNU attributes in GCC 15
114
115 Version 3.1 - 2025-02-11
116 ------------------------
117
118 * adds properties.h
119 * adds tree.h
120 * adds json.h
121 * adds locale-independent string to number conversion functions
122 * adds reallocarray() like functions to allocator.h
123 * adds cxIterator() to create iterators over raw C arrays
124 * adds cxIteratorPtr() to create iterators over raw C pointer arrays
125 * adds cx_array_reallocator() and cx_array_default_reallocator
126 * adds several new array and list functions
127 * adds cxBufferReset()
128 * adds cxBufferAppend()
129 * adds cxBufferEnableFlushing() and cxBufferFlush()
130 * adds CX_BUFFER_COPY_ON_WRITE and CX_BUFFER_COPY_ON_EXTEND flags
131 * adds cxBufferWriteFunc and cxBufferReadFunc function pointers (for convenience)
132 * adds cx_cmp_ptr()
133 * adds cx_vcmp_* family of functions
134 * adds cx_sprintf() and several more variants
135 * adds runtime constants to read out the actual SBO sizes
136 * adds improved version of UCX 2 Test framework (now a self-contained header)
137 * adds cx_nmemb() utility function to common.h
138 * changes that CxMap returns own CxMapIterator to save memory in CxIterator
139 * changes name of cxBasicMempoolCreate() to cxMempoolCreateSimple()
140 * changes all functions, for which there is no dedicated xyz_a variant,
141 to accept NULL as allocator argument (in which case a default allocator will be used)
142 * changes the name of destroy functions that actually free the memory to better indicate their behavior
143 * changes cx_strcat variants to allow handling of ENOMEM
144 * changes cx_strcast() to also accept cxstring (and doing nothing in that case)
145 * changes the behavior of cxBufferSeek() to allow offset zero for SEEK_END
146 * moves cx_compare_func typedef to compare.h
147 * moves cx_szmul() to common.h
148 * moves stream copy functions to new streams.h
149 * removes cx_strupper() and cx_strlower() because they only do the right thing in special cases
150 * removes several *_m variants of functions in string.h in favor of automatic conversion
151 * removes utils.h
152 * removes flag_removal function from iterator
153 * removes cxMapDetach() and makes cxMapRemoveAndGet() compatible with both map variants
154 * removes the API for changing the store_pointer property of collections after their creation
155 * removes CMake
156 * removes GTest dependency
157 * removes flags to disable SBO in tests
158 * removes CX_LINKED_LIST_SWAP_SBO_SIZE (it's not really an optimization for linked lists)
159 * fixes cx_strcmp() and cx_strcasecmp() not being useful for lexicographic ordering
160 * fixes cx_hash_key_cxstr() evaluating the argument twice
161 * fixes critical bug that produced wrong results when comparing lists of different type but same size
162 * ends UCX 2.1 long term support
163
164 Version 3.0 - 2023-07-09
165 ------------------------
166
167 * complete redesign from scratch
168 * collections can now store copies of objects and not just pointers
169 * collections are now dynamically implemented
170 * users of the library can specify own implementations of collections that work with the UCX API
171 * low level API for custom lists that do not use the UCX structures
172 * various fixes and improvements
173 * drops some other, rarely used, features
174 * removes testing implementation from the lib
175
176
177 Version 2.1 - 2019-12-30
178 ------------------------
179
180 * adds string replace functions
181 * adds set operations for UcxList and UcxMap
182 * adds sstrcaseprefix() and sstrcasesuffix()
183 * improves Doxygen documentation in ucx/string.h
184 * adds UcxArray data type
185 * adds support for CMake builds, but main build system is still autotools
186
187 Version 2.0 - 2018-12-28
188 ------------------------
189
190 * some uncritical bug fixes
191 * overflow of sstrnlen now returns SIZE_MAX instead of zero
192 * adds scstr_t - a const char* variant for sstr_t
193 * renames utility compare functions
194
195 Version 1.1 - 2018-05-14
196 ------------------------
197
198 * adds missing 32 bit support to integer overflow checks
199 * adds ucx_buffer_to_sstr() macro
200 * adds ucx_avl_free_content()
201 * adds some more compare and distance functions in utils.h
202 * adds SFMT() and PRIsstr convenience macros
203 * destructor functions for *_free_content() functions are now optional
204
205 Version 1.0.1 - 2018-01-21
206 --------------------------
207
208 * some bug fixes
209 * adds integer overflow checks
210
211 Version 1.0 - 2017-10-28
212 ------------------------
213
214 * first stable version of UCX released
215