From 6a5245ae08e35bd90436ddb97a8c7fbfea89b1fd Mon Sep 17 00:00:00 2001
From: Alexander Levin <al.le@rockbox.org>
Date: Tue, 30 Jun 2009 20:00:46 +0000
Subject: Improve the highscore related functions in plugin lib (FS#10350)

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@21578 a1c6a512-1295-4272-9138-f99709370657
---
 apps/plugins/lib/highscore.h | 52 +++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 51 insertions(+), 1 deletion(-)

(limited to 'apps/plugins/lib/highscore.h')

diff --git a/apps/plugins/lib/highscore.h b/apps/plugins/lib/highscore.h
index db09172c7d..a38a6f7bf3 100644
--- a/apps/plugins/lib/highscore.h
+++ b/apps/plugins/lib/highscore.h
@@ -21,6 +21,8 @@
 #ifndef HIGHSCORE_H
 #define HIGHSCORE_H
 
+/* see rockblox.c for the example of usage. */
+
 struct highscore
 {
     char name[32];
@@ -28,8 +30,56 @@ struct highscore
     int level;
 };
 
+/* Saves the scores to a file
+ *   - filename: name of the file to write the data to
+ *   - scores  : scores to store
+ *   - num_scores: number of the elements in the array 'scores'
+ * Returns 0 on success or a negative value if an error occures
+ */
 int highscore_save(char *filename, struct highscore *scores, int num_scores);
+
+/* Reads the scores from a file. The file must be a text file, each line
+ * represents a score entry.
+ *
+ *   - filename: name of the file to read the data from
+ *   - scores  : where to put the read data
+ *   - num_scores: max number of the scores to read (array capacity)
+ *
+ * Returns 0 on success or a negative value if an error occures
+ */
 int highscore_load(char *filename, struct highscore *scores, int num_scores);
-int highscore_update(int score, int level, struct highscore *scores, int num_scores);
+
+/* Inserts score and level into array of struct highscore in the
+ * descending order of scores, i.e. higher scores are at lower array
+ * indexes.
+ *
+ *   - score : the new score value to insert
+ *   - level : the game level at which the score was reached
+ *   - name  : the name of the new entry (whatever it means)
+ *   - scores: the array of scores to insert the new value into
+ *   - num_scores: number of elements in 'scores'
+ *
+ * Returns the 0-based position of the newly inserted score if it was
+ * inserted. Returns a negative value if the score was not inserted
+ * (i.e. it was less than the lowest score in the array).
+ */
+int highscore_update(int score, int level, const char *name,
+                     struct highscore *scores, int num_scores);
+
+/* Checks whether the new score would be inserted into the score table.
+ * This function can be used to find out whether a score with the given
+ * value would be inserted into the score table. If yes, the program
+ * can collect the name of the entry from the user (if it's done that
+ * way) and then really update the score table with 'highscore_update'.
+ *
+ *   - score : the score value to check
+ *   - scores: the array of existing scores
+ *   - num_scores: number of elements in 'scores'
+ *
+ * Returns true iff the given score would be inserted into the score
+ * table by highscore_update.
+ */
+bool highscore_would_update(int score, struct highscore *scores,
+                            int num_scores);
 
 #endif
-- 
cgit v1.2.3