memoire

@@ -1,6 +1,6 @@

 --[[

     returns a not-necessarily-meaningful number

-    iff `s` has mismathched curly-brackets

+    iff `s` has mismatched curly-brackets

 ]]

 local function mismatched(s)

     return ("}" .. s):find("}[^{]+}") or (s .. "{"):find("{[^}]+{")

@@ -10,24 +10,24 @@ local function fn(config, deck)

     if isatty() then

         io.write("Reading prompts; press Ctrl-D to stop\n")

     end

-    local rt = io.read("a")

+    local readtext = io.read("a")

     local cardctr = 0

     local prctr = 0

-    for pt in rt:gmatch("(..-)\n\n") do

-        local nc = {}

+    for notetext in readtext:gmatch("(..-)\n\n") do

+        local newcard = Card:new({ note = notetext, ct = "bmc", created = os.time() })

         -- these Prompts will just be converted to Rec, so we don't need to exclude answers from prompt-text

-        for _re in pt:gmatch("%{[^%}]+%}") do

-            table.insert(nc, Prompt:new(pt, "", os.time(), 30, 0, 0, os.time(), config:get("StartingEase") or 2.5))

+        for _re in pt:gmatch("{[^}]+}") do

+            table.insert(newcard.pr, Prompt:new({ card = newcard, ease = config:get("StartingEase") }))

             prctr = prctr + 1

         end

-        if mismatched(pt) then

-            io.write(string.format("Prompt %d:1 (\"%s\") contains mismatched braces\n", #deck + 1, pt))

+        if mismatched(notetext) then

+            io.write(string.format("Card %d (\"%s\") contains mismatched braces\n", #deck + 1, notetext))

         end

-        if #nc >= 1 then

-            table.insert(deck, nc)

+        if #newcard.pr >= 1 then

+            table.insert(deck, newcard)

             cardctr = cardctr + 1

         else

-            io.write(string.format("Prompt \"%s\" contains no answers (check braces)\n", pt))

+            io.write(string.format("Card \"%s\" contains no answers (check braces)\n", notetext))

         end

     end

     io.write(string.format(

@@ -0,0 +1,77 @@

+--[[

+    a card consists of a base note, a card type, a creation timestamp,

+    and a list of prompts

+

+    timestamps are seconds from the Unix epoch

+]]

+

+local Card = {}

+Card.__index = Card

+

+function Card:new(ctable)

+    local o = { note = "", ct = "bmc", created = os.time(), pr = {} }

+    setmetatable(o, self)

+    for k, v in pairs(ctable) do

+        if o[k] then o[k] = v end

+    end

+    return o

+end

+

+function Card:__tostring()

+    return string.format("\"%s\" (%s), %d (%d)", self.note, self.ct, #self.pr, self.created)

+end

+

+--[[

+    extracts `Card`s from a record-based deck

+    returns a table of `Card`s

+]]

+function Card:fromrecs(recs, conf)

+    local ret = {}

+    for i, rec in ipairs(recs) do

+        local bn

+        if rec.PromptText then bn = rec.PromptText[1] end

+        if rec.BaseNote then bn = rec.BaseNote[1] end

+        if bn then

+            local cc = Card:new({ note = bn, ct = (rec.CardType or {})[1], created = (rec.Created or {})[1] })

+            if cc.ct == "bmc" then

+                local m, n = cc.note:find("{[^}]+}")

+                local ctr = 1

+                while m do

+                    table.insert(cc.pr, Prompt:new({

+                        card = cc,

+                        ind = m,

+                        time = tonumber((rec.LastReview or {})[ctr]),

+                        delay = tonumber((rec.LastDelay or {})[ctr]),

+                        succ = tonumber((rec.Successes or {})[ctr]),

+                        fail = tonumber((rec.Failures or {})[ctr]),

+                        ease = tonumber((rec.Ease or {})[ctr]),

+                    }))

+                    m, n = cc.note:find("{[^}]+}", n)

+                    ctr = ctr + 1

+                end

+                table.insert(ret, cc)

+            else

+                print("error: unsupported card type " .. cc.ct)

+            end

+        end

+    end

+    return ret

+end

+

+--[[

+    serialises a `Card` to a record

+    returns a table mapping labels to value-lists

+]]

+function Card:torec()

+    local ret = { BaseNote = { self.note }, CardType = { self.ct }, Created = { self.created }, LastReview = {}, LastDelay = {}, Successes = {}, Failures = {}, Ease = {} }

+    for i, pr in ipairs(self.pr) do

+        ret.LastReview[i] = pr.time

+        ret.LastDelay[i] = pr.delay

+        ret.Successes[i] = pr.succ

+        ret.Failures[i] = pr.fail

+        ret.Ease[i] = pr.ease

+    end

+    return ret

+end

+

+return Card

@@ -1,9 +1,9 @@

 local function fn(config, deck, _, ip)

-    local sp = deck[ip[1]][ip[2]]

-    local rt = sp:spt()

+    local sc = deck[ip[1]]

+    local ot = sc.note

     local fname = "memoire_cc.tmp"

     local fh = io.open(fname, "w")

-    fh:write(rt)

+    fh:write(ot)

     fh:close()

     os.execute(string.format(

         "%s %q",

@@ -14,10 +14,8 @@ local function fn(config, deck, _, ip)

     local nt = fh:read("a"):gsub("%s+$", ""):gsub("^%s+", "")

     fh:close()

     os.remove(fname)

-    if nt ~= sp:spt() and nt ~= "" then

-        local cardrec = Prompt:torec(deck[ip[1]])

-        cardrec.PromptText = { nt }

-        deck[ip[1]] = Prompt:fromrecs({ cardrec }, config)[1]

+    if nt ~= ot and nt ~= "" then

+        deck[ip[1]].note = nt

         return deck

     end

 end

@@ -1,7 +1,7 @@

 local function fn(config, deck, deckfname)

     local mcl = {}

     for i, card in ipairs(deck) do

-        for path in card[1]:spt():gmatch(IMG_PATTERN) do

+        for path in card.note:gmatch(IMG_PATTERN) do

             local fh = io.open((deckfname:match(".*/") or "") .. path, "r")

             if not fh then

                 table.insert(mcl, i)

@@ -15,7 +15,7 @@ local function fn(config, deck, deckfname)

         io.write(string.format("No cards with bad image references\n"))

     end

     for _, i in ipairs(mcl) do

-        io.write(string.format("%d %s\n", i, deck[i][1]:spt()))

+        io.write(string.format("%d %s\n", i, deck[i].note))

     end

 end

@@ -8,18 +8,18 @@ end

 local function fn(config, deck)

     local leechqueue = {}

     for i, cg in ipairs(deck) do

-        for j, pr in ipairs(cg) do

+        for j, pr in ipairs(cg.pr) do

             if badness(pr) > 0.3 and pr.delay >= 0 then

                 table.insert(leechqueue, { i, j })

             end

         end

     end

     table.sort(leechqueue, function(a, b)

-        return badness(deck[a[1]][a[2]]) > badness(deck[b[1]][b[2]])

+        return badness(deck[a[1]].pr[a[2]]) > badness(deck[b[1]].pr[b[2]])

     end)

     io.write(string.format("Detected %d leeches:\n", #leechqueue))

     for _, ij in ipairs(leechqueue) do

-        io.write(string.format("%d:%d %s\n", ij[1], ij[2], deck[ij[1]][ij[2]]))

+        io.write(string.format("%d:%d %s\n", ij[1], ij[2], deck[ij[1]].pr[ij[2]]))

     end

 end

@@ -2,31 +2,32 @@

     deck loading and saving functions (working with Recfiles)

 ]]

-local Prompt = dofile(SRC_DIR .. "prompt.lua")

+local Card = dofile(SRC_DIR .. "card.lua")

 local recrw = dofile(SRC_DIR .. "recrw.lua")

 --[[

-    load a deck (a table of tables of `Prompt`s) from a Recfile

+    load a deck (a table of `Card`s) from a Recfile

 ]]

 local function loaddeck(fname, conf)

     local fh = io.open(fname)

-    if not fh then return nil end

+    if not fh then print("no fh") return nil end

     local rt = fh:read "a"

-    if not rt then return nil end

+    if not rt then print("no read") return nil end

     fh:close()

     local pr = recrw.read(rt)

-    if not pr then return nil end

-    local ep = Prompt:fromrecs(pr, conf)

+    if not pr then print("no recs") return nil end

+    local ep = Card:fromrecs(pr, conf)

+    if not ep then print("no cards") return nil end

     return ep

 end

 --[[

-    save a deck (a table of tables of `Prompt`s) to a Recfile

+    save a deck (a table of `Card`s) to a Recfile

 ]]

 local function savedeck(fname, deck)

     local rrf = {}

     for i, cg in ipairs(deck) do

-        rrf[i] = Prompt:torec(cg)

+        rrf[i] = cg:torec()

     end

     local wot = recrw.write(rrf)

     local fh = io.open(fname, "w")

@@ -5,6 +5,7 @@

 SRC_DIR = arg[0]:match("^.*/") or ""

+Card = dofile(SRC_DIR .. "card.lua")

 Prompt = dofile(SRC_DIR .. "prompt.lua")

 review = dofile(SRC_DIR .. "review.lua")

 loader = dofile(SRC_DIR .. "loader.lua")

@@ -78,7 +79,7 @@ end

     question-text, question-lang, answer-text, answer-lang

 ]]

 defaultprspeak = function(pr)

-    return {(pr.text:gsub("%{([^{}]+)%}", "%1"):gsub("%%A", "WHAT"))}, {false}, {"ANSWER: " .. pr.ans}, {false}

+    return {(pr:text():gsub("%{([^{}]+)%}", "%1"):gsub("%%A", "WHAT"))}, {false}, {"ANSWER: " .. pr:ans()}, {false}

 end

 prspeak = defaultprspeak

 do

@@ -1,8 +1,7 @@

 --[[

-    a prompt consists of prompt text (with an answer-insertion point),

-    a correct answer, the review timestamp, the review delay,

-    counts of successful and failed reviews,

-    a creation timestamp, and an ease measurement

+    a prompt consists of a parent card, an index into the note,

+    the review timestamp, the review delay,

+    counts of successful and failed reviews, and an ease measurement

     timestamps are seconds from the Unix epoch

     review delay is in seconds

@@ -11,41 +10,52 @@

 local Prompt = {}

 Prompt.__index = Prompt

---[[

-    the answer-insertion point is indicated with a "%A" in the prompt text

-]]

-function Prompt:new(pt, ca, rts, rd, sc, fc, ct, ez)

-    local o = {}

+function Prompt:new(prtable)

+    local o = { card = {}, ind = 0, time = os.time(), delay = 30, succ = 0, fail = 0, ease = 2.5 }

     setmetatable(o, self)

-    o.text = pt

-    o.ans = ca

-    o.time = tonumber(rts)

-    o.delay = tonumber(rd)

-    o.succ = tonumber(sc)

-    o.fail = tonumber(fc)

-    o.created = tonumber(ct)

-    o.ease = tonumber(ez)

+    for k, v in pairs(prtable) do

+        if o[k] then o[k] = v end

+    end

     return o

 end

 function Prompt:__tostring()

     return string.format(

         "\"%s\" (\"%s\") %d -> %d+%d*%f %d/%d",

-        self.text, self.ans, self.created or 0,

+        self:text(), self:ans(), self.card.created or 0,

         self.time, math.floor(self.delay), self.ease,

         self.succ, self.fail

     )

 end

-function Prompt:retention()

-    return self.succ / (self.succ + self.fail)

-end

-

 --[[

-    derive the `PromptText` used to create this `Prompt`

+    the answer-insertion point is indicated with a "%A" in the prompt text

 ]]

-function Prompt:spt()

-    return self.text:gsub("%%A", "{" .. self.ans:gsub("%%", "%%%%") .. "}")

+function Prompt:text()

+    if self.ind == 0 then

+        return "error: unpopulated ind"

+    end

+    if self.card.ct == "bmc" then

+        local _, eoa = self.card.note:find("{[^}]+}", self.ind)

+        return self.card.note:sub(1, self.ind - 1) .. "%A" .. self.card.note:sub(eoa + 1)

+    else

+        return "error: unrecognised card type " .. self.card.ct

+    end

+end

+

+function Prompt:ans()

+    if self.ind == 0 then

+        return "error: unpopulated ind"

+    end

+    if self.card.ct == "bmc" then

+        return self.card.note:match("{([^}]+)}", self.ind)

+    else

+        return "error: unrecognised card type " .. self.card.ct

+    end

+end

+

+function Prompt:retention()

+    return self.succ / (self.succ + self.fail)

 end

 --[[

@@ -1,7 +1,7 @@

 local function fn(config, deck, deckfname, qs)

     local mcl = {}

     for i, card in ipairs(deck) do

-        if card[1]:spt():find(qs) then

+        if card.note:find(qs) then

             table.insert(mcl, i)

         end

     end

@@ -11,7 +11,7 @@ local function fn(config, deck, deckfname, qs)

         io.write(string.format("No matches for %q\n", qs))

     end

     for _, i in ipairs(mcl) do

-        io.write(string.format("%d %s\n", i, deck[i][1]:spt()))

+        io.write(string.format("%d %s\n", i, deck[i].note))

     end

 end

@@ -49,7 +49,7 @@ local function importance(prompt, conf)

     pb = conf["PriorityBias"] or {}

     s = 0

     for i, t in ipairs(pt) do

-        if prompt:spt():find(t) then

+        if prompt.card.note:find(t) then

             s = s + pb[i]

         end

     end

@@ -84,7 +84,7 @@ local function toreviewlist(deck, conf, filter)

     local ctrt = {}

     local ff = filter or alwaystrue

     for i, cg in ipairs(deck) do

-        for j, pr in ipairs(cg) do

+        for j, pr in ipairs(cg.pr) do

             local sc = should(pr, conf)

             if sc and ff(pr) then

                 table.insert(ctrt, { i, j, sc or 0 })

@@ -124,16 +124,16 @@ local function fn(config, deck, deckfname)

         if ind > climn then

             break

         end

-        local pr = deck[ip[1]][ip[2]]

+        local pr = deck[ip[1]].pr[ip[2]]

         -- remove braces for display

-        local pst = pr.text:gsub("%{([^{}]+)%}", "%1")

+        local pst = pr:text():gsub("%{([^{}]+)%}", "%1")

         local st = os.time()

         imgify(pst:gsub("%%A", "___"), deckfname:match(".*/") or "", ind, climn, config, true)

         io.write("\n")

         io.read("l")

         clear()

         imgify(

-            pst:gsub("%%A", "\x1b[1m" .. (pr.ans:gsub("%%", "%%%%")) .. "\x1b[0m"),

+            pst:gsub("%%A", "\x1b[1m" .. (pr:ans():gsub("%%", "%%%%")) .. "\x1b[0m"),

             deckfname:match(".*/") or "",

             ind,

             climn,

@@ -155,7 +155,7 @@ local function fn(config, deck, deckfname)

             if sc == 0 then

                 lrc = lrc + 1

             end

-            review.update(deck[ip[1]][ip[2]], st, sc, config)

+            review.update(deck[ip[1]].pr[ip[2]], st, sc, config)

         end

         clear()

         if resp:sub(#resp):lower() == "q" then

@@ -180,7 +180,7 @@ local function fn(config, deck, deckfname)

     if #editqueue > 0 then

         io.write(string.format("The following cards are marked for correction:\n"))

         for _, ip in ipairs(editqueue) do

-            io.write(string.format("%d:%d %s\n", ip[1], ip[2], deck[ip[1]][ip[2]]))

+            io.write(string.format("%d %s\n", ip[1], deck[ip[1]]))

         end

     end

     if climn > 0 then

@@ -34,9 +34,9 @@ local function fn(config, deck, deckfname, qs)

     local expdeck = {}

     for _, card in ipairs(deck) do

         local rtc

-        for _, pr in ipairs(card) do

-            if not qs or (pr.text:find(qs) or pr.ans:find(qs)) then

+        if not qs or card.note:find(qs) then

             rtc = true

+            for _, pr in ipairs(card.pr) do

                 tsc = tsc + pr.succ

                 tfc = tfc + pr.fail

                 if pr.delay < 0 then

@@ -78,11 +78,11 @@ local function fn(config, deck, deckfname, qs)

     io.write("\nDelay-last review ratio\n" .. histogram(expdeck, 0, 2, 0.1, function(pr) return (os.time() - pr.time) / pr.delay end, 0.1))

     io.write("\nRetention (%)\n" .. histogram(expdeck, 30, 100, 10, function(pr) return 100 * pr:retention() end, 0.02))

     io.write("\nReview counts\n" .. histogram(expdeck, 0, 20, 2, function(pr) return pr.succ + pr.fail end, 0.03))

-    io.write("\nLog2-age (seconds)\n" .. histogram(expdeck, 18, 28, 0.5, function(pr) return math.log(os.time() - (pr.created or 2 * os.time()), 2) end, 0.05))

-    io.write("\nPrompt-count\n" .. histogram(deck, 1, 10, 1, function(card) return #card end, 0.03))

+    io.write("\nLog2-age (seconds)\n" .. histogram(deck, 18, 28, 0.5, function(card) return math.log(os.time() - (card.created or 2 * os.time()), 2) end, 0.05))

+    io.write("\nPrompt-count\n" .. histogram(deck, 1, 10, 1, function(card) return #card.pr end, 0.03))

     local cpcs = {}

     for _, card in ipairs(deck) do

-        local cp = card[1].text:match("([^:]+):") or ""

+        local cp = card.note:match("([^:]+):") or ""

         cpcs[cp] = (cpcs[cp] or 0) + 1

     end

     local scl = {}

@@ -1,5 +1,5 @@

 local function fn(config, deck, _, ip)

-    local sp = deck[ip[1]][ip[2]]

+    local sp = deck[ip[1]].pr[ip[2]]

     local dir

     if sp.delay < 0 then

         dir = "Restoring"

@@ -25,7 +25,7 @@ local function fn(config, deck, deckfname)

         return nil

     end

     -- collect list of index-pairs for prompts to be reviewed this session

-    local ctrt = review.list(deck, config, function(pr) return not pr:spt():find("IMG%[") end)

+    local ctrt = review.list(deck, config, function(pr) return not pr.card.note:find("IMG%[") end)

     speak(string.format(

         "%d prompts to review; how many in this session? ", #ctrt

     ), config)

@@ -44,9 +44,9 @@ local function fn(config, deck, deckfname)

         if ind > climn then

             break

         end

-        local pr = deck[ip[1]][ip[2]]

+        local pr = deck[ip[1]].pr[ip[2]]

         -- remove braces for display

-        local pst = pr.text:gsub("%{([^{}]+)%}", "%1")

+        local pst = pr:text():gsub("%{([^{}]+)%}", "%1")

         local st = os.time()

         io.write(pst .. "\n" .. ind .. "/" .. climn .. "\n")

         local qt, ql, at, al = prspeak(pr)

@@ -65,7 +65,7 @@ local function fn(config, deck, deckfname)

             if sc == 0 then

                 lrc = lrc + 1

             end

-            review.update(deck[ip[1]][ip[2]], st, sc, config)

+            review.update(deck[ip[1]].pr[ip[2]], st, sc, config)

         end

         clear()

         if resp:sub(#resp):lower() == "q" then

@@ -90,7 +90,7 @@ local function fn(config, deck, deckfname)

     if #editqueue > 0 then

         io.write(string.format("The following cards are marked for correction:\n"))

         for _, ip in ipairs(editqueue) do

-            io.write(string.format("%d:%d %s\n", ip[1], ip[2], deck[ip[1]][ip[2]]))

+            io.write(string.format("%d %s\n", ip[1], deck[ip[1]]))

         end

     end

     if climn > 0 then