git.maemo.org Git - modest/blob - src/modest-pair.h

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef __MODEST_PAIR_H__
  31 #define __MODEST_PAIR_H__
  32
  33 #include <glib.h>
  34
  35 G_BEGIN_DECLS
  36
  37 typedef struct _ModestPair {
  38         gpointer *first;
  39         gpointer *second;
  40         gboolean own;
  41 } ModestPair;
  42
  43 typedef GSList ModestPairList;
  44
  45
  46 /**
  47  * modest_pair_new:
  48  * @first: the first element of the pair
  49  * @second: the second element of the pair
  50  * @own: does the pair own the item (ie. should the items be freed when the pair is destroyed)
  51  *
  52  * create a new ModestPair instance
  53  *
  54  * Returns: a newly allocated ModestPair instance
  55  */
  56 ModestPair* modest_pair_new   (gpointer first, gpointer second, gboolean own);
  57
  58
  59
  60 /**
  61  * modest_pair_free:
  62  * @self: a valid ModestPair instance or NULL
  63  *
  64  * free a ModestPair instance. If it was created with own==TRUE, the elements
  65  * will be g_free'd as well. If pair==NULL, nothing will be done.
  66  */
  67 void        modest_pair_free       (ModestPair *self);
  68
  69
  70 /**
  71  * modest_pair_list_free:
  72  * @pairs: a valid ModestPairList
  73  *
  74  * Convenience function to destroy all pairs in a list and the list itself.
  75  *
  76  */
  77 void  modest_pair_list_free (ModestPairList *pairs);
  78
  79 /**
  80  * modest_pair_list_find_by_first
  81  * @pairs: A valid ModestPairList
  82  * @first: The first element of the pair to be found.
  83  * @func: The function to call for each element. It should return 0 when the desired element is found.
  84  *
  85  * Find an element with a matching first entry.
  86  *
  87  * Returns: a previously allocated ModestPair instance, or NULL if none was found.
  88  */
  89 ModestPair* modest_pair_list_find_by_first_as_string  (ModestPairList *pairs,
  90         const gchar* first);
  91
  92 G_END_DECLS
  93
  94 #endif /* __MODEST_PAIR_H__ */