/*****************************************************************************
 * Copyright (c) 2005  Daniel Lerch Hostalot <http://daniellerch.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a 
 * copy of this software and associated documentation files (the "Software"), 
 * to deal in the Software without restriction, including without limitation 
 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 
 * and/or sell copies of the Software, and to permit persons to whom the 
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in 
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
 * DEALINGS IN THE SOFTWARE.
 ****************************************************************************/


#ifndef __DATABASE_H__
#define __DATABASE_H__

#ifdef __cplusplus
extern "C" {
#endif


#include "resultset.h"
#include <mysql.h>

/**
 *  Tipo de representacion de una base de datos.  
 */
typedef struct  database_t
{
   MYSQL *conn;
   char dbname[256];
   char dbuser[256];
   char dbpass[256];
   char dbhost[256];
}
database_t;

/**
 *  Crea un tipo de acceso a bases de datos.
 *
 *  @return database_t: tipo de acceso a bases de datos.
 */
database_t* database_new();

/**
 *  Libera la memoria reservada.
 *
 *  @param *obj: Objeto con el que trabaja.
 */
void database_free(database_t *obj);


/**
 *  Obtiene el nombre de usuario de la base de datos
 *
 *  @param *obj: Objeto con el que trabaja.
 *  @return char*: Nombre del usuario
 */
char *database_get_dbuser(database_t *obj);

/**
 *  Modifica el nombre de usuario de la base de datos
 *
 *  @param *obj: Objeto con el que trabaja.
 *  @param *user: Nombre del usuario
 */
void database_set_dbuser(database_t *obj, char *user);

/**
 *  Obtiene el nombre de la base de datos
 *
 *  @param *obj: Objeto con el que trabaja.
 *  @return char*: Nombre de la base de datos
 */
char* database_get_dbname(database_t *obj);

/**
 *  Modifica el nombre de la base de datos
 *
 *  @param *obj: Objeto con el que trabaja.
 *  @param *name: Nombre de la base de datos
 */
void database_set_dbname(database_t *obj, char *name);

/**
 *  Modifica el password del usuario de la base de datos
 *
 *  @param *obj: Objeto con el que trabaja.
 *  @param *passw: Password del usuario
 */
void database_set_dbpass(database_t *obj, char* passw);

/**
 *  Obtiene el host de la base de datos
 *
 *  @param *obj: Objeto con el que trabaja.
 *  @return char*: Host de la base de datos
 */
char *database_get_dbhost(database_t *obj);

/**
 *  Modifica el host de la base de datos
 *
 *  @param *obj: Objeto con el que trabaja.
 *  @param *host: Host de la base de datos
 */
void database_set_dbhost(database_t *obj, char* host);

/**
 *  Conecta a la base de datos
 *
 *  @param *obj: Objeto con el que trabaja.
 *  @return int: 1 conexion correcta, 0 en caso contrario.
 */
int database_connect(database_t *obj);

/**
 *  Desconecta de la base de datos
 *
 *  @param *obj: Objeto con el que trabaja.
 */
void database_disconnect(database_t *obj);

/**
 *  Ejecuta una consulta.
 *
 *  @param *obj: Objeto con el que trabaja.
 *  @param *query: Consulta a ejecutar.
 *  @return resultset_t: Resultset con el resultado de la consulta.
 */
resultset_t *database_execquery (database_t *obj, char* query);

/**
 *  Inicia una transaccion en la base de datos
 *
 *  @param *obj: Objeto con el que trabaja.
 */
void database_transaction_start(database_t *obj);

/**
 *  Guarda los cambios de una transaccion.
 *
 *  @param *obj: Objeto con el que trabaja.
 */
void database_transaction_commit(database_t *obj);

/**
 *  Deshace los cambios de una transaccion.
 *
 *  @param *obj: Objeto con el que trabaja.
 */
void database_transaction_rollback(database_t *obj);

#ifdef __cplusplus
}
#endif

#endif