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