/*
 *  libMirage: index
 *  Copyright (C) 2006-2014 Rok Mandeljc
 *
 *  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, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef __MIRAGE_INDEX_H__
#define __MIRAGE_INDEX_H__

#include <mirage/types.h>


G_BEGIN_DECLS


/**********************************************************************\
 *                          MirageIndex object                        *
\**********************************************************************/
#define MIRAGE_TYPE_INDEX            (mirage_index_get_type())
#define MIRAGE_INDEX(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), MIRAGE_TYPE_INDEX, MirageIndex))
#define MIRAGE_INDEX_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass), MIRAGE_TYPE_INDEX, MirageIndexClass))
#define MIRAGE_IS_INDEX(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), MIRAGE_TYPE_INDEX))
#define MIRAGE_IS_INDEX_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), MIRAGE_TYPE_INDEX))
#define MIRAGE_INDEX_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), MIRAGE_TYPE_INDEX, MirageIndexClass))

typedef struct _MirageIndexClass   MirageIndexClass;
typedef struct _MirageIndexPrivate MirageIndexPrivate;

/**
 * MirageIndex:
 *
 * All the fields in the <structname>MirageIndex</structname>
 * structure are private to the #MirageIndex implementation and
 * should never be accessed directly.
 */
struct _MirageIndex
{
    MirageObject parent_instance;

    /*< private >*/
    MirageIndexPrivate *priv;
};

/**
 * MirageIndexClass:
 * @parent_class: the parent class
 *
 * The class structure for the <structname>MirageIndex</structname> type.
 */
struct _MirageIndexClass
{
    MirageObjectClass parent_class;
};

/* Used by MIRAGE_TYPE_INDEX */
GType mirage_index_get_type (void);

void mirage_index_set_number (MirageIndex *self, gint number);
gint mirage_index_get_number (MirageIndex *self);

void mirage_index_set_address (MirageIndex *self, gint address);
gint mirage_index_get_address (MirageIndex *self);

G_END_DECLS

#endif /* __MIRAGE_INDEX_H__ */
