Add a command for repeating (/r)

[mnemon] / mnemon.c

diff --git a/mnemon.c b/mnemon.c
index d0a960909d43eb5ea8539fa67f78bb1b1c530812..56a518d8ed752e63c06023d1c884474089346b76 100644 (file)
--- a/mnemon.c
+++ b/mnemon.c
@@ -35,6 +35,12 @@
 #include <readline/readline.h>
 #include <readline/history.h>
 
+#define ASSERT_NOT_REACHED             \
+do {                                   \
+    static const int NOT_REACHED = 0;  \
+    assert (NOT_REACHED);              \
+} while (0)
+
 typedef int bool_t;
 
 typedef struct _item {
@@ -57,7 +63,8 @@ typedef enum {
 
 typedef enum {
     CHALLENGE_TYPE_TEXT,
-    CHALLENGE_TYPE_IMAGE
+    CHALLENGE_TYPE_IMAGE,
+    CHALLENGE_TYPE_AUDIO
 } challenge_type_t;
 
 typedef struct _category {
@@ -278,6 +285,9 @@ category_print (category_t  *category,
     case CHALLENGE_TYPE_IMAGE:
        fprintf (file, "image");
        break;
+    case CHALLENGE_TYPE_AUDIO:
+       fprintf (file, "audio");
+       break;
     }
     fprintf (file, "\n\n");
 
@@ -597,7 +607,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, '=');
@@ -642,6 +652,8 @@ mnemon_load_category (mnemon_t              *mnemon,
                category->challenge_type = CHALLENGE_TYPE_TEXT;
            } else if (strcmp (value, "image") == 0) {
                category->challenge_type = CHALLENGE_TYPE_IMAGE;
+           } else if (strcmp (value, "audio") == 0) {
+               category->challenge_type = CHALLENGE_TYPE_AUDIO;
            } else {
                fprintf (stderr, "Unknown value for \"challenge\" option \"%s\" at %s:%d\n",
                         value, path, line_count);
@@ -894,9 +906,20 @@ mnemon_select_item (mnemon_t        *mnemon,
     category_t *category;
 
     bin_index = rand_within_exponential (mnemon->num_bins);
-
     bin = &mnemon->bins[bin_index];
 
+    /* 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_index = rand_within (bin->num_items);
 
     item = bin->items[item_index];
@@ -1018,6 +1041,7 @@ mnemon_handle_command (mnemon_t           *mnemon,
     const char *arg;
     int len;
     switch (command[0]) {
+       /* 'h' for histogram */
        case 'h':
        {
            char *category = NULL;
@@ -1036,6 +1060,12 @@ mnemon_handle_command (mnemon_t          *mnemon,
            mnemon_print_histogram (mnemon, category, length);
        }
        break;
+       /* 'r' for repeat */
+        case 'r':
+       {
+           /* Nothing necessary for repeating. */
+       }
+       break;
         default:
            printf ("Unknown command: %s\n", command);
            break;
@@ -1132,26 +1162,51 @@ mnemon_handle_response (mnemon_t        *mnemon,
 }
 
 static void
-mnemon_show_image (mnemon_t *mnemon, const char *filename)
+mnemon_show_challenge (mnemon_t *mnemon,
+                      challenge_type_t challenge_type,
+                      const char *challenge)
 {
+    const char *program;
     char *command;
 
+    if (challenge_type == CHALLENGE_TYPE_TEXT) {
+       printf ("%s\n", challenge);
+       return;
+    }
+
     /* 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);
+    switch (challenge_type) {
+    case CHALLENGE_TYPE_TEXT:
+       ASSERT_NOT_REACHED;
+       break;
+    case CHALLENGE_TYPE_IMAGE:
+       program = "xli -gamma 2.2";
+       break;
+    case CHALLENGE_TYPE_AUDIO:
+       program = "play";
+       break;
+    }
+
+    xasprintf (&command, "%s %s/%s >/dev/null 2>&1 &",
+              program,
+              mnemon->dir_name,
+              challenge);
     system (command);
     free (command);
 }
 
 static void
-mnemon_hide_image (mnemon_t *mnemon)
+mnemon_hide_challenge (mnemon_t *mnemon, challenge_type_t challenge_type)
 {
     char * command;
 
+    if (challenge_type != CHALLENGE_TYPE_IMAGE)
+       return;
+
     /* XXX: And this is just embarrassing (obviously wrong in several
      * ways). Hopefully I'll amend away any commit that includes this.
      */
@@ -1206,37 +1261,20 @@ mnemon_do_challenges (mnemon_t *mnemon)
        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);
            }
 
-           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;
-           }
+           mnemon_show_challenge (mnemon, category->challenge_type,
+                                  item->challenge);
 
            gettimeofday (&start, NULL);
            response = readline ("> ");
            gettimeofday (&end, NULL);
 
-           if (category->challenge_type == CHALLENGE_TYPE_IMAGE)
-               mnemon_hide_image (mnemon);
+           mnemon_hide_challenge (mnemon, category->challenge_type);
 
            /* Terminate on EOF */
            if (response == NULL) {
@@ -1258,6 +1296,13 @@ mnemon_do_challenges (mnemon_t *mnemon)
                                (start.tv_sec + start.tv_usec / 1e6),
                                category->time_limit);
        free (response);
+
+       /* Replay audio challenges for reinforcement. */
+       if (category->challenge_type == CHALLENGE_TYPE_AUDIO) {
+           mnemon_show_challenge (mnemon, category->challenge_type,
+                                  item->challenge);
+           sleep (1);
+       }
     } while (mnemon->to_introduce ||
             mnemon->unlearned ||
             mnemon->to_master > 0);