cursor.c

Go to the documentation of this file.

#include <stdlib.h>
#include <grass/dbmi.h>

void db_init_cursor(dbCursor * cursor)
{
    cursor->driver = NULL;
    cursor->token = -1;
    cursor->type = 0;
    cursor->mode = 0;
    cursor->table = NULL;
    cursor->column_flags = NULL;
}

int db_alloc_cursor_table(dbCursor * cursor, int ncols)
{
    cursor->table = db_alloc_table(ncols);
    if (cursor->table == NULL)
        return db_get_error_code();
    return DB_OK;
}

void db_free_cursor(dbCursor * cursor)
{
    if (cursor->table)
        db_free_table(cursor->table);
    if (cursor->column_flags)
        db_free_cursor_column_flags(cursor);
    db_init_cursor(cursor);
}

dbTable *db_get_cursor_table(dbCursor * cursor)
{
    return cursor->table;
}

void db_set_cursor_table(dbCursor * cursor, dbTable * table)
{
    cursor->table = table;
}

dbToken db_get_cursor_token(dbCursor * cursor)
{
    return cursor->token;
}

void db_set_cursor_token(dbCursor * cursor, dbToken token)
{
    cursor->token = token;
}

void db_set_cursor_type_readonly(dbCursor * cursor)
{
    cursor->type = DB_READONLY;
}

void db_set_cursor_type_update(dbCursor * cursor)
{
    cursor->type = DB_UPDATE;
}

void db_set_cursor_type_insert(dbCursor * cursor)
{
    cursor->type = DB_INSERT;
}

int db_test_cursor_type_fetch(dbCursor * cursor)
{
    return (cursor->type == DB_READONLY || cursor->type == DB_UPDATE);
}

int db_test_cursor_type_update(dbCursor * cursor)
{
    return (cursor->type == DB_UPDATE);
}

int db_test_cursor_type_insert(dbCursor * cursor)
{
    return (cursor->type == DB_INSERT);
}

void db_set_cursor_mode(dbCursor * cursor, int mode)
{
    cursor->mode = mode;
}

void db_set_cursor_mode_scroll(dbCursor * cursor)
{
    cursor->mode |= DB_SCROLL;
}

void db_unset_cursor_mode_scroll(dbCursor * cursor)
{
    cursor->mode &= ~DB_SCROLL;
}

void db_unset_cursor_mode(dbCursor * cursor)
{
    cursor->mode = 0;
}

void db_set_cursor_mode_insensitive(dbCursor * cursor)
{
    cursor->mode |= DB_INSENSITIVE;
}

void db_unset_cursor_mode_insensitive(dbCursor * cursor)
{
    cursor->mode &= ~DB_INSENSITIVE;
}

int db_test_cursor_mode_scroll(dbCursor * cursor)
{
    return (cursor->mode & DB_SCROLL);
}


int db_test_cursor_mode_insensitive(dbCursor * cursor)
{
    return (cursor->mode & DB_INSENSITIVE);
}

int db_alloc_cursor_column_flags(dbCursor * cursor)
{
    int ncols;
    int col;

    ncols = db_get_cursor_number_of_columns(cursor);
    cursor->column_flags = (short *)db_calloc(ncols, sizeof(short));
    if (cursor->column_flags == NULL)
        return db_get_error_code();
    for (col = 0; col < ncols; col++)
        db_unset_cursor_column_flag(cursor, col);
    return DB_OK;
}

void db_free_cursor_column_flags(dbCursor * cursor)
{
    if (cursor->column_flags)
        db_free(cursor->column_flags);
    cursor->column_flags = NULL;
}

void db_set_cursor_column_for_update(dbCursor * cursor, int col)
{
    db_set_cursor_column_flag(cursor, col);
}

void db_unset_cursor_column_for_update(dbCursor * cursor, int col)
{
    db_unset_cursor_column_flag(cursor, col);
}

int db_test_cursor_column_for_update(dbCursor * cursor, int col)
{
    return db_test_cursor_column_flag(cursor, col);
}

int db_test_cursor_any_column_for_update(dbCursor * cursor)
{
    return db_test_cursor_any_column_flag(cursor);
}

void db_set_cursor_column_flag(dbCursor * cursor, int col)
{
    if (cursor->column_flags)
        cursor->column_flags[col] = 1;
}

void db_unset_cursor_column_flag(dbCursor * cursor, int col)
{
    if (cursor->column_flags)
        cursor->column_flags[col] = 0;
}

int db_test_cursor_column_flag(dbCursor * cursor, int col)
{
    return cursor->column_flags && cursor->column_flags[col] ? 1 : 0;
}

int db_get_cursor_number_of_columns(dbCursor * cursor)
{
    dbTable *table;

    table = db_get_cursor_table(cursor);
    if (table)
        return db_get_table_number_of_columns(table);
    return 0;
}

/* is any cursor column flag set? */
int db_test_cursor_any_column_flag(dbCursor * cursor)
{
    int ncols, col;

    ncols = db_get_cursor_number_of_columns(cursor);
    for (col = 0; col < ncols; col++)
        if (db_test_cursor_column_flag(cursor, col))
            return 1;
    return 0;
}