X-Git-Url: https://git.cworth.org/git?p=mnemon;a=blobdiff_plain;f=mnemon.c;h=fd7b9bf15b4ce7da6b6772420cfeea79e4028a39;hp=3298197cde18d781b02ca19f0c64332ffe0078ec;hb=ce8d39d4b7bd3cc650ea85636dfde4dad56903cf;hpb=f73556d049d6c8b26a6619d7321899974c7fa764

diff --git a/mnemon.c b/mnemon.c
index 3298197..fd7b9bf 100644
--- a/mnemon.c
+++ b/mnemon.c
@@ -48,11 +48,20 @@ typedef struct _bin {
     item_t **items;
 } bin_t;
 
+typedef enum {
+    CATEGORY_ORDER_RANDOM,
+    CATEGORY_ORDER_SEQUENTIAL
+} category_order_t;
+
 typedef struct _category {
     char *name;
     int items_size;
     int num_items;
     item_t *items;
+
+    /* Support sequential introduction of items from bin 0 */
+    category_order_t order;
+    int bin_zero_head;
 } category_t;
 
 typedef struct _mnemon {
@@ -106,7 +115,21 @@ xstrdup (const char *s)
     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);
     }
@@ -163,6 +186,8 @@ category_init (category_t *category,
     category->items_size = 0;
     category->num_items = 0;
     category->items = NULL;
+    category->order = CATEGORY_ORDER_RANDOM;
+    category->bin_zero_head = 0;
 }
 
 static void
@@ -208,6 +233,18 @@ category_add_item (category_t	*category,
     return item;
 }
 
+static item_t *
+category_next_bin_zero_item (category_t	*category)
+{
+    int *i = &category->bin_zero_head;
+
+    for ( ; *i < category->num_items; *i = *i + 1)
+	if (category->items[*i].score == 0)
+	    return &category->items[*i];
+
+    return NULL;
+}
+
 static void
 category_print (category_t	*category,
 		FILE		*file)
@@ -215,6 +252,9 @@ category_print (category_t	*category,
     int i;
     item_t *item;
 
+    fprintf (file, "order = %s\n\n",
+	    category->order == CATEGORY_ORDER_RANDOM ? "random" : "sequential");
+
     for (i = 0; i < category->num_items; i++) {
 	item = &category->items[i];
 	if (i != 0)
@@ -279,6 +319,45 @@ bin_remove_item (bin_t	*bin,
 	bin->items[item_index] = bin->items[bin->num_items];
 }
 
+/* Find the index for an item within a bin.
+ *
+ * XXX: This is currently a linear search, so is a potential
+ * performance problem.
+ */
+static int
+bin_item_index (bin_t	*bin,
+		item_t	*item)
+{
+    int i;
+
+    for (i = 0; i < bin->num_items; i++)
+	if (bin->items[i] == item)
+	    return 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)
 {
@@ -298,10 +377,10 @@ mnemon_init (mnemon_t *mnemon)
     mnemon->num_bins = 0;
     mnemon->bins = NULL;
 
-    mnemon->to_introduce = 3;
+    mnemon->to_introduce = 10;
     mnemon->to_master = 10;
     mnemon->unlearned = 0;
-    mnemon->mastered = 0;
+    mnemon->mastered = -1;
 }
 
 static void
@@ -332,17 +411,31 @@ mnemon_categories_grow (mnemon_t *mnemon)
 				   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++];
@@ -414,6 +507,26 @@ chomp (char *s)
 	s[len - 1] = '\0';
 }
 
+static char *
+trim_space (char *string)
+{
+    char *s;
+
+    s = string;
+    while (*s && isspace (*s))
+	s++;
+
+    string = s;
+
+    s = string + strlen (string) - 1;
+    while (s > string && isspace (*s)) {
+	*s = '\0';
+	s--;
+    }
+
+    return string;
+}
+
 static void
 mnemon_load_category (mnemon_t		*mnemon,
 		      const char	*name)
@@ -439,19 +552,71 @@ mnemon_load_category (mnemon_t		*mnemon,
 
     category = mnemon_get_category (mnemon, name);
 
+#define READ_LINE do {					\
+    bytes_read = getline (&line, &line_size, file);	\
+    if (bytes_read == -1)				\
+	goto END_OF_FILE;				\
+    line_count++;					\
+    chomp (line);					\
+} while (0)
+
+    /* Parse options */
+    while (1) {
+	char *name, *equal, *value;
+
+	/* Ignore blank lines */
+	READ_LINE;
+	if (*line == '\0')
+	    continue;
+
+	/* An initial digit means we hit an item. Trigger the
+	 * spaghetti machine. */
+	if (*line >= '0' && *line <= '9')
+	    goto PARSE_BIN;
+
+	equal = strchr (line, '=');
+	if (equal == NULL) {
+	    fprintf (stderr, "Malformed option, (expected name=value): \"%s\" at %s:%d\n",
+		     line, path, line_count);
+	    exit (1);
+	}
+
+	value = equal + 1;
+	name = line;
+	*equal = '\0';
+
+	name = trim_space (name);
+	value = trim_space (value);
+
+	if (strcmp (name, "order") == 0) {
+	    if (strcmp (value, "sequential") == 0) {
+		category->order = CATEGORY_ORDER_SEQUENTIAL;
+	    } else if (strcmp (value, "random") == 0) {
+		category->order = CATEGORY_ORDER_RANDOM;
+	    } else {
+		fprintf (stderr, "Unknown value for \"order\" 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);
+	    exit (1);
+	}
+    }
+
+    /* Parse items */
     while (1) {
 	int score;
 	char *challenge, *response;
 
-	/* Read bin number (ignoring blank separator lines) */
-	do {
-	    bytes_read = getline (&line, &line_size, file);
-	    if (bytes_read == -1)
-		goto END_OF_FILE;
-	    line_count++;
-	    chomp (line);
-	} while (*line == '\0');
+	/* Ignore blank lines */
+	READ_LINE;
+	if (*line == '\0')
+	    continue;
 
+	/* Read bin number */
+      PARSE_BIN:
 	score = strtol (line, &end, 10);
 	if (*end != '\0') {
 	    fprintf (stderr, "Failed to parse bin number from \"%s\" at %s:%d\n",
@@ -460,19 +625,11 @@ mnemon_load_category (mnemon_t		*mnemon,
 	}
 
 	/* Read challenge */
-	bytes_read = getline (&line, &line_size, file);
-	if (bytes_read == -1)
-	    break;
-	line_count++;
-	chomp (line);
+	READ_LINE;
 	challenge = strdup (line);
 
 	/* Read response */
-	bytes_read = getline (&line, &line_size, file);
-	if (bytes_read == -1)
-	    break;
-	line_count++;
-	chomp (line);
+	READ_LINE;
 	response = line;
 
 	category_add_item (category, score, challenge, response);
@@ -620,20 +777,92 @@ rand_within_exponential (int num_values)
     return ones;
 }
 
+/* Find the category to which an item belongs. */
+static category_t *
+mnemon_item_category (mnemon_t	*mnemon,
+		      item_t	*item)
+{
+    category_t *category;
+    int i, item_index;
+
+    for (i = 0; i < mnemon->num_categories; i++) {
+	category = &mnemon->categories[i];
+	item_index = item - category->items;
+	if (item_index >= 0 && item_index < category->num_items)
+	    return category;
+    }
+
+    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 bin_index;
+    int bin_index, item_index;
     bin_t *bin;
 
     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;
+
+	item = bin->items[item_index];
+
+	category = mnemon_item_category (mnemon, item);
+
+	if (category->order == CATEGORY_ORDER_SEQUENTIAL) {
+	    item = category_next_bin_zero_item (category);
+	    if (item)
+		item_index = bin_item_index (bin, item);
+	}
+    }
+
     *bin_ret = bin;
-    *item_index_ret = rand_within (bin->num_items);
+    *item_index_ret = item_index;
 }
 
 
@@ -678,26 +907,56 @@ print_histogram_bar (double	size,
 }
 
 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;
     }
 }
@@ -706,10 +965,27 @@ static void
 mnemon_handle_command (mnemon_t		*mnemon,
 		       const char	*command)
 {
+    const char *arg;
+    int len;
     switch (command[0]) {
 	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;
         default:
 	    printf ("Unknown command: %s\n", command);
 	    break;
@@ -740,11 +1016,13 @@ mnemon_handle_response (mnemon_t	*mnemon,
 
     if (correct) {
 	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.",
@@ -761,9 +1039,15 @@ mnemon_handle_response (mnemon_t	*mnemon,
 	 * 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++;
-	    mnemon->mastered = 0;
+	    /* 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
@@ -771,25 +1055,18 @@ mnemon_handle_response (mnemon_t	*mnemon,
 	    item->score = -2;
 	} else {
 	    item->score--;
+	    mnemon->to_master++;
 	}
     }
 
-    printf (" (");
+    printf (" ");
     if (mnemon->to_introduce)
-	printf ("%d to come.", mnemon->to_introduce);
-    if (mnemon->to_introduce && mnemon->unlearned)
-	printf (" ");
+	printf ("%d to come. ", mnemon->to_introduce);
     if (mnemon->unlearned)
-	printf ("%d still unlearned.", mnemon->unlearned);
-    if (mnemon->to_introduce == 0 && mnemon->unlearned == 0) {
-	if (mnemon->mastered < mnemon->to_master)
-	    printf ("%d items to master",
-		    mnemon->to_master - mnemon->mastered);
-	else
-	    printf ("Great job!");
-	    mnemon->mastered++;
-    }
-    printf (")\n\n");
+	printf ("%d still unlearned. ", mnemon->unlearned);
+    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);
 
@@ -860,7 +1137,11 @@ mnemon_do_challenges (mnemon_t *mnemon)
 
 	mnemon_handle_response (mnemon, bin, item_index,
 				item, response);
-    } while (mnemon->mastered <= mnemon->to_master);
+    } while (mnemon->to_introduce ||
+	     mnemon->unlearned ||
+	     mnemon->to_master > 0);
+
+    printf ("Great job.\n");
 }
 
 int