/* gchecksum.h - data hashing functions
 *
 * Copyright (C) 2007  Emmanuele Bassi  <ebassi@gnome.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */


#ifndef __G_CHECKSUM_H__
#define __G_CHECKSUM_H__

#include <glib.h>

G_BEGIN_DECLS

/**
 * GChecksumType:
 * @G_CHECKSUM_MD5: Use the MD5 hashing algorithm
 * @G_CHECKSUM_SHA1: Use the SHA-1 hashing algorithm
 * @G_CHECKSUM_SHA256: Use the SHA-256 hashing algorithm
 *
 * The hashing algorithm to be used by #GChecksum when performing the
 * digest of some data.
 *
 * Note that the #GChecksumType enumeration may be extended at a later 
 * date to include new hashing algorithm types. 
 *
 * Since: 2.16
 */
typedef enum {
  G_CHECKSUM_MD5,
  G_CHECKSUM_SHA1,
  G_CHECKSUM_SHA256
} GChecksumType;

/**
 * GChecksum:
 *
 * An opaque structure representing a checksumming operation.
 * To create a new GChecksum, use g_checksum_new(). To free
 * a GChecksum, use g_checksum_free().
 *
 * Since: 2.16
 */
typedef struct _GChecksum       GChecksum;

gssize                g_checksum_type_get_length (GChecksumType checksum_type);

GChecksum *           g_checksum_new        (GChecksumType     checksum_type);
void                  g_checksum_reset      (GChecksum        *checksum);
GChecksum *           g_checksum_copy       (const GChecksum  *checksum);
void                  g_checksum_free       (GChecksum        *checksum);
void                  g_checksum_update     (GChecksum        *checksum,
                                             const guchar     *data,
                                             gssize            length);
G_CONST_RETURN gchar *g_checksum_get_string (GChecksum        *checksum);
void                  g_checksum_get_digest (GChecksum        *checksum,
                                             guint8           *buffer,
                                             gsize            *digest_len);

gchar *g_compute_checksum_for_data   (GChecksumType  checksum_type,
                                      const guchar  *data,
                                      gsize          length);
gchar *g_compute_checksum_for_string (GChecksumType  checksum_type,
                                      const gchar   *str,
                                      gssize         length);

G_END_DECLS

#endif /* __G_CHECKSUM_H__ */