rcurses 3.8.1 → 4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce853c344b8eb5bf0f3cf398344fd038a54052687036dacd3ffe9030eb9d0ed2
-  data.tar.gz: bd6899c2572a9d663bb02436061733f369cb8857d19bce499d737dae2f683785
+  metadata.gz: 64fede93e0d646b947c3cf6c3217a1aa7bf62f923b724a4dd55b02e3981b8593
+  data.tar.gz: 3dca4a698dbbc31356e50e322d3e52ba2c0d6a574b7b824e6d6fe7d5d5b49dd2
 SHA512:
-  metadata.gz: d9d6db33bd763b7f2f6db4098babede2d6500b3a3d10d467849457791e2ed8a5975eacbfd7c5376fda1b1592401024ddb2f952631a82c45dc5b101a0b89bb583
-  data.tar.gz: 0e4ce716e6398e86c213105932345215e684ec4b7e02b9a3332e513c73a5cf4f5664fd1cc11b706e550ce398745be49191a2faeb3cbfe394d819cc442dd631f1
+  metadata.gz: e866db8fa1db394653b90a88c73632d024b7b565db7f984360004b6d4bb4b83c56650e2784669bf827f32585dbbbb9918f98016d5a6612ee39ff352e194b7f84
+  data.tar.gz: 67ceadf4ccb04fb5708e0faa33253099156cddedd9fe906d5d24a11d9ccfeac836a945ff7990f19df380f64061a986836a6432206e5f7a8cd09cb6f9e112e81b

data/README.md

@@ -6,6 +6,10 @@
 
 Create curses applications for the terminal easier than ever.
 
+Here's a somewhat simple example of a TUI program using rcurses: The [T-REX](https://github.com/isene/T-REX) calculator.
+
+And here's a much more involved example: The [RTFM](https://github.com/isene/RTFM) terminal file manager.
+
 # Why?
 Having struggled with the venerable curses library and the ruby interface to it for many years, I finally got around to write an alternative - in pure Ruby.
 
@@ -239,6 +243,17 @@ mypane.edit
 
 And - try running the example file `rcurses_example.rb`.
 
+# Clean exit for your application
+To restore the terminal fully after you exit your application, add this:
+```
+at_exit do # Always restore terminal state on quit (or fatal)
+  $stdin.cooked!
+  $stdin.echo = true
+  Rcurses.clear_screen
+  Cursor.show
+end
+```
+
 # Not yet implemented
 Let me know what other features you like to see.
 

data/examples/basic_panes.rb

@@ -35,3 +35,9 @@ pane_mid.refresh
 pane_bottom.prompt   = "Now hit ENTER again "
 pane_bottom.text     = ""
 pane_bottom.editline
+
+# Reset terminal
+$stdin.cooked!
+$stdin.echo = true
+Rcurses::clear_screen
+Rcurses::Cursor.show

data/examples/focus_panes.rb

@@ -7,11 +7,11 @@ include Rcurses::Cursor
 @max_h, @max_w = IO.console.winsize
 @pane    = []
 @focused = 3 # Start with pane 3 so that the first keypress focuses back to Pane 0
-hide_cursor
+Rcurses::Cursor.hide
 
 # Start by creating the panes; Format:
 # pane    = Rcurses::Pane.new( startx, starty,  width, height,  fg,  bg)
-pane_back = Rcurses::Pane.new(      1,      1, @max_w, @max_h, 255, 236)
+pane_back = Rcurses::Pane.new(      1,      1, @max_w, @max_h, nil, 236)
 @pane[0]  = Rcurses::Pane.new(      4,      4,     20,     10, 236, 254)
 @pane[1]  = Rcurses::Pane.new(     30,     10,     16,     12, 232, 132)
 @pane[2]  = Rcurses::Pane.new(      8,     20,     30,     20, 136,  54)
@@ -19,21 +19,24 @@ pane_back = Rcurses::Pane.new(      1,      1, @max_w, @max_h, 255, 236)
 
 pane_back.text = "PRESS ANY KEY TO SHIFT FOCUS. PRESS 'ESC' TO QUIT."
 @pane.each_index { |i| @pane[i].text = "This is pane " + i.to_s }
-pane_back.refresh
+pane_back.full_refresh
 @pane.each_index { |i| @pane[i].refresh }
 
 input = ''
 while input != 'ESC'
   input = getchr
-  @pane[@focused].border = false
+  pane_back.full_refresh
   @focused += 1
   @focused  = 0 if @focused == @pane.size
+  @pane.each_index {|i| @pane[i].border = false}
+  @pane.each_index {|i| @pane[i].full_refresh}
   @pane[@focused].border = true
-  pane_back.refresh
-  @pane.each_index { |i| @pane[i].refresh }
-  @pane[@focused].refresh
+  @pane[@focused].full_refresh
 end
-col(1)
-row(1)
-clear_screen_down
-show_cursor
+
+# Always end an application with these lines:
+$stdin.cooked!
+$stdin.echo = true
+Rcurses.clear_screen
+Rcurses::Cursor.show
+

data/lib/rcurses/pane.rb

@@ -128,6 +128,35 @@ module Rcurses
       refresh(cont)
     end
 
+    # Refresh only the border
+    def border_refresh
+      left_col   = @x - 1
+      right_col  = @x + @w
+      top_row    = @y - 1
+      bottom_row = @y + @h
+
+      if @border
+        fmt = [@fg.to_s, @bg.to_s].join(',')
+        top = ("┌" + "─" * @w + "┐").c(fmt)
+        STDOUT.print "\e[#{top_row};#{left_col}H" + top
+        (0...@h).each do |i|
+          row = @y + i
+          STDOUT.print "\e[#{row};#{left_col}H"  + "│".c(fmt)
+          STDOUT.print "\e[#{row};#{right_col}H" + "│".c(fmt)
+        end
+        bottom = ("└" + "─" * @w + "┘").c(fmt)
+        STDOUT.print "\e[#{bottom_row};#{left_col}H" + bottom
+      else
+        STDOUT.print "\e[#{top_row};#{left_col}H" + " " * (@w + 2)
+        (0...@h).each do |i|
+          row = @y + i
+          STDOUT.print "\e[#{row};#{left_col}H"  + " "
+          STDOUT.print "\e[#{row};#{right_col}H" + " "
+        end
+        STDOUT.print "\e[#{bottom_row};#{left_col}H" + " " * (@w + 2)
+      end
+    end
+
     # Diff-based refresh that minimizes flicker.
     # In this updated version we lazily process only the raw lines required to fill the pane.
     def refresh(cont = @text)
@@ -150,7 +179,7 @@ module Rcurses
       # Hide cursor and disable auto-wrap (minimal fix)
       STDOUT.print "\e[?25l\e[?7l"
 
-      fmt = [@fg, @bg].compact.join(',')
+      fmt = [@fg.to_s, @bg.to_s].join(',')
 
       # Lazy evaluation: If the content or pane width has changed, reinitialize the lazy cache.
       if !defined?(@cached_text) || @cached_text != cont || @cached_w != @w
@@ -444,7 +473,7 @@ module Rcurses
         @scroll = false
         @ix = 0
         row(@y)
-        fmt = [@fg, @bg].compact.join(',')
+        fmt = [@fg.to_s, @bg.to_s].join(',')
         col(@x)
         print @prompt.c(fmt)
         prompt_len = @prompt.pure.length

data/lib/rcurses.rb

@@ -5,7 +5,7 @@
 # Web_site:   http://isene.com/
 # Github:     https://github.com/isene/rcurses
 # License:    Public domain
-# Version:    3.8.1: Code clean-up
+# Version:    4.0: Added border_refresh to refresh only the border of a pane
 
 require 'io/console' # Basic gem for rcurses
 require 'io/wait'    # stdin handling

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcurses
 version: !ruby/object:Gem::Version
-  version: 3.8.1
+  version: '4.0'
 platform: ruby
 authors:
 - Geir Isene
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-27 00:00:00.000000000 Z
+date: 2025-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -30,7 +30,8 @@ description: 'Create curses applications for the terminal easier than ever. Crea
   color, blink and in any 256 terminal colors for foreground and background. Use a
   simple editor to let users edit text in panes. Left, right or center align text
   in panes. Cursor movement around the terminal. New in 3.8: Fixed border fragments
-  upon utf-8 characters. 3.8.1: Code clean-up'
+  upon utf-8 characters. 4.0: Added border_refresh to refresh only the border of a
+  pane.'
 email: g@isene.com
 executables: []
 extensions: []