adg/adg-util.c

   1 /* ADG - Automatic Drawing Generation
   2  * Copyright (C) 2007,2008,2009,2010  Nicola Fontana <ntd at entidi.it>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  * Boston, MA  02110-1301, USA.
  18  */
  19
  20
  21 /**
  22  * SECTION:adg-util
  23  * @Section_Id:utilities
  24  * @title: Utilities
  25  * @short_description: Assorted macros and functions
  26  *
  27  * Collection of macros and functions that do not fit inside any other topic.
  28  **/
  29
  30 /**
  31  * ADG_DIR_RIGHT:
  32  *
  33  * Symbolic constant for the right direction (in radians).
  34  **/
  35
  36 /**
  37  * ADG_DIR_DOWN:
  38  *
  39  * Symbolic constant for the down direction (in radians).
  40  **/
  41
  42 /**
  43  * ADG_DIR_LEFT:
  44  *
  45  * Symbolic constant for the left direction (in radians).
  46  **/
  47
  48 /**
  49  * ADG_DIR_UP:
  50  *
  51  * Symbolic constant for the up direction (in radians).
  52  **/
  53
  54 /**
  55  * ADG_FORWARD_DECL:
  56  * @id: The name of a struct
  57  *
  58  * Forward declaration of struct @id. It is equivalent to a typical
  59  * struct forward declaration, for example:
  60  *
  61  * |[
  62  * ADG_FORWARD_DECL(test)
  63  * ]|
  64  *
  65  * will expand to:
  66  *
  67  * |[
  68  * typedef struct _test test
  69  * ]|
  70  *
  71  * This macro is needed to fake <command>gtk-doc</command>, because
  72  * up to now (v.1.12) it generates two conflicting links when using
  73  * forward declarations: the first in the source with the declaration
  74  * and the second where the type is defined. Using ADG_FORWARD_DECL()
  75  * instead of the usual typedef avoids the parsing of the declaration
  76  * in the first file (<command>gtk-doc</command> is not able to do C
  77  * preprocessing).
  78  *
  79  * The same principle can be applied in the definition file. Following
  80  * the previous example, you can use something like this where struct
  81  * _type is defined:
  82  *
  83  * |[
  84  * #if 0
  85  * // This is declared in another file
  86  * typedef struct _type type;
  87  * #endif
  88  * struct _type {
  89  * ...
  90  * };
  91  * ]|
  92  **/
  93
  94
  95 #include "adg-internal.h"
  96 #include "adg-util.h"
  97 #include <string.h>
  98 #include <limits.h>
  99
 100
 101 #if GLIB_CHECK_VERSION(2, 16, 0)
 102 #else
 103 /**
 104  * adg_strcmp:
 105  * @s1: first string to compare
 106  * @s2: second string to compare
 107  *
 108  * A strcmp() function guarded against %NULL values. If glib-2.16.0 or
 109  * greather is used, adg_strcmp() will be an alias for g_strcmp0.
 110  * Otherwise the function will behave in the same way as strcmp() with
 111  * the following exceptions:
 112  *
 113  * <itemizedlist>
 114  * <listitem><code>s1 == NULL && s2 == NULL</code>: returns %0;</listitem>
 115  * <listitem><code>s1 == NULL</code>: returns %INT_MIN;</listitem>
 116  * <listitem><code>s2 == NULL</code>: returns %INT_MAX.</listitem>
 117  * </itemizedlist>
 118  *
 119  * Returns: %0 if @s1 matches @s2, a value less than %0 if @s1 is less
 120  *          than @s2 or greather than %0 if @s1 is greather than @s2
 121  **/
 122 gint
 123 adg_strcmp(const gchar *s1, const gchar *s2)
 124 {
 125     /* This will also catch the NULL == NULL case */
 126     if (s1 == s2)
 127         return 0;
 128
 129     if (s1 == NULL)
 130         return INT_MIN;
 131
 132     if (s2 == NULL)
 133         return INT_MAX;
 134
 135     return strcmp(s1, s2);
 136 }
 137 #endif
 138
 139 /**
 140  * adg_is_string_empty:
 141  * @str: the subject string
 142  *
 143  * Checks if @str is an empty string, that is if is %NULL or if
 144  * its first character is %'\0'.
 145  *
 146  * Returns: %TRUE if @str is an empty string, %FALSE otherwise
 147  **/
 148 gboolean
 149 adg_is_string_empty(const gchar *str)
 150 {
 151     return str == NULL || str[0] == '\0';
 152 }
 153
 154 /**
 155  * adg_is_enum_value:
 156  * @value: the enum value to check
 157  * @enum_type: a #GEnum based type
 158  *
 159  * Checks if @value is a valid @enum_type value.
 160  *
 161  * Returns: %TRUE if @value is a valid @enum_type, %FALSE otherwise
 162  **/
 163 gboolean
 164 adg_is_enum_value(int value, GType enum_type)
 165 {
 166     GEnumClass *enum_class;
 167     gboolean found;
 168
 169     enum_class = g_type_class_ref(enum_type);
 170     g_return_val_if_fail(enum_class != NULL, FALSE);
 171
 172     found = FALSE;
 173
 174     if (value >= enum_class->minimum && value <= enum_class->maximum) {
 175         GEnumValue *enum_value;
 176         guint n;
 177
 178         for (n = 0; !found && n < enum_class->n_values; ++n) {
 179             enum_value = enum_class->values + n;
 180             found = value == enum_value->value;
 181         }
 182     }
 183
 184     g_type_class_unref(enum_class);
 185
 186     return found;
 187 }
 188
 189 /**
 190  * adg_is_boolean_value:
 191  * @value: the gboolean value to check
 192  *
 193  * Checks if @value is a valid #gboolean value, that is if it is %TRUE
 194  * or %FALSE. No other values are accepted.
 195  *
 196  * Returns: %TRUE if @value is a valid #gboolean, %FALSE otherwise
 197  **/
 198 gboolean
 199 adg_is_boolean_value(gboolean value)
 200 {
 201     return value == TRUE || value == FALSE;
 202 }