glark 1.9.0 → 1.10.0

data/bin/glark

@@ -12,9 +12,9 @@ dir = File.dirname(File.dirname(File.expand_path(__FILE__)))
 libpath = dir + "/lib"
 $:.unshift libpath
 
-require 'glark/glark'
+require 'glark/app/app'
 
-Glark.main
+Glark::App.new
 
 __END__
 # prototype of forthcoming feature:

data/lib/glark.rb

@@ -1,4 +1,4 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-require 'glark/glark'
+require 'glark/app/app'

data/lib/glark/app/app.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/ruby -w
+#!ruby -w
+# vim: set filetype=ruby : set sw=2
+
+# An extended grep, with extended functionality including full regular
+# expressions, contextual output, highlighting, detection and exclusion of
+# nontext files, and complex matching criteria.
+
+require 'glark/app/options'
+require 'glark/app/runner'
+
+module Glark
+  class App
+    def initialize
+      begin
+        Log.set_widths(-15, -40, -40)
+        
+        opts = AppOptions.new
+        opts.run ARGV
+        
+        # To get rid of the annoying stack trace on ctrl-C:
+        trap("INT") { abort }
+        
+        if opts.info_options.explain
+          puts opts.match_spec.expr.explain
+        end
+
+        files = ARGV.size > 0 ? ARGV : [ '-' ]
+        runner = Runner.new opts, files
+        
+        exit runner.exit_status
+      rescue => e
+        # show the message, and the stack trace only if verbose:
+        $stderr.puts "error: #{e}"
+        if Log.verbose
+          $stderr.puts e.backtrace
+          raise
+        else
+          exit 2
+        end
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  Glark::App.new
+end

data/lib/glark/app/help.rb

@@ -0,0 +1,103 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+module Glark
+  class Help
+    def show_usage
+      puts "Usage: glark [options] expression file..."
+      puts "Search for expression in each file or standard input."
+      puts "Example: glark --and=3 'try' 'catch' *.java"
+      puts ""
+
+      puts "Input:"
+      puts "  -0[nnn]                        Use \\nnn as the input record separator"
+      puts "      --before NUM[%]            Restrict the search to the top % or lines"
+      puts "      --after NUM[%]             Restrict the search to after the given location"
+      puts "  -d, --directories=ACTION       Process directories as list, skip, or find (recurse)"
+      puts "      --binary-files=TYPE        Treat binary files as TYPE"
+      puts "      --split-as-path            Treat file arguments as paths, to be split into directories and files"
+      puts "      --match-name EXPR          Search only files with names (base names) matching EXPR"
+      puts "      --not-name EXPR            Ignore files with names matching EXPR"
+      puts "      --match-path EXPR          Search only files with paths (full names) matching EXPR"
+      puts "      --not-path EXPR            Ignore files with paths matching EXPR"
+      puts "      --match-dirname EXPR       Search only directories with base names matching EXPR"
+      puts "      --not-dirname EXPR         Ignore directories with names matching EXPR"
+      puts "      --match-dirpath EXPR       Search only directories with full paths matching EXPR"
+      puts "      --not-dirpath EXPR         Ignore directories with full paths matching EXPR"
+      puts "  -M, --exclude-matching         Ignore files with names matching the expression"
+      puts "  -R, --range NUM[%],NUM[%]      Restrict the search to the given range of lines per file."
+      puts "  -r, --recurse                  Recurse through directories"
+      puts "      --size-limit=SIZE          Search only files no larger than SIZE"
+      puts ""
+
+      puts "Matching:"
+      puts "  -a, --and=NUM EXPR1 EXPR2      Match both expressions, within NUM lines"
+      puts "      --extended                 Use the given regular expression as extended"
+      puts "  -f, --file=FILE                Use the lines in the given file as expressions"
+      puts "  -i, --ignore-case              Ignore case for matching regular expressions"
+      puts "  -o, --or EXPR1 EXPR2           Match either of the two expressions"
+      puts "  -w, --word                     Match the pattern(s) with word boundaries added"
+      puts "  -x, --line-regexp              Select entire line matching pattern"
+      puts "      --xor EXPR1 EXPR2          Match either expression, but not both"
+      puts ""
+
+      puts "Output:"
+      puts "  -A, --after-context=NUM        Print NUM lines of trailing context"
+      puts "  -B, --before-context=NUM       Print NUM lines of leading context"
+      puts "  -C, -NUM, --context[=NUM]      Output NUM lines of context"
+      puts "  -c, --count                    Display only the match count per file"
+      puts "      --file-color COLOR         Specify the highlight color for file names"
+      puts "      --no-filter                Display the entire file, not only the matching lines"
+      puts "  -g, --grep                     Produce output like the grep default"
+      puts "  -h, --no-filename              Do not display the names of matching files"
+      puts "  -H, --with-filename            Display the names of matching files"
+      puts "  -l, --files-with-matches       Print only names of matching file"
+      puts "  -L, --files-without-match      Print only names of file not matching"
+      puts "      --label=NAME               Use NAME as output file name"
+      puts "  -n, --line-number              Display line numbers"
+      puts "  -N, --no-line-number           Do not display line numbers"
+      puts "      --line-number-color COLOR  Specify the highlight color for line numbers"
+      puts "  -m, --match-limit=NUM          Find only the first NUM matches in each file"
+      puts "      --text-color COLOR         Specify the highlight color for text"
+      puts "  -u, --highlight[=FORMAT]       Enable highlighting. Format is single or multi"
+      puts "  -U, --no-highlight             Disable highlighting"
+      puts "  -v, --invert-match             Show lines not matching the expression"
+      puts "  -y, --extract-matches          Display only the matching region, not the entire line"
+      puts "  -Z, --null                     In --files-with-matches mode, write file names followed by NULL"
+      puts ""
+
+      puts "Debugging/Errors:"
+      puts "      --conf                     Write the current options in RC file format"
+      puts "      --dump                     Write all options and expressions"
+      puts "      --explain                  Write the expression in a more legible format"
+      puts "  -q, --quiet                    Suppress warnings"
+      puts "  -Q, --no-quiet                 Enable warnings"
+      puts "  -s, --no-messages              Suppress warnings"
+      puts "  -V, --version                  Display version information"
+      puts "      --verbose                  Display normally suppressed output"
+
+      puts ""
+      puts "Run gem man glark for more information. That requires the installation of the gem-man gem."
+    end
+    
+    def show_man
+      pn = Pathname.new __FILE__
+
+      dir = pn
+      0.upto(3) do
+        break unless dir
+        dir = dir.parent
+      end
+
+      if dir
+        manfile = dir + "man/glark.1"
+        cmd = "gem man glark"
+        ::IO.popen(cmd) do |io|
+          puts io.readlines
+        end
+      else
+        puts "no doc directory"
+      end
+    end
+  end
+end

data/lib/glark/app/info/options.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/ruby -w
+#!ruby -w
+# vim: set filetype=ruby : set sw=2
+
+require 'glark/app/help'
+require 'glark/util/options'
+
+module Glark
+  PACKAGE = 'glark'
+  VERSION = '1.10.0'
+  
+  class InfoOptions < Options
+    attr_reader :colors
+    attr_reader :explain
+
+    def initialize colors, optdata
+      @colors = colors
+      @explain = false      # display a legible version of the expression
+
+      add_as_options optdata
+    end
+
+    def config_fields
+      fields = {
+        "known-nontext-files" => FileType.nontext_extensions.sort.join(' '),
+        "known-text-files" => FileType.text_extensions.sort.join(' '),
+        "quiet" => Log.quiet,
+        "verbose" => Log.verbose,
+      }
+    end
+
+    def dump_fields
+      fields = { 
+        "explain" => @explain,
+        "known_nontext_files" => FileType.nontext_extensions.join(", "),
+        "known_text_files" => FileType.text_extensions.join(", "),
+        "quiet" => Log.quiet,
+        "ruby version" => RUBY_VERSION,
+        "verbose" => Log.verbose,
+        "version" => Glark::VERSION,
+      }
+    end
+
+    def update_fields fields
+      fields.each do |name, values|
+        case name
+        when "known-nontext-files"
+          values.last.split.each do |ext|
+            FileType.set_nontext ext
+          end
+        when "known-text-files"
+          values.last.split.each do |ext|
+            FileType.set_text ext
+          end
+        when "quiet"
+          Log.quiet = to_boolean(values.last)
+        when "verbose"
+          Log.verbose = to_boolean(values.last) ? 1 : nil
+        when "verbosity"
+          Log.verbose = values.last.to_i
+        end
+      end
+    end
+    
+    def add_as_options optdata
+      add_opt_blk(optdata, %w{ -V --version }) { show_version }
+      add_opt_blk(optdata, %w{ --verbose }) { Log.verbose = true }
+      add_opt_blk(optdata, %w{ -? --help }) { Help.new.show_usage; exit 0 }
+      add_opt_blk(optdata, %w{ --man }) { Help.new.show_man; exit 0 }
+      
+      add_opt_true optdata, :explain, %w{ --explain }
+
+      add_opt_blk(optdata, %w{ -q -s --quiet --messages }) { Log.quiet = true }
+      add_opt_blk(optdata, %w{ -Q -S --no-quiet --no-messages }) { Log.quiet = false }
+    end
+
+    def show_version
+      puts Glark::PACKAGE + ", version " + Glark::VERSION
+      puts "Written by Jeff Pace (jeugenepace@gmail.com)."
+      puts "Released under the Lesser GNU Public License."
+      exit 0
+    end
+  end
+end

data/lib/glark/app/options.rb

@@ -0,0 +1,201 @@
+#!/usr/bin/ruby -w
+# -*- ruby -*-
+
+require 'rubygems'
+require 'riel/dir'
+require 'riel/optproc'
+require 'glark/app/info/options'
+require 'glark/app/rcfile'
+require 'glark/app/spec'
+require 'glark/input/options'
+require 'glark/match/options'
+require 'glark/output/options'
+require 'glark/util/colors/options'
+require 'glark/util/options'
+require 'glark/util/optutil'
+
+module Glark
+  class AppOptions < AppSpec
+    include OptionUtil
+    
+    attr_reader :colors
+    attr_reader :fileset
+    attr_reader :info_options
+    attr_reader :output_options
+    
+    def initialize
+      optdata = Array.new
+
+      @colors = ColorOptions.new    
+
+      @input_options = InputOptions.new optdata
+      @match_options = MatchOptions.new @colors, optdata
+      @output_options = OutputOptions.new @colors, optdata
+
+      @info_options = InfoOptions.new @colors, optdata
+
+      add_opt_blk(optdata, %w{ --config }) { write_configuration; exit }
+      add_opt_blk(optdata, %w{ --dump }) { dump_all_fields; exit 0 }
+
+      super @input_options, @match_options, @output_options
+      
+      @optset = OptProc::OptionSet.new optdata
+    end
+    
+    def run args
+      @args = args
+
+      read_home_rcfile
+
+      if @local_config_files
+        read_local_rcfiles
+      end
+
+      read_environment_variable
+
+      # honor thy EMACS; go to grep mode
+      if ENV["EMACS"]
+        @output_options.style = "grep"
+      end
+
+      read_options
+
+      validate!
+
+      @fileset = @input_options.create_fileset @args
+
+      if @output_options.show_file_names.nil?
+        @output_options.show_file_names = @output_options.label || !one_file?
+      end
+    end
+
+    def one_file?
+      return false if @fileset.size > 1
+      first = @fileset.files.first
+      first.to_s != '-' && first.file?
+    end
+
+    def read_home_rcfile
+      return unless hdir = Dir.home
+      hdpn = Pathname.new hdir
+      homerc = hdpn + '.glarkrc'
+      read_rcfile homerc
+    end
+
+    def read_local_rcfiles
+      hdir = Dir.home
+      dir = Pathname.new('.').expand_path
+      while !dir.root? && dir != hdir
+        rcfile = dir + '.glarkrc'
+        return if read_rcfile rcfile
+        dir = dir.dirname
+      end
+    end
+
+    def all_option_sets
+      [ @colors, @match_options, @output_options, @info_options, @input_options ]
+    end
+
+    def read_rcfile rcfname
+      return nil unless rcfname.exist?
+      rcfile = RCFile.new rcfname
+      rcvalues = rcfile.names.collect { |name| [ name, rcfile.values(name) ] }
+
+      all_option_sets.each do |opts|
+        opts.update_fields rcvalues
+      end
+      update_fields rcvalues
+      true
+    end
+
+    def config_fields
+      fields = {
+        "local-config-files" => @local_config_files,
+      }
+    end
+
+    def dump_fields
+      config_fields
+    end
+
+    def update_fields fields
+      fields.each do |name, values|
+        case name
+        when "local-config-files"
+          @local_config_files = to_boolean values.last
+        end
+      end
+    end
+
+    def read_environment_variable
+      options = Env.split "GLARKOPTS"
+      while options.size > 0
+        @optset.process_option options
+      end
+    end
+
+    def read_expression
+      if @args.size > 0
+        known_end = false
+        if @args[0] == "--"
+          @args.shift
+          known_end = true
+        end
+        
+        if @args && @args.size > 0
+          return @match_options.read_expression @args, !known_end
+        end
+      end
+      
+      if @args.size > 0
+        raise "No expression provided."
+      end
+      
+      $stderr.puts "Usage: glark [options] expression file..."
+      $stderr.puts "Try `glark --help' for more information."
+      exit 1
+    end
+
+    def read_options
+      # solitary "-v" means "--version", not --invert-match
+      @info_options.show_version if @args.size == 1 && @args.first == "-v"
+      
+      @match_options.expr = nil
+      
+      nil while @args.size > 0 && @optset.process_option(@args)
+
+      unless @match_options.expr
+        read_expression
+      end
+    end
+
+    def write_configuration
+      fields = config_fields
+      all_option_sets.each do |opts|
+        fields.merge! opts.config_fields
+      end
+      
+      fields.keys.sort.each do |fname|
+        puts "#{fname}: #{fields[fname]}"
+      end
+    end
+
+    def dump_all_fields
+      fields = dump_fields
+      all_option_sets.each do |opts|
+        fields.merge! opts.dump_fields
+      end
+
+      len = fields.keys.collect { |f| f.length }.max
+      
+      fields.keys.sort.each do |field|
+        printf "%*s : %s\n", len, field, fields[field]
+      end
+    end
+
+    # check options for collisions/data validity
+    def validate!
+      @input_options.range.validate!
+    end
+  end
+end