RubyGems - curses-extension - Versions diffs - 1.3 → 2.0 - Mend

curses-extension 1.3 → 2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a03325b4dbf6aa5c2cd506e50e642f62588a07cc543314d98eafce40cb7d2e3
-  data.tar.gz: 2862dc209031c64df476ca07c3bd7fcba8f2929620966492f53f858903f30207
+  metadata.gz: 1a1e832808f3f3ffbf4d39755719168b08fbc0c644a7a48840839844b3fca3a4
+  data.tar.gz: 23e73a5413638273336b211d3274a48bdeb21963b7600f0c731968e2269bb343
 SHA512:
-  metadata.gz: be4ab27081169af7f9219df23272012e287e3f838f78407bc495d7470f522d1c1fd9c945c7b3ce99ea9dd48a81930ab2a7411e76efbe0b11d75da18a86af425d
-  data.tar.gz: 3eaa3fba2972af226cffa6380d55a3a3e034bc0ba8984c2893d6cec6cee7801eafdbbae023c711195217f5def9e48e34450dbf97229762d9a20d1f7b8ad4a6bd
+  metadata.gz: 34e132b85309f493f6b31efb216edd963b32c13dea3b62b3ca56df56d50c6eb89dcc8783f3a33aa9f8dea5f951c82c9d966623ccee8f75ccc0cc9197a3826338
+  data.tar.gz: 8237d8b29d71c83a1e13d5a4d679ea3fc55cc80cb2d2f635bba070dd29b8ca4bd06039c79b98eaa6df026bdadcb0a4ce87d3a375c125d782ba9c9531ea075e5f

data/lib/README.md CHANGED Viewed

@@ -1,31 +1,31 @@
 # Ruby-Curses-Class-Extension
-Extending the Ruby Curses module with some obvious functionality
+Extending the Ruby Curses module with some obvious needed functionality.
 ## Attributes
 Attribute           | Description
 --------------------|--------------------------------------------------------
-color               | Set the window's color to an already initiated color pair (with `init_pair(index, forground, backround`)
 fg                  | Foreground color for window (0-255)
 bg                  | Background color for window (0-255)
 attr                | Attributes for window (such as Curses::A_BOLD) - string with "\|" (such as Curses::A_BOLD \| Curses::A_UNDERLINE)
+text				| Holds the text to be written with the `write`method
 update				| Whether to update the window on the next refresh
+index				| Used to track an index for each window (used to display lists such as the content of a directory, etc.)
 ## Functions
 Function							| Description
 ------------------------------------|--------------------------------------------------------
 clr									| Clears window without flicker (win.clear flickers)
-clr_to_cur_pos						| Clears the window up to the current line
-clr_from_cur_pos					| Clears the rest of the window after the current line
+clr_to_cur_line						| Clears the window up to the current line
+clr_from_cur_line					| Clears the rest of the window after the current line
 fill								| Fill window with color as set by :color ( or :bg if not :color is set)
 fill_to_cur_pos						| Fill the window up to the current line
 fill_from_cur_pos					| Fill the rest of the window after the current line
-p(text)								| Write text to window with color or fg/bg and attributes (will handle the exceptions if no colors are set)
+write								| Write what is already stored in window.text with the set values for fg, bg and attr
+p(text) or puts(test)				| Write text to window with fg/bg and attributes (will handle the exceptions if no colors are set)
 pclr(text)							| As `p(text)` but also clears the rest of the window
 pa(fg, bg, attr, text)				| Write text to window with specified fg, bg and attribute(s)
-paclr(text)							| As `pa(text)` but also clears the rest of the window
-print(text, fg=255, bg=0, attr=0)	| Print text (from current position) with optional attributes
-puts(text, fg=255, bg=0, attr=0)	| Clears window and puts text with optional attributes
+paclr(text, fg=255, bg=0, attr=0)	| As `pa(text)` but also clears the rest of the window
 format_text(text)					| Format text so that it linebreaks neatly inside window
 ## Curses template
-The `curses_template.rb` includes the class extension and serves as the basis for my curses applications.
+The `curses_template.rb` includes the class extension and serves as the basis for my curses applications. It is a runnable curses application that does nothing.

data/lib/curses-extension.rb CHANGED Viewed

@@ -1,11 +1,26 @@
 class Curses::Window # CLASS EXTENSION
   # General extensions (see https://github.com/isene/Ruby-Curses-Class-Extension)
-  attr_accessor :color, :fg, :bg, :attr, :update, :index
-  # Set self.color for an already defined color pair such as: init_pair(1, 255, 3)
-  # The color pair is defined like this: init_pair(index, foreground, background)
-  # self.fg is set for the foreground color (and is used if self.color is not set)
-  # self.bg is set for the background color (and is used if self.color is not set)
+  # This is a class extension to Ruby Curses - a class in dire need of such.
+  # self.pair keeps a registry of colors as they are encountered - defined with:
+  # init_pair(index, foreground, background)
+  # self.fg is set for the foreground color
+  # self.bg is set for the background color
   # self.attr is set for text attributes like Curses::A_BOLD
+  # self.update can be used to indicate if a window should be updated (true/false)
+  # self.index can be used to keep track of the current list item in a window
+  attr_accessor :fg, :bg, :attr, :text, :update, :index
+  def self.pair(fg, bg)
+    @p = [[]] if @p == nil
+    fg = fg.to_i; bg = bg.to_i
+    if @p.include?([fg,bg])
+      @p.index([fg,bg])
+    else
+      @p.push([fg,bg])
+      cp = @p.index([fg,bg])
+      init_pair(cp, fg, bg)
+      @p.index([fg,bg])
+    end
+  end
   def clr # Clears the whole window
     self.setpos(0, 0)
     self.maxy.times {self.deleteln()}
@@ -32,15 +47,11 @@ class Curses::Window # CLASS EXTENSION
     x = self.curx
     y = self.cury
     self.setpos(0, 0)
+    self.bg = 0 if self.bg   == nil
+    self.fg = 255 if self.fg == nil
     blank = " " * self.maxx
-    if self.color == nil
-      self.bg = 0 if self.bg   == nil
-      self.fg = 255 if self.fg == nil
-      init_pair(self.fg, self.fg, self.bg)
-      y.times {self.attron(color_pair(self.fg)) {self << blank}}
-    else
-      y.times {self.attron(color_pair(self.color)) {self << blank}}
-    end
+    cp = Curses::Window.pair(self.fg, self.bg)
+    y.times {self.attron(color_pair(cp)) {self << blank}}
     self.refresh
     self.setpos(y, x)
   end
@@ -48,60 +59,46 @@ class Curses::Window # CLASS EXTENSION
     x = self.curx
     y = self.cury
     self.setpos(y, 0)
+    self.bg = 0 if self.bg   == nil
+    self.fg = 255 if self.fg == nil
     blank = " " * self.maxx
-    if self.color == nil
-      self.bg = 0 if self.bg   == nil
-      self.fg = 255 if self.fg == nil
-      init_pair(self.fg, self.fg, self.bg)
-      self.maxy.times {self.attron(color_pair(self.fg)) {self << blank}}
-    else
-      self.maxy.times {self.attron(color_pair(self.color)) {self << blank}}
-    end
+    cp = Curses::Window.pair(self.fg, self.bg)
+    self.maxy.times {self.attron(color_pair(cp)) {self << blank}}
     self.refresh
     self.setpos(y, x)
   end
+  def write
+    self.attr = 0 if self.attr == nil
+    self.bg = 0 if self.bg   == nil
+    self.fg = 255 if self.fg == nil
+    cp = Curses::Window.pair(self.fg, self.bg)
+    self.attron(color_pair(cp) | self.attr) { self << self.text }
+    self.refresh
+  end
   def p(text) # Puts text to window
     self.attr = 0 if self.attr == nil
-    if self.color == nil
-      self.bg = 0 if self.bg   == nil
-      self.fg = 255 if self.fg == nil
-      init_pair(self.fg, self.fg, self.bg)
-      self.attron(color_pair(self.fg) | self.attr) { self << text }
-    else
-      self.attron(color_pair(self.color) | self.attr) { self << text }
-    end
+    self.bg = 0 if self.bg   == nil
+    self.fg = 255 if self.fg == nil
+    cp = Curses::Window.pair(self.fg, self.bg)
+    self.attron(color_pair(cp) | attr) { self << text }
     self.refresh
   end
   def pclr(text) # Puts text to window and clears the rest of the window
     self.p(text)
     self.clr_from_cur_line
   end
-  def paclr(fg, bg, attr, text) # Puts text to window with full set of attributes and clears rest of window
-    self.paclr(fg, bg, attr, text)
-    self.clr_from_cur_line
-  end
-  def pa(fg, bg, attr, text) # Puts text to window with full set of attributes
-    self.fg = fg
-    self.bg = bg
-    self.attr = attr
-    init_pair(self.fg, self.fg, self.bg)
-    self.attron(color_pair(self.fg) | self.attr) { self << text }
+  def pa(fg = self.fg, bg = self.bg, attr = self.attr, text) # Puts text to window with full set of attributes
+    cp = Curses::Window.pair(fg, bg)
+    self.attron(color_pair(cp) | attr) { self << text }
     self.refresh
   end
-  def puts(text, fg=255, bg=0, attr=0) # Clears window and puts text with optional attributes
-    self.clr
-    self.refresh
-    self.setpos(0, 0)
-    self.print(text, fg, bg, attr)
-  end
-  def print(text, fg=255, bg=0, attr=0) # Print text (from current position) with optional attributes
-    init_pair(fg, fg, bg)
-    self.attron(color_pair(fg) | attr) { self << text }
-    self.refresh
+  def paclr(fg = self.fg, bg = self.bg, attr = self.attr, text) # Puts text to window with full set of attributes and clears rest of window
+    self.pa(fg, bg, attr, text)
+    self.clr_from_cur_line
   end
   def format_text(text) # Format text so that it linebreaks neatly inside window
     return "\n" + text.gsub(/(.{1,#{self.maxx}})( +|$\n?)|(.{1,#{self.maxx}})/, "\\1\\3\n")
   end
+  alias :puts :p
 end
-# vim: set sw=2 sts=2 et fdm=syntax fdn=2 fcs=fold\:\ :

data/lib/curses-template.rb CHANGED Viewed

@@ -8,10 +8,10 @@
 # +-------------------------------+
 # | @w_t                          |
 # +---------------+---------------+
-# |               |               |
 # | @w_l          | @w_r          |
 # |               |               |
 # |               |               |
+# |               |               |
 # +---------------+---------------+
 # | @w_b                          |
 # +-------------------------------+
@@ -32,12 +32,27 @@ end
 class Curses::Window # CLASS EXTENSION
   # General extensions (see https://github.com/isene/Ruby-Curses-Class-Extension)
-  attr_accessor :color, :fg, :bg, :attr, :update, :index
-  # Set self.color for an already defined color pair such as: init_pair(1, 255, 3)
-  # The color pair is defined like this: init_pair(index, foreground, background)
-  # self.fg is set for the foreground color (and is used if self.color is not set)
-  # self.bg is set for the background color (and is used if self.color is not set)
+  # This is a class extension to Ruby Curses - a class in dire need of such.
+  # self.pair keeps a registry of colors as they are encountered - defined with:
+  # init_pair(index, foreground, background)
+  # self.fg is set for the foreground color
+  # self.bg is set for the background color
   # self.attr is set for text attributes like Curses::A_BOLD
+  # self.update can be used to indicate if a window should be updated (true/false)
+  # self.index can be used to keep track of the current list item in a window
+  attr_accessor :fg, :bg, :attr, :text, :update, :index
+  def self.pair(fg, bg)
+    @p = [[]] if @p == nil
+    fg = fg.to_i; bg = bg.to_i
+    if @p.include?([fg,bg])
+      @p.index([fg,bg])
+    else
+      @p.push([fg,bg])
+      cp = @p.index([fg,bg])
+      init_pair(cp, fg, bg)
+      @p.index([fg,bg])
+    end
+  end
   def clr # Clears the whole window
     self.setpos(0, 0)
     self.maxy.times {self.deleteln()}
@@ -64,15 +79,11 @@ class Curses::Window # CLASS EXTENSION
     x = self.curx
     y = self.cury
     self.setpos(0, 0)
+    self.bg = 0 if self.bg   == nil
+    self.fg = 255 if self.fg == nil
     blank = " " * self.maxx
-    if self.color == nil
-      self.bg = 0 if self.bg   == nil
-      self.fg = 255 if self.fg == nil
-      init_pair(self.fg, self.fg, self.bg)
-      y.times {self.attron(color_pair(self.fg)) {self << blank}}
-    else
-      y.times {self.attron(color_pair(self.color)) {self << blank}}
-    end
+    cp = Curses::Window.pair(self.fg, self.bg)
+    y.times {self.attron(color_pair(cp)) {self << blank}}
     self.refresh
     self.setpos(y, x)
   end
@@ -80,60 +91,47 @@ class Curses::Window # CLASS EXTENSION
     x = self.curx
     y = self.cury
     self.setpos(y, 0)
+    self.bg = 0 if self.bg   == nil
+    self.fg = 255 if self.fg == nil
     blank = " " * self.maxx
-    if self.color == nil
-      self.bg = 0 if self.bg   == nil
-      self.fg = 255 if self.fg == nil
-      init_pair(self.fg, self.fg, self.bg)
-      self.maxy.times {self.attron(color_pair(self.fg)) {self << blank}}
-    else
-      self.maxy.times {self.attron(color_pair(self.color)) {self << blank}}
-    end
+    cp = Curses::Window.pair(self.fg, self.bg)
+    self.maxy.times {self.attron(color_pair(cp)) {self << blank}}
     self.refresh
     self.setpos(y, x)
   end
+  def write
+    self.attr = 0 if self.attr == nil
+    self.bg = 0 if self.bg   == nil
+    self.fg = 255 if self.fg == nil
+    cp = Curses::Window.pair(self.fg, self.bg)
+    self.attron(color_pair(cp) | self.attr) { self << self.text }
+    self.refresh
+  end
   def p(text) # Puts text to window
     self.attr = 0 if self.attr == nil
-    if self.color == nil
-      self.bg = 0 if self.bg   == nil
-      self.fg = 255 if self.fg == nil
-      init_pair(self.fg, self.fg, self.bg)
-      self.attron(color_pair(self.fg) | self.attr) { self << text }
-    else
-      self.attron(color_pair(self.color) | self.attr) { self << text }
-    end
+    self.bg = 0 if self.bg   == nil
+    self.fg = 255 if self.fg == nil
+    cp = Curses::Window.pair(self.fg, self.bg)
+    self.attron(color_pair(cp) | attr) { self << text }
     self.refresh
   end
   def pclr(text) # Puts text to window and clears the rest of the window
     self.p(text)
     self.clr_from_cur_line
   end
-  def paclr(fg, bg, attr, text) # Puts text to window with full set of attributes and clears rest of window
-    self.paclr(fg, bg, attr, text)
-    self.clr_from_cur_line
-  end
-  def pa(fg, bg, attr, text) # Puts text to window with full set of attributes
-    self.fg = fg
-    self.bg = bg
-    self.attr = attr
-    init_pair(self.fg, self.fg, self.bg)
-    self.attron(color_pair(self.fg) | self.attr) { self << text }
+  def pa(fg = self.fg, bg = self.bg, attr = self.attr, text) # Puts text to window with full set of attributes
+    cp = Curses::Window.pair(fg, bg)
+    self.attron(color_pair(cp) | attr) { self << text }
     self.refresh
   end
-  def puts(text, fg=255, bg=0, attr=0) # Clears window and puts text with optional attributes
-    self.clr
-    self.refresh
-    self.setpos(0, 0)
-    self.print(text, fg, bg, attr)
-  end
-  def print(text, fg=255, bg=0, attr=0) # Print text (from current position) with optional attributes
-    init_pair(fg, fg, bg)
-    self.attron(color_pair(fg) | attr) { self << text }
-    self.refresh
+  def paclr(fg = self.fg, bg = self.bg, attr = self.attr, text) # Puts text to window with full set of attributes and clears rest of window
+    self.pa(fg, bg, attr, text)
+    self.clr_from_cur_line
   end
   def format_text(text) # Format text so that it linebreaks neatly inside window
     return "\n" + text.gsub(/(.{1,#{self.maxx}})( +|$\n?)|(.{1,#{self.maxx}})/, "\\1\\3\n")
   end
+  alias :puts :p
 end
 def getchr # Process key presses
@@ -210,6 +208,29 @@ def main_getkey # GET KEY FROM USER
     @break = true
   when 'q' # Exit
     exit 0
+  when '@' # Enter "Ruby debug"
+    cmd = w_b_getstr("◆ ", "")
+    @w_b.clr
+    @w_b.refresh
+    @w_b.update = true
+    @w_r.clr
+    info = "Command: #{cmd}\n\n"
+    begin
+      info += eval(cmd).to_s
+    rescue Exception => err
+      info += "Error: #{err.inspect}"
+    end
+    w_r_info(info)
+    @w_r.update = false
+    cmd = w_b_getstr("◆ ", "")
+    begin
+      @w_r.text = eval(cmd)
+      #@w_r.fill
+      @w_r.write
+    rescue StandardError => e
+      w_b("Error: #{e.inspect}")
+    end
+    #@w_b.update = false
   end
   while STDIN.ready?
     chr = STDIN.getc
@@ -219,25 +240,102 @@ end
 # TOP WINDOW FUNCTIONS
 # BOTTOM WINDOW FUNCTIONS
+def w_b(info) # SHOW INFO IN @W_B
+  @w_b.clr
+  info      = "Choose window: i=IMDB list (+/- to add/remove from My list), g=Genres (+/- to add/remove), m=My list. " if info == nil
+  info      = info[1..(@w_b.maxx - 3)] + "…" if info.length + 3 > @w_b.maxx
+  info     += " " * (@w_b.maxx - info.length) if info.length < @w_b.maxx
+  @w_b.text = info
+  @w_b.write
+  @w_b.update = false
+end
+def w_b_getstr(pretext, text) # A SIMPLE READLINE-LIKE ROUTINE
+  Curses.curs_set(1)
+  Curses.echo
+  stk = 0
+  pos = text.length
+  chr = ""
+  while chr != "ENTER"
+    @w_b.setpos(0,0)
+    @w_b.text = pretext + text
+    @w_b.text += " " * (@w_b.maxx - text.length) if text.length < @w_b.maxx
+    @w_b.write
+    @w_b.setpos(0,pretext.length + pos)
+    @w_b.refresh
+    chr = getchr
+    case chr
+    when 'C-C', 'C-G'
+      return ""
+    when 'RIGHT'
+      pos += 1 unless pos > text.length
+    when 'LEFT'
+      pos -= 1 unless pos == 0
+    when 'HOME'
+      pos = 0
+    when 'END'
+      pos = text.length
+    when 'DEL'
+      text[pos] = ""
+    when 'BACK'
+      unless pos == 0
+        pos -= 1
+        text[pos] = ""
+      end
+    when 'LDEL'
+      text = ""
+      pos = 0
+    when /^.$/
+      text.insert(pos,chr)
+      pos += 1
+    end
+  end
+  Curses.curs_set(0)
+  Curses.noecho
+  return text
+end
 # LEFT WINDOW FUNCTIONS
 # RIGHT WINDOW FUNCTIONS
+def w_r_info(info) # SHOW INFO IN THE RIGHT WINDOW
+  begin
+    @w_r.clr
+    @w_r.refresh
+    @w_r.text   = info
+    @w_r.write
+    @w_r.update = false
+  rescue
+  end
+end
 # MAIN PROGRAM
 loop do # OUTER LOOP - (catching refreshes via 'r')
   @break = false # Initialize @break variable (set if user hits 'r')
-  begin # Create the four windows/panels
+  begin # Create the four windows/panes
     maxx = Curses.cols
-    exit if maxx < @w_l_width
     maxy = Curses.lines
-    # Curses::Window.new(h,w,y,x)
-    @w_t = Curses::Window.new(1, maxx, 0, 0)
-    @w_b = Curses::Window.new(1, maxx, maxy - 1, 0)
-    @w_l = Curses::Window.new(maxy - 2, maxx / 2, 1, 0)
-    @w_r = Curses::Window.new(maxy - 2, maxx / 2, 1, maxx / 2)
+    # Create windows/panes
+    # Curses::Window.new     (     h,      w,      y,      x)
+    @w_t = Curses::Window.new(     1,   maxx,      0,      0)
+    @w_b = Curses::Window.new(     1,   maxx, maxy-1,      0)
+    @w_l = Curses::Window.new(maxy-2, maxx/2,      1,      0)
+    @w_r = Curses::Window.new(maxy-2, maxx/2,      1, maxx/2)
+    # Set foreground and background colors and attributes
+    @w_t.fg, @w_t.bg, @w_t.attr = 255,  23, 0
+    @w_b.fg, @w_b.bg, @w_b.attr = 231, 238, 0
+    @w_l.fg, @w_l.bg, @w_l.attr =  46, 234, 0
+    @w_r.fg, @w_r.bg, @w_r.attr = 202, 235, 0
     loop do # INNER, CORE LOOP
+      @w_t.fill; @w_b.fill; @w_l.fill; @w_r.fill
+      # Example code to write to the panes in various ways
+      @w_t.text = "Top window"
+      @w_t.write
+      @w_b.pa("Bottom window")
+      @w_l.pa(196,182,Curses::A_BOLD,"Left window")
+      @w_r.text = "Right window"
+      @w_r.write
       # Top window (info line)
       # Bottom window (command line)
@@ -246,9 +344,10 @@ loop do # OUTER LOOP - (catching refreshes via 'r')
       # Right window
-      main_getkey        # Get key from user
+      # Get key from user
+      main_getkey
-      break if @break    # Break to outer loop, redrawing windows, if user hit 'r'
+      break if @break    # Break to outer loop, redrawing windows, if user hits 'r'
       break if Curses.cols != maxx or Curses.lines != maxy # break on terminal resize
     end
   ensure # On exit: close curses, clear terminal

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: curses-extension
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: '2.0'
 platform: ruby
 authors:
 - Geir Isene
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-02 00:00:00.000000000 Z
+date: 2023-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curses
@@ -35,8 +35,7 @@ description: 'The Ruby curses library is sorely lacking some important features.
   terminal curses applications in Ruby. See the Github page for information on what
   properties and functions are included: https://github.com/isene/Ruby-Curses-Class-Extension.
   The curses_template.rb is also installed in the lib directory and serves as the
-  basis for my own curses applications. New in 1.3: Included :index as Class accessor
-  and other improvements'
+  basis for my own curses applications. New in 2.0: Full rewrite/upgrade'
 email: g@isene.com
 executables: []
 extensions: []