rcurses 4.6 → 4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 240aec267dd4c5e8377ffba6844848463a8d4a0c5291f159f354e9c600e6a264
-  data.tar.gz: 3d3534900f41903901758496d0ed0494c400c6ca45dfbd9eb3265b1b924fd108
+  metadata.gz: 5bd13b6d8edf4884599788ea2ab4ee0cd74e19c76dd5d8816fee9a8c39af2ed7
+  data.tar.gz: 710c11b21962f2c833b109dd1991a4e61994db67609ffa41f85ceca7d8f08aaf
 SHA512:
-  metadata.gz: 92a3f431d49eb85bd4c2a25429acfe87acb2cb1a553c4ebad78614f3e34c3f9bcd23037b725b72a117404fa22397a8d5e8a6ba0d1b6193b227c126bcb4f87e80
-  data.tar.gz: 07e0d869aa2025be468a98d359ef2f1894751b301c5ec37965fe75b6bb97bec452b01bcd67c6ddb3fa6a08fe7f7289d85082eaf0153ac6b487d70d417759e1eb
+  metadata.gz: 6ba8e09362dd518bf485d0e5d725fe421fe1fa70d03827878581d75c9296645b7edef9450881ae4403fd9fe9fa64208c58d3b196b194d27dd8021bf990bb5e13
+  data.tar.gz: b1bd57631466afd0da235ee5c4e34e9124c6fd15a40bb2db44bb4ddcf9c8a54d8809c593ed580d64200fab02a4bed315723bb5ad48731f165ed9867453810a3e

data/README.md

@@ -73,7 +73,8 @@ bg             | Background color for the Pane
 border         | Draw border around the Pane (=true) or not (=false), default being false
 scroll         | Whether to indicate more text to be shown above/below the Pane, default is true
 text           | The text/content of the Pane
-ix             | "Index" - the line number at the top of the Pane, starts at 0, the first line of text in the Pane
+ix             | The line number at the top of the Pane, starts at 0, the first line of text in the Pane
+index          | An attribute that can be used to track the selected line/element in the pane
 align          | Text alignment in the Pane: "l" = lefts aligned, "c" = center, "r" = right, with the default "l"
 prompt         | The prompt to print at the beginning of a one-liner Pane used as an input box
 moreup         | Set to true when there is more text above what is shown (top scroll bar i showing)
@@ -88,7 +89,7 @@ move(x,y)      | Move the pane by `x`and `y` (`mypane.move(-4,5)` will move the
 refresh        | Refreshes/redraws the Pane with content
 border_refresh | Refresh the Pane border only
 full_refresh   | Refreshes/redraws the Pane with content completely (without diff rendering)
-edit           | An editor for the Pane. When this is invoked, all existing font dressing is stripped and the user gets to edit the raw text. The user can add font effects similar to Markdown; Use an asterisk before and after text to be drawn in bold, text between forward-slashes become italic, and underline before and after text means the text will be underlined, a hash-sign before and after text makes the text reverse colored. You can also combine a whole set of dressings in this format: `<23,245,biurl|Hello World!>` - this will make "Hello World!" print in the color 23 with the background color 245 (regardless of the Pane's fg/bg setting) in bold, italic, underlined, reversed colored and blinking. Hitting `ESC` while in edit mode will disregard the edits, while `Ctrl-S` will save the edits
+edit           | An editor for the Pane. When this is invoked, all existing font dressing is stripped and the user gets to edit the raw text. The user can add font effects similar to Markdown; Use an asterisk before and after text to be drawn in bold, text between forward-slashes become italic, and underline before and after text means the text will be underlined, a hash-sign before and after text makes the text reverse colored. You can also combine a whole set of dressings in this format: `<23,245,biurl\|Hello World!>` - this will make "Hello World!" print in the color 23 with the background color 245 (regardless of the Pane's fg/bg setting) in bold, italic, underlined, reversed colored and blinking. Hitting `ESC` while in edit mode will disregard the edits, while `Ctrl-S` will save the edits
 editline       | Used for one-line Panes. It will print the content of the property `prompt` and then the property `text` that can then be edited by the user. Hitting `ESC` will disregard the edits, while `ENTER` will save the edited text
 clear          | Clears the pane
 say(text)      | Short form for setting panel.text, then doing a refresh of that panel
@@ -115,7 +116,7 @@ i              | Set text to be printed in italic (example: `"TEST".i`)
 u              | Set text to be printed underlined (example: `"TEST".u`)
 l              | Set text to be printed blinking (example: `"TEST".l`)
 r              | Set text to be printed in reverse colors (example: `"TEST".r`)
-c(code)        | Use coded format like "TEST".c("204,45,bui") to print "TEST" in bold, underline italic, fg=204 and bg=45 (the format is `.c("fg,bg,biulr"))
+c(code)        | Use coded format like "TEST".c("204,45,bui") to print "TEST" in bold, underline italic, fg=204 and bg=45 (the format is `.c("fg,bg,biulr")`)
 pure           | Strip text of any "dressing" (example: with `text = "TEST".b`, you will have bold text in the variable `text`, then with `text.pure` it will show "uncoded" or pure text)
 ansi_clean     | Strip seemingly uncolored strings of ansi code (those that are enclosed in "\e[0m"
 shorten(n)     | Shorten the pure version of the string to 'n' characters, preserving any ANSI coding
@@ -249,17 +250,6 @@ 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/lib/rcurses/pane.rb

@@ -33,7 +33,7 @@ module Rcurses
     include Cursor
     include Input
     attr_accessor :x, :y, :w, :h, :fg, :bg
-    attr_accessor :border, :scroll, :text, :ix, :align, :prompt
+    attr_accessor :border, :scroll, :text, :ix, :index, :align, :prompt
     attr_accessor :moreup, :moredown
     attr_accessor :record, :history
 

data/lib/rcurses.rb

@@ -5,7 +5,7 @@
 # Web_site:   http://isene.com/
 # Github:     https://github.com/isene/rcurses
 # License:    Public domain
-# Version:    4.5: Full RGB support in addition to 256-colors
+# Version:    4.7: Removed the need for user templates on startup/exit. Added attr 'index' to pane
 
 require 'io/console' # Basic gem for rcurses
 require 'io/wait'    # stdin handling
@@ -17,4 +17,45 @@ require_relative 'rcurses/cursor'
 require_relative 'rcurses/input'
 require_relative 'rcurses/pane'
 
+module Rcurses
+  class << self
+    # Public: Initialize Rcurses. Switches terminal into raw/no-echo
+    # and registers cleanup handlers. Idempotent.
+    def init!
+      return if @initialized
+      return unless $stdin.tty?
+
+      # enter raw mode, disable echo
+      $stdin.raw!
+      $stdin.echo = false
+
+      # ensure cleanup on normal exit
+      at_exit { cleanup! }
+
+      # ensure cleanup on signals
+      %w[INT TERM].each do |sig|
+        trap(sig) { cleanup!; exit }
+      end
+
+      @initialized = true
+    end
+
+    # Public: Restore terminal to normal mode, clear screen, show cursor.
+    # Idempotent: subsequent calls do nothing.
+    def cleanup!
+      return if @cleaned_up
+
+      $stdin.cooked!
+      $stdin.echo = true
+      Rcurses.clear_screen
+      Cursor.show
+
+      @cleaned_up = true
+    end
+  end
+
+  # Kick off initialization as soon as the library is required.
+  init!
+end
+
 # vim: set sw=2 sts=2 et filetype=ruby fdn=2 fcs=fold\:\ :

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcurses
 version: !ruby/object:Gem::Version
-  version: '4.6'
+  version: '4.7'
 platform: ruby
 authors:
 - Geir Isene
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-06 00:00:00.000000000 Z
+date: 2025-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -30,8 +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. 4.6: Fixed a broken pane.edit. Fixed ANSI termination bug
-  in RGB support.'
+  upon utf-8 characters. 4.7: Removed the need for user templates on startup/exit.
+  Added attr ''index'' to pane.'
 email: g@isene.com
 executables: []
 extensions: []