path: root/widgets/table/e-table-sorting-utils.c

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) version 3.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with the program; if not, see <http://www.gnu.org/licenses/>
 *
 *
 * Authors:
 *      Chris Lahey <clahey@ximian.com>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#include <config.h>

#include <string.h>

#include "e-util/e-util.h"

#include "e-table-sorting-utils.h"

#define d(x)

/* This takes source rows. */
static int
etsu_compare(ETableModel *source, ETableSortInfo *sort_info, ETableHeader *full_header, gint row1, gint row2)
{
    gint j;
    gint sort_count = e_table_sort_info_sorting_get_count(sort_info);
    gint comp_val = 0;
    gint ascending = 1;

    for (j = 0; j < sort_count; j++) {
        ETableSortColumn column = e_table_sort_info_sorting_get_nth(sort_info, j);
        ETableCol *col;
        col = e_table_header_get_column_by_col_idx(full_header, column.column);
        if (col == NULL)
            col = e_table_header_get_column (full_header, e_table_header_count (full_header) - 1);
        comp_val = (*col->compare)(e_table_model_value_at (source, col->compare_col, row1),
                       e_table_model_value_at (source, col->compare_col, row2));
        ascending = column.ascending;
        if (comp_val != 0)
            break;
    }
    if (comp_val == 0) {
        if (row1 < row2)
            comp_val = -1;
        if (row1 > row2)
            comp_val = 1;
    }
    if (!ascending)
        comp_val = -comp_val;
    return comp_val;
}

typedef struct {
    gint cols;
    gpointer *vals;
    gint *ascending;
    GCompareFunc *compare;
} ETableSortClosure;

typedef struct {
    ETreeModel *tree;
    ETableSortInfo *sort_info;
    ETableHeader *full_header;
} ETreeSortClosure;

/* FIXME: Make it not cache the second and later columns (as if anyone cares.) */

static int
e_sort_callback(gconstpointer data1, gconstpointer data2, gpointer user_data)
{
    gint row1 = *(gint *)data1;
    gint row2 = *(gint *)data2;
    ETableSortClosure *closure = user_data;
    gint j;
    gint sort_count = closure->cols;
    gint comp_val = 0;
    gint ascending = 1;
    for (j = 0; j < sort_count; j++) {
        comp_val = (*(closure->compare[j]))(closure->vals[closure->cols * row1 + j], closure->vals[closure->cols * row2 + j]);
        ascending = closure->ascending[j];
        if (comp_val != 0)
            break;
    }
    if (comp_val == 0) {
        if (row1 < row2)
            comp_val = -1;
        if (row1 > row2)
            comp_val = 1;
    }
    if (!ascending)
        comp_val = -comp_val;
    return comp_val;
}

void
e_table_sorting_utils_sort(ETableModel *source, ETableSortInfo *sort_info, ETableHeader *full_header, gint *map_table, gint rows)
{
    gint total_rows;
    gint i;
    gint j;
    gint cols;
    ETableSortClosure closure;

    g_return_if_fail(source != NULL);
    g_return_if_fail(E_IS_TABLE_MODEL(source));
    g_return_if_fail(sort_info != NULL);
    g_return_if_fail(E_IS_TABLE_SORT_INFO(sort_info));
    g_return_if_fail(full_header != NULL);
    g_return_if_fail(E_IS_TABLE_HEADER(full_header));

    total_rows = e_table_model_row_count(source);
    cols = e_table_sort_info_sorting_get_count(sort_info);
    closure.cols = cols;

    closure.vals = g_new(gpointer , total_rows * cols);
    closure.ascending = g_new(int, cols);
    closure.compare = g_new(GCompareFunc, cols);

    for (j = 0; j < cols; j++) {
        ETableSortColumn column = e_table_sort_info_sorting_get_nth(sort_info, j);
        ETableCol *col;
        col = e_table_header_get_column_by_col_idx(full_header, column.column);
        if (col == NULL)
            col = e_table_header_get_column (full_header, e_table_header_count (full_header) - 1);
        for (i = 0; i < rows; i++) {
            closure.vals[map_table[i] * cols + j] = e_table_model_value_at (source, col->compare_col, map_table[i]);
        }
        closure.compare[j] = col->compare;
        closure.ascending[j] = column.ascending;
    }

    g_qsort_with_data (
        map_table, rows, sizeof(int), e_sort_callback, &closure);

    g_free(closure.vals);
    g_free(closure.ascending);
    g_free(closure.compare);
}

gboolean
e_table_sorting_utils_affects_sort  (ETableSortInfo *sort_info,
                     ETableHeader   *full_header,
                     gint             col)
{
    gint j;
    gint cols;

    g_return_val_if_fail(sort_info != NULL, TRUE);
    g_return_val_if_fail(E_IS_TABLE_SORT_INFO(sort_info), TRUE);
    g_return_val_if_fail(full_header != NULL, TRUE);
    g_return_val_if_fail(E_IS_TABLE_HEADER(full_header), TRUE);

    cols = e_table_sort_info_sorting_get_count(sort_info);

    for (j = 0; j < cols; j++) {
        ETableSortColumn column = e_table_sort_info_sorting_get_nth(sort_info, j);
        ETableCol *tablecol;
        tablecol = e_table_header_get_column_by_col_idx(full_header, column.column);
        if (tablecol == NULL)
            tablecol = e_table_header_get_column (full_header, e_table_header_count (full_header) - 1);
        if (col == tablecol->compare_col)
            return TRUE;
    }
    return FALSE;
}


/* FIXME: This could be done in time log n instead of time n with a binary search. */
gint
e_table_sorting_utils_insert(ETableModel *source, ETableSortInfo *sort_info, ETableHeader *full_header, gint *map_table, gint rows, gint row)
{
    gint i;

    i = 0;
    /* handle insertions when we have a 'sort group' */
    while (i < rows && etsu_compare(source, sort_info, full_header, map_table[i], row) < 0)
        i++;

    return i;
}

/* FIXME: This could be done in time log n instead of time n with a binary search. */
gint
e_table_sorting_utils_check_position (ETableModel *source, ETableSortInfo *sort_info, ETableHeader *full_header, gint *map_table, gint rows, gint view_row)
{
    gint i;
    gint row;

    i = view_row;
    row = map_table[i];

    i = view_row;
    if (i < rows - 1 && etsu_compare(source, sort_info, full_header, map_table[i + 1], row) < 0) {
        i ++;
        while (i < rows - 1 && etsu_compare(source, sort_info, full_header, map_table[i], row) < 0)
            i ++;
    } else if (i > 0 && etsu_compare(source, sort_info, full_header, map_table[i - 1], row) > 0) {
        i --;
        while (i > 0 && etsu_compare(source, sort_info, full_header, map_table[i], row) > 0)
            i --;
    }
    return i;
}




/* This takes source rows. */
static int
etsu_tree_compare(ETreeModel *source, ETableSortInfo *sort_info, ETableHeader *full_header, ETreePath path1, ETreePath path2)
{
    gint j;
    gint sort_count = e_table_sort_info_sorting_get_count(sort_info);
    gint comp_val = 0;
    gint ascending = 1;

    for (j = 0; j < sort_count; j++) {
        ETableSortColumn column = e_table_sort_info_sorting_get_nth(sort_info, j);
        ETableCol *col;
        col = e_table_header_get_column_by_col_idx(full_header, column.column);
        if (col == NULL)
            col = e_table_header_get_column (full_header, e_table_header_count (full_header) - 1);
        comp_val = (*col->compare)(e_tree_model_value_at (source, path1, col->compare_col),
                       e_tree_model_value_at (source, path2, col->compare_col));
        ascending = column.ascending;
        if (comp_val != 0)
            break;
    }
    if (!ascending)
        comp_val = -comp_val;
    return comp_val;
}

static int
e_sort_tree_callback(gconstpointer data1, gconstpointer data2, gpointer user_data)
{
    ETreePath *path1 = *(ETreePath *)data1;
    ETreePath *path2 = *(ETreePath *)data2;
    ETreeSortClosure *closure = user_data;

    return etsu_tree_compare(closure->tree, closure->sort_info, closure->full_header, path1, path2);
}

void
e_table_sorting_utils_tree_sort(ETreeModel *source, ETableSortInfo *sort_info, ETableHeader *full_header, ETreePath *map_table, gint count)
{
    ETableSortClosure closure;
    gint cols;
    gint i, j;
    gint *map;
    ETreePath *map_copy;
    g_return_if_fail(source != NULL);
    g_return_if_fail(E_IS_TREE_MODEL(source));
    g_return_if_fail(sort_info != NULL);
    g_return_if_fail(E_IS_TABLE_SORT_INFO(sort_info));
    g_return_if_fail(full_header != NULL);
    g_return_if_fail(E_IS_TABLE_HEADER(full_header));

    cols = e_table_sort_info_sorting_get_count(sort_info);
    closure.cols = cols;

    closure.vals = g_new(gpointer , count * cols);
    closure.ascending = g_new(int, cols);
    closure.compare = g_new(GCompareFunc, cols);

    for (j = 0; j < cols; j++) {
        ETableSortColumn column = e_table_sort_info_sorting_get_nth(sort_info, j);
        ETableCol *col;

        col = e_table_header_get_column_by_col_idx(full_header, column.column);
        if (col == NULL)
            col = e_table_header_get_column (full_header, e_table_header_count (full_header) - 1);

        for (i = 0; i < count; i++) {
            closure.vals[i * cols + j] = e_tree_model_sort_value_at (source, map_table[i], col->compare_col);
        }
        closure.ascending[j] = column.ascending;
        closure.compare[j] = col->compare;
    }

    map = g_new(int, count);
    for (i = 0; i < count; i++) {
        map[i] = i;
    }

    g_qsort_with_data (
        map, count, sizeof(int), e_sort_callback, &closure);

    map_copy = g_new(ETreePath, count);
    for (i = 0; i < count; i++) {
        map_copy[i] = map_table[i];
    }
    for (i = 0; i < count; i++) {
        map_table[i] = map_copy[map[i]];
    }

    g_free(map);
    g_free(map_copy);

    g_free(closure.vals);
    g_free(closure.ascending);
    g_free(closure.compare);
}

/* FIXME: This could be done in time log n instead of time n with a binary search. */
gint
e_table_sorting_utils_tree_check_position (ETreeModel *source, ETableSortInfo *sort_info, ETableHeader *full_header, ETreePath *map_table, gint count, gint old_index)
{
    gint i;
    ETreePath path;

    i = old_index;
    path = map_table[i];

    if (i < count - 1 && etsu_tree_compare(source, sort_info, full_header, map_table[i + 1], path) < 0) {
        i ++;
        while (i < count - 1 && etsu_tree_compare(source, sort_info, full_header, map_table[i], path) < 0)
            i ++;
    } else if (i > 0 && etsu_tree_compare(source, sort_info, full_header, map_table[i - 1], path) > 0) {
        i --;
        while (i > 0 && etsu_tree_compare(source, sort_info, full_header, map_table[i], path) > 0)
            i --;
    }
    return i;
}

/* FIXME: This does not pay attention to making sure that it's a stable insert.  This needs to be fixed. */
gint
e_table_sorting_utils_tree_insert(ETreeModel *source, ETableSortInfo *sort_info, ETableHeader *full_header, ETreePath *map_table, gint count, ETreePath path)
{
    size_t start;
    size_t end;
    ETreeSortClosure closure;

    closure.tree = source;
    closure.sort_info = sort_info;
    closure.full_header = full_header;

    e_bsearch(&path, map_table, count, sizeof(ETreePath), e_sort_tree_callback, &closure, &start, &end);
    return end;
}