#include <math.h>
#include <sys/types.h>
+#include <sys/time.h>
+#include <unistd.h>
#include <dirent.h>
#include <errno.h>
#include <string.h>
#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 {
CATEGORY_ORDER_SEQUENTIAL
} category_order_t;
+typedef enum {
+ CHALLENGE_TYPE_TEXT,
+ CHALLENGE_TYPE_IMAGE,
+ CHALLENGE_TYPE_AUDIO,
+ CHALLENGE_TYPE_MIDI
+} challenge_type_t;
+
typedef struct _category {
char *name;
int items_size;
/* 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 {
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);
}
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
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;
+ case CHALLENGE_TYPE_AUDIO:
+ fprintf (file, "audio");
+ break;
+ case CHALLENGE_TYPE_MIDI:
+ fprintf (file, "midi");
+ break;
+ }
+ fprintf (file, "\n\n");
for (i = 0; i < category->num_items; i++) {
item = &category->items[i];
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)
{
mnemon->bins = NULL;
mnemon->to_introduce = 10;
- mnemon->to_master = 0;
+ mnemon->to_master = 10;
mnemon->unlearned = 0;
mnemon->mastered = -1;
}
mnemon->categories_size * sizeof (category_t));
}
+/* Get a category by name if it exists */
static category_t *
-mnemon_get_category (mnemon_t *mnemon,
- const char *name)
+mnemon_get_category_if_exists (mnemon_t *mnemon,
+ const char *name)
{
int i;
- category_t *category;
for (i = 0; i < mnemon->num_categories; i++)
if (strcmp (mnemon->categories[i].name, name) == 0)
return &mnemon->categories[i];
+ return NULL;
+}
+
+/* Get a category by name, creating new one if necessary. */
+static category_t *
+mnemon_get_category (mnemon_t *mnemon,
+ const char *name)
+{
+ category_t *category;
+
+ category = mnemon_get_category_if_exists (mnemon, name);
+ if (category)
+ return category;
+
mnemon_categories_grow (mnemon);
category = &mnemon->categories[mnemon->num_categories++];
/* 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, '=');
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 if (strcmp (value, "audio") == 0) {
+ category->challenge_type = CHALLENGE_TYPE_AUDIO;
+ } else if (strcmp (value, "midi") == 0) {
+ category->challenge_type = CHALLENGE_TYPE_MIDI;
+ } 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);
category_print (category, file);
+ fsync (fileno (file));
fclose (file);
err = rename (lock_filename, filename);
assert (0);
}
+typedef struct _item_in_category_closure
+{
+ mnemon_t *mnemon;
+ category_t *category;
+} item_in_category_closure_t;
+
+static int
+mnemon_item_in_category (void *closure, item_t *item)
+{
+ item_in_category_closure_t *iicc = closure;
+ mnemon_t *mnemon = iicc->mnemon;
+ category_t *category = iicc->category;
+
+ return (mnemon_item_category (mnemon, item) == category);
+}
+
+typedef struct _item_in_category_of_length_closure
+{
+ mnemon_t *mnemon;
+ category_t *category;
+ int length;
+} item_in_category_of_length_closure_t;
+
+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);
-
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)
*bin_ret = bin;
*item_index_ret = item_index;
+ *category_ret = category;
}
}
static void
-mnemon_print_histogram (mnemon_t *mnemon)
+mnemon_print_histogram (mnemon_t *mnemon,
+ 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;
- max = mnemon->bins[0].num_items;
- for (i = 1; i < mnemon->num_bins; i++)
- if (mnemon->bins[i].num_items > max)
- max = mnemon->bins[i].num_items;
+ 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 = bin_num_items_matching (&mnemon->bins[i],
+ predicate, closure);
+ if (i == 0 || num_items > max)
+ max = num_items;
+ }
for (i = 0; i < mnemon->num_bins; i++) {
bin = &mnemon->bins[i];
if (i != 0)
while (bin->score - last_score > 1)
printf (HISTOGRAM_ROW_FORMAT "\n", ++last_score, 0);
- printf (HISTOGRAM_ROW_FORMAT " ", bin->score, bin->num_items);
- print_histogram_bar (bin->num_items, max);
+ 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;
}
}
mnemon_handle_command (mnemon_t *mnemon,
const char *command)
{
+ const char *arg;
+ int len;
switch (command[0]) {
+ /* 'h' for histogram */
case 'h':
- mnemon_print_histogram (mnemon);
- break;
+ {
+ char *category = NULL;
+ int length = 0;
+
+ arg = command + 1;
+ 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;
+ /* 'r' for repeat */
+ case 'r':
+ {
+ /* Nothing necessary for repeating. */
+ }
+ break;
default:
printf ("Unknown command: %s\n", command);
break;
bin_t *bin,
int item_index,
item_t *item,
- const char *response)
+ const char *response,
+ double response_time,
+ double time_limit)
{
bool_t correct;
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.",
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
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);
bin_add_item (bin, item);
}
+static void
+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.
+ */
+ 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;
+ case CHALLENGE_TYPE_MIDI:
+ program = "timidity -Os";
+ break;
+ }
+
+ xasprintf (&command, "%s %s/%s >/dev/null 2>&1 &",
+ program,
+ mnemon->dir_name,
+ challenge);
+ system (command);
+ free (command);
+}
+
+static void
+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.
+ */
+ 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;
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);
+ }
+ mnemon_show_challenge (mnemon, category->challenge_type,
+ item->challenge);
+
+ gettimeofday (&start, NULL);
response = readline ("> ");
+ gettimeofday (&end, NULL);
+
+ mnemon_hide_challenge (mnemon, category->challenge_type);
+
/* 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);
+
+ /* Replay audio challenges for reinforcement. */
+ if (category->challenge_type == CHALLENGE_TYPE_AUDIO ||
+ category->challenge_type == CHALLENGE_TYPE_MIDI)
+ {
+ mnemon_show_challenge (mnemon, category->challenge_type,
+ item->challenge);
+ printf ("%s\n", item->challenge);
+ sleep (2);
+ }
+ } while (mnemon->to_introduce ||
+ mnemon->unlearned ||
+ mnemon->to_master > 0);
}
int
main (int argc, char *argv[])
{
mnemon_t mnemon;
+ char *response;
srand (time (NULL));
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;
}