1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
30 #ifndef __MODEST_PAIR_H__
31 #define __MODEST_PAIR_H__
37 typedef struct _ModestPair {
43 typedef GSList ModestPairList;
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)
52 * create a new ModestPair instance
54 * Returns: a newly allocated ModestPair instance
56 ModestPair* modest_pair_new (gpointer first, gpointer second, gboolean own);
62 * @self: a valid ModestPair instance or NULL
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.
67 void modest_pair_free (ModestPair *self);
71 * modest_pair_list_free:
72 * @pairs: a valid ModestPairList
74 * Convenience function to destroy all pairs in a list and the list itself.
77 void modest_pair_list_free (ModestPairList *pairs);
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.
85 * Find an element with a matching first entry.
87 * Returns: a previously allocated ModestPair instance, or NULL if none was found.
89 ModestPair* modest_pair_list_find_by_first_as_string (ModestPairList *pairs,
94 #endif /* __MODEST_PAIR_H__ */