git.r.bdr.sh - rbdr/dotfiles/blob - vim/tmp/command_t/ruby/command-t/finder.rb

   1 # Copyright 2010-2011 Wincent Colaiuta. All rights reserved.
   2 #
   3 # Redistribution and use in source and binary forms, with or without
   4 # modification, are permitted provided that the following conditions are met:
   5 #
   6 # 1. Redistributions of source code must retain the above copyright notice,
   7 #    this list of conditions and the following disclaimer.
   8 # 2. Redistributions in binary form must reproduce the above copyright notice,
   9 #    this list of conditions and the following disclaimer in the documentation
  10 #    and/or other materials provided with the distribution.
  11 #
  12 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  13 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  14 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  15 # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
  16 # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  17 # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  18 # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  19 # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  20 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  21 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  22 # POSSIBILITY OF SUCH DAMAGE.
  23
  24 require 'command-t/ext' # CommandT::Matcher
  25
  26 module CommandT
  27   # Encapsulates a Scanner instance (which builds up a list of available files
  28   # in a directory) and a Matcher instance (which selects from that list based
  29   # on a search string).
  30   #
  31   # Specialized subclasses use different kinds of scanners adapted for
  32   # different kinds of search (files, buffers).
  33   class Finder
  34     def initialize path = Dir.pwd, options = {}
  35       raise RuntimeError, 'Subclass responsibility'
  36     end
  37
  38     # Options:
  39     #   :limit (integer): limit the number of returned matches
  40     def sorted_matches_for str, options = {}
  41       @matcher.sorted_matches_for str, options
  42     end
  43
  44     def flush
  45       @scanner.flush
  46     end
  47
  48     def path= path
  49       @scanner.path = path
  50     end
  51   end # class Finder
  52 end # CommandT