diakonos 0.8.8 → 0.9.8

data/lib/diakonos/buffer/searching.rb

@@ -0,0 +1,552 @@
+module Diakonos
+
+  class Buffer
+
+    attr_reader :num_matches_found, :last_search_regexps
+
+    CHARACTER_PAIRS = {
+      '(' => { partner: ')', direction: :forward },
+      '<' => { partner: '>', direction: :forward },
+      '{' => { partner: '}', direction: :forward },
+      '[' => { partner: ']', direction: :forward },
+      ')' => { partner: '(', direction: :backward },
+      '>' => { partner: '<', direction: :backward },
+      '}' => { partner: '{', direction: :backward },
+      ']' => { partner: '[', direction: :backward },
+    }
+
+    OPPOSITE_DIRECTION = {
+      up: :down,
+      down: :up,
+    }
+
+    def search_area?
+      @search_area
+    end
+
+    def clear_search_area
+      @search_area = nil
+      @text_marks.delete :search_area_pre
+      @text_marks.delete :search_area_post
+    end
+
+    def set_search_area(mark)
+      if mark.nil?
+        raise 'Call Diakonos::Buffer#clear_search_area instead'
+        return
+      end
+
+      @search_area = mark
+      @text_marks[ :search_area_pre ] = TextMark.new(
+        ::Diakonos::Range.new(0, 0, mark.start_row, mark.start_col),
+        @settings[ 'view.non_search_area.format' ]
+      )
+      @text_marks[ :search_area_post ] = TextMark.new(
+        ::Diakonos::Range.new(mark.end_row, mark.end_col, @lines.length - 1, @lines[ -1 ].length),
+        @settings[ 'view.non_search_area.format' ]
+      )
+    end
+
+    def confirm_finding( regexps, search_area, from_row, from_col, match )
+      found_text = match[0]
+      range = ::Diakonos::Range.new(from_row, from_col, from_row, from_col + found_text.length)
+      Finding.confirm(range, regexps, @lines, search_area, match)
+    end
+
+    # @return [Array<String>]
+    def search_area_lines
+      return []  if @search_area.nil?
+
+      lines = @lines[@search_area.start_row..@search_area.end_row]
+      lines[0] = lines[0][@search_area.start_col..-1]
+      lines[-1] = lines[-1][0..@search_area.end_col]
+
+      lines
+    end
+
+    def _find_down(regexps, regexp, from_row, from_col, search_area)
+      # Check the current row first.
+
+      index = @lines[ from_row ].index(
+        regexp,
+        ( @last_finding ? @last_finding.start_col : from_col ) + 1
+      )
+      if index
+        finding = confirm_finding( regexps, search_area, from_row, index, Regexp.last_match )
+        return finding  if finding
+      end
+
+      # Check below the cursor.
+
+      ( (from_row + 1)..search_area.end_row ).each do |i|
+        line = @lines[ i ]
+        if i == search_area.end_row
+          line = line[ 0...search_area.end_col ]
+        end
+        index = line.index( regexp )
+        if index
+          finding = confirm_finding( regexps, search_area, i, index, Regexp.last_match )
+          return finding  if finding
+        end
+      end
+
+      if index
+        finding = confirm_finding( regexps, search_area, search_area.end_row, index, Regexp.last_match )
+        return finding  if finding
+      end
+
+      # Wrap around.
+
+      @wrapped = true
+
+      index = @lines[ search_area.start_row ].index( regexp, search_area.start_col )
+      if index
+        finding = confirm_finding( regexps, search_area, search_area.start_row, index, Regexp.last_match )
+        return finding  if finding
+      end
+
+      ( search_area.start_row+1...from_row ).each do |i|
+        index = @lines[ i ].index( regexp )
+        if index
+          finding = confirm_finding( regexps, search_area, i, index, Regexp.last_match )
+          return finding  if finding
+        end
+      end
+
+      # And finally, the other side of the current row.
+
+      if from_row == search_area.start_row
+        index_col = search_area.start_col
+      else
+        index_col = 0
+      end
+      if index = @lines[ from_row ].index( regexp, index_col )
+        if index <= ( @last_finding ? @last_finding.start_col : from_col )
+          finding = confirm_finding( regexps, search_area, from_row, index, Regexp.last_match )
+          return finding  if finding
+        end
+      end
+    end
+
+    def _find_up(regexps, regexp, search_area, from_row, from_col)
+      # Check the current row first.
+
+      col_to_check = ( @last_finding ? @last_finding.end_col : from_col ) - 1
+      if ( col_to_check >= 0 ) && ( index = @lines[ from_row ][ 0...col_to_check ].rindex( regexp ) )
+        finding = confirm_finding( regexps, search_area, from_row, index, Regexp.last_match )
+        return finding  if finding
+      end
+
+      # Check above the cursor.
+
+      (from_row - 1).downto( 0 ) do |i|
+        if index = @lines[ i ].rindex( regexp )
+          finding = confirm_finding( regexps, search_area, i, index, Regexp.last_match )
+          return finding  if finding
+        end
+      end
+
+      # Wrap around.
+
+      @wrapped = true
+
+      (@lines.length - 1).downto(from_row + 1) do |i|
+        if index = @lines[ i ].rindex( regexp )
+          finding = confirm_finding( regexps, search_area, i, index, Regexp.last_match )
+          return finding  if finding
+        end
+      end
+
+      # And finally, the other side of the current row.
+
+      search_col = ( @last_finding ? @last_finding.start_col : from_col ) + 1
+      if index = @lines[ from_row ].rindex( regexp )
+        if index > search_col
+          finding = confirm_finding( regexps, search_area, from_row, index, Regexp.last_match )
+          return finding  if finding
+        end
+      end
+    end
+
+    # @param regexps [Array] Regexps which represent a user-provided regexp,
+    # split across newline characters.  Once the first element is found,
+    # each successive element must match against lines following the first
+    # element.
+    # @return [Integer] the number of replacements made
+    def find( regexps, options = {} )
+      return  if regexps.nil?
+      regexp = regexps[ 0 ]
+      return  if regexp.nil? || regexp == //
+
+      direction          = options[ :direction ]
+      replacement        = options[ :replacement ]
+      auto_choice        = options[ :auto_choice ]
+      from_row           = options[ :starting_row ] || @last_row
+      from_col           = options[ :starting_col ] || @last_col
+      show_context_after = options[ :show_context_after ]
+
+      if options[:starting]
+        @num_matches_found = nil
+      end
+
+      num_replacements = 0
+
+      # TODO: Just use Range here instead of TextMark?
+      search_area = @search_area || TextMark.new( ::Diakonos::Range.new(0, 0, @lines.size - 1, @lines[ -1 ].size), nil )
+      if ! search_area.contains?( from_row, from_col )
+        from_row, from_col = search_area.start_row, search_area.start_col
+      end
+
+      if direction == :opposite
+        direction = OPPOSITE_DIRECTION[@last_search_direction]
+      end
+      @last_search_regexps = regexps
+      @last_search_direction = direction
+
+      @wrapped = false
+
+      if direction == :down
+        finding = _find_down(regexps, regexp, from_row, from_col, search_area)
+      elsif direction == :up
+        finding = _find_up(regexps, regexp, search_area, from_row, from_col)
+      end
+
+      if ! finding
+        remove_selection DONT_DISPLAY
+        clear_matches DO_DISPLAY
+        if ! options[ :quiet ] && ( replacement.nil? || num_replacements == 0 )
+          $diakonos.set_iline "/#{regexp.source}/ not found."
+        end
+      else
+        if @wrapped && ! options[ :quiet ]
+          if @search_area
+            $diakonos.set_iline( "(search wrapped around to start of search area)" )
+          else
+            $diakonos.set_iline( "(search wrapped around BOF/EOF)" )
+          end
+        end
+
+        remove_selection( DONT_DISPLAY )
+        @last_finding = finding
+        if @settings[ "found_cursor_start" ]
+          anchor_selection( finding.end_row, finding.end_col, DONT_DISPLAY )
+          cursor_to( finding.start_row, finding.start_col )
+        else
+          anchor_selection( finding.start_row, finding.start_col, DONT_DISPLAY )
+          cursor_to( finding.end_row, finding.end_col )
+        end
+        if show_context_after
+          watermark = Curses::lines / 6
+          if @last_row - @top_line > watermark
+            pitch_view( @last_row - @top_line - watermark )
+          end
+        end
+
+        @changing_selection = false
+
+        if regexps.length == 1
+          @highlight_regexp = regexp
+          highlight_matches
+        else
+          clear_matches
+        end
+        display
+
+        if replacement
+          # Substitute placeholders (e.g. \1) in str for the group matches of the last match.
+          actual_replacement = replacement.dup
+          actual_replacement.gsub!( /\\(\\|\d+)/ ) { |m|
+            ref = $1
+            if ref == "\\"
+              "\\"
+            else
+              finding.captured_group(ref.to_i)
+            end
+          }
+
+          choices = [ CHOICE_YES, CHOICE_NO, CHOICE_ALL, CHOICE_CANCEL, CHOICE_YES_AND_STOP, ]
+          if @search_area
+            choices << CHOICE_WITHIN_SELECTION
+          end
+          choice = auto_choice || $diakonos.get_choice(
+            "#{@num_matches_found} match#{ @num_matches_found != 1 ? 'es' : '' } - Replace this one?",
+            choices,
+            CHOICE_YES
+          )
+          case choice
+          when CHOICE_YES
+            paste [ actual_replacement ]
+            num_replacements += 1 + find( regexps, direction: direction, replacement: replacement )
+          when CHOICE_ALL
+            num_replacements += replace_all(regexp, replacement)
+          when CHOICE_WITHIN_SELECTION
+            num_replacements += replace_all(regexp, replacement, :within_search_area)
+          when CHOICE_NO
+            num_replacements += find( regexps, direction: direction, replacement: replacement )
+          when CHOICE_CANCEL
+            # Do nothing further.
+          when CHOICE_YES_AND_STOP
+            paste [ actual_replacement ]
+            num_replacements += 1
+            # Do nothing further.
+          end
+        end
+      end
+
+      num_replacements
+    end
+
+    # @return [Integer] the number of replacements made
+    def replace_all( regexp, replacement, within_search_area = false )
+      return  if( regexp.nil? || replacement.nil? )
+
+      num_replacements = 0
+
+      take_snapshot
+
+      if within_search_area && @search_area
+        lines = self.search_area_lines
+      else
+        lines = @lines
+      end
+
+      lines_modified = lines.collect { |line|
+        num_replacements += line.scan(regexp).size
+        line.gsub( regexp, replacement )
+      }
+
+      if within_search_area && @search_area
+        @lines[@search_area.start_row][@search_area.start_col..-1] = lines_modified[0]
+        if @search_area.end_row - @search_area.start_row > 1
+          @lines[@search_area.start_row+1..@search_area.end_row-1] = lines_modified[1..-2]
+        end
+        @lines[@search_area.end_row][0..@search_area.end_col] = lines_modified[-1]
+      else
+        @lines = lines_modified
+      end
+
+      set_modified
+      clear_matches
+      display
+      num_replacements
+    end
+
+    def highlight_matches( regexp = @highlight_regexp )
+      @highlight_regexp = regexp
+      return  if @highlight_regexp.nil?
+
+      if @search_area
+        lines = self.search_area_lines
+        line_index_offset = @search_area.start_row
+        col_offset = @search_area.start_col
+      else
+        lines = @lines
+        line_index_offset = 0
+        col_offset = 0
+      end
+
+      grepped_lines = lines.grep_indices( @highlight_regexp )
+      n = grepped_lines.count
+      found_marks = grepped_lines.collect do |line_index, start_col, end_col|
+        TextMark.new(
+          ::Diakonos::Range.new(
+            line_index + line_index_offset,
+            start_col + ( line_index == 0 ? col_offset : 0 ),
+            line_index + line_index_offset,
+            end_col,
+          ),
+          @settings["lang.#{@language}.format.found"]
+        )
+      end
+      @text_marks[:found] = found_marks
+      @num_matches_found ||= found_marks.size
+    end
+
+    def clear_matches( do_display = DONT_DISPLAY )
+      @text_marks[ :found ] = []
+      @highlight_regexp = nil
+      display  if do_display
+    end
+
+    def pos_of_next( regexp, start_row, start_col )
+      row, col = start_row, start_col
+      col = @lines[ row ].index( regexp, col )
+      while col.nil? && row < @lines.length - 1
+        row += 1
+        col = @lines[ row ].index( regexp )
+      end
+      if col
+        [ row, col, Regexp.last_match( 0 ) ]
+      end
+    end
+
+    def pos_of_prev( regexp, start_row, start_col )
+      row, col = start_row, start_col
+      if col < 0
+        row -= 1
+        col = -1
+      end
+      return  if row < 0
+
+      col = @lines[ row ].rindex( regexp, col )
+      while col.nil? && row > 0
+        row -= 1
+        col = @lines[ row ].rindex( regexp )
+      end
+      if col
+        [ row, col, Regexp.last_match( 0 ) ]
+      end
+    end
+
+    def pos_of_pair_match( row = @last_row, col = @last_col )
+      c = @lines[ row ][ col ]
+      data = CHARACTER_PAIRS[ c ]
+      return  if data.nil?
+      d = data[ :partner ]
+      c_ = Regexp.escape c
+      d_ = Regexp.escape d
+      target = /(?:#{c_}|#{d_})/
+
+      case data[ :direction ]
+      when :forward
+        row, col, char = pos_of_next( target, row, col + 1 )
+        while char == c  # Take care of nested pairs
+          row, col = pos_of_pair_match( row, col )
+          break  if col.nil?
+          row, col, char = pos_of_next( target, row, col + 1 )
+        end
+      when :backward
+        row, col, char = pos_of_prev( target, row, col - 1 )
+        while char == c  # Take care of nested pairs
+          row, col = pos_of_pair_match( row, col )
+          break  if col.nil?
+          row, col, char = pos_of_prev( target, row, col - 1 )
+        end
+      end
+      [ row, col ]
+    end
+
+    def go_to_pair_match
+      row, col = pos_of_pair_match
+      if row && col
+        if cursor_to( row, col )
+          highlight_pair
+          display
+        end
+      end
+    end
+
+    def highlight_pair
+      match_row, match_col = pos_of_pair_match( @last_row, @last_col )
+      if match_col.nil?
+        @text_marks[ :pair ] = nil
+      else
+        @text_marks[ :pair ] = TextMark.new(
+          ::Diakonos::Range.new(match_row, match_col, match_row, match_col + 1),
+          @settings[ "lang.#{@language}.format.pair" ] || @settings[ "lang.shared.format.pair" ]
+        )
+      end
+    end
+
+    def clear_pair_highlight
+      @text_marks[ :pair ] = nil
+    end
+
+    def find_again( last_search_regexps, direction = @last_search_direction )
+      if @last_search_regexps.nil? || @last_search_regexps.empty?
+        @last_search_regexps = last_search_regexps
+      end
+      if @last_search_regexps
+        find @last_search_regexps, direction: direction
+      end
+    end
+
+    def seek( regexp, direction = :down )
+      return  if regexp.nil? || regexp == //
+
+      found_row = nil
+      found_col = nil
+      found_text = nil
+
+      catch :found do
+        if direction == :down
+          # Check the current row first.
+
+          index, match_text = @lines[ @last_row ].group_index( regexp, @last_col + 1 )
+          if index
+            found_row = @last_row
+            found_col = index
+            found_text = match_text
+            throw :found
+          end
+
+          # Check below the cursor.
+
+          ( (@last_row + 1)...@lines.length ).each do |i|
+            index, match_text = @lines[ i ].group_index( regexp )
+            if index
+              found_row = i
+              found_col = index
+              found_text = match_text
+              throw :found
+            end
+          end
+
+        else
+          # Check the current row first.
+
+          col_to_check = @last_col - 1
+          if col_to_check >= 0
+            index, match_text = @lines[ @last_row ].group_rindex( regexp, col_to_check )
+            if index
+              found_row = @last_row
+              found_col = index
+              found_text = match_text
+              throw :found
+            end
+          end
+
+          # Check above the cursor.
+
+          (@last_row - 1).downto( 0 ) do |i|
+            index, match_text = @lines[ i ].group_rindex( regexp )
+            if index
+              found_row = i
+              found_col = index
+              found_text = match_text
+              throw :found
+            end
+          end
+        end
+      end
+
+      if found_text
+        cursor_to( found_row, found_col )
+        display
+        true
+      end
+    end
+
+    # Returns an Array of results, where each result is a String usually
+    # containing \n's due to context
+    def grep( regexp_source )
+      if @name
+        filename = File.basename( @name )
+        filepath = @name
+      else
+        filename = "(unnamed buffer)"
+        filepath = "(unnamed buffer #{object_id})"
+      end
+
+      ::Diakonos.grep_array(
+        Regexp.new( regexp_source ),
+        @lines,
+        $diakonos.settings[ 'grep.context' ],
+        "#{filename}:",
+        filepath
+      )
+    end
+
+  end
+
+end