Remove UPDATE opertor as there are no default operators that define it (and no one uses it as it is poorly documented). Replace by SET for RB-THREE. Replace by ADD for the splice function of dictionary

README.md

@@ -553,15 +553,14 @@ Other documented operators are:
 * IT\_REF(it\_obj) --> &subobj: Same as IT\_CREF, but return a modifiable pointer to the object referenced by the iterator.
 * IT\_INSERT(obj, it\_obj, subobj): Insert 'subobj' after 'it\_obj' in the container 'obj' and update it\_obj to point to the inserted object (as per IT\_NEXT semantics). All other iterators of the same container become invalidated. If 'it\_obj' is an end of the container, it inserts the object as the first one.
 * IT\_REMOVE(obj, it\_obj): Remove it\_obj from the container 'obj' (clearing the associated object) and update it\_obj to point to the next object (as per IT\_NEXT semantics). As it modifies the container, all other iterators of the same container become invalidated. it\_obj shall not be an end of the container.
-* SPLICE\_BACK(objd, objs, it\_obj): Move the object of the container 'objs' referenced by the iterator 'it\_obj' to the container 'objd'. Where it is moved is container dependent (it is recommended however to be like the PUSH method). Afterward 'it\_obj' references the next item in 'containerSrc' (as per IT\_NEXT semantics). 'it\_obj' shall not be an end of the container.
-* SPLICE\_AT(objd, id\_objd, objs, it\_objs): Move the object referenced by the iterator 'it\_objs' from the container 'objs' just after the object referenced by the iterator 'it\_objd' in the container 'objd'. If 'it\_objd' references an end of the container, it is inserted as the first item of the container (See operator 'IT\_INSERT'). Afterward 'it\_objs' references the next item in the container 'objs', and 'it\_objd' references the moved item in the container 'objd'. 'it\_objs' shall not be an end of the container.
+* SPLICE\_BACK(objd, objs, it\_obj): Move the object of the container 'objs' referenced by the iterator 'it\_obj' to the container 'objd'. Where it is moved is container dependent (it is recommended however to be like the PUSH method). Afterward 'it\_obj' references the next item in 'containerSrc' (as per IT\_NEXT semantics). 'it\_obj' shall not be an end of the container. Both objects shall use the same allocator.
+* SPLICE\_AT(objd, id\_objd, objs, it\_objs): Move the object referenced by the iterator 'it\_objs' from the container 'objs' just after the object referenced by the iterator 'it\_objd' in the container 'objd'. If 'it\_objd' references an end of the container, it is inserted as the first item of the container (See operator 'IT\_INSERT'). Afterward 'it\_objs' references the next item in the container 'objs', and 'it\_objd' references the moved item in the container 'objd'. 'it\_objs' shall not be an end of the container.  Both objects shall use the same allocator.
 * OUT\_STR(FILE* f, obj): Output 'obj' as a custom formatted string into the FILE stream 'f'. Format is container dependent, but is human readable.
 * IN\_STR(obj, FILE* f) --> bool: Set 'obj' to the value associated to the string representation of the object in the FILE stream 'f'. Return true in case of success (in that case the stream 'f' has been advanced to the end of the parsing of the object), false otherwise (in that case, the stream 'f' is in an undetermined position but is likely where the parsing fails). It ensures that an object which is output in a FILE through OUT\_STR, and an object which is read from this FILE through IN\_STR are considered as equal.
 * GET\_STR(string\_t str, obj, bool append): Set 'str' to a formatted string representation of the object 'obj'. Append to the string if 'append' is true, set it otherwise. This operator requires the module m-string.
 * PARSE\_STR(obj, const char *str, const char **endp) --> bool: Set 'obj' to the value associated to the formatted string representation of the object in the char stream 'str'. Return true in case of success (in that case if endp is not NULL, it points to the end of the parsing of the object), false otherwise (in that case, if endp is not NULL, it points to an undetermined position but likely to be where the parsing fails). It ensures that an object which is output in a string through GET\_STR, and an object which is read from this string through GET\_STR are considered as equal.
 * OUT\_SERIAL(m\_serial\_write\_t *serial, obj) --> m\_serial\_return\_code\_t : Output 'obj' into the configurable serialization stream 'serial' (See #[m-serial-json.h](#m-serial-json) for details and example) as per the serial object semantics. Return M\_SERIAL\_OK\_DONE in case of success, or M\_SERIAL\_FAIL otherwise .
 * IN\_SERIAL(obj, m\_serial\_read\_t *serial) --> m\_serial\_return\_code\_t: Set 'obj' to its representation from the configurable serialization stream 'serial' (See #[m-serial-json.h](#m-serial-json) for details and example) as per the serial object semantics. M\_SERIAL\_OK\_DONE in case of success (in that case the stream 'serial' has been advanced up to the complete parsing of the object), or M\_SERIAL\_FAIL otherwise (in that case, the stream 'serial' is in an undetermined position but usually around the next characters after the first failure).
-* UPDATE(objd, objs): Update the object 'objd' with the object 'objs'. What it does exactly is container dependent. It can either SET or ADD (default is SET).
 * OOR\_SET(obj, int\_value): Some containers want to store some information within the uninitialized objects (for example Open Addressing Hash Table). This method stores the integer value 'int\_value' into an uninitialized object 'obj'. It shall be able to differentiate between uninitialized object and initialized object (How is type dependent). The way to store this information is fully object dependent. In general, you use out-of-range value for detecting such values. The object remains uninitialized but sets to of out-of-range value (OOR). int\_value can be 0 or 1.
 * OOR\_EQUAL(obj, int\_value): This method compares the object 'obj' (initialized or uninitialized) to the out-of-range value (OOR) representation associated to 'int\_value' and returns true if both objects are equal, false otherwise. See OOR\_SET.
 * REVERSE(obj) : Reverse the order of the items in the container 'obj'.
@@ -2725,10 +2724,6 @@ Define the binary ordered tree 'name##\_t' and its associated methods as "static
 
 The CMP operator is used to perform the total ordering of the elements.
 
-The UPDATE operator is used to update an element if the 
-pushed item already exist in the container. The default behavior
-will overwrite the recorded value with the new one.
- 
 It shall be done once per type and per compilation unit.
 It also define the iterator name##\_it\_t and its associated methods as "static inline" functions.
 
@@ -2815,9 +2810,6 @@ Return the number of elements of the Red Black Tree.
 
 Push 'data' into the Red Black Tree 'rbtree' at its ordered place
 while keeping the tree balanced.
-If the UPDATE operator is defined and there exists a node that equals (CMP) 'data'
-it will be used to update the data of the node on push (It can be used to increment value).
-Otherwise the value is overwritten.
 
 ##### void name\_pop(type *dest, name\_t rbtree, const type data)
 
@@ -3285,7 +3277,7 @@ The queue will be composed of object of type 'type'.
 'name' shall be a C identifier that will be used to identify the container.
 
 The CMP operator is used to sort the queue so that it always returns the minimum of the queue.
-The EQUAL operator is used to identify an item on UPDATE or REMOVE operations.
+The EQUAL operator is used to identify an item on update or remove operations.
 It is uncorrelated with the CMP operator from the point of view of this operator.
 (i.e. EQUAL() == TRUE is not equivalent to CMP() == 0 for this container)
 
@@ -6090,7 +6082,6 @@ than a 'size\_t'.
 ##### M\_GET\_HASH oplist
 ##### M\_GET\_EQUAL oplist
 ##### M\_GET\_CMP oplist
-##### M\_GET\_UPDATE oplist
 ##### M\_GET\_TYPE oplist
 ##### M\_GET\_SUBTYPE oplist
 ##### M\_GET\_OPLIST oplist

m-core.h

@@ -2729,7 +2729,6 @@ static inline size_t m_core_cstr_hash(const char str[])
 #define M_NAME_NAME(a)           ,a,
 #define M_OPLIST_OPLIST(a)       ,a,
 #define M_SORT_SORT(a)           ,a,
-#define M_UPDATE_UPDATE(a)       ,a,
 #define M_SPLICE_BACK_SPLICE_BACK(a) ,a,
 #define M_SPLICE_AT_SPLICE_AT(a) ,a,
 #define M_IT_TYPE_IT_TYPE(a)     ,a,
@@ -2809,7 +2808,6 @@ static inline size_t m_core_cstr_hash(const char str[])
 #define M_GET_HASH(...)      M_GET_METHOD(HASH,        M_NO_DEFAULT,       __VA_ARGS__)
 #define M_GET_EQUAL(...)     M_GET_METHOD(EQUAL,       M_EQUAL_DEFAULT,    __VA_ARGS__)
 #define M_GET_CMP(...)       M_GET_METHOD(CMP,         M_CMP_DEFAULT,      __VA_ARGS__)
-#define M_GET_UPDATE(...)    M_GET_METHOD(UPDATE,      M_SET_DEFAULT,      __VA_ARGS__)
 #define M_GET_TYPE(...)      M_GET_METHOD(TYPE,        M_NO_DEF_TYPE,      __VA_ARGS__)
 #define M_GET_SUBTYPE(...)   M_GET_METHOD(SUBTYPE,     M_NO_DEF_TYPE,      __VA_ARGS__)
 #define M_GET_NAME(...)      M_GET_METHOD(NAME,        M_NO_DEF_TYPE,      __VA_ARGS__)
@@ -2884,7 +2882,6 @@ static inline size_t m_core_cstr_hash(const char str[])
 #define M_CALL_HASH(oplist, ...) M_APPLY_API(M_GET_HASH oplist, oplist, __VA_ARGS__)
 #define M_CALL_EQUAL(oplist, ...) M_APPLY_API(M_GET_EQUAL oplist, oplist, __VA_ARGS__)
 #define M_CALL_CMP(oplist, ...) M_APPLY_API(M_GET_CMP oplist, oplist, __VA_ARGS__)
-#define M_CALL_UPDATE(oplist, ...) M_APPLY_API(M_GET_UPDATE oplist, oplist, __VA_ARGS__)
 //#define M_CALL_TYPE(oplist, ...) M_APPLY_API(M_GET_TYPE oplist, oplist, __VA_ARGS__)
 //#define M_CALL_SUBTYPE(oplist, ...) M_APPLY_API(M_GET_SUBTYPE oplist, oplist, __VA_ARGS__)
 //#define M_CALL_NAME(oplist, ...) M_APPLY_API(M_GET_NAME oplist, oplist, __VA_ARGS__)

m-dict.h

@@ -991,7 +991,7 @@
     M_C(name, _clean)(d2);                                                    \
   }                                                                           \
   ,                                                                           \
-  M_IF_METHOD(UPDATE, value_oplist)(                                          \
+  M_IF_METHOD(ADD, value_oplist)(                                             \
   static inline void                                                          \
   M_C(name, _splice)(dict_t d1, dict_t d2)                                    \
   {                                                                           \
@@ -1005,7 +1005,7 @@
       if (ptr == NULL) {                                                      \
         M_C(name, _set_at)(d1, item->key, item->value);                       \
       } else {                                                                \
-        M_CALL_UPDATE(value_oplist, *ptr, item->value);                       \
+        M_CALL_ADD(value_oplist, *ptr, *ptr, item->value);                    \
       }                                                                       \
     }                                                                         \
     M_C(name, _clean)(d2);                                                    \

m-rbtree.h

@@ -151,7 +151,6 @@ typedef enum {
                && ((node)->child[1] == NULL || M_RBTR33_IS_BLACK(node->child[1])))); \
   } while (0)
 
-//TODO: UPDATE method shall be a separate method than push method
 
 /* Deferred evaluation for the rbtree definition,
    so that all arguments are evaluated before further expansion */
@@ -346,9 +345,7 @@ typedef enum {
     }                                                                         \
     /* If found, update the data (default is set) */                          \
     if (n != NULL) {                                                          \
-      /* FIXME: Use of SET method instead of UPDATE ? */                      \
-      M_IF_METHOD (UPDATE, oplist)(M_CALL_UPDATE(oplist, n->data, data)       \
-                                   , M_CALL_SET(oplist, n->data, data));      \
+      M_CALL_SET(oplist, n->data, data);                                      \
       M_RBTR33_CONTRACT (tree);                                               \
       return;                                                                 \
     }                                                                         \

tests/test-mdict.c

@@ -30,11 +30,11 @@
 
 static inline bool oor_equal_p(int k, unsigned char n) { return k == (int)-n-1; }
 static inline void oor_set(int *k, unsigned char n) { *k = (int)-n-1; }
-static inline void update_value (int *p, const int val) { *p += val; }
+static inline void update_value (int *p, const int p1, const int p2) { *p = p1 + p2; }
 #include "coverage.h"
 START_COVERAGE
 DICT_DEF2(dict_str, string_t, STRING_OPLIST, string_t, STRING_OPLIST)
-DICT_OA_DEF2(dict_oa_int, int, M_OPEXTEND(M_DEFAULT_OPLIST, OOR_EQUAL(oor_equal_p), OOR_SET(oor_set M_IPTR)), int, M_OPEXTEND(M_DEFAULT_OPLIST, UPDATE(update_value M_IPTR)))
+DICT_OA_DEF2(dict_oa_int, int, M_OPEXTEND(M_DEFAULT_OPLIST, OOR_EQUAL(oor_equal_p), OOR_SET(oor_set M_IPTR)), int, M_OPEXTEND(M_DEFAULT_OPLIST, ADD(update_value M_IPTR)))
 END_COVERAGE
 
 DICT_STOREHASH_DEF2(dict_str2, string_t, STRING_OPLIST, string_t, STRING_OPLIST)