README: Kill "obligatory" and "optional" tags.

[paraslash.git] / score.c

diff --git a/score.c b/score.c
index ad147bba1ef7dc9ac90fbcb30e20a267e0376160..2707e6a71cef8ffb6fa36d007eac01191be414d3 100644 (file)
--- a/score.c
+++ b/score.c
@@ -7,10 +7,10 @@
 /** \file score.c Scoring functions to determine the audio file streaming order. */
 #include "para.h"
 #include "error.h"
+#include "string.h"
 #include "afh.h"
 #include "afs.h"
 #include "list.h"
-#include "string.h"
 
 static struct osl_table *score_table;
 
@@ -28,7 +28,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.
@@ -45,7 +45,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.
  */
@@ -144,7 +144,7 @@ int score_add(const struct osl_row *aft_row, long score)
 //     PARA_DEBUG_LOG("adding %p\n", *(void **) (score_objs[SCORECOL_AFT_ROW].data));
        ret = osl_add_row(score_table, score_objs);
        if (ret < 0) {
-               PARA_ERROR_LOG("failed to add row: %d\n", ret);
+               PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
                free(score_objs[SCORECOL_AFT_ROW].data);
                free(score_objs[SCORECOL_SCORE].data);
        }
@@ -167,7 +167,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.
  *
@@ -196,8 +196,7 @@ 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);
+       PARA_DEBUG_LOG("new score: %ld, rank %u/%u\n", new_score, new_pos, n);
        return osl_update_object(score_table, row, SCORECOL_SCORE, &obj);
 }
 
@@ -315,48 +314,75 @@ int score_delete(const struct osl_row *aft_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)
                return 0;
-       return ret;
+       if (ret < 0)
+               return ret;
+       if (!rank)
+               return 1;
+       ret = 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 = NULL;
+       score_table_desc.dir = NULL; /* this table has only volatile columns */
+       return 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().
+ * \return Standard.
+ */
+int clear_score_table(void)
+{
+       score_close();
+       return score_open(NULL);
+}
+
+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.
  *
- * \sa score_shutdown().
+ * \param t The members of \a t are filled in by the function.
  */
-int score_init(struct table_info *ti, const char *db)
+void score_init(struct afs_table *t)
 {
-       score_table_desc.dir = db;
-       ti->desc = &score_table_desc;
-       ti->flags = TBLFLAG_SKIP_CREATE;
-       return osl_open_table(ti->desc, &score_table);
+       t->name = score_table_desc.name;
+       t->open = score_open;
+       t->close = score_close;
+       t->event_handler = score_event_handler;
 }