1 /* mnemon - A memory training program
3 * Copyright © 2006,2011 Carl Worth
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3, or (at your option)
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software Foundation,
17 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA."
28 #include <sys/types.h>
37 #include <readline/readline.h>
38 #include <readline/history.h>
42 #define ASSERT_NOT_REACHED \
44 static const int NOT_REACHED = 0; \
45 assert (NOT_REACHED); \
48 typedef struct progress {
56 xstrndup (const char *s, size_t n)
62 fprintf (stderr, "Error: out of memory\n");
70 xasprintf (char **strp, const char *fmt, ...)
76 ret = vasprintf (strp, fmt, ap);
80 fprintf (stderr, "Error: out of memory\n");
86 _show_challenge (mnemon_t *mnemon,
87 challenge_type_t challenge_type,
88 const char *challenge)
93 if (challenge_type == CHALLENGE_TYPE_TEXT) {
94 printf ("%s\n", challenge);
98 /* XXX: Yes, shelling out to system is total cheese. The planned
99 * fix here is to bring graphical display in process, (or at least
100 * have a custom external program that accepts image filenames on
103 switch (challenge_type) {
104 case CHALLENGE_TYPE_TEXT:
107 case CHALLENGE_TYPE_IMAGE:
108 program = "xli -gamma 2.2";
110 case CHALLENGE_TYPE_AUDIO:
113 case CHALLENGE_TYPE_MIDI:
114 program = "timidity -Os";
116 case CHALLENGE_TYPE_TEXT_TO_SPEECH:
117 program = "mnemon-tts";
121 xasprintf (&command, "%s %s/%s >/dev/null 2>&1 &",
130 _hide_challenge (unused (mnemon_t *mnemon),
131 challenge_type_t challenge_type)
135 if (challenge_type != CHALLENGE_TYPE_IMAGE)
138 /* XXX: And this is just embarrassing (obviously wrong in several
139 * ways). Hopefully I'll amend away any commit that includes this.
141 xasprintf (&command, "killall xli");
146 typedef int (item_match_predicate_t) (void *closure, item_t *item);
148 /* Return the number of items in the bin from the given category (or
149 * from all categories if category == NULL) */
151 bin_num_items_matching (bin_t *bin,
152 item_match_predicate_t *predicate,
155 int i, num_items = 0;
157 if (predicate == NULL)
158 return bin->num_items;
160 for (i = 0; i < bin->num_items; i++)
161 if ((predicate) (closure, bin->items[i]))
167 typedef struct _item_in_category_closure
170 category_t *category;
171 } item_in_category_closure_t;
174 mnemon_item_in_category (void *closure, item_t *item)
176 item_in_category_closure_t *iicc = closure;
177 mnemon_t *mnemon = iicc->mnemon;
178 category_t *category = iicc->category;
180 return (mnemon_item_category (mnemon, item) == category);
183 typedef struct _item_in_category_of_length_closure
186 category_t *category;
188 } item_in_category_of_length_closure_t;
191 mnemon_item_in_category_of_length (void *closure, item_t *item)
193 item_in_category_of_length_closure_t *iicolc = closure;
194 mnemon_t *mnemon = iicolc->mnemon;
195 category_t *category = iicolc->category;
196 unsigned int length = iicolc->length;
198 if (mnemon_item_category (mnemon, item) != category)
201 return strlen (item->challenge) == length;
204 #define HISTOGRAM_ROW_FORMAT "%3d: %3d"
205 #define HISTOGRAM_BAR_WIDTH 63
208 print_histogram_bar (double size,
211 int units_per_cell = (int) ceil (max / HISTOGRAM_BAR_WIDTH);
212 static char const *boxes[8] = {
217 while (size > units_per_cell) {
219 size -= units_per_cell;
222 size /= units_per_cell;
226 else if (size > 6.5/8.0)
228 else if (size > 5.5/8.0)
230 else if (size > 4.5/8.0)
232 else if (size > 3.5/8.0)
234 else if (size > 2.5/8.0)
236 else if (size > 1.5/8.0)
238 else if (size > 0.5/8.0)
244 /* Print a histogram showing the number of items in each bin.
246 * If category_name is not NULL, then only the items from the given
247 * category (matching a particular filename within the user's .mnemon
248 * directory) will be shown.
250 * If length is non zero, then only items with a challenge string of
251 * 'length' characters will be shown. (This is only useful for
252 * particular types of challenges, such as for showing anagram
253 * challenges of a given length).
255 * To see a histogram of all currently-loaded items, pass NULL for
256 * category and 0 for length.
258 * Note: Some bins may be removed entirely by (a misfeature side
259 * effect of) the mnemon_do_challenges function, (such as bin 0 being
260 * removed after the introduction phase is complete). An accurate
261 * histogram can be guaranteed by calling menmon_print_histogram
262 * immediately after calling mnemon_load.
265 print_histogram (mnemon_t *mnemon,
266 const char *category_name,
269 int i, last_score, max;
270 category_t *category = NULL;
273 item_match_predicate_t *predicate = NULL;
274 void *closure = NULL;
275 item_in_category_closure_t item_in_category;
276 item_in_category_of_length_closure_t item_in_category_of_length;
278 if (mnemon->num_bins == 0)
282 category = mnemon_get_category_if_exists (mnemon, category_name);
285 predicate = mnemon_item_in_category_of_length;
286 item_in_category_of_length.mnemon = mnemon;
287 item_in_category_of_length.category = category;
288 item_in_category_of_length.length = length;
289 closure = &item_in_category_of_length;
291 predicate = mnemon_item_in_category;
292 item_in_category.mnemon = mnemon;
293 item_in_category.category = category;
294 closure = &item_in_category;
299 for (i = 0; i < mnemon->num_bins; i++) {
300 num_items = bin_num_items_matching (&mnemon->bins[i],
302 if (i == 0 || num_items > max)
306 for (i = 0; i < mnemon->num_bins; i++) {
307 bin = &mnemon->bins[i];
309 while (bin->score - last_score > 1)
310 printf (HISTOGRAM_ROW_FORMAT "\n", ++last_score, 0);
311 num_items = bin_num_items_matching (bin,
313 printf (HISTOGRAM_ROW_FORMAT " ", bin->score, num_items);
314 print_histogram_bar (num_items, max);
315 last_score = bin->score;
320 _handle_command (mnemon_t *mnemon,
325 switch (command[0]) {
326 /* 'h' for histogram */
329 char *category = NULL;
333 arg += strspn (arg, " \t");
334 len = strcspn (arg, " \t");
336 category = xstrndup (arg, len);
338 arg += strspn (arg, " \t");
342 print_histogram (mnemon, category, length);
348 /* Nothing necessary for repeating. */
352 printf ("Unknown command: %s\n", command);
358 _handle_response (mnemon_t *mnemon,
362 const char *response,
363 double response_time,
365 progress_t *progress)
368 int old_score = item->score;
370 correct = (strcmp (response, item->response) == 0);
374 printf (" %s is the correct answer.",
379 (time_limit != 0.0 && response_time > time_limit))
381 printf ("Correct, but not quite quick enough (%0.2f seconds---needed %0.2f seconds)\n",
382 response_time, time_limit);
386 mnemon_score_item (mnemon, bin, item_index, correct);
390 if (item->score < 0) {
391 printf ("Yes---just give me %d more.",
393 } else if (item->score == 1) {
395 progress->unlearned--;
396 printf ("You got it!");
398 printf ("On your first try, no less!");
401 printf ("Masterful (%dx).", item->score);
402 if (progress->to_master)
403 progress->to_master--;
407 printf (" Oops, you knew that, right? (%dx)\n ",
409 progress->unlearned++;
410 /* We increase to_master here as an extra penalty. If the
411 * user is forgetting stuff learned previously, then more
412 * time should be spent on mastering than learning new
413 * items. Note that we only do this during the initial
414 * phase while new items are still being introduced. */
415 if (progress->to_introduce)
416 progress->to_master++;
421 if (progress->to_introduce)
422 printf ("%d to come. ", progress->to_introduce);
423 if (progress->unlearned)
424 printf ("%d still unlearned. ", progress->unlearned);
425 if (progress->to_introduce == 0 && progress->to_master > 0)
426 printf ("%d items to master", progress->to_master);
430 /* A session of challenges consists of three phases, some of which may
431 * be entirely empty, as follows:
433 * 1. The introduction phase
435 * This phase is controlled by the to_introduce counter which is
436 * by default set to 10. It is decremented every time an item is
437 * introduced from the bin with score 0, or (if there is no bin
438 * with score 0), every time an item is introduced from the bin
439 * with the lowest non-negative score of any bin.
441 * 2. The mastering phase
443 * This phase is controlled by the to_master counter which is
444 * initially set to 10. It begins at the beginning of the session
445 * so can run concurrently with the introduction phase. The
446 * to_master counter is decremented every time an item with a
447 * positive (non-zero) score is answered correctly. It is also
448 * incremented every time an item with a positive (non-zero) score
449 * is answered incorrectly during the introduction phase. If
450 * perfect mastery is demonstrated, the mastering phase is likely
451 * to be complete simultaneous with the introduction stage. If the
452 * user is really struggling with mastery, the mastering phase
453 * will extend long after the introduction phase is over. But
454 * since we never incremeent to_master after the introduction
455 * phase is over, the user cannot build an infinite snowball of
456 * to_master items and have to give up in despair.
458 * 3. The solidifying phase
460 * This final phase continues after the mastering phase for as
461 * long as any items with a negative score remain. The idea here
462 * is that we want to quickly give the reinforcement from a missed
463 * item in the current session. Also, there's a bit of a challenge
464 * to the user to demonstrate good mastery of any non-negative
465 * items presented so that the phase actually terminates. It's
466 * possible for this phase to extend for an arbitrary amount of
467 * time, but not very likely, (since the negative items are chosen
468 * preferentially and the user will continue to see the correct
469 * answers to them over and over).
471 * This function returns after all three phases are complete.
473 * The user's progress (the movement of items to various new bins) is
474 * kept only in memory. In order to save this progress to disk, the
475 * caller must call mnemon_save.
478 _do_challenges (mnemon_t *mnemon, progress_t *progress)
483 category_t *category;
487 /* Count the number of items with negative scores. */
488 progress->unlearned = 0;
489 for (i = 0; i < mnemon->num_bins; i++) {
490 bin = &mnemon->bins[i];
493 progress->unlearned += bin->num_items;
496 progress->to_introduce -= progress->unlearned;
497 if (progress->to_introduce < 0)
498 progress->to_introduce = 0;
500 /* Get rid of bin with score of 0 if we aren't going to be
501 * introducing anything from it. */
502 if (progress->to_introduce == 0) {
503 mnemon_remove_bin (mnemon, 0);
506 if (progress->unlearned) {
507 printf ("You've got %d items to learn already. ", progress->unlearned);
508 if (progress->to_introduce)
509 printf ("I'll introduce %d more as we go.", progress->to_introduce);
512 printf ("Introducing %d new items.\n", progress->to_introduce);
517 struct timeval start, end;
520 mnemon_select_item (mnemon, &bin, &item_index, &category, &introduced);
521 item = bin->items[item_index];
523 if (progress->to_introduce > 0 && introduced)
524 progress->to_introduce--;
527 if (category->time_limit > 0.0) {
528 response = readline ("The next one is timed. Press enter when ready:");
532 _show_challenge (mnemon, category->challenge_type,
535 gettimeofday (&start, NULL);
536 response = readline ("> ");
537 gettimeofday (&end, NULL);
539 _hide_challenge (mnemon, category->challenge_type);
541 /* Terminate on EOF */
542 if (response == NULL) {
547 if (response[0] == '/') {
548 _handle_command (mnemon, response + 1);
555 _handle_response (mnemon, bin, item_index,
557 (end.tv_sec + end.tv_usec / 1e6) -
558 (start.tv_sec + start.tv_usec / 1e6),
559 category->time_limit, progress);
562 /* Replay audio challenges for reinforcement. */
563 if (category->repeat)
565 _show_challenge (mnemon, category->challenge_type,
567 printf ("%s\n", item->challenge);
570 } while (progress->to_introduce ||
571 progress->unlearned ||
572 progress->to_master > 0);
576 main (int argc, char *argv[])
582 void _load_categories()
586 for (i = 1; i < argc; i++)
587 mnemon_load_category (&mnemon, argv[i]);
589 mnemon_load (&mnemon);
595 mnemon_init (&mnemon);
599 /* Set some reasonable defaults for a session */
600 progress.to_introduce = 10;
601 progress.to_master = 10;
602 progress.unlearned = 0;
603 progress.mastered = -1;
605 _do_challenges (&mnemon, &progress);
607 mnemon_save (&mnemon);
609 mnemon_fini (&mnemon);
611 mnemon_init (&mnemon);
615 printf ("Great job.\nHere are your current results:\n");
616 print_histogram (&mnemon, NULL, 0);
617 response = readline ("Press enter to quit.\n");
620 mnemon_fini (&mnemon);