guid.h

Go to the documentation of this file.

/********************************************************************\
 * guid.h -- globally unique ID User API                            *
 * Copyright (C) 2000 Dave Peticolas <peticola@cs.ucdavis.edu>      *
 *                                                                  *
 * This program is free software; you can redistribute it and/or    *
 * modify it under the terms of the GNU General Public License as   *
 * published by the Free Software Foundation; either version 2 of   *
 * the License, or (at your option) any later version.              *
 *                                                                  *
 * This program is distributed in the hope that it will be useful,  *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of   *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    *
 * GNU General Public License for more details.                     *
 *                                                                  *
 * You should have received a copy of the GNU General Public License*
 * along with this program; if not, contact:                        *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
 * Boston, MA  02110-1301,  USA       gnu@gnu.org                   *
 *                                                                  *
\********************************************************************/

#ifndef GUID_H
#define GUID_H

#include <stddef.h>
#include <glib-object.h>

#define GUID_DATA_SIZE  16
typedef union GNC_INTERNAL_GUID
{
    guchar data[GUID_DATA_SIZE];

    gint __align_me; /* this just ensures that GUIDs are 32-bit
                   * aligned on systems that need them to be. */
} GncGUID;


#define GNC_TYPE_GUID (gnc_guid_get_type())
#define GNC_VALUE_HOLDS_GUID(value) G_VALUE_HOLDS(value, GNC_TYPE_GUID)

GType gnc_guid_get_type (void);
G_CONST_RETURN GncGUID* gnc_value_get_guid (const GValue *value);

#define GUID_ENCODING_LENGTH 32


void guid_init(void);

void guid_shutdown (void);

void guid_new(GncGUID *guid);

GncGUID guid_new_return(void);

const GncGUID * guid_null (void);

GncGUID * guid_malloc (void);

/* Return a guid set to all zero's */
void   guid_free (GncGUID *guid);

GncGUID *guid_copy (const GncGUID *guid);

const gchar * guid_to_string (const GncGUID * guid);

gchar * guid_to_string_buff (const GncGUID * guid, /*@ out @*/ gchar *buff);


gboolean string_to_guid(const gchar * string, /*@ out @*/ GncGUID * guid);


gboolean guid_equal(const GncGUID *guid_1, const GncGUID *guid_2);
gint     guid_compare(const GncGUID *g1, const GncGUID *g2);

guint guid_hash_to_guint(gconstpointer ptr);

gint guid_g_hash_table_equal (gconstpointer guid_a, gconstpointer guid_b);

GHashTable *guid_hash_table_new(void);

/* @} */
/* @} */
#endif