X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;ds=sidebyside;f=mnemon.c;h=f869993061de67ad9332bbe3b77a8753ab882310;hb=e213a74c688dc475578348ac5e0e438055d11311;hp=fd7b9bf15b4ce7da6b6772420cfeea79e4028a39;hpb=ce8d39d4b7bd3cc650ea85636dfde4dad56903cf;p=mnemon diff --git a/mnemon.c b/mnemon.c index fd7b9bf..f869993 100644 --- a/mnemon.c +++ b/mnemon.c @@ -1,9 +1,10 @@ -/* - * Copyright © 2006 Carl Worth +/* mnemon - A memory training library + * + * Copyright © 2006,2011 Carl Worth * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2, or (at your option) + * the Free Software Foundation; either version 3, or (at your option) * any later version. * * This program is distributed in the hope that it will be useful, @@ -16,6 +17,8 @@ * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA." */ +#include "mnemon.h" + /* for asprintf */ #define _GNU_SOURCE #include @@ -25,6 +28,9 @@ #include #include +#include +#include +#include #include #include #include @@ -33,6 +39,14 @@ #include #include +#define ASSERT_NOT_REACHED \ +do { \ + static const int NOT_REACHED = 0; \ + assert (NOT_REACHED); \ +} while (0) + +#define unused(foo) foo __attribute__((unused)) + typedef int bool_t; typedef struct _item { @@ -41,19 +55,27 @@ typedef struct _item { char *response; } item_t; -typedef struct _bin { +struct _bin { int score; int items_size; int num_items; item_t **items; -} bin_t; +}; typedef enum { CATEGORY_ORDER_RANDOM, CATEGORY_ORDER_SEQUENTIAL } category_order_t; -typedef struct _category { +typedef enum { + CHALLENGE_TYPE_TEXT, + CHALLENGE_TYPE_IMAGE, + CHALLENGE_TYPE_AUDIO, + CHALLENGE_TYPE_MIDI, + CHALLENGE_TYPE_TEXT_TO_SPEECH +} challenge_type_t; + +struct _category { char *name; int items_size; int num_items; @@ -61,25 +83,14 @@ 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; - -typedef struct _mnemon { - char *dir_name; - - int categories_size; - int num_categories; - category_t *categories; - - int bins_size; - int num_bins; - bin_t *bins; - - int to_introduce; - int to_master; - int unlearned; - int mastered; -} mnemon_t; + /* Support challenges of non-text types (image, audio, etc.) */ + challenge_type_t challenge_type; + /* Whether to repeat afterwards (for a little extra reinforcement) */ + bool_t repeat; +}; static void * xmalloc (size_t size) @@ -187,7 +198,10 @@ 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; + category->repeat = 0; } static void @@ -254,6 +268,30 @@ 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; + case CHALLENGE_TYPE_AUDIO: + fprintf (file, "audio"); + break; + case CHALLENGE_TYPE_MIDI: + fprintf (file, "midi"); + break; + case CHALLENGE_TYPE_TEXT_TO_SPEECH: + fprintf (file, "text-to-speech"); + break; + } + fprintf (file, "\n\n"); + + fprintf (file, "repeat = %d\n\n", category->repeat); for (i = 0; i < category->num_items; i++) { item = &category->items[i]; @@ -358,7 +396,7 @@ bin_num_items_matching (bin_t *bin, return num_items; } -static void +void mnemon_init (mnemon_t *mnemon) { char *home; @@ -383,7 +421,7 @@ mnemon_init (mnemon_t *mnemon) mnemon->mastered = -1; } -static void +void mnemon_fini (mnemon_t *mnemon) { int i; @@ -527,7 +565,7 @@ trim_space (char *string) return string; } -static void +void mnemon_load_category (mnemon_t *mnemon, const char *name) { @@ -539,6 +577,7 @@ mnemon_load_category (mnemon_t *mnemon, char *path; category_t *category; int i; + struct stat st; path = xmalloc (strlen (mnemon->dir_name) + 1 + strlen (name) + 1); sprintf (path, "%s/%s", mnemon->dir_name, name); @@ -550,6 +589,12 @@ mnemon_load_category (mnemon_t *mnemon, exit (1); } + fstat (fileno(file), &st); + if (! S_ISREG(st.st_mode)) { + fprintf (stderr, "Error: File %s is not a regular file.\n", path); + exit (1); + } + category = mnemon_get_category (mnemon, name); #define READ_LINE do { \ @@ -571,7 +616,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 +643,40 @@ 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 if (strcmp (value, "audio") == 0) { + category->challenge_type = CHALLENGE_TYPE_AUDIO; + } else if (strcmp (value, "midi") == 0) { + category->challenge_type = CHALLENGE_TYPE_MIDI; + } else if (strcmp (value, "text-to-speech") == 0) { + category->challenge_type = CHALLENGE_TYPE_TEXT_TO_SPEECH; + } else { + fprintf (stderr, "Unknown value for \"challenge\" option \"%s\" at %s:%d\n", + value, path, line_count); + exit (1); + } + } else if (strcmp (name, "repeat") == 0) { + if (strcmp (value, "0") == 0) + category->repeat = 0; + else + category->repeat = 1; } else { fprintf (stderr, "Unknown option %s at %s:%d\n", name, path, line_count); @@ -657,7 +736,7 @@ mnemon_load_category (mnemon_t *mnemon, } } -static void +void mnemon_load (mnemon_t *mnemon) { DIR *dir; @@ -686,7 +765,7 @@ mnemon_load (mnemon_t *mnemon) closedir (dir); } -static void +void mnemon_save (mnemon_t *mnemon) { int i, err; @@ -711,6 +790,7 @@ mnemon_save (mnemon_t *mnemon) category_print (category, file); + fsync (fileno (file)); fclose (file); err = rename (lock_filename, filename); @@ -824,7 +904,7 @@ 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; + unsigned int length = iicolc->length; if (mnemon_item_category (mnemon, item) != category) return 0; @@ -835,25 +915,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 +953,7 @@ mnemon_select_item (mnemon_t *mnemon, *bin_ret = bin; *item_index_ret = item_index; + *category_ret = category; } @@ -906,7 +997,7 @@ print_histogram_bar (double size, printf ("\n"); } -static void +void mnemon_print_histogram (mnemon_t *mnemon, const char *category_name, int length) @@ -968,6 +1059,7 @@ mnemon_handle_command (mnemon_t *mnemon, const char *arg; int len; switch (command[0]) { + /* 'h' for histogram */ case 'h': { char *category = NULL; @@ -986,6 +1078,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; @@ -997,7 +1095,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,15 +1114,15 @@ 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.", @@ -1031,10 +1131,16 @@ mnemon_handle_response (mnemon_t *mnemon, printf ("On your first try, no less!"); } else { printf ("Masterful (%dx).", item->score); + if (mnemon->to_master) + mnemon->to_master--; } } 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) { @@ -1042,12 +1148,13 @@ mnemon_handle_response (mnemon_t *mnemon, 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 increase to_master here as an extra penalty. If the + * user is forgetting stuff learned previously, then more + * time should be spent on mastering than learning new + * items. Note that we only do this during the initial + * phase while new items are still being introduced. */ + if (mnemon->to_introduce) + mnemon->to_master++; /* 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 @@ -1055,7 +1162,6 @@ mnemon_handle_response (mnemon_t *mnemon, item->score = -2; } else { item->score--; - mnemon->to_master++; } } @@ -1074,11 +1180,73 @@ mnemon_handle_response (mnemon_t *mnemon, } 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; + case CHALLENGE_TYPE_TEXT_TO_SPEECH: + program = "mnemon-tts"; + break; + } + + xasprintf (&command, "%s %s/%s >/dev/null 2>&1 &", + program, + mnemon->dir_name, + challenge); + system (command); + free (command); +} + +static void +mnemon_hide_challenge (unused (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); +} + +void mnemon_do_challenges (mnemon_t *mnemon) { bin_t *bin; int item_index; item_t *item; + category_t *category; char *response; int i; @@ -1113,53 +1281,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) { - 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); + 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->repeat) + { + 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); - - printf ("Great job.\n"); -} - -int -main (int argc, char *argv[]) -{ - mnemon_t mnemon; - - srand (time (NULL)); - - mnemon_init (&mnemon); - - mnemon_load (&mnemon); - - mnemon_do_challenges (&mnemon); - - mnemon_save (&mnemon); - - mnemon_fini (&mnemon); - - return 0; }