pret-lam.lua

   1 -- filename : type-lam.lua
   2 -- comment  : Pretty printing of (extended) lambda calculus
   3 -- author   : Matthijs Kooijman, Universiteit Twente, NL
   4 -- copyright: Matthijs Kooijman
   5 -- license  : None
   6
   7 local utf = unicode.utf8
   8
   9 local vis = buffers.newvisualizer("lam")
  10
  11 local colors = {
  12     "prettytwo",
  13     "prettyone",
  14     "prettythree",
  15     "prettyfour"
  16 }
  17
  18 -- Symbols that should have a different representation
  19 local symbols = {
  20     -- Note, the space we replace with is a Unicode non-breaking space
  21     -- (U+00A0).
  22     {symbol = ' ', repr = ' '},
  23     {symbol = '_', repr = '\\_'},
  24     {symbol = '->>', repr = '\\twoheadrightarrow'},
  25     {symbol = '->', repr = '→'},
  26     {symbol = '=>', repr = '⇒'},
  27     -- The default * sits very high above the baseline, \ast (u+2217) looks
  28     -- better.
  29     {symbol = '*', repr = '\\ast'},
  30     {symbol = '~', repr = '\\HDLine[width=.20 * \\the\\textwidth]'},
  31     {symbol = '|', repr = '\\char' .. utf.byte('|')},
  32     -- Use ▶ and ∧ from our roman font, since Iwona doesn't have the glyph
  33     {symbol = '▶', repr = '{\\rm{}▶}'},
  34     --{symbol = '∧', repr = '{$∧$}'},
  35     {symbol = '∧', repr = '{\\rm{}∧}'},
  36 }
  37
  38 -- Keywords that should be bold
  39 local keywords = {
  40     ['case'] = {},
  41     ['of'] = {},
  42     ['let'] = {},
  43     ['letrec'] = {},
  44     ['letnonrec'] = {},
  45     ['in'] = {},
  46     ['DEFAULT'] = {small = true},
  47 }
  48
  49 local in_block = 0
  50 local submatches = {}
  51 local bases = {}
  52 -- Store the last line for each indent level
  53 local indentlines = {}
  54
  55 function array_concat(a1, a2)
  56     local res = a1
  57     for k,v in ipairs(a2) do
  58         table.insert(res, v)
  59     end
  60     return res
  61 end
  62
  63
  64 -- See if str starts with a symbol, and return the remaining string and that
  65 -- symbol. If no symbol from the table is matched, just returns the first
  66 -- character.  We can do a lookup directly, since symbols can be different in
  67 -- length, so we just loop over all symbols, trying them in turn.
  68 local function take_symbol(str)
  69     for i,props in ipairs(symbols) do
  70         -- Try to remove symbol from the start of str
  71         symbol, newstr = utf.match(str, "^(" .. props.symbol .. ")(.*)")
  72         if symbol then
  73             -- Return this tokens repr, or just the token if it has no
  74             -- repr.
  75             res = props.repr or symbol
  76             -- Enclose the token in {\style .. }
  77             if props.style then
  78                 res = "{\\" .. props.style ..  " " .. res ..  "}"
  79             end
  80             return res, newstr
  81         end
  82     end
  83     -- No symbol found, just return the first character
  84     return utf.match(str, "^(.)(.*)")
  85 end
  86
  87 -- Take a single word from str, if posible. Returns the rest of the string and
  88 -- the word taken.
  89 local function take_word(str)
  90         -- A word must always start with a-z (in particular, λ is not a valid
  91         -- start of a word).
  92         res, newstr = utf.match(str, "^([a-zA-Z][%a%d%+%-%,_]+)(.*)")
  93         return res, newstr or str
  94 end
  95
  96 -- Tries to match each of the patterns and returns the captures of the first
  97 -- matching pattern (up to 5 captures are supported). Returns nil when nothing
  98 -- matches.
  99 local function match_mul(str, patterns)
 100     for i, pat in ipairs(patterns) do
 101         a, b, c, d, e = utf.match(str, pat)
 102         if a then
 103             return a, b, c, d, e
 104         end
 105     end
 106     return nil
 107 end
 108
 109 -- Find any subscripts in the given word and typeset them
 110 local function do_subscripts(word)
 111     base, sub = match_mul(res, submatches)
 112     if sub then
 113         word = base .. "\\low{" .. sub .. "}"
 114         -- After a word has been used as a base, allow subscripts
 115         -- without _, even for non-numbers.
 116         if not bases[base] then
 117             -- Register that we've added this base
 118             bases[base] = true
 119             -- Add a patterns for this base. First, the base with a single
 120             -- letter or number subscript.
 121             submatches[#submatches+1] = "^(" .. base .. ")([%a%d])$"
 122             -- Seconde, the base with a longer prefix that includes at least
 123             -- one of +-, (to catch things like ri+1, but not return).
 124             submatches[#submatches+1] = "^(" .. base .. ")([%a%d]*[%-%+,]+[%a%d%-%+,]*)$"
 125         end
 126     end
 127     return word
 128 end
 129
 130 -- Do proper aligning for subsequent lines. For example, in
 131 --   foo = bar
 132 --       | baz
 133 -- We replace the spaces in the second line with a skip with the same with as
 134 -- "foo ", to align the | with the =.
 135 -- For this, we keep a table "indentlines", which contains all previous lines
 136 -- with smaller indent levels that are still "in scope" (e.g., have not yet
 137 -- been followed by a line with a smaller indent level). For example:
 138 --   line1
 139 --     line2
 140 --       line3
 141 --     line4
 142 --       line5
 143 -- After the last line, the table will contain:
 144 --   { 0 = "line1", 2 = "  line4", 4 = "    line5"}
 145 --   In other words, line3 is no longer in scope since it is "hidden" by
 146 --   line4, and line is no longer in scope since it is replaced by line4.
 147 local function do_indent(line)
 148     newind, rest = utf.match(line, '^(%s*)(.*)')
 149     prev = -1
 150     -- Loop all the previous lines
 151     for indent, unused in pairs(indentlines) do
 152         if indent > #newind then
 153             -- Remove any lines with a larger indent
 154             indentlines[indent] = nil
 155         elseif indent < #newind and indent > prev then
 156             -- Find the last line (e.g, with the highest indent) with an
 157             -- indent smaller than the new indent. This is the line from which
 158             -- we need to copy the indent.
 159             prev = indent
 160         end
 161     end
 162
 163     -- Always store this line, possibly overwriting a previous line with the
 164     -- same indent
 165     indentlines[#newind] = line
 166
 167     if prev ~= -1 then
 168         -- If there is a previous line with a smaller indent, make sure we
 169         -- align with it. We do this by taking a prefix from that previous
 170         -- line just as long as our indent. This gives us a bunch of
 171         -- whitespace, with a few non-whitespace characters. We find out the
 172         -- width of this prefix, and put whitespace just as wide as that
 173         -- prefix before the current line, instead of the whitespace
 174         -- characters that were there.
 175         -- Doing this is slightly risky, since the prefix might contain
 176         -- unfinished markup (e.g., \foo{bar without the closing }). We might
 177         -- need to solve this later.
 178         copyind = utf.sub(indentlines[prev], 1, #newind)
 179         setwidth = "\\setwidthof{" .. copyind .. "}\\to\\pretlamalignwidth"
 180         hskip = "\\hskip\\pretlamalignwidth"
 181         return "{" .. setwidth .. hskip .. "}" .. rest
 182     end
 183         -- No previous line? Just return the unmodified line then
 184         return line
 185 end
 186
 187
 188 -- Mark the begin of a block of lambda formatted buffers or expressions. This
 189 -- means that, until you call end_of_block again, the subscript bases are
 190 -- shared. For example, if you have \lam{y1} some text \lam{yn} within a
 191 -- single block, the yn will properly get subscripted. Be sure to call
 192 -- end_of_block again!
 193 --
 194 -- Blocks can be partially nested, meaning that the block
 195 -- won't be closed until end_of_block was called exactly as often as
 196 -- begin_of_block. However, subscripts from the inner block can still
 197 -- influence subscripts in the outer block.
 198 function vis.begin_of_block()
 199     vis.begin_of_display()
 200     in_block = in_block + 1
 201 end
 202
 203 -- Ends the current block
 204 function vis.end_of_block()
 205     in_block = in_block - 1
 206 end
 207
 208 function vis.begin_of_display()
 209     if in_block == 0 then
 210         -- Initially allow subscripts using _ or just appending a number (later,
 211         -- we will add extra patterns here.
 212         submatches = {"^(%a*)_([%a%d,]+)$", "^(%a+)(%d[%d,]+)$"}
 213         -- This stores all the bases we've encountered so far (to prevent
 214         -- duplicates). For each of them there will be a pattern in submatches
 215         -- above.
 216         bases = {}
 217     end
 218     indentlines = {}
 219 end
 220
 221
 222 -- Make things work for inline typeing (e.g., \type{}) as well.
 223 vis.begin_of_inline = vis.begin_of_display
 224 vis.end_of_inline = vis.end_of_display
 225
 226 function vis.flush_line(str,nested)
 227     buffers.flush_result(vis.do_line(str, false), nested)
 228 end
 229
 230 function vis.do_line(str, no_indent)
 231     local result = {}
 232     if not no_indent then
 233         -- Allow ignore of the indentation stuff when we're calling ourselves
 234         -- for a partial line.
 235         str = do_indent(str)
 236     end
 237     while str ~= "" do
 238         local found = false
 239         local word, symbol
 240         local text, rest = utf.match(str, "^%-%-(.-)%-%-(.*)")
 241         if text then
 242             table.insert(result, '\\strikethrough{')
 243             -- Recursively call ourselves to handle spaces gracefully.
 244             result = array_concat(result, vis.do_line(text, true))
 245             table.insert(result, '}')
 246             -- Eat the processed characters
 247             str = rest
 248         elseif utf.match(str, "^%-%-") then
 249             table.insert(result, '{\\italic{--')
 250             -- Recursively call ourselves to handle spaces gracefully.
 251             result = array_concat(result, vis.do_line(utf.sub(str, 3), true))
 252             table.insert(result, '}}')
 253             -- Done with this line
 254             str = ''
 255         else
 256             -- See if the next token is a word
 257             word, str = take_word(str)
 258             if word then
 259                 if keywords[res] then
 260                     -- Make all keywords bold
 261                     word = "{\\bold " .. word ..  "}"
 262                     if keywords[res].small then
 263                         word = "\\small" .. word -- Curlies were added above
 264                     end
 265                 else
 266                     -- Process any subscripts in the word
 267                     word = do_subscripts(word)
 268                 end
 269                 table.insert(result, word)
 270             else
 271                 -- The next token is not a word, it must be a symbol
 272                 symbol, str = take_symbol(str)
 273                 table.insert(result, symbol)
 274             end
 275         end
 276     end
 277
 278     return result
 279 end
 280
 281 -- vim: set sw=4 sts=4 expandtab ai: