adindex.cxx

Go to the documentation of this file.

// =============================================================== //
//                                                                 //
//   File      : adindex.cxx                                       //
//   Purpose   :                                                   //
//                                                                 //
//   Institute of Microbiology (Technical University Munich)       //
//   http://www.arb-home.de/                                       //
//                                                                 //
// =============================================================== //

#include "gb_key.h"
#include "gb_undo.h"
#include "gb_index.h"
#include "gb_hashindex.h"
#include "gb_ts.h"

#include <arb_strbuf.h>

#include <cctype>

#define GB_INDEX_FIND(gbf, ifs, quark)                                  \
    for (ifs = GBCONTAINER_IFS(gbf);                                    \
         ifs;                                                           \
         ifs = GB_INDEX_FILES_NEXT(ifs))                                \
    {                                                                   \
        if (ifs->key == quark) break;                                   \
    }

void GBENTRY::index_check_in() {
    // write field in index table

    GBCONTAINER *gfather = GB_GRANDPA(this);
    if (gfather) {
        GBQUARK quark = GB_KEY_QUARK(this);
        gb_index_files *ifs;
        GB_INDEX_FIND(gfather, ifs, quark);

        if (ifs) { // if key is indexed
            if (is_indexable()) {
                if (flags2.is_indexed) {
                    GB_internal_error("Double checked in");
                }
                else {
                    GB_CSTR       content = GB_read_char_pntr(this);
                    unsigned long idx;
                    GB_CALC_HASH_INDEX(content, idx, ifs->hash_table_size, ifs->case_sens);
                    ifs->nr_of_elements++;

                    {
                        GB_REL_IFES   *entries = GB_INDEX_FILES_ENTRIES(ifs);
                        gb_if_entries *ifes    = (gb_if_entries *)gbm_get_mem(sizeof(gb_if_entries), GB_GBM_INDEX(this));

                        SET_GB_IF_ENTRIES_NEXT(ifes, GB_ENTRIES_ENTRY(entries, idx));
                        SET_GB_IF_ENTRIES_GBD(ifes, this);
                        SET_GB_ENTRIES_ENTRY(entries, idx, ifes);
                    }
                    flags2.should_be_indexed = 1;
                    flags2.is_indexed        = 1;
                }
            }
        }
    }
}

void GBENTRY::index_check_out() {
    // remove entry from index table
    if (flags2.is_indexed) {
        GBCONTAINER *gfather = GB_GRANDPA(this);
        GBQUARK      quark   = GB_KEY_QUARK(this);

        flags2.is_indexed = 0;

        gb_index_files *ifs;
        GB_INDEX_FIND(gfather, ifs, quark);

        GB_ERROR     error;
        if (!ifs) error = "key is not indexed";
        else {
            error = GB_push_transaction(this);
            if (!error) {
                GB_CSTR content = GB_read_char_pntr(this);

                if (!content) {
                    error = GBS_global_string("can't read key value (%s)", GB_await_error());
                }
                else {
                    unsigned long idx;
                    GB_CALC_HASH_INDEX(content, idx, ifs->hash_table_size, ifs->case_sens);

                    gb_if_entries *ifes2   = NULp;
                    GB_REL_IFES   *entries = GB_INDEX_FILES_ENTRIES(ifs);
                    gb_if_entries *ifes;

                    for (ifes = GB_ENTRIES_ENTRY(entries, idx); ifes; ifes = GB_IF_ENTRIES_NEXT(ifes)) {
                        if (this == GB_IF_ENTRIES_GBD(ifes)) { // entry found
                            if (ifes2) SET_GB_IF_ENTRIES_NEXT(ifes2, GB_IF_ENTRIES_NEXT(ifes));
                            else SET_GB_ENTRIES_ENTRY(entries, idx, GB_IF_ENTRIES_NEXT(ifes));

                            ifs->nr_of_elements--;
                            gbm_free_mem(ifes, sizeof(gb_if_entries), GB_GBM_INDEX(this));
                            break;
                        }
                        ifes2 = ifes;
                    }
                }
            }
            error = GB_end_transaction(this, error);
        }

        if (error) {
            error = GBS_global_string("GBENTRY::index_check_out failed for key '%s' (%s)\n", GB_KEY(this), error);
            GB_internal_error(error);
        }
    }
}

GB_ERROR GB_create_index(GBDATA *gbd, const char *key, GB_CASE case_sens, long estimated_size) { // goes to header: __ATTR__USERESULT
    /* Create an index for a database.
     * Uses hash tables - collisions are avoided by using linked lists.
     */
    GB_ERROR error = NULp;

    if (gbd->is_entry()) {
        error = "GB_create_index used on non CONTAINER Type";
    }
    else if (GB_read_clients(gbd)<0) {
        error = "No index tables in DB clients allowed";
    }
    else {
        GBCONTAINER *gbc       = gbd->as_container();
        GBQUARK      key_quark = GB_find_or_create_quark(gbd, key);

        gb_index_files *ifs;
        GB_INDEX_FIND(gbc, ifs, key_quark);

        if (!ifs) { // if not already have index (e.g. if fast-loaded)
            ifs = (gb_index_files *)gbm_get_mem(sizeof(gb_index_files), GB_GBM_INDEX(gbc));
            SET_GB_INDEX_FILES_NEXT(ifs, GBCONTAINER_IFS(gbc));
            SET_GBCONTAINER_IFS(gbc, ifs);

            ifs->key             = key_quark;
            ifs->hash_table_size = gbs_get_a_prime(estimated_size);
            ifs->nr_of_elements  = 0;
            ifs->case_sens       = case_sens;

            SET_GB_INDEX_FILES_ENTRIES(ifs, (gb_if_entries **)gbm_get_mem(sizeof(void *)*(int)ifs->hash_table_size, GB_GBM_INDEX(gbc)));

            for (GBDATA *gbf = GB_find_sub_by_quark(gbd, -1, NULp, 0);
                 gbf;
                 gbf = GB_find_sub_by_quark(gbd, -1, gbf, 0))
            {
                if (gbf->is_container()) {
                    for (GBDATA *gb2 = GB_find_sub_by_quark(gbf, key_quark, NULp, 0);
                         gb2;
                         gb2 = GB_find_sub_by_quark(gbf, key_quark, gb2, 0))
                    {
                        if (gb2->is_indexable()) gb2->as_entry()->index_check_in();
                    }
                }
            }
        }
    }
    RETURN_ERROR(error);
}

void gb_destroy_indices(GBCONTAINER *gbc) {
    gb_index_files *ifs = GBCONTAINER_IFS(gbc);

    while (ifs) {
        GB_REL_IFES *if_entries = GB_INDEX_FILES_ENTRIES(ifs);

        for (int index = 0; index<ifs->hash_table_size; index++) {
            gb_if_entries *ifes = GB_ENTRIES_ENTRY(if_entries, index);

            while (ifes) {
                gb_if_entries *ifes_next = GB_IF_ENTRIES_NEXT(ifes);

                gbm_free_mem(ifes, sizeof(*ifes), GB_GBM_INDEX(gbc));
                ifes = ifes_next;
            }
        }
        gbm_free_mem(if_entries, sizeof(void *)*(int)ifs->hash_table_size, GB_GBM_INDEX(gbc));

        gb_index_files *ifs_next = GB_INDEX_FILES_NEXT(ifs);
        gbm_free_mem(ifs, sizeof(gb_index_files), GB_GBM_INDEX(gbc));
        ifs = ifs_next;
    }
}

#if defined(DEBUG)

NOT4PERL void GB_dump_indices(GBDATA *gbd) { // used for debugging
    // dump indices of container

    char *db_path = ARB_strdup(GB_get_db_path(gbd));
    if (gbd->is_entry()) {
        fprintf(stderr, "'%s' (%s) is no container.\n", db_path, GB_get_type_name(gbd));
    }
    else {
        gb_index_files *ifs;
        int             index_count = 0;

        GBCONTAINER  *gbc  = gbd->as_container();
        GB_MAIN_TYPE *Main = GBCONTAINER_MAIN(gbc);

        for (ifs = GBCONTAINER_IFS(gbc); ifs; ifs = GB_INDEX_FILES_NEXT(ifs)) {
            index_count++;
        }

        if (index_count == 0) {
            fprintf(stderr, "Container '%s' has no index.\n", db_path);
        }
        else {
            int pass;

            fprintf(stderr, "Indices for '%s':\n", db_path);
            for (pass = 1; pass <= 2; pass++) {
                if (pass == 2) {
                    fprintf(stderr, "\nDetailed index contents:\n\n");
                }
                index_count = 0;
                for (ifs = GBCONTAINER_IFS(gbc); ifs; ifs = GB_INDEX_FILES_NEXT(ifs)) {
                    fprintf(stderr,
                            "* Index %i for key=%s (%i), entries=%li, %s\n",
                            index_count,
                            quark2key(Main, ifs->key),
                            ifs->key,
                            ifs->nr_of_elements,
                            ifs->case_sens == GB_MIND_CASE
                            ? "Case sensitive"
                            : (ifs->case_sens == GB_IGNORE_CASE
                               ? "Case insensitive"
                               : "<Error in case_sens>")
                            );

                    if (pass == 2) {
                        gb_if_entries *ifes;
                        int            index;

                        fprintf(stderr, "\n");
                        for (index = 0; index<ifs->hash_table_size; index++) {
                            for (ifes = GB_ENTRIES_ENTRY(GB_INDEX_FILES_ENTRIES(ifs), index);
                                 ifes;
                                 ifes = GB_IF_ENTRIES_NEXT(ifes))
                            {
                                GBDATA     *igbd = GB_IF_ENTRIES_GBD(ifes);
                                const char *data = GB_read_char_pntr(igbd);

                                fprintf(stderr, "  - '%s' (@idx=%i)\n", data, index);
                            }
                        }
                        fprintf(stderr, "\n");
                    }
                    index_count++;
                }
            }
        }
    }

    free(db_path);
}

#endif // DEBUG


// find an entry in an hash table
GBDATA *gb_index_find(GBCONTAINER *gbf, gb_index_files *ifs, GBQUARK quark, const char *val, GB_CASE case_sens, int after_index) {
    unsigned long  index;
    GB_CSTR        data;
    gb_if_entries *ifes;
    GBDATA        *result = NULp;
    long           min_index;

    if (!ifs) {
        GB_INDEX_FIND(gbf, ifs, quark);
        if (!ifs) {
            GB_internal_error("gb_index_find called, but no index table found");
            return NULp;
        }
    }

    if (ifs->case_sens != case_sens) {
        GB_internal_error("case mismatch between index and search");
        return NULp;
    }

    GB_CALC_HASH_INDEX(val, index, ifs->hash_table_size, ifs->case_sens);
    min_index = gbf->d.nheader;

    for (ifes = GB_ENTRIES_ENTRY(GB_INDEX_FILES_ENTRIES(ifs), index);
            ifes;
            ifes = GB_IF_ENTRIES_NEXT(ifes))
    {
        GBDATA *igbd = GB_IF_ENTRIES_GBD(ifes);
        GBCONTAINER *ifather = GB_FATHER(igbd);

        if (ifather->index < after_index) continue;
        if (ifather->index >= min_index) continue;
        data = GB_read_char_pntr(igbd);
        if (GBS_string_matches(data, val, case_sens)) { // entry found
            result    = igbd;
            min_index = ifather->index;
        }
    }
    return result;
}


/* UNDO functions
 *
 * There are three undo stacks:
 *
 * GB_UNDO_NONE    no undo
 * GB_UNDO_UNDO    normal undo stack
 * GB_UNDO_REDO    redo stack
 */

static char *gb_set_undo_type(GBDATA *gb_main, GB_UNDO_TYPE type) {
    GB_MAIN_TYPE *Main = GB_MAIN(gb_main);
    Main->undo_type = type;
    return NULp;
}

static void g_b_add_size_to_undo_entry(g_b_undo_entry *ue, long size) {
    ue->sizeof_this                 += size;        // undo entry
    ue->father->sizeof_this         += size;        // one undo
    ue->father->father->sizeof_this += size;        // all undos
}

static g_b_undo_entry *new_g_b_undo_entry(g_b_undo_list *u) {
    g_b_undo_entry *ue = (g_b_undo_entry *)gbm_get_mem(sizeof(g_b_undo_entry), GBM_UNDO);

    ue->next   = u->entries;
    ue->father = u;
    u->entries = ue;

    g_b_add_size_to_undo_entry(ue, sizeof(g_b_undo_entry));

    return ue;
}



void gb_init_undo_stack(GB_MAIN_TYPE *Main) { // @@@ move into GB_MAIN_TYPE-ctor
    ARB_calloc(Main->undo, 1);

    Main->undo->max_size_of_all_undos = GB_MAX_UNDO_SIZE;

    ARB_calloc(Main->undo->u, 1);
    ARB_calloc(Main->undo->r, 1);
}

static void delete_g_b_undo_entry(g_b_undo_entry *entry) {
    switch (entry->type) {
        case GB_UNDO_ENTRY_TYPE_MODIFY:
        case GB_UNDO_ENTRY_TYPE_MODIFY_ARRAY: {
            if (entry->d.ts) {
                gb_del_ref_gb_transaction_save(entry->d.ts);
            }
        }
        default:
            break;
    }
    gbm_free_mem(entry, sizeof(g_b_undo_entry), GBM_UNDO);
}

static void delete_g_b_undo_list(g_b_undo_list *u) {
    g_b_undo_entry *a, *next;
    for (a = u->entries; a; a = next) {
        next = a->next;
        delete_g_b_undo_entry(a);
    }
    free(u);
}

static void delete_g_b_undo_header(g_b_undo_header *uh) {
    g_b_undo_list *next = NULp;
    for (g_b_undo_list *a = uh->stack; a; a = next) {
        next = a->next;
        delete_g_b_undo_list(a);
    }
    free(uh);
}

static char *g_b_check_undo_size2(g_b_undo_header *uhs, long size, long max_cnt) {
    long           csize = 0;
    long           ccnt  = 0;
    g_b_undo_list *us;

    for (us = uhs->stack; us && us->next;  us = us->next) {
        csize += us->sizeof_this;
        ccnt ++;
        if (((csize + us->next->sizeof_this) > size) ||
            (ccnt >= max_cnt)) {  // delete the rest
            g_b_undo_list *next = NULp;

            for (g_b_undo_list *a = us->next; a; a = next) {
                next = a->next;
                delete_g_b_undo_list(a);
            }
            us->next = NULp;
            uhs->sizeof_this = csize;
            break;
        }
    }
    return NULp;
}

static char *g_b_check_undo_size(GB_MAIN_TYPE *Main) {
    long  maxsize     = Main->undo->max_size_of_all_undos;
    char *error       = g_b_check_undo_size2(Main->undo->u, maxsize/2, GB_MAX_UNDO_CNT);
    if (!error) error = g_b_check_undo_size2(Main->undo->r, maxsize/2, GB_MAX_REDO_CNT);
    return error;
}


void gb_free_undo_stack(GB_MAIN_TYPE *Main) {
    delete_g_b_undo_header(Main->undo->u);
    delete_g_b_undo_header(Main->undo->r);
    free(Main->undo);
}

// -------------------------
//      real undo (redo)

static GB_ERROR undo_entry(g_b_undo_entry *ue) {
    GB_ERROR error = NULp;
    switch (ue->type) {
        case GB_UNDO_ENTRY_TYPE_CREATED:
            error = GB_delete(ue->source);
            break;

        case GB_UNDO_ENTRY_TYPE_DELETED: {
            GBDATA *gbd = ue->d.gs.gbd;
            if (gbd->is_container()) {
                gbd = gb_make_pre_defined_container(ue->source->as_container(), gbd->as_container(), -1, ue->d.gs.key);
            }
            else {
                gbd = gb_make_pre_defined_entry(ue->source->as_container(), gbd, -1, ue->d.gs.key);
            }
            GB_ARRAY_FLAGS(gbd).flags = ue->flag;
            gb_touch_header(GB_FATHER(gbd));
            gb_touch_entry(gbd, GB_CREATED);
            break;
        }
        case GB_UNDO_ENTRY_TYPE_MODIFY_ARRAY:
        case GB_UNDO_ENTRY_TYPE_MODIFY: {
            GBDATA *gbd = ue->source;
            if (gbd->is_entry()) {
                GBENTRY *gbe = gbd->as_entry();
                gb_save_extern_data_in_ts(gbe); // check out and free string

                if (ue->d.ts) { // nothing to undo (e.g. if undoing GB_touch)
                    gbe->flags              = ue->d.ts->flags;
                    gbe->flags2.extern_data = ue->d.ts->flags2.extern_data;

                    memcpy(&gbe->info, &ue->d.ts->info, sizeof(gbe->info)); // restore old information
                    if (gbe->type() >= GB_BITS) {
                        if (gbe->stored_external()) {
                            gbe->info.ex.set_data(ue->d.ts->info.ex.data);
                        }

                        gb_del_ref_and_extern_gb_transaction_save(ue->d.ts);
                        ue->d.ts = NULp;

                        gbe->index_re_check_in();
                    }
                }
            }
            {
                gb_header_flags *pflags = &GB_ARRAY_FLAGS(gbd);
                if (pflags->flags != (unsigned)ue->flag) {
                    GBCONTAINER *gb_father = GB_FATHER(gbd);
                    gbd->flags.saved_flags = pflags->flags;
                    pflags->flags = ue->flag;
                    if (GB_FATHER(gb_father)) {
                        gb_touch_header(gb_father); // don't touch father of main
                    }
                }
            }
            gb_touch_entry(gbd, GB_NORMAL_CHANGE);
            break;
        }
        default:
            GB_internal_error("Undo stack corrupt:!!!");
            error = GB_export_error("shit 34345");
            break;
    }

    return error;
}



static GB_ERROR g_b_undo(GBDATA *gb_main, g_b_undo_header *uh) { // goes to header: __ATTR__USERESULT
    GB_ERROR error = NULp;

    if (!uh->stack) {
        error = "Sorry no more undos/redos available";
    }
    else {
        g_b_undo_list  *u = uh->stack;
        g_b_undo_entry *ue, *next;

        error = GB_begin_transaction(gb_main);

        for (ue=u->entries; ue && !error; ue = next) {
            next = ue->next;
            error = undo_entry(ue);
            delete_g_b_undo_entry(ue);
            u->entries = next;
        }
        uh->sizeof_this -= u->sizeof_this;          // remove undo from list
        uh->stack        = u->next;

        delete_g_b_undo_list(u);
        error = GB_end_transaction(gb_main, error);
    }
    return error;
}

static GB_CSTR g_b_read_undo_key_pntr(GB_MAIN_TYPE *Main, g_b_undo_entry *ue) {
    return quark2key(Main, ue->d.gs.key);
}

static char *g_b_undo_info(GB_MAIN_TYPE *Main, g_b_undo_header *uh) {
    char          *info   = NULp;
    g_b_undo_list *u      = uh->stack;
    if (!u) {
        info = ARB_strdup("No more undos available");
    }
    else {
        GBS_strstruct res(1024);
        for (g_b_undo_entry *ue = u->entries; ue; ue = ue->next) {
            switch (ue->type) {
                case GB_UNDO_ENTRY_TYPE_CREATED:
                    res.cat("Delete new entry: ");
                    res.cat(gb_read_key_pntr(ue->source));
                    break;

                case GB_UNDO_ENTRY_TYPE_DELETED:
                    res.cat("Rebuild deleted entry: ");
                    res.cat(g_b_read_undo_key_pntr(Main, ue));
                    break;

                case GB_UNDO_ENTRY_TYPE_MODIFY_ARRAY:
                case GB_UNDO_ENTRY_TYPE_MODIFY:
                    res.cat("Undo modified entry: ");
                    res.cat(gb_read_key_pntr(ue->source));
                    break;
            }
            res.put('\n');
        }
        info = res.release();
    }
    return info;
}

static char *gb_free_all_undos(GBDATA *gb_main) {
    // Remove all existing undos/redos
    GB_MAIN_TYPE  *Main = GB_MAIN(gb_main);
    g_b_undo_list *a, *next;

    for (a = Main->undo->r->stack; a; a = next) {
        next = a->next;
        delete_g_b_undo_list(a);
    }
    Main->undo->r->stack       = NULp;
    Main->undo->r->sizeof_this = 0;

    for (a = Main->undo->u->stack; a; a = next) {
        next = a->next;
        delete_g_b_undo_list(a);
    }
    Main->undo->u->stack       = NULp;
    Main->undo->u->sizeof_this = 0;

    return NULp;
}


char *gb_set_undo_sync(GBDATA *gb_main) {
    // start a new undoable transaction
    GB_MAIN_TYPE    *Main  = GB_MAIN(gb_main);
    char            *error = g_b_check_undo_size(Main);
    g_b_undo_header *uhs;

    if (error) return error;
    switch (Main->requested_undo_type) {    // init the target undo stack
        case GB_UNDO_UNDO:      // that will undo but delete all redos
            uhs         = Main->undo->u;
            break;
        case GB_UNDO_UNDO_REDO: uhs = Main->undo->u; break;
        case GB_UNDO_REDO:      uhs = Main->undo->r; break;
        case GB_UNDO_KILL:      gb_free_all_undos(gb_main);
                                FALLTHROUGH;
        default:                uhs = NULp;
    }
    if (uhs) {
        g_b_undo_list *u = ARB_calloc<g_b_undo_list>(1);
        u->next = uhs->stack;
        u->father = uhs;
        uhs->stack = u;
        Main->undo->valid_u = u;
    }

    return gb_set_undo_type(gb_main, Main->requested_undo_type);
}

char *gb_disable_undo(GBDATA *gb_main) {
    // called to finish an undoable section, called at end of gb_commit_transaction
    GB_MAIN_TYPE  *Main = GB_MAIN(gb_main);
    g_b_undo_list *u    = Main->undo->valid_u;

    if (!u) return NULp;
    if (!u->entries) {      // nothing to undo, just a read transaction
        u->father->stack = u->next;
        delete_g_b_undo_list(u);
    }
    else {
        if (Main->requested_undo_type == GB_UNDO_UNDO) {    // remove all redos
            g_b_undo_list *a, *next;

            for (a = Main->undo->r->stack; a; a = next) {
                next = a->next;
                delete_g_b_undo_list(a);
            }
            Main->undo->r->stack       = NULp;
            Main->undo->r->sizeof_this = 0;
        }
    }
    Main->undo->valid_u = NULp;
    return gb_set_undo_type(gb_main, GB_UNDO_NONE);
}

void gb_check_in_undo_create(GB_MAIN_TYPE *Main, GBDATA *gbd) {
    if (Main->undo->valid_u) {
        g_b_undo_entry *ue = new_g_b_undo_entry(Main->undo->valid_u);

        ue->type      = GB_UNDO_ENTRY_TYPE_CREATED;
        ue->source    = gbd;
        ue->gbm_index = GB_GBM_INDEX(gbd);
        ue->flag      = 0;
    }
}

void gb_check_in_undo_modify(GB_MAIN_TYPE *Main, GBDATA *gbd) {
    if (!Main->undo->valid_u) {
        GB_FREE_TRANSACTION_SAVE(gbd);
    }
    else {
        gb_transaction_save *old = gbd->get_oldData();
        g_b_undo_entry      *ue  = new_g_b_undo_entry(Main->undo->valid_u);

        ue->source    = gbd;
        ue->gbm_index = GB_GBM_INDEX(gbd);
        ue->type      = GB_UNDO_ENTRY_TYPE_MODIFY;
        ue->flag      = gbd->flags.saved_flags;

        if (gbd->is_entry()) {
            ue->d.ts = old;
            if (old) {
                gb_add_ref_gb_transaction_save(old);
                if (gbd->type() >= GB_BITS && old->stored_external() && old->info.ex.data) {
                    ue->type = GB_UNDO_ENTRY_TYPE_MODIFY_ARRAY;
                    // move external array from ts to undo entry struct
                    g_b_add_size_to_undo_entry(ue, old->info.ex.memsize);
                }
            }
        }
    }
}

void gb_check_in_undo_delete(GB_MAIN_TYPE *Main, GBDATA*& gbd) {
    if (!Main->undo->valid_u) {
        gb_delete_entry(gbd);
        return;
    }

    if (gbd->is_container()) {
        GBCONTAINER *gbc = gbd->as_container();
        for (int index = 0; (index < gbc->d.nheader); index++) {
            GBDATA *gbd2 = GBCONTAINER_ELEM(gbc, index);
            if (gbd2) gb_check_in_undo_delete(Main, gbd2);
        }
    }
    else {
        gbd->as_entry()->index_check_out();
        gbd->flags2.should_be_indexed = 0; // do not re-checkin
    }
    gb_abort_entry(gbd);            // get old version

    g_b_undo_entry *ue = new_g_b_undo_entry(Main->undo->valid_u);

    ue->type      = GB_UNDO_ENTRY_TYPE_DELETED;
    ue->source    = GB_FATHER(gbd);
    ue->gbm_index = GB_GBM_INDEX(gbd);
    ue->flag      = GB_ARRAY_FLAGS(gbd).flags;

    ue->d.gs.gbd = gbd;
    ue->d.gs.key = GB_KEY_QUARK(gbd);

    gb_pre_delete_entry(gbd);       // get the core of the entry

    if (gbd->is_container()) {
        g_b_add_size_to_undo_entry(ue, sizeof(GBCONTAINER));
    }
    else {
        if (gbd->type() >= GB_BITS && gbd->as_entry()->stored_external()) {
            /* we have copied the data structures, now
               mark the old as deleted !!! */
            g_b_add_size_to_undo_entry(ue, gbd->as_entry()->memsize());
        }
        g_b_add_size_to_undo_entry(ue, sizeof(GBENTRY));
    }
}

// ----------------------------------------
//      UNDO functions exported to USER

GB_ERROR GB_request_undo_type(GBDATA *gb_main, GB_UNDO_TYPE type) { // goes to header: __ATTR__USERESULT_TODO
    GB_MAIN_TYPE *Main  = GB_MAIN(gb_main);
    GB_ERROR      error = NULp;

    if (Main->is_client()) {
        enum gb_undo_commands cmd = (type == GB_UNDO_NONE || type == GB_UNDO_KILL)
            ? _GBCMC_UNDOCOM_REQUEST_NOUNDO
            : _GBCMC_UNDOCOM_REQUEST_UNDO;
        error = gbcmc_send_undo_commands(gb_main, cmd);
    }
    if (!error) Main->requested_undo_type = type;

    return error;
}

GB_UNDO_TYPE GB_get_requested_undo_type(GBDATA *gb_main) {
    GB_MAIN_TYPE *Main = GB_MAIN(gb_main);
    return Main->requested_undo_type;
}


GB_ERROR GB_undo(GBDATA *gb_main, GB_UNDO_TYPE type) { // goes to header: __ATTR__USERESULT
    // undo/redo the last transaction

    GB_MAIN_TYPE *Main  = GB_MAIN(gb_main);
    GB_ERROR      error = NULp;

    if (Main->is_client()) {
        switch (type) {
            case GB_UNDO_UNDO:
                error = gbcmc_send_undo_commands(gb_main, _GBCMC_UNDOCOM_UNDO);
                break;

            case GB_UNDO_REDO:
                error = gbcmc_send_undo_commands(gb_main, _GBCMC_UNDOCOM_REDO);
                break;

            default:
                GB_internal_error("unknown undo type in GB_undo");
                error = "Internal UNDO error";
                break;
        }
    }
    else {
        GB_UNDO_TYPE old_type = GB_get_requested_undo_type(gb_main);
        switch (type) {
            case GB_UNDO_UNDO:
                error = GB_request_undo_type(gb_main, GB_UNDO_REDO);
                if (!error) {
                    error = g_b_undo(gb_main, Main->undo->u);
                    ASSERT_NO_ERROR(GB_request_undo_type(gb_main, old_type));
                }
                break;

            case GB_UNDO_REDO:
                error = GB_request_undo_type(gb_main, GB_UNDO_UNDO_REDO);
                if (!error) {
                    error = g_b_undo(gb_main, Main->undo->r);
                    ASSERT_NO_ERROR(GB_request_undo_type(gb_main, old_type));
                }
                break;

            default:
                error = "GB_undo: unknown undo type specified";
                break;
        }
    }

    return error;
}


char *GB_undo_info(GBDATA *gb_main, GB_UNDO_TYPE type) {
    // get some information about the next undo
    // returns NULp in case of exported error

    GB_MAIN_TYPE *Main = GB_MAIN(gb_main);
    if (Main->is_client()) {
        switch (type) {
            case GB_UNDO_UNDO:
                return gbcmc_send_undo_info_commands(gb_main, _GBCMC_UNDOCOM_INFO_UNDO);
            case GB_UNDO_REDO:
                return gbcmc_send_undo_info_commands(gb_main, _GBCMC_UNDOCOM_INFO_REDO);
            default:
                GB_export_error("GB_undo_info: unknown undo type specified");
                return NULp;
        }
    }
    switch (type) {
        case GB_UNDO_UNDO:
            return g_b_undo_info(Main, Main->undo->u);
        case GB_UNDO_REDO:
            return g_b_undo_info(Main, Main->undo->r);
        default:
            GB_export_error("GB_undo_info: unknown undo type specified");
            return NULp;
    }
}

GB_ERROR GB_set_undo_mem(GBDATA *gbd, long memsize) {
    // set the maximum memory used for undoing

    GB_MAIN_TYPE *Main = GB_MAIN(gbd);
    if (memsize < _GBCMC_UNDOCOM_SET_MEM) {
        return GB_export_errorf("Not enough UNDO memory specified: should be more than %i",
                                _GBCMC_UNDOCOM_SET_MEM);
    }
    Main->undo->max_size_of_all_undos = memsize;
    if (Main->is_client()) {
        return gbcmc_send_undo_commands(gbd, (enum gb_undo_commands)memsize);
    }
    g_b_check_undo_size(Main);
    return NULp;
}


#ifdef UNIT_TESTS
#include <test_unit.h>
#include <map>
#include <ad_cb_prot.h>

class cb_counter : virtual Noncopyable {
    GBDATA *gbd;
    int deletes, changes, creates;
    bool do_trace;
public:
    static void count_swapped(GBDATA* gbd, cb_counter* counter, GB_CB_TYPE t ) {
        // CB system cannot swap parameters, we need to wrap
        // And yes... fixed parameters are added *in the middle*, not at the end.
        counter->count(gbd, t);
    }

    cb_counter(GBDATA* gbd_) : gbd(gbd_), deletes(0), changes(0), creates(0), do_trace(false) {
        GB_add_callback(gbd, GB_CB_ALL, makeDatabaseCallback(cb_counter::count_swapped, this));
    }

    ~cb_counter() {
        // CB system cannot auto-destroy callbacks, nor are there CB handles
        if (deletes == 0) { // (GB_delete destroys CBs I think)
            GB_remove_callback(gbd, GB_CB_ALL, makeDatabaseCallback(cb_counter::count_swapped, this));
            // above must be exact copy of GB_add_callback copy
        }
    }

    void count(GBDATA*, GB_CB_TYPE t) {
        if (t & GB_CB_DELETE) deletes ++;
        if (t & GB_CB_SON_CREATED) creates ++;
        if (t & GB_CB_CHANGED) changes ++;
        if (do_trace) printf("counts: %p d=%i c=%i n=%i\n", gbd, deletes, changes, creates);
    }

    void trace(bool t) {
        do_trace = t;
    }

    int get_deletes() {
        int res = deletes;
        deletes = 0;
        return res;
    }

    int get_creates() {
        int res = creates;
        creates = 0;
        return res;
    }

    int get_changes() {
        int res = changes;
        changes = 0;
        return res;
    }
};



void TEST_GB_undo__basic() {
    GB_shell  shell;
    // GB_ERROR err;

    GBDATA   *main = GB_open("nosuch.arb", "c");
    GB_begin_transaction(main);
    cb_counter main_counter(main);
    GB_commit_transaction(main);

    GBDATA   *gbd;
    cb_counter *gbd_counter;

    GB_set_undo_mem(main, 10000);
    GB_request_undo_type(main, GB_UNDO_UNDO);

    // Notes:
    // - CB_CHANGED == CB_SON_CREATED
    //   Both are called on creating sons as well as just writing strings.
    // - GB_SON_CREATED also called if "SON_DELETED"
    // - It's possible to get CB_SON_CREATED on GBENTRY if the CB is
    //   registered within the running transaction.
    // - CBs are triggered at the end of the transaction.


    // test undo create empty string entry
    GB_begin_transaction(main);
    gbd = GB_create(main, "test", GB_STRING);
    gbd_counter = new cb_counter(gbd);
    GB_commit_transaction(main);

    TEST_EXPECT_EQUAL( main_counter.get_creates(), 1);
    TEST_EXPECT_EQUAL( main_counter.get_changes(), 1);
    TEST_EXPECT_EQUAL( main_counter.get_deletes(), 0);
    TEST_EXPECT_EQUAL( gbd_counter->get_creates(), 1);
    TEST_EXPECT_EQUAL( gbd_counter->get_changes(), 1);
    TEST_EXPECT_EQUAL( gbd_counter->get_deletes(), 0);
    // string initialises as empty
    TEST_EXPECT_EQUAL( GB_read_pntr(GB_find(main, "test", SEARCH_CHILD)), "");
    TEST_EXPECT_NULL(  GB_undo(main, GB_UNDO_UNDO)                 );
    TEST_EXPECT_EQUAL( main_counter.get_creates(), 1); // BROKEN -- should be 0
    TEST_EXPECT_EQUAL( main_counter.get_changes(), 1);
    TEST_EXPECT_EQUAL( main_counter.get_deletes(), 0); // BROKEN -- should be 1
    TEST_EXPECT_EQUAL( gbd_counter->get_creates(), 0);
    TEST_EXPECT_EQUAL( gbd_counter->get_changes(), 0);
    TEST_EXPECT_EQUAL( gbd_counter->get_deletes(), 1);
    TEST_EXPECT_NULL(  GB_find(main, "test", SEARCH_CHILD)         );
    TEST_EXPECT_NULL(  GB_undo(main, GB_UNDO_REDO)                 );
    TEST_EXPECT_EQUAL( main_counter.get_creates(), 1);
    TEST_EXPECT_EQUAL( main_counter.get_changes(), 1);
    TEST_EXPECT_EQUAL( main_counter.get_deletes(), 0);
    TEST_REJECT_NULL(  gbd = GB_find(main, "test", SEARCH_CHILD) );
    TEST_EXPECT_EQUAL( GB_read_pntr(GB_find(main, "test", SEARCH_CHILD)), "");

    // re-establish counter
    GB_begin_transaction(main);
    delete gbd_counter;
    gbd_counter = new cb_counter(gbd);
    GB_commit_transaction(main);

    // test undo delete empty string
    GB_begin_transaction(main);
    GB_delete(gbd);
    GB_commit_transaction(main);
    TEST_EXPECT_EQUAL( main_counter.get_creates(), 1); // BROKEN -- should be 0
    TEST_EXPECT_EQUAL( main_counter.get_changes(), 1);
    TEST_EXPECT_EQUAL( main_counter.get_deletes(), 0);
    TEST_EXPECT_EQUAL( gbd_counter->get_creates(), 0);
    TEST_EXPECT_EQUAL( gbd_counter->get_changes(), 0);
    TEST_EXPECT_EQUAL( gbd_counter->get_deletes(), 1);
    TEST_EXPECT_NULL(  GB_find(main, "test", SEARCH_CHILD)                   );
    TEST_EXPECT_NULL(  GB_undo(main, GB_UNDO_UNDO)                           );
    TEST_EXPECT_EQUAL( main_counter.get_creates(), 1);
    TEST_EXPECT_EQUAL( main_counter.get_changes(), 1);
    TEST_EXPECT_EQUAL( main_counter.get_deletes(), 0);
    TEST_EXPECT_EQUAL( GB_read_pntr(GB_find(main, "test", SEARCH_CHILD)), "" );
    TEST_EXPECT_NULL(  GB_undo(main, GB_UNDO_REDO)                           );
    TEST_EXPECT_EQUAL( main_counter.get_creates(), 1); // BROKEN -- should be 0
    TEST_EXPECT_EQUAL( main_counter.get_changes(), 1);
    TEST_EXPECT_EQUAL( main_counter.get_deletes(), 0);
    TEST_EXPECT_NULL(  GB_find(main, "test", SEARCH_CHILD)                   );
    TEST_EXPECT_NULL(  GB_undo(main, GB_UNDO_UNDO)                           );
    TEST_REJECT_NULL( gbd = GB_find(main, "test", SEARCH_CHILD) );
    TEST_EXPECT_EQUAL( gbd_counter->get_creates(), 0);
    TEST_EXPECT_EQUAL( gbd_counter->get_changes(), 0);
    TEST_EXPECT_EQUAL( gbd_counter->get_deletes(), 0);

    // re-establish counter
    GB_begin_transaction(main);
    delete gbd_counter;
    gbd_counter = new cb_counter(gbd);
    GB_commit_transaction(main);

    // test undo write short string
    const char* str = "testtest9012345";
    GB_begin_transaction(main);
    GB_write_string(gbd, str);
    GB_commit_transaction(main);
    TEST_EXPECT_EQUAL( gbd_counter->get_creates(), 1); // BROKEN?
    TEST_EXPECT_EQUAL( gbd_counter->get_changes(), 1);
    TEST_EXPECT_EQUAL( gbd_counter->get_deletes(), 0);
    TEST_EXPECT_EQUAL( GB_read_pntr(GB_find(main, "test", SEARCH_CHILD)), str);
    TEST_EXPECT_NULL(  GB_undo(main, GB_UNDO_UNDO)                           );
    TEST_EXPECT_EQUAL( gbd_counter->get_creates(), 1); // BROKEN?
    TEST_EXPECT_EQUAL( gbd_counter->get_changes(), 1);
    TEST_EXPECT_EQUAL( gbd_counter->get_deletes(), 0);
    TEST_EXPECT_EQUAL( GB_read_pntr(GB_find(main, "test", SEARCH_CHILD)), "");
    TEST_EXPECT_NULL(  GB_undo(main, GB_UNDO_REDO)                           );
    TEST_EXPECT_EQUAL( gbd_counter->get_creates(), 1); // BROKEN?
    TEST_EXPECT_EQUAL( gbd_counter->get_changes(), 1);
    TEST_EXPECT_EQUAL( gbd_counter->get_deletes(), 0);
    TEST_EXPECT_EQUAL( GB_read_pntr(GB_find(main, "test", SEARCH_CHILD)), str);

    delete gbd_counter;

    // test undo delete short string
    GB_begin_transaction(main);
    GB_delete(gbd);
    GB_commit_transaction(main);
    TEST_EXPECT_NULL(  GB_find(main, "test", SEARCH_CHILD)                   );
    TEST_EXPECT_NULL(  GB_undo(main, GB_UNDO_UNDO)                           );

    TEST_EXPECT_EQUAL__BROKEN( GB_read_pntr(GB_find(main, "test", SEARCH_CHILD)), str, (char*)NULp);
    GB_close(main);
    return; // remainder will fail now


    TEST_EXPECT_NULL(  GB_undo(main, GB_UNDO_REDO)                           );
    TEST_EXPECT_NULL(  GB_find(main, "test", SEARCH_CHILD)                   );
    TEST_EXPECT_NULL(  GB_undo(main, GB_UNDO_UNDO)                           );
    TEST_REJECT_NULL( gbd = GB_find(main, "test", SEARCH_CHILD) );

    // test undo write "" and delete short string
    GB_begin_transaction(main);
    GB_write_string(gbd, str);
    GB_delete(gbd);
    GB_commit_transaction(main);
    TEST_EXPECT_NULL(  GB_find(main, "test", SEARCH_CHILD)                   );
    TEST_EXPECT_NULL(  GB_undo(main, GB_UNDO_UNDO)                           );
    TEST_EXPECT_EQUAL( GB_read_pntr(GB_find(main, "test", SEARCH_CHILD)), str);
    TEST_EXPECT_NULL(  GB_undo(main, GB_UNDO_REDO)                           );
    TEST_EXPECT_NULL(  GB_find(main, "test", SEARCH_CHILD)                   );
    TEST_EXPECT_NULL(  GB_undo(main, GB_UNDO_UNDO)                           );
    TEST_REJECT_NULL( gbd = GB_find(main, "test", SEARCH_CHILD) );

    //err = GB_write_string(gbd, "testtest9012345");

    GB_close(main);
}
TEST_PUBLISH(TEST_GB_undo__basic);


#endif // UNIT_TESTS