]> git.cworth.org Git - mnemon/blobdiff - mnemon.c
Reload file before printing final histogram
[mnemon] / mnemon.c
index 52a77d02ff82a430108748b76d5714aa6a057e30..db8f62fe87c917de251bcb4537c65eed7f65c15c 100644 (file)
--- a/mnemon.c
+++ b/mnemon.c
@@ -25,6 +25,7 @@
 #include <math.h>
 
 #include <sys/types.h>
+#include <sys/time.h>
 #include <dirent.h>
 #include <errno.h>
 #include <string.h>
@@ -61,6 +62,8 @@ typedef struct _category {
 
     /* Support sequential introduction of items from bin 0 */
     category_order_t order;
+    /* Support categories where responses are timed (0.0 == disable). */
+    double time_limit;
     int bin_zero_head;
 } category_t;
 
@@ -115,7 +118,21 @@ xstrdup (const char *s)
     char *ret;
 
     ret = strdup (s);
-    if (s == NULL) {
+    if (ret == NULL) {
+       fprintf (stderr, "Error: out of memory\n");
+       exit (1);
+    }
+
+    return ret;
+}
+
+static char *
+xstrndup (const char *s, size_t n)
+{
+    char *ret;
+
+    ret = strndup (s, n);
+    if (ret == NULL) {
        fprintf (stderr, "Error: out of memory\n");
        exit (1);
     }
@@ -173,6 +190,7 @@ category_init (category_t *category,
     category->num_items = 0;
     category->items = NULL;
     category->order = CATEGORY_ORDER_RANDOM;
+    category->time_limit = 0.0;
     category->bin_zero_head = 0;
 }
 
@@ -240,6 +258,8 @@ category_print (category_t  *category,
 
     fprintf (file, "order = %s\n\n",
            category->order == CATEGORY_ORDER_RANDOM ? "random" : "sequential");
+    fprintf (file, "time = %f\n\n",
+            category->time_limit);
 
     for (i = 0; i < category->num_items; i++) {
        item = &category->items[i];
@@ -323,6 +343,27 @@ bin_item_index (bin_t      *bin,
     assert (0);
 }
 
+typedef int (item_match_predicate_t) (void *closure, item_t *item);
+
+/* Return the number of items in the bin from the given category (or
+ * from all categories if category == NULL) */
+static int
+bin_num_items_matching (bin_t                  *bin,
+                       item_match_predicate_t  *predicate,
+                       void                    *closure)
+{
+    int i, num_items = 0;
+
+    if (predicate == NULL)
+       return bin->num_items;
+
+    for (i = 0; i < bin->num_items; i++)
+       if ((predicate) (closure, bin->items[i]))
+           num_items++;
+
+    return num_items;
+}
+
 static void
 mnemon_init (mnemon_t *mnemon)
 {
@@ -343,7 +384,7 @@ mnemon_init (mnemon_t *mnemon)
     mnemon->bins = NULL;
 
     mnemon->to_introduce = 10;
-    mnemon->to_master = 0;
+    mnemon->to_master = 10;
     mnemon->unlearned = 0;
     mnemon->mastered = -1;
 }
@@ -563,6 +604,19 @@ mnemon_load_category (mnemon_t             *mnemon,
                         value, path, line_count);
                exit (1);
            }
+       } else if (strcmp (name, "time") == 0) {
+           double limit;
+           char *end;
+           limit = strtod (value, &end);
+           while (isspace (*end))
+               end++;
+           if (*end == '\0') {
+               category->time_limit = limit;
+           } else {
+               fprintf (stderr, "Failed to parse time value: %s at %s:%d\n",
+                        value, path, line_count);
+               exit (1);
+           }
        } else {
            fprintf (stderr, "Unknown option %s at %s:%d\n",
                     name, path, line_count);
@@ -760,32 +814,53 @@ mnemon_item_category (mnemon_t    *mnemon,
     assert (0);
 }
 
-/* Return the number of items in the bin from the given category (or
- * from all categories if category == NULL) */
+typedef struct _item_in_category_closure
+{
+    mnemon_t *mnemon;
+    category_t *category;
+} item_in_category_closure_t;
+
 static int
-mnemon_bin_num_items_in_category (mnemon_t     *mnemon,
-                                 bin_t         *bin,
-                                 category_t    *category)
+mnemon_item_in_category (void *closure, item_t *item)
 {
-    int i, num_items = 0;
+    item_in_category_closure_t *iicc = closure;
+    mnemon_t *mnemon = iicc->mnemon;
+    category_t *category = iicc->category;
 
-    if (category == NULL)
-       return bin->num_items;
+    return (mnemon_item_category (mnemon, item) == category);
+}
 
-    for (i = 0; i < bin->num_items; i++)
-       if (mnemon_item_category (mnemon, bin->items[i]) == category)
-           num_items++;
+typedef struct _item_in_category_of_length_closure
+{
+    mnemon_t *mnemon;
+    category_t *category;
+    int length;
+} item_in_category_of_length_closure_t;
 
-    return num_items;
+static int
+mnemon_item_in_category_of_length (void *closure, item_t *item)
+{
+    item_in_category_of_length_closure_t *iicolc = closure;
+    mnemon_t *mnemon = iicolc->mnemon;
+    category_t *category = iicolc->category;
+    int length = iicolc->length;
+
+    if (mnemon_item_category (mnemon, item) != category)
+       return 0;
+
+    return strlen (item->challenge) == length;
 }
 
 static void
 mnemon_select_item (mnemon_t    *mnemon,
                    bin_t       **bin_ret,
-                   int          *item_index_ret)
+                   int          *item_index_ret,
+                   category_t  **category_ret)
 {
     int bin_index, item_index;
     bin_t *bin;
+    item_t *item;
+    category_t *category;
 
     bin_index = rand_within_exponential (mnemon->num_bins);
 
@@ -793,14 +868,10 @@ mnemon_select_item (mnemon_t       *mnemon,
 
     item_index = rand_within (bin->num_items);
 
-    if (bin->score == 0) {
-       category_t *category;
-       item_t *item;
-
-       item = bin->items[item_index];
-
-       category = mnemon_item_category (mnemon, item);
+    item = bin->items[item_index];
+    category = mnemon_item_category (mnemon, item);
 
+    if (bin->score == 0) {
        if (category->order == CATEGORY_ORDER_SEQUENTIAL) {
            item = category_next_bin_zero_item (category);
            if (item)
@@ -810,6 +881,7 @@ mnemon_select_item (mnemon_t         *mnemon,
 
     *bin_ret = bin;
     *item_index_ret = item_index;
+    *category_ret = category;
 }
 
 
@@ -855,23 +927,42 @@ print_histogram_bar (double       size,
 
 static void
 mnemon_print_histogram (mnemon_t    *mnemon,
-                       const char  *category_name)
+                       const char  *category_name,
+                       int          length)
 {
     int i, last_score, max;
     category_t *category = NULL;
     bin_t *bin;
     int num_items;
+    item_match_predicate_t *predicate = NULL;
+    void *closure = NULL;
+    item_in_category_closure_t item_in_category;
+    item_in_category_of_length_closure_t item_in_category_of_length;
 
     if (mnemon->num_bins == 0)
        return;
 
-    if (category_name)
+    if (category_name) {
        category = mnemon_get_category_if_exists (mnemon, category_name);
+       if (category) {
+           if (length) {
+               predicate = mnemon_item_in_category_of_length;
+               item_in_category_of_length.mnemon = mnemon;
+               item_in_category_of_length.category = category;
+               item_in_category_of_length.length = length;
+               closure = &item_in_category_of_length;
+           } else {
+               predicate = mnemon_item_in_category;
+               item_in_category.mnemon = mnemon;
+               item_in_category.category = category;
+               closure = &item_in_category;
+           }
+       }
+    }
 
     for (i = 0; i < mnemon->num_bins; i++) {
-       num_items = mnemon_bin_num_items_in_category (mnemon,
-                                                     &mnemon->bins[i],
-                                                     category);
+       num_items = bin_num_items_matching (&mnemon->bins[i],
+                                           predicate, closure);
        if (i == 0 || num_items > max)
            max = num_items;
     }
@@ -881,8 +972,8 @@ mnemon_print_histogram (mnemon_t    *mnemon,
        if (i != 0)
            while (bin->score - last_score > 1)
                printf (HISTOGRAM_ROW_FORMAT "\n", ++last_score, 0);
-       num_items = mnemon_bin_num_items_in_category (mnemon,
-                                                     bin, category);
+       num_items = bin_num_items_matching (bin,
+                                           predicate, closure);
        printf (HISTOGRAM_ROW_FORMAT " ", bin->score, num_items);
        print_histogram_bar (num_items, max);
        last_score = bin->score;
@@ -894,15 +985,26 @@ mnemon_handle_command (mnemon_t           *mnemon,
                       const char       *command)
 {
     const char *arg;
+    int len;
     switch (command[0]) {
        case 'h':
+       {
+           char *category = NULL;
+           int length = 0;
+
            arg = command + 1;
-           while (*arg && isspace (*arg))
-               arg++;
-           if (*arg == '\0')
-               arg = NULL;
-           mnemon_print_histogram (mnemon, arg);
-           break;
+           arg += strspn (arg, " \t");
+           len = strcspn (arg, " \t");
+           if (len) {
+               category = xstrndup (arg, len);
+               arg += len;
+               arg += strspn (arg, " \t");
+               if (*arg)
+                   length = atoi (arg);
+           }
+           mnemon_print_histogram (mnemon, category, length);
+       }
+       break;
         default:
            printf ("Unknown command: %s\n", command);
            break;
@@ -914,7 +1016,9 @@ mnemon_handle_response (mnemon_t   *mnemon,
                        bin_t           *bin,
                        int              item_index,
                        item_t          *item,
-                       const char      *response)
+                       const char      *response,
+                       double           response_time,
+                       double           time_limit)
 {
     bool_t correct;
 
@@ -931,13 +1035,17 @@ mnemon_handle_response (mnemon_t *mnemon,
        mnemon_remove_bin (mnemon, bin);
     }
 
-    if (correct) {
+    if (correct &&
+       (time_limit == 0.0 || response_time < time_limit))
+    {
        item->score++;
+       mnemon->to_master--;
        /* We reserve an item score of 0 for an item that has
         * never been asked. */
        if (item->score == 0) {
            item->score = 1;
            mnemon->unlearned--;
+           mnemon->to_master--;
            printf ("You got it!");
        } else if (item->score < 0) {
            printf ("Yes---just give me %d more.",
@@ -946,18 +1054,27 @@ mnemon_handle_response (mnemon_t *mnemon,
            printf ("On your first try, no less!");
        } else {
            printf ("Masterful (%dx).", item->score);
-           if (mnemon->to_master)
-               mnemon->mastered++;
        }
     } else {
-       printf ("  %s is the correct answer.",
-               item->response);
+       if (! correct)
+           printf ("  %s is the correct answer.",
+                   item->response);
+       else
+           printf ("Correct, but not quite quick enough (%0.2f seconds---needed %0.2f seconds)\n",
+                   response_time, time_limit);
        /* Penalize an incorrect response by forcing the score
         * negative. */
        if (item->score >= 0) {
            if (item->score > 0)
-               printf ( " Oops, you knew that, right?\n ");
+               printf (" Oops, you knew that, right? (%dx)\n ",
+                       item->score);
            mnemon->unlearned++;
+           /* We add three here, (rather than just 2 to track the
+            * change in the item's score below), as an extra
+            * penalty. If the user is forgetting stuff learned
+            * previously, then more time should be spent on mastering
+            * than learning new items. */
+           mnemon->to_master += item->score + 3;
            /* We go to -2 to force a little extra reinforcement
             * when re-learning an item, (otherwise, it will often
             * get asked again immediately where it is easy to get
@@ -965,29 +1082,17 @@ mnemon_handle_response (mnemon_t *mnemon,
            item->score = -2;
        } else {
            item->score--;
+           mnemon->to_master++;
        }
     }
 
-    if (mnemon->to_introduce == 0 &&
-       mnemon->unlearned == 0 &&
-       mnemon->to_master == 0)
-    {
-       mnemon->to_master = 10;
-       mnemon->mastered = 0;
-    }
-
     printf (" ");
     if (mnemon->to_introduce)
        printf ("%d to come. ", mnemon->to_introduce);
     if (mnemon->unlearned)
        printf ("%d still unlearned. ", mnemon->unlearned);
-    if (mnemon->to_master) {
-       if (mnemon->mastered < mnemon->to_master)
-           printf ("%d items to master",
-                   mnemon->to_master - mnemon->mastered);
-       else
-           printf ("Great job!");
-    }
+    if (mnemon->to_introduce == 0 && mnemon->to_master > 0)
+       printf ("%d items to master", mnemon->to_master);
     printf ("\n\n");
 
     bin = mnemon_get_bin (mnemon, item->score);
@@ -1001,6 +1106,7 @@ mnemon_do_challenges (mnemon_t *mnemon)
     bin_t *bin;
     int item_index;
     item_t *item;
+    category_t *category;
     char *response;
     int i;
 
@@ -1035,37 +1141,56 @@ mnemon_do_challenges (mnemon_t *mnemon)
     printf ("\n");
 
     do {
-       mnemon_select_item (mnemon, &bin, &item_index);
+       struct timeval start, end;
+       
+       mnemon_select_item (mnemon, &bin, &item_index, &category);
        item = bin->items[item_index];
 
        if (bin->score == 0)
            mnemon->to_introduce--;
 
        while (1) {
+           if (category->time_limit > 0.0) {
+               response = readline ("The next one is timed. Press enter when ready:");
+               free (response);
+           }
+               
            printf ("%s\n", item->challenge);
 
+           gettimeofday (&start, NULL);
            response = readline ("> ");
+           gettimeofday (&end, NULL);
+
            /* Terminate on EOF */
            if (response == NULL) {
                printf ("\n");
                return;
            }
 
-           if (response[0] == '/')
+           if (response[0] == '/') {
                mnemon_handle_command (mnemon, response + 1);
-           else
+               free (response);
+           } else {
                break;
+           }
        }
 
        mnemon_handle_response (mnemon, bin, item_index,
-                               item, response);
-    } while (mnemon->mastered < mnemon->to_master);
+                               item, response,
+                               (end.tv_sec + end.tv_usec / 1e6) -
+                               (start.tv_sec + start.tv_usec / 1e6),
+                               category->time_limit);
+       free (response);
+    } while (mnemon->to_introduce ||
+            mnemon->unlearned ||
+            mnemon->to_master > 0);
 }
 
 int
 main (int argc, char *argv[])
 {
     mnemon_t mnemon;
+    char *response;
 
     srand (time (NULL));
 
@@ -1079,5 +1204,15 @@ main (int argc, char *argv[])
 
     mnemon_fini (&mnemon);
 
+    mnemon_init (&mnemon);
+    mnemon_load (&mnemon);
+
+    printf ("Great job.\nHere are your current results:\n");
+    mnemon_print_histogram (&mnemon, NULL, 0);
+    response = readline ("Press enter to quit.\n");
+    free (response);
+
+    mnemon_fini (&mnemon);
+
     return 0;
 }