]> git.cworth.org Git - mnemon/blobdiff - mnemon.c
Merge branch 'master' into image
[mnemon] / mnemon.c
index fd7b9bf15b4ce7da6b6772420cfeea79e4028a39..74eb2c0a036034f44cba334861845afc863d1e6b 100644 (file)
--- a/mnemon.c
+++ b/mnemon.c
@@ -25,6 +25,8 @@
 #include <math.h>
 
 #include <sys/types.h>
+#include <sys/time.h>
+#include <unistd.h>
 #include <dirent.h>
 #include <errno.h>
 #include <string.h>
@@ -53,6 +55,11 @@ typedef enum {
     CATEGORY_ORDER_SEQUENTIAL
 } category_order_t;
 
+typedef enum {
+    CHALLENGE_TYPE_TEXT,
+    CHALLENGE_TYPE_IMAGE
+} challenge_type_t;
+
 typedef struct _category {
     char *name;
     int items_size;
@@ -61,7 +68,11 @@ 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;
+    /* Support challenges of non-text types (image, audio, etc.) */
+    challenge_type_t challenge_type;
 } category_t;
 
 typedef struct _mnemon {
@@ -187,7 +198,9 @@ 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;
+    category->challenge_type = CHALLENGE_TYPE_TEXT;
 }
 
 static void
@@ -254,6 +267,19 @@ 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);
+
+    fprintf (file, "challenge = ");
+    switch (category->challenge_type) {
+    case CHALLENGE_TYPE_TEXT:
+       fprintf (file, "text");
+       break;
+    case CHALLENGE_TYPE_IMAGE:
+       fprintf (file, "image");
+       break;
+    }
+    fprintf (file, "\n\n");
 
     for (i = 0; i < category->num_items; i++) {
        item = &category->items[i];
@@ -571,7 +597,7 @@ mnemon_load_category (mnemon_t              *mnemon,
 
        /* An initial digit means we hit an item. Trigger the
         * spaghetti machine. */
-       if (*line >= '0' && *line <= '9')
+       if ((*line >= '0' && *line <= '9') || *line == '-')
            goto PARSE_BIN;
 
        equal = strchr (line, '=');
@@ -598,6 +624,29 @@ 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 if (strcmp (name, "challenge") == 0) {
+           if (strcmp (value, "text") == 0) {
+               category->challenge_type = CHALLENGE_TYPE_TEXT;
+           } else if (strcmp (value, "image") == 0) {
+               category->challenge_type = CHALLENGE_TYPE_IMAGE;
+           } else {
+               fprintf (stderr, "Unknown value for \"challenge\" option \"%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);
@@ -711,6 +760,7 @@ mnemon_save (mnemon_t *mnemon)
 
        category_print (category, file);
 
+       fsync (fileno (file));
        fclose (file);
 
        err = rename (lock_filename, filename);
@@ -835,25 +885,35 @@ mnemon_item_in_category_of_length (void *closure, item_t *item)
 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);
-
     bin = &mnemon->bins[bin_index];
 
-    item_index = rand_within (bin->num_items);
-
-    if (bin->score == 0) {
-       category_t *category;
-       item_t *item;
+    /* The most intuitive understanding of the to_introduce counter is
+     * that it's tracking never-before-learned items as they are
+     * pulled from the bin with score 0. But that bin can become
+     * empty. So the refined rule is that we decrement to_introduce
+     * whenever we pull from the lowest-indexed bin with a
+     * non-negative score. */
+    if (mnemon->to_introduce && bin->score >=0 &&
+       (bin_index == 0 || mnemon->bins[bin_index-1].score < 0))
+    {
+       mnemon->to_introduce--;
+    }
 
-       item = bin->items[item_index];
+    item_index = rand_within (bin->num_items);
 
-       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)
@@ -863,6 +923,7 @@ mnemon_select_item (mnemon_t         *mnemon,
 
     *bin_ret = bin;
     *item_index_ret = item_index;
+    *category_ret = category;
 }
 
 
@@ -997,7 +1058,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;
 
@@ -1014,7 +1077,9 @@ 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
@@ -1033,8 +1098,12 @@ mnemon_handle_response (mnemon_t *mnemon,
            printf ("Masterful (%dx).", item->score);
        }
     } 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) {
@@ -1073,12 +1142,42 @@ mnemon_handle_response (mnemon_t        *mnemon,
     bin_add_item (bin, item);
 }
 
+static void
+mnemon_show_image (mnemon_t *mnemon, const char *filename)
+{
+    char *command;
+
+    /* XXX: Yes, shelling out to system is total cheese. The planned
+     * fix here is to bring graphical display in process, (or at least
+     * have a custom external program that accepts image filenames on
+     * stdin.
+     */
+    xasprintf (&command, "xli -gamma 2.2 %s >/dev/null 2>&1 &",
+              filename);
+    system (command);
+    free (command);
+}
+
+static void
+mnemon_hide_image (mnemon_t *mnemon)
+{
+    char * command;
+
+    /* XXX: And this is just embarrassing (obviously wrong in several
+     * ways). Hopefully I'll amend away any commit that includes this.
+     */
+    xasprintf (&command, "killall xli");
+    system (command);
+    free (command);
+}
+
 static void
 mnemon_do_challenges (mnemon_t *mnemon)
 {
     bin_t *bin;
     int item_index;
     item_t *item;
+    category_t *category;
     char *response;
     int i;
 
@@ -1113,41 +1212,70 @@ 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) {
-           printf ("%s\n", item->challenge);
+           if (category->time_limit > 0.0) {
+               response = readline ("The next one is timed. Press enter when ready:");
+               free (response);
+           }
+
+           switch (category->challenge_type) {
+           case CHALLENGE_TYPE_TEXT:
+               printf ("%s\n", item->challenge);
+               break;
+           case CHALLENGE_TYPE_IMAGE:
+               {
+                   char *absolute_filename;
+
+                   xasprintf (&absolute_filename, "%s/%s",
+                              mnemon->dir_name, item->challenge);
+                   mnemon_show_image (mnemon, absolute_filename);
+                   free (absolute_filename);
+               }
+               break;
+           }
 
+           gettimeofday (&start, NULL);
            response = readline ("> ");
+           gettimeofday (&end, NULL);
+
+           if (category->challenge_type == CHALLENGE_TYPE_IMAGE)
+               mnemon_hide_image (mnemon);
+
            /* 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);
+                               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);
-
-    printf ("Great job.\n");
 }
 
 int
 main (int argc, char *argv[])
 {
     mnemon_t mnemon;
+    char *response;
 
     srand (time (NULL));
 
@@ -1161,5 +1289,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;
 }