Adding a first very basic documentation to data types implementations.
[platform/upstream/libgee.git] / gee / functions.vala
1 /* functions.vala
2  *
3  * Copyright (C) 2009  Maciej Piechotka
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
18  *
19  * Author:
20  *      Maciej Piechotka <uzytkownik2@gmail.com>
21  */
22
23 using GLib;
24
25 namespace Gee {
26
27         public class Functions {
28
29                 /**
30                  * Get a equality testing function for a given type.
31                  *
32                  * @param t the type which to get an equality testing function for.
33                  *
34                  * @return the equality testing function corresponding to the given type.
35                  */
36                 public static EqualFunc get_equal_func_for (Type t) {
37                         if (t == typeof (string)) {
38                                 return str_equal;
39                         } else {
40                                 return direct_equal;
41                         }
42                 }
43
44                 /**
45                  * Get a hash function for a given type.
46                  *
47                  * @param t the type which to get the hash function for.
48                  *
49                  * @return the hash function corresponding to the given type.
50                  */
51                 public static HashFunc get_hash_func_for (Type t) {
52                         if (t == typeof (string)) {
53                                 return str_hash;
54                         } else {
55                                 return direct_hash;
56                         }
57                 }
58
59                 /**
60                  * Get a comparator function for a given type.
61                  *
62                  * @param t the type which to get a comparator function for.
63                  *
64                  * @return the comparator function corresponding to the given type.
65                  */
66                 public static CompareFunc get_compare_func_for (Type t) {
67                         if (t == typeof (string)) {
68                                 return (CompareFunc) strcmp;
69                         } else {
70                                 return direct_compare;
71                         }
72                 }
73         }
74
75         /**
76          * Compares to arbitrary elements together.
77          *
78          * The comparison is done on pointers and not on values behind.
79          *
80          * @param _val1 the first value to compare.
81          * @param _val2 the second value to compare.
82          *
83          * @return a negative value if _val1 is lesser than _val2, a positive value
84          *         if _val1 is greater then _val2 and zero if both are equal.
85          */
86         public static int direct_compare (void* _val1, void* _val2) {
87                 long val1 = (long)_val1, val2 = (long)_val2;
88                 if (val1 > val2) {
89                         return 1;
90                 } else if (val1 == val2) {
91                         return 0;
92                 } else {
93                         return -1;
94                 }
95         }
96 }