typr 1.1.2 → 1.2.0

data/lib/text.rb

@@ -1,14 +1,10 @@
-#!/usr/bin/env ruby
-# coding: utf-8
-# frozen_string_literal: true
-
 require 'stringio'
 require_relative 'stack.rb'
 
 module Typr
 
   # A vertically scrollable text viewer with word-wrapping, header bar,
-  # row selection via hint characters, and search.
+  # row selection via hint characters, and pager-style search (/ n p).
   #
   # Accepts String, IO, or StringIO input. Content is split into display
   # rows by newlines and line width, then rendered as a sliding window.
@@ -21,8 +17,8 @@ module Typr
   #     top: 2, left: 0.1, right: 0.9, bottom: -4,
   #     border: :round,
   #     colors: { header: [:yellow, :grey30] }
-  #   )
-  #   text.draw
+#   )
+#   text.show
 
   class Text < Stack
 
@@ -72,6 +68,7 @@ module Typr
         end
       end
       @lines << @data.length unless @lines.last == @data.length
+      highlight if @re
     end
     alias :<< :build
 
@@ -84,7 +81,14 @@ module Typr
     def print row=nil
       header = ( row == :header )
       return super unless row and @lines[ row + 1 ] unless header
-      show prepare( ( header ? @header : @page[ row-@start ] ), width )
+      text = ( header ? @header : @page[ row-@start ] )
+      if row.is_a?(Integer) and @search[:matches].include? row
+        background @colors[:search]
+        draw prepare( text, width )
+        background
+      else
+        draw prepare( text, width )
+      end
     end
 
     # Returns word-boundary column offsets for a given page row.
@@ -99,9 +103,9 @@ module Typr
     # Full draw cycle: rebuilds on resize, computes visible lines,
     # and renders the viewport with borders and hints.
     #
-    #   text.draw
+    #   text.show
 
-    def draw
+    def show
       (build; @lastwidth = width) if width != @lastwidth
       range = @lines[@start..@start+height]
       page = StringIO.new @data[range.first..range.last]
@@ -115,11 +119,60 @@ module Typr
 
     def rows; @lines.count end
 
-    # Placeholder for text search. Currently unimplemented.
+    ##
+    # Pager-style search over the buffer, modeled after less/vim.
+    #
+    # With a +query+ (String, matched literally, or Regexp) it stores the
+    # pattern, highlights every matching line, and scrolls to the first
+    # match from the current position. +dir+ is +:forward+ or +:backward+.
+    # Returns the matched line id, or nil when nothing matches.
+    #
+    # With no argument it prompts interactively for a pattern at the bottom
+    # of the screen (pressing Return searches, Escape aborts).
     #
-    #   text.search("query")  # => nil
+    # Matching is smart-case: lowercase queries are case-insensitive;
+    # a query containing an uppercase letter is case-sensitive.
+    #
+    #   text.search "needle"    # => 12 (or nil)
+    #   text.search /^TODO/     # => 3
+    #   text.search "needle", :backward   # search upward
+
+    def search query=nil, dir=:forward
+      return search_prompt if query.nil?
+      @search[:pattern] = query
+      @search[:dir] = dir
+      @search[:last] = nil
+      @re = query.is_a?(Regexp) ? query :
+        Regexp.new( Regexp.escape( query ),
+          ( query[/[A-Z]/] ? 0 : Regexp::IGNORECASE ) )
+      highlight
+      step
+    end
+
+    ## Jump to the next match of the last search (wrap-around). Returns its line id or nil.
+
+    def search_next; @search[:dir] = :forward; step end
+
+    ## Jump to the previous match of the last search (wrap-around). Returns its line id or nil.
+
+    def search_prev; @search[:dir] = :backward; step end
+
+    ## Recompute the set of lines containing the current pattern.
+
+    def highlight
+      @search[:matches] = @re ?
+        @lines[0...-1].each_index.select{ |i|
+          @data[ @lines[i] ... @lines[i+1] ][ @re ] } : []
+      return
+    end
+
+    ## Clear the search pattern and all match highlights.
 
-    def search query
+    def highlight_clear
+      @re = @search[:pattern] = nil
+      @search[:matches] = []
+      @search[:last] = nil
+      return
     end
 
     # Creates a new Text widget.
@@ -130,11 +183,62 @@ module Typr
     def initialize args={}
       @tabspace = 2
       @data, @lines, @tail = "", [0], ""
+      @search = { pattern: nil, dir: :forward, last: nil, matches: [] }
       super args
-      @colors = { header: :yellow }.merge( @colors || {} )
+      @colors = { header: :yellow, search: :grey20 }.merge( @colors || {} )
+      @keymap = { search: ?/, search_next: ?n, search_prev: ?p }.merge @keymap
       @lastwidth = width
       self << @input
     end
+
+    def reset type=:all
+      case type
+        when :search; highlight_clear
+        when :all; reset [:position, :selection, :search]; return
+      end
+      super
+    end
+
+    private
+
+    def live_search query
+      query.empty? ? highlight_clear : search(query)
+    end
+
+    def step
+      matches = @search[:matches]
+      return nil if matches.empty?
+      last = @search[:last]
+      if @search[:dir] == :backward
+        id = matches.reverse.find{ |m| last and m < last }
+        id ||= ( last ? matches.last : matches.reverse.find{ |m| m <= @start } || matches.last )
+      else
+        id = matches.find{ |m| last and m > last }
+        id ||= ( last ? matches.first : matches.find{ |m| m >= @start } || matches.first )
+      end
+      @search[:last] = id
+      @start = id
+      return id
+    end
+
+    def search_prompt
+      query = @search[:pattern].is_a?(String) ? @search[:pattern].dup : ''
+      saved = { re: @re, pattern: @search[:pattern],
+        matches: @search[:matches].dup, last: @search[:last], start: @start }
+      result = Typr.read_line '/', left: left, top: Typr.height - 1, initial: query,
+        &->(key, query, _) {
+          live_search query
+          nil
+        }
+      if result
+        return search(result) unless result.empty?
+        return search(@search[:pattern]) if @search[:pattern]
+      end
+      @re = saved[:re]; @search[:pattern] = saved[:pattern]
+      @search[:matches] = saved[:matches]; @search[:last] = saved[:last]
+      @start = saved[:start]
+      return
+    end
   end
 
 end

data/lib/typr.rb

@@ -1,6 +1,5 @@
 # typr is a Ruby library for building interactive terminal-based user interfaces.
-# It provides layout primitives, widgets, and event-driven interaction built on
-# top of curses.
+# It provides layout primitives, widgets, and event-driven interaction.
 #
 # == Widgets
 #
@@ -16,8 +15,8 @@
 #   Typr.init               # Initialize terminal (hide cursor, enable key mode)
 #   Typr.clear              # Clear entire screen
 #   Typr.clear :line        # Clear current line only
-#   key = Typr.read(:key)   # Read a single keypress
-#   line = Typr.read(:line) # Read a line of text input
+#   key = Typr.read_key      # Read a single keypress
+#   line = Typr.read_line "> " # Edit a line of text (enter to accept, esc to abort)
 #   Typr.exit               # Restore terminal state
 #
 # == Layout Properties
@@ -38,8 +37,8 @@
 #     header: ['Name', 'Age'],
 #     format: [:max, :right]
 #   )
-#   grid.draw
-#   key = Typr.read(:key)
+#   grid.show
+#   key = Typr.read_key
 #   Typr.exit
 #
 # == Installation