common/tr_list.c

   1 /*
   2  * Copyright (c) 2018 JANET(UK)
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * 3. Neither the name of JANET(UK) nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  24  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  25  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  29  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  31  * OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34 #include <talloc.h>
  35 #include <tr_list.h>
  36
  37 static int tr_list_destructor(void *object)
  38 {
  39   TR_LIST *list = talloc_get_type_abort(object, TR_LIST);
  40   if (*list)
  41     g_ptr_array_unref(*list);
  42   return 0;
  43 }
  44
  45 /* Note that the TR_LIST type is a pointer-to-pointer to
  46  * a GPtrArray. This is done so that we can hook a talloc destructor
  47  * to the list to ensure that the GLib reference count is handled correctly
  48  * when used with talloc. */
  49 TR_LIST *tr_list_new(TALLOC_CTX *mem_ctx)
  50 {
  51   TR_LIST *list = talloc(mem_ctx, TR_LIST);
  52   if (list) {
  53     *list = g_ptr_array_new();
  54     if (*list == NULL) {
  55       talloc_free(list);
  56       return NULL;
  57     }
  58     talloc_set_destructor((void *)list, tr_list_destructor);
  59   }
  60   return list;
  61 }
  62
  63 void tr_list_free(TR_LIST *list)
  64 {
  65   talloc_free(list);
  66 }
  67
  68 void *tr_list_add(TR_LIST *list, void *item)
  69 {
  70   guint old_len = (*list)->len;
  71   g_ptr_array_add((*list), item);
  72
  73   if ((*list)->len == old_len)
  74     return NULL; /* failed to add */
  75
  76   return item;
  77 }
  78
  79 TR_LIST_ITER *tr_list_iter_new(TALLOC_CTX *mem_ctx)
  80 {
  81   TR_LIST_ITER *iter = talloc(mem_ctx, TR_LIST_ITER);
  82   if (iter)
  83     iter->list = NULL;
  84   return iter;
  85 }
  86
  87 void tr_list_iter_free(TR_LIST_ITER *iter)
  88 {
  89   talloc_free(iter);
  90 }
  91
  92 void *tr_list_iter_first(TR_LIST_ITER *iter, TR_LIST *list)
  93 {
  94   if (!iter || !list || (!(*list)))
  95     return NULL;
  96
  97   iter->list = list;
  98   iter->index = 0;
  99   return tr_list_iter_next(iter);
 100 }
 101
 102 void *tr_list_iter_next(TR_LIST_ITER *iter)
 103 {
 104   if (!iter)
 105     return NULL;
 106
 107   if (iter->index < (*(iter->list))->len)
 108     return g_ptr_array_index(*(iter->list), iter->index++);
 109   return NULL;
 110 }
 111
 112 void tr_list_foreach(TR_LIST *list, void (*function)(void *, void *), void *cookie)
 113 {
 114   g_ptr_array_foreach((*list), function, cookie);
 115 }