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>      *
 *               2014 Aaron Laws <dartmetrash@gmail.com>            *
 *                                                                  *
 * 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 <glib-object.h>
#include <stddef.h>

#ifdef __cplusplus
extern "C"
{
#endif

#define GUID_DATA_SIZE  16

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

/* We use two definitions for gncguid: one when compiling for C (so that
 * the object can be persisted), and a different one when compiling for C++
 * found in guid.hpp
 */
#ifdef __cplusplus
namespace gnc {
struct GUID;
}
#endif

typedef struct _gncGuid {
    unsigned char reserved[GUID_DATA_SIZE];
} GncGUID;

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

#define GUID_ENCODING_LENGTH 32

void guid_replace (GncGUID *guid);

GncGUID guid_new_return (void);

const GncGUID * guid_null (void);

GncGUID * guid_malloc (void);

GncGUID * guid_new (void);

/*Free the guid pointed to. Do not use this guid any more.*/
void   guid_free (GncGUID *guid);

GncGUID *guid_copy (const GncGUID *guid);

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);

/* @} */
/* @} */
#ifdef __cplusplus
}
#endif

#endif