cheap-impression-presenter 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76030894a0e7c54a9977b6fc6f65e11d4c516191192ca10eda508ad46cff45e6
-  data.tar.gz: 1014aa89eb276c6223f0f1529c8578e3b454d4b2d73ae9929786d2910b3e0a6a
+  metadata.gz: d17cd3acd2e14f93234d32a413c6356104901a2a9d10a224c9fb191d2dc0f82a
+  data.tar.gz: 2d2ded7f61c5b0bb2e895097971fd93d321a8253f9d0718dfca0fbdad758a949
 SHA512:
-  metadata.gz: 0b788a032d8441f975d781d8cd2a9787fb2ffe12727c712af5fe837cc8f9ee37244425a75494a52b7bbc31f85b4c777c3cb24510fb644f270772c7fee9519da3
-  data.tar.gz: de89b182400f26184b2dfe5a3c74b3d624a34b0055faf67b08aa10a5f0c3de0c51fcd035872563072ed51e47780f7b81eef088255ee2d1be7cd26dc48e02cc92
+  metadata.gz: 623c58715bc814d8385432867cbfd6aec6f5ef676a9049190a03aca71fa2e1a3f58a23c5cfe305ff2992921f4b5daf801aaecf4a88b82998d58e926d474f216a
+  data.tar.gz: '0139f72003c626a3b9e4eb17f9eafd93baafeccd193c32951d26e813ec0b1a8026cd8a34e2cf7e825ac76b2d790b3fbb4a2b639b345719191dc91e099e7759b8'

data/INSTALL.md

@@ -1,5 +1,5 @@
 ```bash
-gem install chimp
+gem install cheap-impression-presenter
 ```
 
 It wont work in a windows terminal for now.
@@ -10,4 +10,8 @@ You can utilize 'img2sixel' if you want to display graphics on your terminal
 (chimp has a sixel plugin).
 
 You can utilize 'inkscape' if you want to display svgs as sixel graphics on
-your terminal (chimp has a sixel plugin).
+your terminal, or include them in the PDF output (chimp has a sixel plugin).
+
+The PDF output (chimp -o pdf) uses the DejaVu Sans Mono font if it is
+installed. Otherwise Courier is used, which lacks some characters (e.g. box
+drawing).

data/README.md

@@ -12,28 +12,51 @@ Make a cheap impression. Present via terminal.
 
 ```gem install cheap-impression-presenter```
 
+The ruby gems it needs (tty-screen, pastel, hexapdf) are installed with it. Some
+features need external programs, which have to be installed separately (all are
+available in the usual linux distributions and homebrew):
+
+* ``figlet``: for the figlet plugin.
+* ``img2sixel`` (from libsixel): for the sixel plugin, i.e. pictures in the terminal.
+  Your terminal also needs sixel support.
+* ``inkscape``: for svg pictures, in the terminal as well as in the PDF output.
+* DejaVu Sans Mono font: for the PDF output. If it is not installed, Courier is
+  used, which lacks some characters (e.g. box drawing).
+
 It has a simple syntax:
 
     #what: the title of presentation
+    #size: the number of lines to zoom to (default 26, see below)
+    #theme: the PDF colors, e.g. background=#fdf6e3 text=#657b83 (see below)
+    #template: content drawn before anything else on the slide (e.g. ```figlet,right LOGO)
+    #template:
+      content drawn before anything else on the slide
+    #end
 
     --- splits slides
 
     +++ slides parts to appear
 
     !!Bold Text!!
-    ``Red Text``
+    ''Red Text''
     %%Blue Text%%
     ~~Center Text
+    ~~Center Text with !!Bold!!, ''Red'' and %%Blue%%
+
+Plugins can not be used in centered lines, they have
+their own center parameter.
 
 Everything else is in plugins. The following plugins are existing for now:
 
 * Sixel: display graphics in the terminal: `` ```sixel,20 name.png``.
   * The parameter 20 denotes the size in characters.
   * You can add right or center as an additional parameter to align the picture.
-  * If the picture is right aligned, text is added on the left of the picture instead of beneath.  
+  * If the picture is right aligned and float is added as an additional parameter, text is added on the left of the picture instead of beneath.
+  * You can add animate as an additional parameter to return the cursor to where the picture started. Text that follows is then added on top of the picture instead of beneath. Combined with +++ the next picture replaces the current one, which allows for simple animations (see examples/sixel_svg.2.txt).
 * Figlet: display fancy ascii text: `` ```figlet FANCY_TEXT``.
   * You can add right or center as a parameter to align the fancy text.
-  * If the fancy text is right aligned, normal text is added on the left of the fancy text instead of beneath.  
+  * If the fancy text is right aligned, normal text is added on the left of the fancy text instead of beneath.
+  * You can add bold as an additional parameter to display the fancy text in bold (in the PDF in the bold color).
 * Line Numbers: display line numbers beforce any text (mostly used for code :-).
 ~~~text
 ```lnums
@@ -43,6 +66,10 @@ Line
 ```
 ~~~
 
+Templates should be positioned carefully (e.g. right aligned figlet or sixel) to
+not collide with the content. All header lines (#what, #size, #theme, #template)
+have to be at the very beginning of the presentation.
+
 Run the presentation with:
 
 ```bash
@@ -50,17 +77,24 @@ chimp mypresentation.txt
 ```
 
 While presenting you can use the usual button for navigating. In addition, you
-can use ``q`` to quit the presentation, and ``r`` to refresh the screen. I suggest zooming
-the terminal until about 30 lines are visible. To make this easy a lightgray ``^`` character is
-visible in the rightmost column of the terminal. Zoom until the ``^`` character is no longer visible for
-the most audience friendly results.
+can use ``q`` to quit the presentation, and ``r`` to refresh the screen. I
+suggest zooming the terminal until about 26 lines are visible. To make this
+easy a ``^`` character is visible at the right end of the footer line. Zoom
+until the ``^`` character is no longer visible for the most audience friendly
+results. The ``^`` is shown as long as more than 26 lines are visible, use
+``#size:`` directly after ``#what:`` to change this number.
 
 Check out the examples.
 
+How does it look?
+=================
+
+![CHIMP Screenshot](chimp_screenshot.png)
+
 History & Thanks
 ================
 
-Amy Hoy allowed me to use the monkey ascii art she created for the CHIMP all the way back in 2009. The
+Amy Hoy all the way back in 2009 allowed me to use her monkey ascii art for the CHIMP. The
 CHIMP was written as an icebreaker for the curucamp, which was a ruby
 un-conference in 2009 in Vienna. We had fun, and many cool people from the
 community attended.
@@ -74,11 +108,31 @@ into graphics anyway, which I create with dedicated tools.
 Drop me a note if you want to be a contributor, or send me merge request if you
 have created some plugins. Creating plugins is very simple :-)
 
-Missing Features
-================
+PDF Output
+==========
+
+To send the presentation to people in one file, write it to a PDF:
+
+```bash
+chimp -o pdf mypresentation.txt
+```
+
+This writes mypresentation.pdf to the directory you are currently in.
+
+By default the slides are 26 lines high, as if you zoomed the terminal. It
+respects the size header. Pictures are embedded as vector graphics for SVGs or
+as images for everything else.
+
+The default colors are solarized light. Change them with a ``#theme:`` line in
+the header, holding KEY=#RRGGBB pairs for background, text, bold, red, blue and
+footer. Colors you leave out keep their default. Solarized dark for example:
+
+    #theme: background=#002b36 text=#839496 bold=#93a1a1 red=#dc322f blue=#268bd2 footer=#586e75
+
+examples/chimp.txt (light) and examples/markus.txt (dark) show both.
 
-Presenting is nice. A PDF output mode would be useful ... to send the presentation
-to people in one file.
+A ``#theme:`` line can also be put on any slide (on a line of its own). It
+overrides the given colors from there on, for this and all following slides.
 
 LICENSE
 =======

data/chimp.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name             = "cheap-impression-presenter"
-  s.version          = "1.0.1"
+  s.version          = "1.1.1"
   s.platform         = Gem::Platform::RUBY
   s.license          = "GPL-3.0-or-later"
   s.summary          = "CHIMP - Make a cheap impression. Present via terminal."
@@ -22,4 +22,5 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'tty-screen', '~> 0.8'
   s.add_runtime_dependency 'pastel', '~> 0.8'
+  s.add_runtime_dependency 'hexapdf', '~> 1.0'
 end

data/lib/ChimpParser-Grammar.rb

@@ -10,6 +10,10 @@ module Chimp
 
       P_SLIDES      = Pattern.new("P_SLIDES",      /---+.*?(\z|\n)|\A/,                  /^(?=---+)|\z/)
       P_WHAT        = Pattern.new("P_WHAT",        /^#\s*what:\s*/,                      /[\t ]*(\n|\z)/)
+      P_SIZE        = Pattern.new("P_SIZE",        /^#\s*size:\s*/,                      /[\t ]*(\n|\z)/)
+      P_THEME       = Pattern.new("P_THEME",       /^#\s*theme:\s*/,                     /[\t ]*(\n|\z)/)
+      P_TEMPLATES   = Pattern.new("P_TEMPLATE",    /^#\s*template:[\t ]*\n/,             /^#\s*end[\t ]*(\n|\z)/)
+      P_TEMPLATE    = Pattern.new("P_TEMPLATE",    /^#\s*template:[\t ]*/,                /[\t ]*(\n|\z)/)
       P_INCREMENTAL = Pattern.new("P_INCREMENTAL", /\+\+\++.*?(\z|\n)|\A/,               /^(?=\+\+\++)|\z/)
       P_RANGE       = Pattern.new("P_RANGE",       /^```([a-z0-9_]+,)*[a-z0-9_]+[\t ]*/, /^```[\t ]*(\n|\z)/)
       P_INCLUDE     = Pattern.new("P_INCLUDE",     /^```([a-z0-9_]+,)*[a-z0-9_]+[\t ]+/, /[\t ]*(\n|\z)/)
@@ -25,16 +29,13 @@ module Chimp
       #### G + patternname is selected to look up nested patterns ####
       #### If G + patternname not exists, [] is assumend ####
 
-      ROOT           = [ P_WHAT, P_SLIDES ]
+      ROOT           = [ P_WHAT, P_SIZE, P_THEME, P_TEMPLATES, P_TEMPLATE, P_SLIDES ]
       GP_SLIDES      = [ P_INCREMENTAL ]
-      GP_INCREMENTAL = [ P_CENTER, P_RANGE, P_INCLUDE, P_STRONGRED, P_STRONGBLUE, P_STRONG, P_RED, P_BLUE ]
+      GP_INCREMENTAL = [ P_THEME, P_CENTER, P_RANGE, P_INCLUDE, P_STRONGRED, P_STRONGBLUE, P_STRONG, P_RED, P_BLUE ]
+      GP_TEMPLATE    = GP_INCREMENTAL
+      GP_CENTER      = [ P_STRONGRED, P_STRONGBLUE, P_STRONG, P_RED, P_BLUE ]
 
       ### Optional functions called when a pattern occurs (m + patternname) ####
-      def mP_CENTER(ts,ti,te)
-        @tree.last.data = ti.length
-        ti
-      end
-
       def mP_INCLUDE(ts,ti,te)
         @tree.last.data = {}
         @tree.last.data[:name] = ts[3..-1].strip.split(',')[0]
@@ -54,6 +55,14 @@ module Chimp
         @tree.last.data = ti
         ''
       end
+      def mP_SIZE(ts,ti,te)
+        @tree.last.data = ti.to_i
+        ''
+      end
+      def mP_THEME(ts,ti,te)
+        @tree.last.data = ti
+        ''
+      end
     end
 
   end

data/lib/ChimpParser.rb

@@ -30,6 +30,8 @@ module Chimp
     class TagContentSkipEvent < Exception; end
 
     class Output
+      SIZE = 26 # default number of lines of a slide (including the footer), #size: overrides
+
       def finish_prepare
       end
       def finish_output
@@ -38,6 +40,35 @@ module Chimp
       def string(data)
         data
       end
+
+      #### calls the output method for element i of the tree, raises NameError if there is none
+      def dispatch(tree,i)
+        c = tree[i]
+        met, data = case c
+          when String then [method("string"), c]
+          when OpenTag then [method("mO" + c.ttype), c.data]
+          when CloseTag then [method("mC" + c.ttype), tree[c.open].data]
+        end
+        case met.arity
+          when 0; met.call
+          when 1; met.call(data)
+          when 2; met.call(c,tree)
+          when 3; met.call(c,tree,i)
+          when 4; met.call(c,tree,i,data)
+          else
+            ""
+        end
+      end
+
+      #### outputs a part of the tree again (e.g. a template for every slide)
+      def replay(tree,from,to)
+        from.upto(to) do |i|
+          begin
+            dispatch(tree,i)
+          rescue NameError
+          end
+        end
+      end
     end
 
     class Grammar
@@ -83,26 +114,7 @@ module Chimp
         while @tree.length > i
           c = @tree[i]
           begin
-            met = case
-              when c.class == String
-                data = c
-                output.method("string")
-              when c.class == OpenTag
-                data = c.data
-                output.method("mO" + c.ttype)
-              when c.class == CloseTag
-                data = @tree[c.open].data
-                output.method("mC" + c.ttype)
-            end
-            out << case met.arity
-              when 0; met.call
-              when 1; met.call(data)
-              when 2; met.call(c,@tree)
-              when 3; met.call(c,@tree,i)
-              when 4; met.call(c,@tree,i,data)
-              else
-                ""
-            end.to_s
+            out << output.dispatch(@tree,i).to_s
 
             i += 1
           rescue NameError => e

data/lib/ChimpPlugin.rb

@@ -2,6 +2,8 @@ module Chimp
   module Plugin
     class Base
       def initialize; end
+      def prepare(what,parameters,additional); end
+      def process(what,parameters,screen,additional); end
     end
   end
 end

data/lib/output/pdf.rb

@@ -0,0 +1,227 @@
+require 'hexapdf'
+require 'fileutils'
+require_relative 'screen'
+
+module Chimp
+  class Parser
+
+    class Pdf < Screen
+      #### solarized light, #theme: in the header overrides single colors, e.g.
+      #### #theme: background=#002b36 text=#839496 bold=#93a1a1 footer=#586e75
+      THEME = {
+        :background => 'fdf6e3', :text => '657b83', :bold => '586e75',
+        :red => 'dc322f', :blue => '268bd2', :footer => '93a1a1'
+      }
+      FONTS = [
+        %w(/usr/share/fonts/dejavu-sans-mono-fonts/DejaVuSansMono.ttf /usr/share/fonts/dejavu-sans-mono-fonts/DejaVuSansMono-Bold.ttf),
+        %w(/usr/share/fonts/truetype/dejavu/DejaVuSansMono.ttf /usr/share/fonts/truetype/dejavu/DejaVuSansMono-Bold.ttf),
+        %w(/usr/share/fonts/TTF/DejaVuSansMono.ttf /usr/share/fonts/TTF/DejaVuSansMono-Bold.ttf),
+        %w(/Library/Fonts/DejaVuSansMono.ttf /Library/Fonts/DejaVuSansMono-Bold.ttf)
+      ]
+      WIDTH  = 960 # 16:9 page in points
+      HEIGHT = 540
+      MARGIN = 20
+
+      #### a virtual terminal that collects what is printed into a character grid {{{
+      class Terminal
+        attr_reader :columns, :lines, :images
+
+        def initialize(columns,lines,pdf)
+          @columns = columns
+          @lines = lines
+          @pdf = pdf
+          clear
+        end
+
+        def clear
+          @grid = Array.new(@lines) { Array.new(@columns) }
+          @images = []
+          @x = @y = 1
+          @bold = false
+          @color = nil
+          self
+        end
+
+        def set_pos(x,y)
+          @x = x < 1 ? 1 : x
+          @y = y < 1 ? 1 : y
+          self
+        end
+        def get_pos
+          [@x, @y]
+        end
+
+        def print(a)
+          a.to_s.scan(/\e\[([\d;]*)m|(\r?\n)|(.)/m) do |sgr,nl,char|
+            if sgr
+              sgr.split(';').map(&:to_i).each do |code|
+                case code
+                  when 0 then @bold = false; @color = nil
+                  when 1 then @bold = true
+                  when 31 then @color = :red
+                  when 34 then @color = :blue
+                end
+              end
+            elsif nl
+              @x = 1
+              @y += 1
+            else
+              if @x > @columns # deferred autowrap, like a real terminal
+                @x = 1
+                @y += 1
+              end
+              @grid[@y-1][@x-1] = [char, @bold, @color] if @y <= @lines
+              @x += 1
+            end
+          end
+        end
+
+        ### the image is placed at the cursor, the cursor moves below it
+        def image(what,width,fname)
+          img, rows = @pdf.load_image(what,width,fname)
+          return print("Image #{what} not found.\n") if img.nil?
+          @images << { :file => img, :x => @x, :y => @y, :width => width }
+          @y += rows
+        end
+
+        ### yields runs of equally formatted text: x, y, text, bold, color
+        def each_run
+          @grid.each_with_index do |row,y|
+            x = 0
+            while x < row.length
+              if row[x].nil? || row[x][0] == ' '
+                x += 1
+                next
+              end
+              start = x
+              text = ''
+              while x < row.length && row[x] && row[x][1..2] == row[start][1..2]
+                text << row[x][0]
+                x += 1
+              end
+              yield start + 1, y + 1, text.rstrip, row[start][1], row[start][2]
+            end
+          end
+        end
+      end #}}}
+
+      #### the pdf is written next to the presentation: talk.txt -> talk.pdf
+      def initialize(fname) #{{{
+        @scounter = @ccounter = 0
+        @what = ''
+        @size = SIZE
+        @last = 0
+        @skip = -1
+        @templates = []
+
+        @fname = File.basename(fname,'.*') + '.pdf'
+        @theme = THEME.dup
+        @doc = HexaPDF::Document.new
+        @doc.config['font.on_missing_glyph'] = proc { |char,font| font.decode_utf8('?').first }
+        regular, bold = FONTS.find { |f| f.all? { |e| File.exist?(e) } }
+        @font = @doc.fonts.add(regular || 'Courier')
+        @bold = @doc.fonts.add(bold || 'Courier', **(bold ? {} : { :variant => :bold }))
+        @page = nil
+      end #}}}
+
+      #### the slide always has @size lines, the last two of which are the footer
+      def finish_prepare #{{{
+        @rowh = (HEIGHT - 2 * MARGIN).to_f / @size
+        @fsize = @rowh / 1.2
+        @cw = @font.decode_utf8('M').first.width * @fsize / 1000.0
+        columns = ((WIDTH - 2 * MARGIN) / @cw).floor
+        @left = (WIDTH - columns * @cw) / 2.0
+        @screen = Terminal.new(columns, @size - 2, self)
+      end #}}}
+
+      def finish_output #{{{
+        @doc.write(@fname, :optimize => true)
+        nil
+      end #}}}
+
+      #### a #theme: in a slide overrides colors from this point on
+      def mOP_THEME(data) #{{{
+        data.split.each do |pair|
+          key, color = pair.split('=',2)
+          unless THEME.key?(key.to_sym) && color =~ /\A#?(\h{6})\z/
+            abort "Invalid #theme: entry '#{pair}', use KEY=#RRGGBB with KEY one of: #{THEME.keys.join(', ')}"
+          end
+          @theme[key.to_sym] = $1
+        end
+      end #}}}
+
+      def mOP_SLIDES(c,tree)
+        @page = c.userdata
+        @screen.clear
+        template tree
+      end
+      #### every +++ step (animation frame) becomes a page of its own
+      def mOP_INCREMENTAL(c,tree); end
+      def mCP_INCREMENTAL(c,tree,i)
+        render
+      end
+
+      #### plugins only need to prepare things for the terminal
+      def mPP_INCLUDE(data); end
+      def mPP_RANGE(data); end
+
+      #### an image in the pdf, svgs are converted to pdf with inkscape (cached)
+      def load_image(what,width,fname) #{{{
+        src = File.join(File.dirname(fname),what)
+        return unless File.exist?(src)
+        if what =~ /\.svg$/
+          cache = File.join(File.dirname(fname),'.' + File.basename(fname,'.*'),"#{what.gsub('/','_')}.pdf")
+          unless File.exist?(cache) && File.mtime(cache) >= File.mtime(src)
+            FileUtils.mkdir_p(File.dirname(cache))
+            system 'inkscape', '-D', '--export-type=pdf', src, '-o', cache, :err => File::NULL
+          end
+          src = cache
+        end
+        img = @doc.images.add(src)
+        w, h = img.is_a?(HexaPDF::Type::Form) ? [img.box.width, img.box.height] : [img.width, img.height]
+        [img, (width * @cw * h / w / @rowh).ceil]
+      end #}}}
+
+      def render #{{{
+        return if @page.nil?
+        canvas = @doc.pages.add([0, 0, WIDTH, HEIGHT]).canvas
+        canvas.fill_color(@theme[:background]).rectangle(0, 0, WIDTH, HEIGHT).fill
+
+        ### images first, text that follows goes on top. an image covers
+        ### what was below (e.g. for animations), so paint the background first.
+        @screen.images.each do |i|
+          x = @left + (i[:x] - 1) * @cw
+          w = i[:width] * @cw
+          obj = i[:file]
+          h = w * (obj.is_a?(HexaPDF::Type::Form) ? obj.box.height / obj.box.width : obj.height.to_f / obj.width)
+          y = top(i[:y]) - h
+          canvas.fill_color(@theme[:background]).rectangle(x, y, w, h).fill
+          canvas.image(obj, :at => [x, y], :width => w)
+        end
+
+        @screen.each_run do |x,y,text,bold,color|
+          canvas.font(bold ? @bold : @font, :size => @fsize)
+          canvas.fill_color(@theme[color || (bold ? :bold : :text)])
+          canvas.text(text, :at => [@left + (x - 1) * @cw, baseline(y)])
+        end
+
+        ### footer
+        canvas.stroke_color(@theme[:footer]).line_width(0.5)
+        canvas.line(@left, top(@size - 1) - @rowh / 2, @left + @screen.columns * @cw, top(@size - 1) - @rowh / 2).stroke
+        canvas.font(@font, :size => @fsize).fill_color(@theme[:footer])
+        canvas.text(@what, :at => [@left, baseline(@size)])
+        num = "#{@page}/#{@scounter}"
+        canvas.text(num, :at => [@left + (@screen.columns - num.length) * @cw, baseline(@size)])
+      end #}}}
+
+      def top(y)
+        HEIGHT - MARGIN - (y - 1) * @rowh
+      end
+      def baseline(y)
+        top(y) - (@rowh + @fsize * 0.6) / 2
+      end
+      private :render, :top, :baseline
+
+    end
+  end
+end

data/lib/output/screen.rb

@@ -70,7 +70,7 @@ module Window #{{{
     end
     m = res.match /(?<column>\d+);(?<row>\d+)/
     [ Integer(m[:row]), Integer(m[:column]) ]
-  rescue WinchErrror
+  rescue WinchError
     [0,0]
   end
 end #}}}
@@ -83,11 +83,13 @@ module Chimp
       #### mO + patternname for opening tags ####
       #### mC + patternname for closing tags ####
 
-      def initialize() #{{{
+      def initialize(fname) #{{{
         @scounter = @ccounter = 0
         @what = ''
+        @size = SIZE
         @last = 0
         @skip = -1
+        @templates = []
 
         @format = Pastel.new
         @screen = Window
@@ -95,6 +97,11 @@ module Chimp
         @screen.init
       end #}}}
 
+      def template(tree)
+        @templates.each { |from,to| replay tree, from, to }
+        @screen.set_pos 0, 0
+      end
+
       def finish_output #{{{
         @screen.set_pos 0,  @screen.lines
         @screen.print ' ' * (@screen.columns - 5)
@@ -104,6 +111,9 @@ module Chimp
       def mPP_WHAT(data)
         @what = data
       end
+      def mPP_SIZE(data)
+        @size = data if data > 0
+      end
 
       def mPP_SLIDES(c,tree)
         #{{{
@@ -117,21 +127,26 @@ module Chimp
         @screen.clear
         lines = @screen.lines
         columns = @screen.columns
-        ### print mark
-        @screen.set_pos columns, 30
-        @screen.print "\e[0;37m^\e[0m"
-        ### print footer
         @screen.set_pos 0, lines-1
-        @screen.print "-"*columns
+        ### print footer, with a mark at the end
+        @screen.print (lines > @size ? ("-"*(columns-1) + "^") : "-"*columns)
         @screen.set_pos 0, lines
         @screen.print @what
         num = "#{c.userdata}/#{@scounter}"
-        @screen.set_pos columns-num.length, lines
+        @screen.set_pos columns-num.length+1, lines
         @screen.print num
         @screen.set_pos 0, 0
+        template tree
         #}}}
       end
 
+      def mPP_TEMPLATE(c,tree,i)
+        @templates << [i+1, c.close-1]
+      end
+      def mOP_TEMPLATE(data)
+        raise TagSkipEvent
+      end
+
       def mPP_INCREMENTAL(c,tree,i)
         @last = c.close
       end
@@ -142,6 +157,9 @@ module Chimp
       def mCP_INCREMENTAL(c,tree,i)
         return if @skip > i
         @skip = -1
+        ### on the first part of the first slide there is nothing to go back to
+        pos = c.open-1
+        first = tree[pos].ttype == "P_SLIDES" && tree[0...pos].none? { |t| t.class == OpenTag && t.ttype == "P_SLIDES" }
         begin
           if @last == i
             lines = @screen.lines
@@ -154,18 +172,13 @@ module Chimp
           rescue Window::WinchError
             ch = :refresh
           end
-        end while @last == i && ![:previous, :exit, :refresh].include?(ch)
+        end while (first && ch == :previous) || (@last == i && ![:previous, :exit, :refresh].include?(ch))
         case ch
           when :previous
             #{{{
-            pos = c.open-1
             tag = tree[pos]
             if tag.ttype == "P_SLIDES"
-              if pos ==  0
-                raise TagMoveEvent, pos
-              else
-                raise TagMoveEvent, tree[pos-1].open
-              end
+              raise TagMoveEvent, tree[pos-1].open
             end
             if tag.ttype == "P_INCREMENTAL"
               pos = tag.open
@@ -176,7 +189,7 @@ module Chimp
               #### how many spaces needed
               howmuch = ((y - tag.userdata[:y] + 1) * columns) - (columns - x) - tag.userdata[:x]
               @screen.set_pos tag.userdata[:x], tag.userdata[:y]
-              @screen.print x.to_s + ',' + y.to_s
+              # @screen.print x.to_s + ',' + y.to_s
               @screen.print ' ' * howmuch
               @screen.set_pos tag.userdata[:x], tag.userdata[:y]
               ####
@@ -197,6 +210,15 @@ module Chimp
             exit
         end
       end
+      def mPP_INCLUDE(data)
+        require File::dirname(__FILE__) + "/../plugins/#{data[:name]}.rb"
+        eval('Chimp::Plugin::' + data[:name].upcase).new.prepare(data[:what],data[:parameters],data[:additional])
+      end
+      def mPP_RANGE(data)
+        require File::dirname(__FILE__) + "/../plugins/#{data[:name]}.rb"
+        eval('Chimp::Plugin::' + data[:name].upcase).new.prepare(data[:what],data[:parameters],data[:additional])
+      end
+
       def mOP_INCLUDE(data)
         require File::dirname(__FILE__) + "/../plugins/#{data[:name]}.rb"
         eval('Chimp::Plugin::' + data[:name].upcase).new.process(data[:what],data[:parameters],@screen,data[:additional])
@@ -217,7 +239,9 @@ module Chimp
       def mOP_STRONGBLUE(data); @screen.print "\e[1;34m"; end
       def mCP_STRONGBLUE(data); @screen.print "\e[0m"; end
 
-      def mOP_CENTER(data)
+      def mOP_CENTER(c,tree,i)
+        ### only the visible text counts, not the markup
+        data = tree[i+1...c.close].grep(String).sum(&:length)
         len = @screen.columns
         if len-data > 0
           @screen.print ' ' * ((len - data) / 2)

data/lib/plugins/figlet.rb

@@ -2,6 +2,7 @@ module Chimp
   module Plugin
     class FIGLET < Base
       def process(what,parameters,screen,additional)
+        screen.print "\e[1m" if parameters.include? 'bold'
         if parameters.include? 'right'
           pos = screen.get_pos
           len = screen.columns
@@ -17,6 +18,7 @@ module Chimp
         else
           screen.print `figlet #{what}`
         end
+        screen.print "\e[0m" if parameters.include? 'bold'
       end
     end
   end

data/lib/plugins/sixel.rb

@@ -1,31 +1,62 @@
+require 'fileutils'
+
 module Chimp
   module Plugin
     class SIXEL < Base
+      # converted images are cached in .PRESENTATIONNAME/ next to the presentation
+      def cache_file(what,width,fname)
+        dir = File.join(File.dirname(fname),'.' + File.basename(fname,'.*'))
+        File.join(dir,"#{what.gsub('/','_')}.#{width}.sixel")
+      end
+
+      def sixel(what,width,fname)
+        src = File.join(File.dirname(fname),what)
+        cache = cache_file(what,width,fname)
+        if File.exist?(cache) && File.exist?(src) && File.mtime(cache) >= File.mtime(src)
+          return File.read(cache)
+        end
+        convert = if what =~ /\.svg$/
+          "inkscape -D -d 300 --export-type=png #{src} -o - | img2sixel -w #{width*10}"
+        else
+          "img2sixel -w #{width*10} #{src}"
+        end
+        result = `#{convert}`
+        if $?.success? && !result.empty?
+          FileUtils.mkdir_p(File.dirname(cache))
+          File.write(cache,result)
+        end
+        result
+      end
+
+      def prepare(what,parameters,additional)
+        return if parameters[0] !~ /\d/
+        sixel(what,parameters[0].to_i,additional[:fname])
+      end
+
       def process(what,parameters,screen,additional)
         if parameters[0] !~ /\d/
           screen.print 'Use ```sixel,NUM with NUM beeing the width if the picture in characters.'
           return
         end
 
-        printit = if what =~ /\.svg$/
-          "inkscape -D -d 300 --export-type=png #{File.join(File.dirname(additional[:fname]),what)} -o - | img2sixel -w #{parameters[0].to_i*10}"
-        else
-          "img2sixel -w #{parameters[0].to_i*10} #{File.join(File.dirname(additional[:fname]),what)}"
-        end
+        restore = parameters.include?('animate') || parameters.include?('float')
+        pos = screen.get_pos if restore
+        len = screen.columns
         if parameters.include? 'right'
-          pos = screen.get_pos
-          len = screen.columns
           screen.print " " * (len-parameters[0].to_i)
-          screen.print `#{printit}`
-          screen.set_pos *pos
         elsif parameters.include? 'center'
-          len = screen.columns
           screen.print " " * ((len-parameters[0].to_i)/2)
-          screen.print `#{printit}`
+        end
+        if screen.respond_to?(:image) # pdf output
+          screen.image what, parameters[0].to_i, additional[:fname]
+        else
+          screen.print sixel(what,parameters[0].to_i,additional[:fname])
+        end
+        if restore
+          screen.set_pos *pos
+        else
           x, y = screen.get_pos
           screen.set_pos 0,y
-        else
-          screen.print `#{printit}`
         end
       end
     end

data/tools/chimp

@@ -8,22 +8,26 @@ require 'optparse'
 require_relative '../lib/ChimpParser'
 require_relative '../lib/ChimpPlugin'
 require_relative '../lib/ChimpParser-Grammar'
-require_relative '../lib/output/screen'
 
+output = 'screen'
+outputs = Dir[File.join(__dir__,'..','lib','output','*.rb')].map { |f| File.basename(f,'.rb') }.sort
 ARGV.options { |opt|
   opt.summary_indent = ' ' * 2
   opt.banner = "Usage:\n#{opt.summary_indent}#{File.basename($0)} [options] [FILENAME]\n"
   opt.on("Options:")
   opt.on("--help", "-h", "This text") { puts opt; exit }
+  opt.on("--output=NAME", "-o NAME", outputs, "Output: #{outputs.join(', ')} (default: screen)") { |o| output = o }
   opt.on("Filename needs to be a chimp presentation.")
   opt.parse!
-}
+} or exit 1 # nil on invalid options
 if ARGV.length == 0 || !File.exist?(ARGV[0])
   puts ARGV.options
   exit
 end
 
-grammy = Chimp::Parser::SimpleGrammar.parse File::read(ARGV[0]), :fname => File.realpath(ARGV[0])
-screen = Chimp::Parser::Screen.new
+fname = File.realpath(ARGV[0])
+grammy = Chimp::Parser::SimpleGrammar.parse File::read(fname), :fname => fname
+require_relative "../lib/output/#{output}"
+screen = Chimp::Parser.const_get(output.capitalize).new fname
 grammy.prepare screen
 grammy.output screen

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: cheap-impression-presenter
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Juergen eTM Mangler
 bindir: tools
 cert_chain: []
-date: 2025-06-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-screen
@@ -37,14 +37,28 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: hexapdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: see https://github.com/etm/chimp
 email: juergen.mangler@gmail.com
 executables:
 - chimp
 extensions: []
 extra_rdoc_files:
-- README.md
 - INSTALL.md
+- README.md
 files:
 - AUTHORS
 - INSTALL.md
@@ -55,6 +69,7 @@ files:
 - lib/ChimpParser-Grammar.rb
 - lib/ChimpParser.rb
 - lib/ChimpPlugin.rb
+- lib/output/pdf.rb
 - lib/output/screen.rb
 - lib/plugins/figlet.rb
 - lib/plugins/lnums.rb
@@ -78,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: CHIMP - Make a cheap impression. Present via terminal.
 test_files: []