add some const qualifiers

Tue, 28 Dec 2021 17:38:02 +0100

author
Mike Becker <universe@uap-core.de>
date
Tue, 28 Dec 2021 17:38:02 +0100
changeset 489
af6be1e123aa
parent 488
9138acaa494b
child 490
e66551b47466

add some const qualifiers

src/buffer.c file | annotate | diff | comparison | revisions
src/cx/buffer.h file | annotate | diff | comparison | revisions
src/cx/linked_list.h file | annotate | diff | comparison | revisions
src/cx/list.h file | annotate | diff | comparison | revisions
src/linked_list.c file | annotate | diff | comparison | revisions
test/test_list.c file | annotate | diff | comparison | revisions
     1.1 --- a/src/buffer.c	Tue Dec 28 17:24:18 2021 +0100
     1.2 +++ b/src/buffer.c	Tue Dec 28 17:38:02 2021 +0100
     1.3 @@ -158,7 +158,7 @@
     1.4  }
     1.5  
     1.6  size_t cxBufferWrite(
     1.7 -        const void *ptr,
     1.8 +        void const *ptr,
     1.9          size_t size,
    1.10          size_t nitems,
    1.11          CxBuffer buffer
     2.1 --- a/src/cx/buffer.h	Tue Dec 28 17:24:18 2021 +0100
     2.2 +++ b/src/cx/buffer.h	Tue Dec 28 17:38:02 2021 +0100
     2.3 @@ -302,7 +302,7 @@
     2.4   * @return the total count of bytes written
     2.5   */
     2.6  size_t cxBufferWrite(
     2.7 -        const void *ptr,
     2.8 +        void const *ptr,
     2.9          size_t size,
    2.10          size_t nitems,
    2.11          CxBuffer buffer
     3.1 --- a/src/cx/linked_list.h	Tue Dec 28 17:24:18 2021 +0100
     3.2 +++ b/src/cx/linked_list.h	Tue Dec 28 17:38:02 2021 +0100
     3.3 @@ -90,7 +90,7 @@
     3.4          CxListComparator comparator,
     3.5          size_t item_size,
     3.6          size_t num_items,
     3.7 -        const void *array
     3.8 +        void const *array
     3.9  ) __attribute__((__nonnull__));
    3.10  
    3.11  /**
    3.12 @@ -139,12 +139,12 @@
    3.13   * @return the index of the element or a past-one index if the element could not be found
    3.14   */
    3.15  size_t cx_linked_list_find(
    3.16 -        void *start,
    3.17 +        void const *start,
    3.18          ptrdiff_t loc_advance,
    3.19          ptrdiff_t loc_data,
    3.20          bool follow_ptr,
    3.21          CxListComparator cmp_func,
    3.22 -        void *elem
    3.23 +        void const *elem
    3.24  ) __attribute__((__nonnull__));
    3.25  
    3.26  /**
    3.27 @@ -355,7 +355,7 @@
    3.28   * @return the size of the list or zero if \p node is \c NULL
    3.29   */
    3.30  size_t cx_linked_list_size(
    3.31 -        void *node,
    3.32 +        void const *node,
    3.33          ptrdiff_t loc_next
    3.34  );
    3.35  
    3.36 @@ -416,8 +416,8 @@
    3.37   * @return
    3.38   */
    3.39  int cx_linked_list_compare(
    3.40 -        void *begin_left,
    3.41 -        void *begin_right,
    3.42 +        void const *begin_left,
    3.43 +        void const *begin_right,
    3.44          ptrdiff_t loc_advance,
    3.45          ptrdiff_t loc_data,
    3.46          bool follow_ptr,
     4.1 --- a/src/cx/list.h	Tue Dec 28 17:24:18 2021 +0100
     4.2 +++ b/src/cx/list.h	Tue Dec 28 17:38:02 2021 +0100
     4.3 @@ -47,7 +47,10 @@
     4.4  /**
     4.5   * A comparator function comparing two list elements.
     4.6   */
     4.7 -typedef int(*CxListComparator)(void const *left, void const *right);
     4.8 +typedef int(*CxListComparator)(
     4.9 +        void const *left,
    4.10 +        void const *right
    4.11 +);
    4.12  
    4.13  /**
    4.14   * Internal type for the list structure - use CxList instead.
    4.15 @@ -61,29 +64,42 @@
    4.16      /**
    4.17       * Member function for adding an element.
    4.18       */
    4.19 -    int (*add)(cx_list_s *list, void *elem);
    4.20 +    int (*add)(
    4.21 +            cx_list_s *list,
    4.22 +            void const *elem
    4.23 +    );
    4.24  
    4.25      /**
    4.26       * Member function for inserting an element.
    4.27       */
    4.28 -    int (*insert)(cx_list_s *list, size_t index, void *elem);
    4.29 +    int (*insert)(
    4.30 +            cx_list_s *list,
    4.31 +            size_t index,
    4.32 +            void const *elem
    4.33 +    );
    4.34  
    4.35      /**
    4.36       * Member function for removing an element.
    4.37       */
    4.38 -    int (*remove)(cx_list_s *list, size_t index);
    4.39 +    int (*remove)(
    4.40 +            cx_list_s *list,
    4.41 +            size_t index
    4.42 +    );
    4.43  
    4.44      /**
    4.45       * Member function for element lookup.
    4.46       */
    4.47 -    void *(*at)(cx_list_s *list, size_t index);
    4.48 +    void *(*at)(
    4.49 +            cx_list_s const *list,
    4.50 +            size_t index
    4.51 +    );
    4.52  
    4.53      /**
    4.54       * Member function for finding an element.
    4.55       */
    4.56      size_t (*find)(
    4.57 -            cx_list_s *list,
    4.58 -            void *elem
    4.59 +            cx_list_s const *list,
    4.60 +            void const *elem
    4.61      );
    4.62  
    4.63      /**
    4.64 @@ -95,8 +111,8 @@
    4.65       * Member function for comparing this list to another list of the same type.
    4.66       */
    4.67      int (*compare)(
    4.68 -            cx_list_s *list,
    4.69 -            cx_list_s *other
    4.70 +            cx_list_s const *list,
    4.71 +            cx_list_s const *other
    4.72      );
    4.73  } cx_list_class;
    4.74  
    4.75 @@ -147,7 +163,10 @@
    4.76   * @param elem a pointer to the element to add
    4.77   * @return zero on success, non-zero on memory allocation failure
    4.78   */
    4.79 -static inline int cxListAdd(CxList list, void *elem) {
    4.80 +static inline int cxListAdd(
    4.81 +        CxList list,
    4.82 +        void const *elem
    4.83 +) {
    4.84      return list->cl->add(list, elem);
    4.85  }
    4.86  
    4.87 @@ -167,7 +186,11 @@
    4.88   * @return zero on success, non-zero on memory allocation failure
    4.89   * or when the index is out of bounds
    4.90   */
    4.91 -static inline int cxListInsert(CxList list, size_t index, void *elem) {
    4.92 +static inline int cxListInsert(
    4.93 +        CxList list,
    4.94 +        size_t index,
    4.95 +        void const *elem
    4.96 +) {
    4.97      return list->cl->insert(list, index, elem);
    4.98  }
    4.99  
   4.100 @@ -177,7 +200,10 @@
   4.101   * @param index the index of the element
   4.102   * @return zero on success, non-zero if the index is out of bounds
   4.103   */
   4.104 -static inline int cxListRemove(CxList list, size_t index) {
   4.105 +static inline int cxListRemove(
   4.106 +        CxList list,
   4.107 +        size_t index
   4.108 +) {
   4.109      return list->cl->remove(list, index);
   4.110  }
   4.111  
   4.112 @@ -188,7 +214,10 @@
   4.113   * @param index the index of the element
   4.114   * @return a pointer to the element or \c NULL if the index is out of bounds
   4.115   */
   4.116 -static inline void *cxListAt(CxList list, size_t index) {
   4.117 +static inline void *cxListAt(
   4.118 +        CxList list,
   4.119 +        size_t index
   4.120 +) {
   4.121      return list->cl->at(list, index);
   4.122  }
   4.123  
   4.124 @@ -201,7 +230,10 @@
   4.125   * @param elem the element to find
   4.126   * @return the index of the element or \c (size+1) if the element is not found
   4.127   */
   4.128 -static inline size_t cxListFind(CxList list, void *elem) {
   4.129 +static inline size_t cxListFind(
   4.130 +        CxList list,
   4.131 +        void const *elem
   4.132 +) {
   4.133      return list->cl->find(list, elem);
   4.134  }
   4.135  
     5.1 --- a/src/linked_list.c	Tue Dec 28 17:24:18 2021 +0100
     5.2 +++ b/src/linked_list.c	Tue Dec 28 17:38:02 2021 +0100
     5.3 @@ -57,19 +57,19 @@
     5.4  }
     5.5  
     5.6  size_t cx_linked_list_find(
     5.7 -        void *start,
     5.8 +        void const *start,
     5.9          ptrdiff_t loc_advance,
    5.10          ptrdiff_t loc_data,
    5.11          bool follow_ptr,
    5.12          CxListComparator cmp_func,
    5.13 -        void *elem
    5.14 +        void const *elem
    5.15  ) {
    5.16      assert(start != NULL);
    5.17      assert(loc_advance >= 0);
    5.18      assert(loc_data >= 0);
    5.19      assert(cmp_func);
    5.20  
    5.21 -    void *node = start;
    5.22 +    void const *node = start;
    5.23      size_t index = 0;
    5.24      do {
    5.25          void *current = ll_data(node);
    5.26 @@ -268,7 +268,7 @@
    5.27  }
    5.28  
    5.29  size_t cx_linked_list_size(
    5.30 -        void *node,
    5.31 +        void const *node,
    5.32          ptrdiff_t loc_next
    5.33  ) {
    5.34      assert(loc_next >= 0);
    5.35 @@ -397,14 +397,14 @@
    5.36  }
    5.37  
    5.38  int cx_linked_list_compare(
    5.39 -        void *begin_left,
    5.40 -        void *begin_right,
    5.41 +        void const *begin_left,
    5.42 +        void const *begin_right,
    5.43          ptrdiff_t loc_advance,
    5.44          ptrdiff_t loc_data,
    5.45          bool follow_ptr,
    5.46          CxListComparator cmp_func
    5.47  ) {
    5.48 -    void *left = begin_left, *right = begin_right;
    5.49 +    void const *left = begin_left, *right = begin_right;
    5.50  
    5.51      while (left != NULL && right != NULL) {
    5.52          int result = cmp_func(ll_data(left), ll_data(right));
    5.53 @@ -469,7 +469,7 @@
    5.54  } cx_linked_list;
    5.55  
    5.56  static cx_linked_list_node *cx_ll_node_at(
    5.57 -        cx_linked_list *list,
    5.58 +        cx_linked_list const *list,
    5.59          size_t index
    5.60  ) {
    5.61      if (index >= list->base.size) {
    5.62 @@ -484,7 +484,7 @@
    5.63  static int cx_ll_insert(
    5.64          cx_list_s *list,
    5.65          size_t index,
    5.66 -        void *elem
    5.67 +        void const *elem
    5.68  ) {
    5.69      // out-of bounds check
    5.70      if (index > list->size) return 1;
    5.71 @@ -520,7 +520,7 @@
    5.72  
    5.73  static int cx_ll_add(
    5.74          cx_list_s *list,
    5.75 -        void *elem
    5.76 +        void const *elem
    5.77  ) {
    5.78      return cx_ll_insert(list, list->size, elem);
    5.79  }
    5.80 @@ -528,14 +528,14 @@
    5.81  static int cx_pll_insert(
    5.82          cx_list_s *list,
    5.83          size_t index,
    5.84 -        void *elem
    5.85 +        void const *elem
    5.86  ) {
    5.87      return cx_ll_insert(list, index, &elem);
    5.88  }
    5.89  
    5.90  static int cx_pll_add(
    5.91          cx_list_s *list,
    5.92 -        void *elem
    5.93 +        void const *elem
    5.94  ) {
    5.95      return cx_ll_insert(list, list->size, &elem);
    5.96  }
    5.97 @@ -564,7 +564,7 @@
    5.98  }
    5.99  
   5.100  static void *cx_ll_at(
   5.101 -        cx_list_s *list,
   5.102 +        cx_list_s const *list,
   5.103          size_t index
   5.104  ) {
   5.105      cx_linked_list *ll = (cx_linked_list *) list;
   5.106 @@ -573,7 +573,7 @@
   5.107  }
   5.108  
   5.109  static void *cx_pll_at(
   5.110 -        cx_list_s *list,
   5.111 +        cx_list_s const *list,
   5.112          size_t index
   5.113  ) {
   5.114      cx_linked_list *ll = (cx_linked_list *) list;
   5.115 @@ -582,8 +582,8 @@
   5.116  }
   5.117  
   5.118  static size_t cx_ll_find(
   5.119 -        cx_list_s *list,
   5.120 -        void *elem
   5.121 +        cx_list_s const *list,
   5.122 +        void const *elem
   5.123  ) {
   5.124      return cx_linked_list_find(((cx_linked_list *) list)->begin,
   5.125                                 CX_LL_LOC_NEXT, CX_LL_LOC_DATA,
   5.126 @@ -591,8 +591,8 @@
   5.127  }
   5.128  
   5.129  static size_t cx_pll_find(
   5.130 -        cx_list_s *list,
   5.131 -        void *elem
   5.132 +        cx_list_s const *list,
   5.133 +        void const *elem
   5.134  ) {
   5.135      return cx_linked_list_find(((cx_linked_list *) list)->begin,
   5.136                                 CX_LL_LOC_NEXT, CX_LL_LOC_DATA,
   5.137 @@ -614,8 +614,8 @@
   5.138  }
   5.139  
   5.140  static int cx_ll_compare(
   5.141 -        cx_list_s *list,
   5.142 -        cx_list_s *other
   5.143 +        cx_list_s const *list,
   5.144 +        cx_list_s const *other
   5.145  ) {
   5.146      cx_linked_list *left = (cx_linked_list *) list;
   5.147      cx_linked_list *right = (cx_linked_list *) other;
   5.148 @@ -625,8 +625,8 @@
   5.149  }
   5.150  
   5.151  static int cx_pll_compare(
   5.152 -        cx_list_s *list,
   5.153 -        cx_list_s *other
   5.154 +        cx_list_s const *list,
   5.155 +        cx_list_s const *other
   5.156  ) {
   5.157      cx_linked_list *left = (cx_linked_list *) list;
   5.158      cx_linked_list *right = (cx_linked_list *) other;
   5.159 @@ -703,7 +703,7 @@
   5.160          CxListComparator comparator,
   5.161          size_t item_size,
   5.162          size_t num_items,
   5.163 -        const void *array
   5.164 +        void const *array
   5.165  ) {
   5.166      CxList list = cxLinkedListCreate(allocator, comparator, item_size);
   5.167      if (list == NULL) return NULL;
     6.1 --- a/test/test_list.c	Tue Dec 28 17:24:18 2021 +0100
     6.2 +++ b/test/test_list.c	Tue Dec 28 17:38:02 2021 +0100
     6.3 @@ -52,7 +52,7 @@
     6.4  
     6.5  struct node *create_test_data(
     6.6          size_t n,
     6.7 -        const int data[]
     6.8 +        int const data[]
     6.9  ) {
    6.10      if (n == 0) return NULL;
    6.11      struct node *begin = calloc(1, sizeof(struct node));

mercurial