adg/adg-pair.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-pair
  23  * @Section_Id:AdgPair
  24  * @title: AdgPair
  25  * @short_description: A wrapper for #CpmlPair
  26  *
  27  * AdgPair is a wrapper in #GType syntax of the #CpmlPair struct.
  28  **/
  29
  30 /**
  31  * AdgPair:
  32  *
  33  * Another name for #CpmlPair: check its documentation for the
  34  * fields description and visibility details.
  35  **/
  36
  37
  38 #include "adg-internal.h"
  39 #include "adg-pair.h"
  40 #include <string.h>
  41
  42
  43 GType
  44 adg_pair_get_type(void)
  45 {
  46     static int pair_type = 0;
  47
  48     if (G_UNLIKELY(pair_type == 0))
  49         pair_type = g_boxed_type_register_static("AdgPair",
  50                                                  (GBoxedCopyFunc) adg_pair_dup,
  51                                                  g_free);
  52
  53     return pair_type;
  54 }
  55
  56 /**
  57  * adg_pair_dup:
  58  * @pair: an #AdgPair structure
  59  *
  60  * Duplicates @pair.
  61  *
  62  * Returns: the duplicate of @pair: must be freed with g_free()
  63  *           when no longer needed.
  64  **/
  65 AdgPair *
  66 adg_pair_dup(const AdgPair *pair)
  67 {
  68     /* g_memdup() returns NULL if pair is NULL */
  69     return g_memdup(pair, sizeof(AdgPair));
  70 }
  71
  72 /**
  73  * adg_pair_equal:
  74  * @pair1: the first pair to compare
  75  * @pair2: the second pair to compare
  76  *
  77  * Compares @pair1 and @pair2 and returns %TRUE if the pairs are equals.
  78  *
  79  * Returns: %TRUE if @pair1 is equal to @pair2, %FALSE otherwise
  80  **/
  81 gboolean
  82 adg_pair_equal(const AdgPair *pair1, const AdgPair *pair2)
  83 {
  84     g_return_val_if_fail(pair1 != NULL, FALSE);
  85     g_return_val_if_fail(pair2 != NULL, FALSE);
  86
  87     return pair1->x == pair2->x && pair1->y == pair2->y;
  88 }