pret-trans.lua

   1 -- filename : type-trans.lua
   2 -- comment  : Pretty printing of core transformations. Parses a specific
   3 --            syntax, consisting of a before / after with a dashed lined in
   4 --            between, and some extra conditions to the right of the line.
   5 --            Recreates this layout using frames and line commands.
   6 -- author   : Matthijs Kooijman, Universiteit Twente, NL
   7 -- copyright: Matthijs Kooijman
   8 -- license  : None
   9
  10 local utf = unicode.utf8
  11
  12 vis = buffers.newvisualizer("trans")
  13
  14 local commands = {}
  15 -- A command to create a horizontal rule.
  16 commands.rule = "\\blackrule[height=0.5pt,depth=0pt,width=.45\\textwidth]"
  17 -- Pretty printer to use for the stuff before and after the line
  18 commands.before_pret = "lam"
  19 commands.after_pret = "lam"
  20 -- Frame commands to use for the left (before + line + after) and right
  21 -- (conditions) parts. Should include an opening {, which will be closed
  22 -- automatically.
  23 commands.leftframe = "\\framed[offset=0mm,location=middle,strut=no,align=right,frame=off,width=.5\\textwidth]{\\sans"
  24 commands.rightframe = "\\framed[offset=0mm,location=middle,strut=no,align=right,frame=off,width=.5\\textwidth]{"
  25
  26 -- A table to keep the lines in this buffer, so we can process them all at
  27 -- once at the end.
  28 local lines
  29
  30 -- Some helper functions
  31 local function ltrim(s)
  32     return (string.gsub(s, "^%s*", ""))
  33 end
  34
  35 local function rtrim(s)
  36     return (string.gsub(s, "%s*$", ""))
  37 end
  38
  39 -- Insert n blank lines
  40 local function blanks(n)
  41     for i = 1,n do
  42         buffers.visualizers.handlers.default.empty_line()
  43     end
  44 end
  45
  46 -- Prettyprint the given lines using the given pretty printer
  47 local function prettyprint(ppr, lines)
  48     -- Change the current visualizer
  49     buffers.setvisualizer('lam')
  50
  51     -- Output the lines
  52     buffers.hooks.begin_of_display()
  53     line = 0
  54     for i = 1,#lines do
  55         _, line = buffers.typeline(lines[i], i, #lines, line)
  56     end
  57     buffers.hooks.end_of_display()
  58
  59     -- Change the visualizer back
  60     buffers.setvisualizer('trans')
  61 end
  62
  63 -- Capture all lines, without generating any output
  64 function vis.begin_of_display()
  65     lines = {}
  66 end
  67 function vis.begin_of_line(n)
  68     -- Don't generate output here
  69 end
  70 function vis.flush_line(str, nested)
  71     table.insert(lines, str)
  72     -- Don't generate output here
  73 end
  74 function vis.end_of_line(n)
  75     -- Don't generate output here
  76 end
  77 function vis.empty_line()
  78     table.insert(lines, '')
  79     -- Don't generate output here
  80 end
  81
  82 -- We do the actual work here. Process all the lines in the buffer and
  83 -- generate output for them.
  84 function vis.end_of_display()
  85     -- Find the horizontal rule, and see how long it is.
  86     len = nil
  87     for i = 1,#lines do
  88         match = utf.match(lines[i], "^%-%-%-*")
  89         if match then
  90             len = utf.len(match)
  91             break
  92         end
  93     end
  94
  95     -- Split the input in three parts. Stuff before the line, stuff
  96     -- after the line, stuff to the right of the line.
  97     before, after, rights = {}, {}, {}
  98     found_line = false
  99     for i = 1,#lines do
 100         line = lines[i]
 101         -- Split the line into a left and right part
 102         left = rtrim(utf.sub(line, 1, len))
 103         right = ltrim(utf.sub(line, len + 1))
 104         if utf.match(left, "^%-%-%-*") then
 105             found_line = true
 106         else
 107             if utf.len(left) > 0 then
 108                 if not found_line then
 109                     table.insert(before, left)
 110                 else
 111                     table.insert(after, left)
 112                 end
 113             end
 114         end
 115         if utf.len(right) > 0 then
 116             table.insert(rights, right)
 117         end
 118     end
 119
 120     --
 121     -- Real output starts here
 122     --
 123
 124     -- Ensure the left and right frames end up next to each other.
 125     tex.sprint("\\dontleavehmode")
 126
 127     -- Open and fill the left frame
 128     tex.sprint(commands.leftframe)
 129
 130     prettyprint('lam', before)
 131
 132     tex.sprint(commands.rule)
 133
 134     prettyprint('lam', after)
 135
 136     -- Close the left frame
 137     tex.sprint("}")
 138
 139     -- Open and fill the right frame
 140     tex.sprint(commands.rightframe)
 141
 142     -- Insert spacer blank lines to align the middle condition with the
 143     -- conclusion rule
 144     n_blanks = #before - math.ceil((#rights - 1) / 2)
 145     n_blanks = math.max(0, n_blanks)
 146     blanks(n_blanks)
 147
 148     -- Print the conditions
 149     for i = 1,#rights do
 150         tex.sprint(rights[i])
 151         buffers.visualizers.handlers.default.end_of_line()
 152     end
 153
 154     -- Fill up the remaining space with blanks
 155     n_blanks = (#before + 1 + #after) - (n_blanks + #rights)
 156     n_blanks = math.max(0, n_blanks)
 157     blanks(n_blanks)
 158
 159     -- Close the right frame
 160     tex.sprint("}")
 161
 162     -- Clean up
 163     lines = {}
 164 end
 165
 166 -- vim: set sw=4 sts=4 expandtab ai: