Pass full argument list to mood parsers.
[paraslash.git] / score.c
diff --git a/score.c b/score.c
index b53d60b38b582b6989f65fc290e894647e53f1f7..3557b042a31e5d84df636062cb54c15cd04ebe3c 100644 (file)
--- a/score.c
+++ b/score.c
@@ -1,20 +1,19 @@
 /*
- * Copyright (C) 2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2007-2009 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
 /** \file score.c Scoring functions to determine the audio file streaming order. */
+#include <osl.h>
 #include "para.h"
 #include "error.h"
+#include "string.h"
 #include "afh.h"
 #include "afs.h"
 #include "list.h"
-#include "string.h"
 
-int mood_compute_score(const void *row, long *score);
-
-static void *score_table;
+static struct osl_table *score_table;
 
 static int ptr_compare(const struct osl_object *obj1, const struct osl_object *obj2)
 {
@@ -30,7 +29,7 @@ static int ptr_compare(const struct osl_object *obj1, const struct osl_object *o
  * \param obj2 Pointer to the second score object.
  *
  * This function first compares the score values as usual integers. If they compare as
- * equal, the addresss of \a obj1 and \a obj2 are compared. So this compare function
+ * equal, the address of \a obj1 and \a obj2 are compared. So this compare function
  * returns zero if and only if \a obj1 and \a obj2 point to the same memory area.
  *
  * \sa osl_compare_function.
@@ -47,7 +46,7 @@ static int score_compare(const struct osl_object *obj1, const struct osl_object
 }
 
 /**
- * The score table consists of two colums: The \a aft_row column contains
+ * The score table consists of two columns: The \a aft_row column contains
  * pointers to the rows of the audio file table,  and the score column contains
  * the current score of the audio file associated with that row.
  */
@@ -63,7 +62,7 @@ enum score_table_columns {
 static struct osl_column_description score_cols[] = {
        [SCORECOL_AFT_ROW] = {
                .storage_type = OSL_NO_STORAGE,
-               .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
+               .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE | OSL_DONT_FREE,
                .name = "aft_row",
                .compare_function = ptr_compare,
                .data_size = sizeof(void *)
@@ -95,7 +94,7 @@ static struct osl_table_description score_table_desc = {
  */
 int get_num_admissible_files(unsigned *num)
 {
-       return osl_get_num_rows(score_table, num);
+       return osl(osl_get_num_rows(score_table, num));
 }
 
 /**
@@ -111,7 +110,7 @@ int get_num_admissible_files(unsigned *num)
 static int get_score_of_row(void *score_row, long *score)
 {
        struct osl_object obj;
-       int ret = osl_get_object(score_table, score_row, SCORECOL_SCORE, &obj);
+       int ret = osl(osl_get_object(score_table, score_row, SCORECOL_SCORE, &obj));
 
        if (ret >= 0)
                *score = *(long *)obj.data;
@@ -134,9 +133,8 @@ int score_add(const struct osl_row *aft_row, long score)
 
        assert(aft_row);
        size = score_table_desc.column_descriptions[SCORECOL_AFT_ROW].data_size;
-       score_objs[SCORECOL_AFT_ROW].data = para_malloc(size);
+       score_objs[SCORECOL_AFT_ROW].data = (struct osl_row *)aft_row;
        score_objs[SCORECOL_AFT_ROW].size = size;
-       *(const void **)(score_objs[SCORECOL_AFT_ROW].data) = aft_row;
 
        size = score_table_desc.column_descriptions[SCORECOL_SCORE].data_size;
        score_objs[SCORECOL_SCORE].data = para_malloc(size);
@@ -144,10 +142,9 @@ int score_add(const struct osl_row *aft_row, long score)
        *(int *)(score_objs[SCORECOL_SCORE].data) = score;
 
 //     PARA_DEBUG_LOG("adding %p\n", *(void **) (score_objs[SCORECOL_AFT_ROW].data));
-       ret = osl_add_row(score_table, score_objs);
+       ret = osl(osl_add_row(score_table, score_objs));
        if (ret < 0) {
-               PARA_ERROR_LOG("failed to add row: %d\n", ret);
-               free(score_objs[SCORECOL_AFT_ROW].data);
+               PARA_ERROR_LOG("%s\n", para_strerror(-ret));
                free(score_objs[SCORECOL_SCORE].data);
        }
        return ret;
@@ -156,7 +153,7 @@ int score_add(const struct osl_row *aft_row, long score)
 static int get_nth_score(unsigned n, long *score)
 {
        struct osl_row *row;
-       int ret = osl_get_nth_row(score_table, SCORECOL_SCORE, n, &row);
+       int ret = osl(osl_get_nth_row(score_table, SCORECOL_SCORE, n, &row));
 
        if (ret < 0)
                return ret;
@@ -169,7 +166,7 @@ static int get_nth_score(unsigned n, long *score)
  * \param aft_row Determines the audio file to change.
  * \param percent The position to re-insert the audio file.
  *
- * The percent paramenter must be between \p 0 and 100 and. A value of zero
+ * The percent parameter must be between \p 0 and 100 and. A value of zero
  * means to re-insert the audio file into the score table with a score lower
  * than any other admissible file.
  *
@@ -182,9 +179,12 @@ int score_update(const struct osl_row *aft_row, long percent)
        struct osl_row *row;
        long new_score;
        unsigned n, new_pos;
-       struct osl_object obj = {.data = &aft_row, .size = sizeof(void **)};
-       int ret = osl_get_row(score_table, SCORECOL_AFT_ROW, &obj, &row);
+       struct osl_object obj = {.data = (struct osl_row *)aft_row,
+               .size = sizeof(aft_row)};
+       int ret = osl(osl_get_row(score_table, SCORECOL_AFT_ROW, &obj, &row));
 
+       if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND)) /* not an error */
+               return 1;
        if (ret < 0)
                return ret;
        ret = get_num_admissible_files(&n);
@@ -198,9 +198,8 @@ int score_update(const struct osl_row *aft_row, long percent)
        obj.size = sizeof(long);
        obj.data = para_malloc(obj.size);
        *(long *)obj.data = new_score;
-       PARA_DEBUG_LOG("new score: %ld, position: %u/%u\n", new_score,
-               new_pos, n);
-       return osl_update_object(score_table, row, SCORECOL_SCORE, &obj);
+       PARA_DEBUG_LOG("new score: %ld, rank %u/%u\n", new_score, new_pos, n);
+       return osl(osl_update_object(score_table, row, SCORECOL_SCORE, &obj));
 }
 
 /**
@@ -221,19 +220,19 @@ int get_score_and_aft_row(struct osl_row *score_row, long *score,
 
        if (ret < 0)
                return ret;
-       ret = osl_get_object(score_table, score_row, SCORECOL_AFT_ROW, &obj);
+       ret = osl(osl_get_object(score_table, score_row, SCORECOL_AFT_ROW, &obj));
        if (ret < 0)
                return ret;
-       *aft_row = *(void **)obj.data;
+       *aft_row = obj.data;
        return 1;
 }
 
 static int get_score_row_from_aft_row(const struct osl_row *aft_row,
                struct osl_row **score_row)
 {
-       struct osl_object obj = {.data = &aft_row, .size = sizeof(void **)};
-       return osl_get_row(score_table, SCORECOL_AFT_ROW, &obj, score_row);
-
+       struct osl_object obj = {.data = (struct osl_row *)aft_row,
+               .size = sizeof(aft_row)};
+       return osl(osl_get_row(score_table, SCORECOL_AFT_ROW, &obj, score_row));
 }
 
 /**
@@ -251,7 +250,7 @@ static int get_score_row_from_aft_row(const struct osl_row *aft_row,
  */
 int admissible_file_loop(void *data, osl_rbtree_loop_func *func)
 {
-       return osl_rbtree_loop(score_table, SCORECOL_SCORE, data, func);
+       return osl(osl_rbtree_loop(score_table, SCORECOL_SCORE, data, func));
 }
 
 /**
@@ -266,7 +265,7 @@ int admissible_file_loop(void *data, osl_rbtree_loop_func *func)
  */
 int admissible_file_loop_reverse(void *data, osl_rbtree_loop_func *func)
 {
-       return osl_rbtree_loop_reverse(score_table, SCORECOL_SCORE, data, func);
+       return osl(osl_rbtree_loop_reverse(score_table, SCORECOL_SCORE, data, func));
 }
 
 /**
@@ -282,14 +281,14 @@ int score_get_best(struct osl_row **aft_row, long *score)
 {
        struct osl_row *row;
        struct osl_object obj;
-       int ret = osl_rbtree_last_row(score_table, SCORECOL_SCORE, &row);
+       int ret = osl(osl_rbtree_last_row(score_table, SCORECOL_SCORE, &row));
 
        if (ret < 0)
                return ret;
-       ret = osl_get_object(score_table, row, SCORECOL_AFT_ROW, &obj);
+       ret = osl(osl_get_object(score_table, row, SCORECOL_AFT_ROW, &obj));
        if (ret < 0)
                return ret;
-       *aft_row = *(void **)obj.data;
+       *aft_row = obj.data;
        return get_score_of_row(row, score);
 }
 
@@ -310,57 +309,82 @@ int score_delete(const struct osl_row *aft_row)
 
        if (ret < 0)
                return ret;
-       return osl_del_row(score_table, score_row);
+       return osl(osl_del_row(score_table, score_row));
 }
 
 /**
  * Find out whether an audio file is contained in the score table.
  *
  * \param aft_row The row of the audio file table.
+ * \param rank Result pointer
  *
  * \return Positive, if \a aft_row belongs to the audio file table,
- * zero if not, negative on errors.
+ * zero if not, negative on errors. If \a aft_row was found, and \a rank
+ * is not \p NULL, the rank of \a aft_row is returned in \a rank.
  */
-int row_belongs_to_score_table(const struct osl_row *aft_row)
+int row_belongs_to_score_table(const struct osl_row *aft_row, unsigned *rank)
 {
        struct osl_row *score_row;
        int ret = get_score_row_from_aft_row(aft_row, &score_row);
-       if (ret >= 0)
-               return 1;
-       if (ret == -E_RB_KEY_NOT_FOUND)
+
+       if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
                return 0;
-       return ret;
+       if (ret < 0)
+               return ret;
+       if (!rank)
+               return 1;
+       ret = osl(osl_get_rank(score_table, score_row, SCORECOL_SCORE, rank));
+       if (ret < 0)
+               return ret;
+       return 1;
+}
+
+/* Close the score table. */
+static void score_close(void)
+{
+       osl_close_table(score_table, OSL_FREE_VOLATILE);
+       score_table = NULL;
 }
 
 /**
- * Close the score table.
+ * Open the score table.
  *
- * \param flags Options passed to osl_close_table().
+ * \param dir Unused.
  *
- * \sa score_init().
+ * \return The return value of the underlying call to osl_open_table().
  */
-void score_shutdown(enum osl_close_flags flags)
+static int score_open(__a_unused const char *dir)
 {
-       osl_close_table(score_table, flags | OSL_FREE_VOLATILE);
+       score_table_desc.dir = NULL; /* this table has only volatile columns */
+       return osl(osl_open_table(&score_table_desc, &score_table));
 }
 
 /**
- * Init the scoring subsystem.
- *
- * \param ti Gets filled in by the function.
- * \param db The database directory.
+ * Remove all entries from the score table, but keep the table open.
  *
- * \return The return value of the underlying call to osl_open_table().
- *
- * \sa score_shutdown().
+ * \return Standard.
  */
-int score_init(struct table_info *ti, const char *db)
+int clear_score_table(void)
 {
-       score_table_desc.dir = db;
-       ti->desc = &score_table_desc;
-       ti->flags = TBLFLAG_SKIP_CREATE;
-       int ret = osl_open_table(ti->desc, &ti->table);
+       score_close();
+       return score_open(NULL);
+}
 
-       score_table = ti->table;
-       return ret;
+static int score_event_handler(__a_unused enum afs_events event,
+               __a_unused struct para_buffer *pb, __a_unused void *data)
+{
+       return 1;
+}
+
+/**
+ * Initialize the scoring subsystem.
+ *
+ * \param t The members of \a t are filled in by the function.
+ */
+void score_init(struct afs_table *t)
+{
+       t->name = score_table_desc.name;
+       t->open = score_open;
+       t->close = score_close;
+       t->event_handler = score_event_handler;
 }