cheap-impression-presenter 1.1.1 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d17cd3acd2e14f93234d32a413c6356104901a2a9d10a224c9fb191d2dc0f82a
-  data.tar.gz: 2d2ded7f61c5b0bb2e895097971fd93d321a8253f9d0718dfca0fbdad758a949
+  metadata.gz: 559b5a0157ab1677e1e1f57de21cb22327e6b779ef25da65124e5e02f115585f
+  data.tar.gz: 4e92ed0ae3c091965b6df6444200b56c240046194646ede5d1637faf165e4a95
 SHA512:
-  metadata.gz: 623c58715bc814d8385432867cbfd6aec6f5ef676a9049190a03aca71fa2e1a3f58a23c5cfe305ff2992921f4b5daf801aaecf4a88b82998d58e926d474f216a
-  data.tar.gz: '0139f72003c626a3b9e4eb17f9eafd93baafeccd193c32951d26e813ec0b1a8026cd8a34e2cf7e825ac76b2d790b3fbb4a2b639b345719191dc91e099e7759b8'
+  metadata.gz: 43bdfcddc75072ec0d3767bbb58802c55af33973ceeed469ee3eb9a3ddbfa49cc947b56b629f97184562295a25a98cc5d5b9b3720dfe1fff2088f8491e54c8f1
+  data.tar.gz: af3794816e59ea883cfd2149c43350cd22298013a79d9d854db5fba7e0250aff35835952eb0e1fd1c4c75049bf685315dd16f3ef0ab72adc6aba04807f553237

data/README.md

@@ -18,7 +18,10 @@ 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.
+  Your terminal also needs sixel support. On linux a VTE based terminal with
+  sixel enabled works well, e.g. Black Box
+  (https://flathub.org/apps/com.raggesilver.BlackBox), where sixel has to be
+  switched on in the preferences.
 * ``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).
@@ -50,13 +53,21 @@ 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 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).
+  * You can add right or center as an additional parameter to align the
+    picture.
+  * 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.
-  * You can add bold as an additional parameter to display the fancy text in bold (in the PDF in the bold color).
+  * 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
@@ -77,8 +88,16 @@ 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 26 lines are visible. To make this
+can use:
+
+* ``q`` to quit the presentation.
+* ``r`` to reload the presentation and refresh the screen. You stay on the
+  current slide and part, so you can edit the presentation while it is running
+  and see the changes immediately.
+* ``g`` followed by a slide number and enter to go to that slide (e.g.
+  ``g12<ENTER>``). Any other key cancels the goto.
+
+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
@@ -91,27 +110,11 @@ How does it look?
 
 ![CHIMP Screenshot](chimp_screenshot.png)
 
-History & Thanks
-================
-
-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.
-
-I am still using the CHIMP for scientifc presentations, and as sixel terminals
-finally are more common, I tried to polish the CHIMP up (2025) and make it available
-for easy consumption. Maybe you like it. I use it because I can create
-presentations faster than in PP, KN, other programs. Most of the work goes
-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 :-)
-
 PDF Output
 ==========
 
-To send the presentation to people in one file, write it to a PDF:
+Presenting is nice. Sending presentations to people is sometimes mandatory. But many
+people have not embraced the terminal (yet). So send them a PDF:
 
 ```bash
 chimp -o pdf mypresentation.txt
@@ -132,7 +135,24 @@ footer. Colors you leave out keep their default. Solarized dark for example:
 examples/chimp.txt (light) and examples/markus.txt (dark) show both.
 
 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.
+overrides the given colors for all subsequent slides.
+
+History & Thanks
+================
+
+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.
+
+I am still using the CHIMP for scientifc presentations, and as sixel terminals
+finally are more common, I tried to polish the CHIMP up (2025) and make it
+available for easy consumption. Maybe you like it. I use it because I can
+create presentations faster than in PP, KN, other programs. Most of the work
+goes 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 :-)
 
 LICENSE
 =======

data/chimp.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name             = "cheap-impression-presenter"
-  s.version          = "1.1.1"
+  s.version          = "1.1.3"
   s.platform         = Gem::Platform::RUBY
   s.license          = "GPL-3.0-or-later"
   s.summary          = "CHIMP - Make a cheap impression. Present via terminal."

data/lib/ChimpParser.rb

@@ -28,6 +28,13 @@ module Chimp
     class TagSkipEvent < Exception; end
     class TagMoveEvent < Exception; end
     class TagContentSkipEvent < Exception; end
+    class ReloadEvent < Exception
+      attr_reader :goto # [slide, step] to return to after reloading
+      def initialize(goto)
+        @goto = goto
+        super 'reload'
+      end
+    end
 
     class Output
       SIZE = 26 # default number of lines of a slide (including the footer), #size: overrides

data/lib/output/pdf.rb

@@ -21,6 +21,7 @@ module Chimp
       WIDTH  = 960 # 16:9 page in points
       HEIGHT = 540
       MARGIN = 20
+      CELL   = 2.1 # character cell height / width, as in a terminal with 10x21 pixel cells, so pictures cover the same number of lines
 
       #### a virtual terminal that collects what is printed into a character grid {{{
       class Terminal
@@ -127,8 +128,8 @@ module Chimp
       #### 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
+        @cw = @rowh / CELL
+        @fsize = @cw * 1000.0 / @font.decode_utf8('M').first.width
         columns = ((WIDTH - 2 * MARGIN) / @cw).floor
         @left = (WIDTH - columns * @cw) / 2.0
         @screen = Terminal.new(columns, @size - 2, self)

data/lib/output/screen.rb

@@ -21,8 +21,19 @@ module Window #{{{
     nil
   end
   def self::getch()
+    number = nil
     loop do
-      case $stdin.getch
+      ch = $stdin.getch
+      if number
+        if ch =~ /\d/
+          number << ch
+          next
+        end
+        return [:goto, number.to_i] if ch == "\r" && !number.empty?
+        number = nil
+      end
+      case ch
+        when 'g' then number = ''
         when 'r' then return :refresh
         when 'q' then return :exit
         when "\r" then return :enter
@@ -83,12 +94,14 @@ module Chimp
       #### mO + patternname for opening tags ####
       #### mC + patternname for closing tags ####
 
+      attr_writer :goto
+
       def initialize(fname) #{{{
+        @goto = nil
         @scounter = @ccounter = 0
         @what = ''
         @size = SIZE
         @last = 0
-        @skip = -1
         @templates = []
 
         @format = Pastel.new
@@ -124,6 +137,8 @@ module Chimp
       end
       def mOP_SLIDES(c,tree)
         #{{{
+        ### after a reload, skip the slides before the one we were on
+        raise TagSkipEvent if @goto && c.userdata < [@goto[0], @scounter].min
         @screen.clear
         lines = @screen.lines
         columns = @screen.columns
@@ -151,12 +166,25 @@ module Chimp
         @last = c.close
       end
       def mOP_INCREMENTAL(c,tree)
-        x, y = @screen.get_pos
-        c.userdata = { :x => x, :y => y }
+        @x, @y = @screen.get_pos
+        @drawn = []
+        c.userdata = { :x => @x, :y => @y, :drawn => @drawn }
+      end
+      #### the slide the incremental closing at i belongs to, which step it is, and how many steps the slide has
+      def position(tree,i)
+        b = i.downto(0).find { |x| tree[x].class == OpenTag && tree[x].ttype == "P_SLIDES" }
+        steps = tree[b..tree[b].close].select { |t| t.class == CloseTag && t.ttype == "P_INCREMENTAL" }
+        [b, steps.index(tree[i]) + 1, steps.length]
       end
+      private :position
+
       def mCP_INCREMENTAL(c,tree,i)
-        return if @skip > i
-        @skip = -1
+        ### after a reload, show the steps up to the one we were on without waiting
+        if @goto
+          b, step, steps = position(tree,i)
+          return if step < [@goto[1], steps].min
+          @goto = nil
+        end
         ### 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" }
@@ -168,12 +196,17 @@ module Chimp
             @screen.print "Press 'q' to finish making a cheap impression..."
           end
           begin
-          ch = @screen.getch
+          ch, slide = @screen.getch
           rescue Window::WinchError
             ch = :refresh
           end
-        end while (first && ch == :previous) || (@last == i && ![:previous, :exit, :refresh].include?(ch))
+        end while (first && ch == :previous) || (@last == i && ![:previous, :exit, :refresh, :goto].include?(ch))
         case ch
+          when :goto
+            #{{{
+            slide = slide.clamp(1, @scounter)
+            raise TagMoveEvent, tree.index { |t| t.class == OpenTag && t.ttype == "P_SLIDES" && t.userdata == slide }
+            #}}}
           when :previous
             #{{{
             tag = tree[pos]
@@ -181,29 +214,23 @@ module Chimp
               raise TagMoveEvent, tree[pos-1].open
             end
             if tag.ttype == "P_INCREMENTAL"
-              pos = tag.open
-              tag = tree[pos]
-              columns = @screen.columns
-              #### get current position
-              x, y = @screen.get_pos
-              #### 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 ' ' * howmuch
-              @screen.set_pos tag.userdata[:x], tag.userdata[:y]
-              ####
+              ### erase only what this step has drawn (pictures next to it stay), then wait at the end of the previous step again
+              step = tree[c.open].userdata
+              step[:drawn].each do |x1,y1,x2,y2|
+                y1.upto(y2) do |y|
+                  @screen.set_pos x1, y
+                  @screen.print ' ' * (x2-x1+1)
+                end
+              end
+              @screen.set_pos step[:x], step[:y]
               raise TagMoveEvent, pos
             end
             #}}}
           when :refresh
             #{{{
-            (c.open-1).downto(0) do |b|
-              if tree[b].class == OpenTag && tree[b].ttype == "P_SLIDES"
-                @skip = i
-                raise TagMoveEvent, b
-              end
-            end
+            ### reparse the presentation (it may have changed) and return to the same slide and step
+            b, step, steps = position(tree,i)
+            raise ReloadEvent, [tree[b].userdata, step]
             #}}}
           when :exit
             @screen.finish
@@ -219,13 +246,22 @@ module Chimp
         eval('Chimp::Plugin::' + data[:name].upcase).new.prepare(data[:what],data[:parameters],data[:additional])
       end
 
-      def mOP_INCLUDE(data)
+      #### plugins may return the area they drew as [x1,y1,x2,y2], otherwise the whole lines they printed on count
+      def process(data)
         require File::dirname(__FILE__) + "/../plugins/#{data[:name]}.rb"
-        eval('Chimp::Plugin::' + data[:name].upcase).new.process(data[:what],data[:parameters],@screen,data[:additional])
+        area = eval('Chimp::Plugin::' + data[:name].upcase).new.process(data[:what],data[:parameters],@screen,data[:additional])
+        return unless @drawn
+        x, y = @screen.get_pos
+        @drawn << (area.is_a?(Array) && area.length == 4 ? area : [1, @y, @screen.columns, y])
+        @x, @y = x, y
+      end
+      private :process
+
+      def mOP_INCLUDE(data)
+        process data
       end
       def mOP_RANGE(data)
-        require File::dirname(__FILE__) + "/../plugins/#{data[:name]}.rb"
-        eval('Chimp::Plugin::' + data[:name].upcase).new.process(data[:what],data[:parameters],@screen,data[:additional])
+        process data
       end
 
       def mOP_STRONG(data); @screen.print "\e[1m"; end
@@ -245,13 +281,24 @@ module Chimp
         len = @screen.columns
         if len-data > 0
           @screen.print ' ' * ((len - data) / 2)
+          @x += (len - data) / 2 if @drawn
         end
       end
       def mCP_CENTER(data)
-        @screen.print "\n"
+        string "\n"
       end
 
       def string(data)
+        ### remember which part of which line the current step prints, so going back can erase exactly that
+        data.split(/(\n)/).each do |part|
+          if part == "\n"
+            @x = 1
+            @y += 1
+          elsif !part.empty?
+            @drawn << [@x, @y, @x+part.length-1, @y]
+            @x += part.length
+          end
+        end if @drawn
         @screen.print(data)
       end
 

data/lib/plugins/figlet.rb

@@ -3,20 +3,21 @@ module Chimp
     class FIGLET < Base
       def process(what,parameters,screen,additional)
         screen.print "\e[1m" if parameters.include? 'bold'
+        font = parameters.include?('small') ? ' -f small' : ''
         if parameters.include? 'right'
           pos = screen.get_pos
           len = screen.columns
-          `figlet #{what}`.each_line do |l|
+          `figlet#{font} #{what}`.each_line do |l|
             screen.print " " * (len-l.length+1) + l
           end
           screen.set_pos *pos
         elsif parameters.include? 'center'
           len = screen.columns
-          `figlet #{what}`.each_line do |l|
+          `figlet#{font} #{what}`.each_line do |l|
             screen.print " " * ((len-l.length+1)/2) + l
           end
         else
-          screen.print `figlet #{what}`
+          screen.print `figlet#{font} #{what}`
         end
         screen.print "\e[0m" if parameters.include? 'bold'
       end

data/lib/plugins/sixel.rb

@@ -40,24 +40,30 @@ module Chimp
         end
 
         restore = parameters.include?('animate') || parameters.include?('float')
-        pos = screen.get_pos if restore
+        width = parameters[0].to_i
         len = screen.columns
+        pos = screen.get_pos
+        x, y = pos
+        ### move instead of printing spaces, spaces would erase a picture already on this line
         if parameters.include? 'right'
-          screen.print " " * (len-parameters[0].to_i)
+          x += len-width
         elsif parameters.include? 'center'
-          screen.print " " * ((len-parameters[0].to_i)/2)
+          x += (len-width)/2
         end
+        screen.set_pos x, y
         if screen.respond_to?(:image) # pdf output
-          screen.image what, parameters[0].to_i, additional[:fname]
+          screen.image what, width, additional[:fname]
         else
-          screen.print sixel(what,parameters[0].to_i,additional[:fname])
+          screen.print sixel(what,width,additional[:fname])
         end
+        _, bottom = screen.get_pos
         if restore
           screen.set_pos *pos
         else
-          x, y = screen.get_pos
-          screen.set_pos 0,y
+          screen.set_pos 0, bottom
         end
+        ### the area the picture covers, so going back can erase exactly that
+        [x, y, x+width-1, bottom]
       end
     end
   end

data/tools/chimp

@@ -26,8 +26,15 @@ if ARGV.length == 0 || !File.exist?(ARGV[0])
 end
 
 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
+goto = nil
+begin
+  grammy = Chimp::Parser::SimpleGrammar.parse File::read(fname), :fname => fname
+  screen = Chimp::Parser.const_get(output.capitalize).new fname
+  screen.goto = goto if goto
+  grammy.prepare screen
+  grammy.output screen
+rescue Chimp::Parser::ReloadEvent => e # refresh
+  goto = e.goto
+  retry
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cheap-impression-presenter
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.3
 platform: ruby
 authors:
 - Juergen eTM Mangler