linecache 0.43 → 0.45

data/ChangeLog

@@ -1,317 +0,0 @@
-2008-04-10 20:06  Rocky Bernstein
-
-	* NEWS: What's new for 0.41.
-
-2008-04-10 20:02  Rocky Bernstein
-
-	* ChangeLog, Rakefile, VERSION: Forgot to add test/data to the gem.
-
-2008-04-10 02:15  Rocky Bernstein
-
-	* NEWS:
-
-2008-03-28 15:04  Rocky Bernstein
-
-	* test/data/if6.rb, test/data/if7.rb: More if tests
-
-2008-03-09 23:24  Rocky Bernstein
-
-	* ChangeLog, Rakefile, VERSION, lib/linecache.rb: Deal with
-	  Depricated win32.
-
-2008-03-05 02:01  Rocky Bernstein
-
-	* Rakefile: Add rubyforge_upload task -- code from
-	  ruby-memory-profiler.
-
-2008-03-04 22:47  Rocky Bernstein
-
-	* README: Ooops - forgot to credit Ryan Davis and ParseTree.
-
-2008-02-10 13:59  Rocky Bernstein
-
-	* ChangeLog, Rakefile, ext/trace_nums.c, ext/win32, svn2cl_usermap:
-	  Go over Rakefile and doc for 0.3 release.
-
-2008-01-29 21:51  Rocky Bernstein
-
-	* test/test-linecache.rb: Interface change. Don't know why this
-	  didn't get updated before.
-
-2008-01-28 15:35  Rocky Bernstein
-
-	* ChangeLog, lib/linecache.rb: Change line number return from a Set
-	  to an Array.
-
-2008-01-27 11:24  Rocky Bernstein
-
-	* ext/trace_nums.c, ext/trace_nums.h, test/data/if5.rb: Handle
-	  defined? node. Add "if" weirdness test.
-
-2008-01-27 04:26  Rocky Bernstein
-
-	* test/data/case5.rb: Verify that the 'else' doesn't appear in a
-	  trace.
-
-2008-01-27 04:21  Rocky Bernstein
-
-	* ext/trace_nums.c, test/data/block1.rb, test/data/block2.rb,
-	  test/data/case1.rb, test/data/case2.rb, test/data/case3.rb,
-	  test/data/case4.rb, test/data/case5.rb, test/data/def1.rb,
-	  test/data/each1.rb, test/data/for1.rb, test/data/if3.rb,
-	  test/data/if4.rb, test/data/match3.rb, test/data/match3a.rb,
-	  test/data/not-lit.rb: Was not showing blocks after when's.
-
-2008-01-27 04:03  Rocky Bernstein
-
-	* ext/trace_nums.c, test/data/block1.rb, test/data/block2.rb,
-	  test/data/if4.rb, test/lnum-diag.rb: trace_nums.c, block1.c,
-	  block2.c: bug in handling blocks
-	  lnum-diag.rb: more graceful about not finding the source.
-	  if4.rb: note weirdness in the way comparison works.
-
-2008-01-27 02:11  Rocky Bernstein
-
-	* ext/trace_nums.c, ext/trace_nums.h, test/data/case4.rb,
-	  test/data/def1.rb, test/data/if3.rb, test/lnum-diag.rb: Finish
-	  adding all tree nodes. Work on case nodes some more.
-	  lnum-diag.rb: add options to turn on and off various parts.
-
-2008-01-26 11:12  Rocky Bernstein
-
-	* test/data/comments1.rb: Add comment test and situation where no
-	  lines traced.
-
-2008-01-26 11:08  Rocky Bernstein
-
-	* ext/trace_nums.c, test/data/class1.rb: Add class, scope and
-	  module nodes.
-
-2008-01-26 10:18  Rocky Bernstein
-
-	* ext/trace_nums.c, test/rcov-bug.rb, test/test-linecache.rb,
-	  test/test-tracelines.rb: Add more tree nodes.
-
-2008-01-26 02:09  Rocky Bernstein
-
-	* test/data/each1.rb, test/data/for1.rb, test/data/if1.rb,
-	  test/data/if2.rb, test/test-lnum.rb: Add Debugger.init which
-	  intializes things that rdebug does. This
-	  allows a restart even though rdebug wasn't called initially.
-
-2008-01-25 03:50  Rocky Bernstein
-
-	* ext/trace_nums.c: Some code cleanup.
-
-2008-01-25 02:50  Rocky Bernstein
-
-	* ext/trace_nums.c, test/data/case1.rb, test/data/case2.rb,
-	  test/data/case3.rb, test/data/match3.rb, test/data/match3a.rb:
-	  Work over case, when and match3.
-
-2008-01-25 00:17  Rocky Bernstein
-
-	* ext/trace_nums.c, test/data, test/lnum-data, test/lnum-diag.rb,
-	  test/test-lnum.rb, test/test-tracelines.rb: Trace just line
-	  numbers for now until we get a better handle on things.
-
-2008-01-24 13:36  Rocky Bernstein
-
-	* test/lnum-diag.rb, test/rcov-bug.rb, test/test-linecache.rb,
-	  test/test-tracelines.rb: Need recursion in more places because of
-	  block continuation nodes.
-	  Add nodes needed so we don't complain about rcov-bug.rb:
-	  NODE_MATCH3, NODE_LASN, and NODE_STR (and those similar to that).
-
-2008-01-24 04:09  Rocky Bernstein
-
-	* test/lnum-diag.rb: Fix bug if print_file == false
-
-2008-01-24 04:04  Rocky Bernstein
-
-	* ext/trace_nums.c, test/lnum-data/begin3.rb,
-	  test/lnum-data/end.rb, test/lnum-data/match.rb,
-	  test/lnum-data/not-lit.rb, test/lnum-diag.rb: Add more
-	  operatiors. Go over existing ones and add more tests of them.
-
-2008-01-23 19:17  Rocky Bernstein
-
-	* NEWS: What's up.
-
-2008-01-23 19:12  Rocky Bernstein
-
-	* test/lnum-diag.rb: Don't assume we have expected line numbers.
-
-2008-01-23 19:05  Rocky Bernstein
-
-	* test/lnum-diag.rb: A conversion-error bug.
-
-2008-01-23 19:04  Rocky Bernstein
-
-	* test/lnum-diag.rb: variable name typo.
-
-2008-01-23 19:03  Rocky Bernstein
-
-	* ext, ext/trace_nums.c, test/lnum-diag.rb, test/parse-show.rb:
-	  lnum-diag.rb and parse-show.rb - some diagnostic tools.
-
-2008-01-23 16:06  Rocky Bernstein
-
-	* ChangeLog, ext/trace_nums.c: Show add_lines level, nicer
-	  formatting including \n for end.
-
-2008-01-23 15:32  Rocky Bernstein
-
-	* test/test-lnum.rb: Generalized routine to test everything in
-	  lnum-data
-
-2008-01-23 12:07  Rocky Bernstein
-
-	* Rakefile, ext, ext/extconf.rb, ext/trace_nums.c,
-	  ext/trace_nums.h, lib/linecache.rb, lib/tracelines.rb,
-	  test/lnum-data, test/lnum-data/begin1.rb,
-	  test/lnum-data/begin2.rb, test/lnum-data/begin3.rb,
-	  test/test-tracelines.rb: ParseTree is broken for our purposes.
-	  Having custom code for getting
-	  the trace line numbers is going remove a lot of headaches down
-	  the line.
-
-2008-01-20 21:37  Rocky Bernstein
-
-	* Rakefile, lib/linecache.rb, test/test-linecache.rb: Add
-	  trace_line_numbers to save/get line numbers which we can set
-	  breakpoints
-	  on.
-
-2008-01-20 16:31  Rocky Bernstein
-
-	* ChangeLog, Rakefile, lib/linecache.rb, lib/tracelines.rb,
-	  test/rcov-bug.rb, test/test-tracelines.rb: Add module
-	  TraceLineNumbers for extracting the stoppable lines in a
-	  Ruby program.
-
-2008-01-19 15:55  Rocky Bernstein
-
-	* lib/linecache.rb, test/test-linecache.rb: Allow nil to mean the
-	  same file. More tests.
-
-2008-01-19 15:45  Rocky Bernstein
-
-	* lib/linecache.rb, test/test-linecache.rb: Start remap_file_lines:
-	  ability to remap file ranges.
-
-2008-01-17 22:25  Rocky Bernstein
-
-	* lib/linecache.rb, test/test-linecache.rb: lines -> size. Add
-	  empty? Add remap_file.
-
-2008-01-17 20:05  Rocky Bernstein
-
-	* lib/linecache.rb, test/test-linecache.rb: Add method to get the
-	  number of lines in a cached file.
-
-2008-01-17 19:42  Rocky Bernstein
-
-	* lib/linecache.rb, test/short-file, test/test-linecache.rb: Add
-	  convenience method for testing presence in SCRIPT_LINES__.
-
-2008-01-17 07:30  Rocky Bernstein
-
-	* lib/linecache.rb, test/test-linecache.rb: Add path method and
-	  test.
-
-2008-01-17 06:54  Rocky Bernstein
-
-	* VERSION, lib/linecache.rb, test/test-linecache.rb: Add
-	  @@full2file_cache_key. getlines wasn't returning the right value
-	  sometimes.
-	  Make return from checkcache meaningful. Change return value of
-	  upate_cache().
-	  test-linecache.rb: was testing for buggy behavior!
-	  VERSION: now in 0.3 - hope we get it right this time.
-
-2008-01-16 12:51  Rocky Bernstein
-
-	* lib/linecache.rb: Add cached_files.
-
-2008-01-16 01:30  Rocky Bernstein
-
-	* NEWS: Update news for 0.2 release.
-
-2008-01-15 22:43  Rocky Bernstein
-
-	* test/test-linecache.rb: Remove debug line.
-
-2008-01-15 22:42  Rocky Bernstein
-
-	* lib/linecache.rb: Fix some syntax errors.
-
-2008-01-15 22:40  Rocky Bernstein
-
-	* Rakefile, lib/linecache.rb, test/short-file,
-	  test/test-linecache.rb: Add routine to save and get SHA1.
-
-2008-01-15 22:16  Rocky Bernstein
-
-	* lib/linecache.rb, test/test-linecache.rb: Add cached? and stat
-	  methods to determine in a file is cached and get
-	  File.stat from it.
-
-2008-01-15 08:49  Rocky Bernstein
-
-	* lib/linecache.rb: Don't ever modify SCRIPT_LINES__. And until
-	  SCRIPT_LINES__ is fixed,
-	  don't read from it. Corrections to comments.
-
-2008-01-14 12:27  Rocky Bernstein
-
-	* ChangeLog, VERSION, lib/linecache.rb: Add parameter to getline
-	  and getlines to reload file on change. Add
-	  option on clear_file_cache to clear out SCRIPT_LINES__ as well.
-	  TESTS ARE NEEDED.
-	  Update to version 0.2.
-
-2008-01-14 03:41  Rocky Bernstein
-
-	* lib/linecache.rb: Use SCRIPT_LINES__ if we can.
-
-2007-12-10 16:24  Rocky Bernstein
-
-	* : release 0.1
-
-2007-12-09 17:47  Rocky Bernstein
-
-	* : Make Ruby 1.9 compatible.
-
-2007-12-09 17:17  Rocky Bernstein
-
-	* : Better tests mean more bugs found. "rake" defaults now to
-	  "test".
-
-2007-12-09 14:10  Rocky Bernstein
-
-	* : Add VERSION to gem.
-
-2007-12-09 14:09  Rocky Bernstein
-
-	* : Change classname to something more appropriate.
-
-2007-12-09 13:41  Rocky Bernstein
-
-	* : . : ignore doc and pkg
-	  Rakefile: clean now does clobber_rdoc and clobber_package, i.e.
-	  removes
-	  the doc and pkg directories.
-
-2007-12-09 13:15  Rocky Bernstein
-
-	* : NEWS, README, linecache.rb: Add $Id$ line
-	  test-linecache.rb: make executable
-	  Rakefile: Correct documentation
-
-2007-12-09 12:58  Rocky Bernstein
-
-	* : Initial import of LineCache, a module for reading and caching
-	  lines.
-	  This time to trunk.
-

data/NEWS

@@ -1,3 +1,8 @@
+0.45
+06-12-11
+- Support for syntax highlighting and caching eval strings. The former
+  is used in rb8-trepanning.
+
 0.43
 06-12-08
 - tolerance for finding windows extension in lib rather than ext.
@@ -26,4 +31,4 @@
 
 - Initial release of LineCache, a module for reading and caching lines.
 
-$Id: NEWS 144 2008-06-12 11:29:53Z rockyb $
+$Id: NEWS 265 2011-06-09 21:51:21Z rockyb $

data/README

@@ -1,4 +1,16 @@
-= LineCache - Module to read and cache lines of a file
+= LineCache - A module to read and cache file information of a Ruby program.
+
+== SYNOPSIS
+
+The LineCache module allows one to get any line from any file, caching
+the lines and file information on first access to the file. Although
+the file may be any file, the common use is when the file is a Ruby
+script since parsing of the file is done to figure out where the
+statement boundaries are.
+
+The routines here may be is useful when a small random sets of lines
+are read from a single file, in particular in a debugger to show
+source lines.
 
 == Summary
 
@@ -35,4 +47,4 @@ but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
-$Id: README 63 2008-03-04 22:47:26Z rockyb $
+$Id: README 169 2009-02-08 17:19:33Z rockyb $

data/Rakefile

@@ -5,12 +5,12 @@ require 'rake/gempackagetask'
 require 'rake/rdoctask'
 require 'rake/testtask'
 
-SO_NAME = "trace_nums.so"
+SO_NAME = 'trace_nums.so'
 
-# ------- Default Package ----------
-PKG_VERSION = open(File.join(File.dirname(__FILE__), 'VERSION')) do 
-  |f| f.readlines[0].chomp
-end
+ROOT_DIR = File.dirname(__FILE__)
+load File.join %W(#{ROOT_DIR} lib version.rb)
+
+PKG_VERSION = LineCache::VERSION
 PKG_NAME           = 'linecache'
 PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
 RUBY_FORGE_PROJECT = 'rocky-hacks'
@@ -23,7 +23,6 @@ FILES = FileList[
   'NEWS',
   'README',
   'Rakefile',
-  'VERSION',
   'ext/trace_nums.c',
   'ext/trace_nums.h',
   'ext/extconf.rb',
@@ -33,36 +32,38 @@ FILES = FileList[
   'test/short-file'
 ]                        
 
-desc "Test everything."
-test_task = task :test => :lib do 
-  Rake::TestTask.new(:test) do |t|
-    t.pattern = 'test/test-*.rb'
-    t.verbose = true
-  end
+desc 'Test everything'
+Rake::TestTask.new(:test) do |t|
+  t.libs << './lib'
+  t.pattern = 'test/test-*.rb'
+  t.options = '--verbose' if $VERBOSE
 end
+task :test => :lib
 
-desc "Create the core ruby-debug shared library extension"
+desc 'Create the core ruby-debug shared library extension'
 task :lib do
-  Dir.chdir("ext") do
+  Dir.chdir('ext') do
     system("#{Gem.ruby} extconf.rb && make")
   end
 end
 
 
-desc "Test everything - same as test."
+desc 'Test everything - same as test.'
 task :check => :test
 
-desc "Create a GNU-style ChangeLog via svn2cl"
+desc 'Create a GNU-style ChangeLog via svn2cl'
 task :ChangeLog do
-  system("svn2cl --authors=svn2cl_usermap")
+  system('svn2cl --authors=svn2cl_usermap')
 end
 
+gem_file = nil
+
 # Base GEM Specification
 default_spec = Gem::Specification.new do |spec|
-  spec.name = "linecache"
+  spec.name = 'linecache'
   
-  spec.homepage = "http://rubyforge.org/projects/rocky-hacks/linecache"
-  spec.summary = "Read file with caching"
+  spec.homepage = 'http://rubyforge.org/projects/rocky-hacks/linecache'
+  spec.summary = 'Read file with caching'
   spec.description = <<-EOF
 LineCache is a module for reading and caching lines. This may be useful for
 example in a debugger where the same lines are shown many times.
@@ -70,12 +71,12 @@ EOF
 
   spec.version = PKG_VERSION
 
-  spec.author = "R. Bernstein"
-  spec.email = "rockyb@rubyforge.net"
+  spec.author = 'R. Bernstein'
+  spec.email = 'rockyb@rubyforge.net'
   spec.platform = Gem::Platform::RUBY
-  spec.require_path = "lib"
+  spec.require_path = 'lib'
   spec.files = FILES.to_a  
-  spec.extensions = ["ext/extconf.rb"]
+  spec.extensions = ['ext/extconf.rb']
 
   spec.required_ruby_version = '>= 1.8.2'
   spec.date = Time.now
@@ -86,10 +87,12 @@ EOF
   spec.extra_rdoc_files = ['README', 'lib/linecache.rb', 'lib/tracelines.rb']
 
   spec.test_files = FileList['test/*.rb']
+  gem_file = "#{spec.name}-#{spec.version}.gem"
+
 end
 
 # Rake task to build the default package
-  Rake::GemPackageTask.new(default_spec) do |pkg|
+Rake::GemPackageTask.new(default_spec) do |pkg|
   pkg.need_tar = true
 end
 
@@ -102,12 +105,12 @@ win_spec.extensions = []
 win_spec.platform = 'mswin32'
 win_spec.files += ["lib/#{SO_NAME}"]
 
-desc "Create Windows Gem"
+desc 'Create Windows Gem'
 task :win32_gem do
   # Copy the win32 extension the top level directory.
   current_dir = File.expand_path(File.dirname(__FILE__))
-  source = File.join(current_dir, "ext", "win32", SO_NAME)
-  target = File.join(current_dir, "lib", SO_NAME)
+  source = File.join(current_dir, 'ext', 'win32', SO_NAME)
+  target = File.join(current_dir, 'lib', SO_NAME)
   cp(source, target)
 
   # Create the gem, then move it to pkg.
@@ -119,37 +122,45 @@ task :win32_gem do
   rm(target)
 end
 
-desc "Publish linecache to RubyForge."
+desc 'Publish linecache to RubyForge.'
 task :publish do 
   require 'rake/contrib/sshpublisher'
   
   # Get ruby-debug path.
   ruby_debug_path = File.expand_path(File.dirname(__FILE__))
 
-  publisher = Rake::SshDirPublisher.new("rockyb@rubyforge.org",
-        "/var/www/gforge-projects/rocky-hacks/linecache", ruby_debug_path)
+  publisher = Rake::SshDirPublisher.new('rockyb@rubyforge.org',
+        '/var/www/gforge-projects/rocky-hacks/linecache', ruby_debug_path)
+end
+
+desc 'Remove residue from running patch'
+task :rm_patch_residue do
+  FileUtils.rm_rf Dir.glob('**/*.{rej,orig}'), :verbose => true
 end
 
-desc "Remove built files"
-task :clean => [:clobber_package, :clobber_rdoc] do
-  cd "ext" do
-    if File.exists?("Makefile")
-      sh "make clean"
-      rm  "Makefile"
+desc 'Remove ~ backup files'
+task :rm_tilde_backups do
+  FileUtils.rm_rf Dir.glob('**/*~'), :verbose => true
+end
+
+desc 'Remove built files'
+task :clean => [:clobber_package, :clobber_rdoc, :rm_patch_residue, 
+                :rm_tilde_backups] do
+  cd 'ext' do
+    if File.exists?('Makefile')
+      sh 'make clean'
+      rm 'Makefile'
     end
-    derived_files = Dir.glob(".o") + Dir.glob("*.so")
+    derived_files = Dir.glob('.o') + Dir.glob('*.so')
     rm derived_files unless derived_files.empty?
   end
 end
 
 # ---------  RDoc Documentation ------
-desc "Generate rdoc documentation"
-Rake::RDocTask.new("rdoc") do |rdoc|
+desc 'Generate rdoc documentation'
+Rake::RDocTask.new('rdoc') do |rdoc|
   rdoc.rdoc_dir = 'doc'
-  rdoc.title    = "linecache"
-  # Show source inline with line numbers
-  rdoc.options << "--inline-source" << "--line-numbers"
-  # Make the readme file the start page for the generated html
+  rdoc.title    = "linecache #{LineCache::VERSION} Documentation"
   rdoc.options << '--main' << 'README'
   rdoc.rdoc_files.include('ext/**/*.c',
                           'lib/*.rb', 
@@ -157,10 +168,18 @@ Rake::RDocTask.new("rdoc") do |rdoc|
                           'COPYING')
 end
 
-desc "Publish the release files to RubyForge."
+desc 'Publish the release files to RubyForge.'
 task :rubyforge_upload do
   `rubyforge login`
   release_command = "rubyforge add_release #{PKG_NAME} #{PKG_NAME} '#{PKG_NAME}-#{PKG_VERSION}' pkg/#{PKG_NAME}-#{PKG_VERSION}.gem"
   puts release_command
   system(release_command)
 end
+
+desc 'Install the gem locally'
+task :install => :gem do
+  Dir.chdir(ROOT_DIR) do
+    sh %{gem install --local pkg/#{gem_file}}
+  end
+end
+

data/ext/trace_nums.c

@@ -34,15 +34,29 @@
 #include <ruby.h>
 #include <version.h>
 #include <node.h>
-#include <env.h>
 #include <rubysig.h>
 #include "trace_nums.h"
 
 VALUE mTraceLineNumbers;
-extern NODE *ruby_eval_tree_begin;
+RUBY_EXTERN NODE *ruby_eval_tree_begin;
+RUBY_EXTERN int ruby_in_eval;
 
 #define nd_3rd   u3.node
 
+extern struct FRAME {
+    VALUE self;
+    int argc;
+    ID last_func;
+    ID orig_func;
+    VALUE last_class;
+    struct FRAME *prev;
+    struct FRAME *tmp;
+    struct RNode *node;
+    int iter;
+    int flags;
+    unsigned long uniq;
+} *ruby_frame;
+
 struct METHOD {
   VALUE klass, rklass;
   VALUE recv;
@@ -87,7 +101,7 @@ struct BLOCK {
 #endif
 
 /* Used just in debugging. */
-static indent_level = 0;
+static int indent_level = 0;
 
 static
 void ln_eval(VALUE self, NODE * n, VALUE ary) {

data/ext/trace_nums.h

@@ -1,7 +1,7 @@
 /* Order is in C enum order. The below is correct for Ruby 1.8.6.
    Possibly others, but there may need some adjustment here.
   */
-char *NODE2NAME[] = 
+const char *NODE2NAME[] = 
   {
     "method",
     "fbody",

data/lib/linecache.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
-# $Id: linecache.rb 69 2008-03-09 23:24:25Z rockyb $
+# $Id: linecache.rb 266 2011-06-10 23:41:29Z rockyb $
 # 
-#   Copyright (C) 2007, 2008 Rocky Bernstein <rockyb@rubyforge.net>
+#   Copyright (C) 2007, 2008, 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 #
 #    This program is free software; you can redistribute it and/or modify
 #    it under the terms of the GNU General Public License as published by
@@ -22,16 +22,20 @@
 # Author::    Rocky Bernstein  (mailto:rockyb@rubyforge.net)
 #
 # = linecache
-# Module to read and cache lines of a file
-# == Version
-# :include:VERSION
+# A module to read and cache lines of a Ruby program. 
 
 # == SYNOPSIS
 #
 # The LineCache module allows one to get any line from any file,
-# caching lines of the file on first access to the file. The may be is
-# useful when a small random sets of lines are read from a single
-# file, in particular in a debugger to show source lines.
+# caching lines of the file on first access to the file. Although the 
+# file may be any file, the common use is when the file is a Ruby
+# script since parsing of the file is done to figure out where the
+# statement boundaries are.
+#
+# The routines here may be is useful when a small random sets of lines
+# are read from a single file, in particular in a debugger to show
+# source lines.
+#
 #
 #  require 'linecache'
 #  lines = LineCache::getlines('/tmp/myruby.rb')
@@ -43,7 +47,6 @@
 #  # Note lines[6] == line (if /tmp/myruby.rb has 6 lines)
 #
 #  LineCache::clear_file_cache
-#  LineCache::clear_file_cache('/tmp/myruby.rb')
 #  LineCache::update_cache   # Check for modifications of all cached files.
 #
 # Some parts of the interface is derived from the Python module of the
@@ -60,11 +63,13 @@ require 'digest/sha1'
 require 'set'
 
 begin require 'rubygems' rescue LoadError end
-require 'tracelines'
+require 'require_relative'
+require_relative 'tracelines'
+require_relative 'version'
 # require 'ruby-debug' ; Debugger.start
 
 # = module LineCache
-# Module caching lines of a file
+# A module to read and cache lines of a Ruby program. 
 module LineCache
   LineCacheInfo = Struct.new(:stat, :line_numbers, :lines, :path, :sha1) unless
     defined?(LineCacheInfo)
@@ -72,6 +77,11 @@ module LineCache
   # The file cache. The key is a name as would be given by Ruby for 
   # __FILE__. The value is a LineCacheInfo object. 
   @@file_cache = {} 
+  @@script_cache = {} 
+
+
+  # Used for CodeRay syntax highlighting
+  @@ruby_highlighter = nil
   
   # Maps a string filename (a String) to a key in @@file_cache (a
   # String).
@@ -87,28 +97,80 @@ module LineCache
   # ranges. Will probably use this for that, but I'm not sure.
   @@file2file_remap = {} 
   @@file2file_remap_lines = {}
+  @@script2file = {} 
+
+  module_function
+
+  def remove_script_temps
+    @@script2file.values.each do |filename|
+      File.unlink(filename) if File.exist?(filename)
+    end
+  end
+  at_exit { remove_script_temps }
+
   
   # Clear the file cache entirely.
-  def clear_file_cache()
-    @@file_cache = {}
-    @@file2file_remap = {}
-    @@file2file_remap_lines = {}
+  def clear_file_cache(filename=nil)
+    if filename 
+      if @@file_cache[filename]
+        @@file_cache.delete(filename)
+      end
+    else
+      @@file_cache = {}
+      @@file2file_remap = {}
+      @@file2file_remap_lines = {}
+    end
+  end
+
+  # Remove syntax-formatted lines in the cache. Use this
+  # when you change the CodeRay syntax or Token formatting
+  # and want to redo how files may have previously been 
+  # syntax marked.
+  def clear_file_format_cache
+    @@file_cache.each_pair do |fname, cache_info|
+      cache_info.lines.each_pair do |format, lines|
+        next if :plain == format
+        @@file_cache[fname].lines[format] = nil
+      end
+    end
+  end
+
+  # Remove syntax-formatted lines in the cache. Use this
+  # when you change the CodeRay syntax or Token formatting
+  # and want to redo how files may have previously been 
+  # syntax marked.
+  def clear_file_format_cache
+    @@file_cache.each_pair do |fname, cache_info|
+      cache_info.lines.each_pair do |format, lines|
+        next if :plain == format
+        @@file_cache[fname].lines[format] = nil
+      end
+    end
+  end
+
+  # Clear the script cache entirely.
+  def clear_script_cache()
+    @@script_cache = {}
   end
-  module_function :clear_file_cache
 
   # Return an array of cached file names
   def cached_files()
     @@file_cache.keys
   end
-  module_function :cached_files
 
   # Discard cache entries that are out of date. If +filename+ is +nil+
   # all entries in the file cache +@@file_cache+ are checked.
-  # If we don't have stat information about a file which can happen
+  # If we don't have stat information about a file, which can happen
   # if the file was read from __SCRIPT_LINES but no corresponding file
   # is found, it will be kept. Return a list of invalidated filenames.
   # nil is returned if a filename was given but not found cached.
-  def checkcache(filename=nil, use_script_lines=false)
+  def checkcache(filename=nil, opts=false)
+    use_script_lines = 
+      if opts.kind_of?(Hash)
+        opts[:use_script_lines]
+      else
+        opts
+      end
     
     if !filename
       filenames = @@file_cache.keys()
@@ -123,19 +185,60 @@ module LineCache
       next unless @@file_cache.member?(filename)
       path = @@file_cache[filename].path
       if File.exist?(path)
-        cache_info = @@file_cache[filename]
+        cache_info = @@file_cache[filename].stat
         stat = File.stat(path)
-        if stat && 
-            (cache_info.size != stat.size or cache_info.mtime != stat.mtime)
+        if cache_info
+          if stat && 
+              (cache_info.size != stat.size or cache_info.mtime != stat.mtime)
+            result << filename
+            update_cache(filename, opts)
+          end
+        else
           result << filename
-          update_cache(filename, use_script_lines)
+          update_cache(filename, opts)
         end
       end
     end
     return result
   end
-  module_function :checkcache
+
+  # Cache script if it's not already cached.
+  def cache_script(script, opts={})
+    if !@@script_cache.member?(script)
+      update_script_cache(script, opts)
+    end
+    script
+  end
+
+  # Cache file name or script object if it's not already cached.
+  # Return the expanded filename for it in the cache if a filename,
+  # or the script, or nil if we can't find the file.
+  def cache(file_or_script, reload_on_change=false)
+    if file_or_script.kind_of?(String)
+      cache_file(file_or_script, reload_on_change)
+    else
+      cache_script(file_or_script)
+    end
+  end
 
+  # Cache filename if it's not already cached.
+  # Return the expanded filename for it in the cache
+  # or nil if we can't find the file.
+  def cache_file(filename, reload_on_change=false, opts={})
+    if @@file_cache.member?(filename)
+      checkcache(filename) if reload_on_change
+    else
+      opts[:use_script_lines] = true
+      update_cache(filename, opts)
+    end
+    if @@file_cache.member?(filename)
+      @@file_cache[filename].path
+    else
+      nil
+    end
+  end
+
+  # Older routine - for compability.
   # Cache filename if it's not already cached.
   # Return the expanded filename for it in the cache
   # or nil if we can't find the file.
@@ -151,80 +254,116 @@ module LineCache
       nil
     end
   end
-  module_function :cache
       
-  # Return true if filename is cached
-  def cached?(filename)
-    @@file_cache.member?(unmap_file(filename))
+  # Return true if file_or_script is cached
+  def cached?(file_or_script)
+    if file_or_script.kind_of?(String) 
+      @@file_cache.member?(unmap_file(file_or_script))
+    else 
+      cached_script?(file_or_script)
+    end
   end
-  module_function :cached?
 
   def cached_script?(filename)
     SCRIPT_LINES__.member?(unmap_file(filename))
   end
-  module_function :cached_script?
       
   def empty?(filename)
     filename=unmap_file(filename)
-    @@file_cache[filename].lines.empty?
+    !!@@file_cache[filename].lines[:plain]
   end
-  module_function :empty?
 
   # Get line +line_number+ from file named +filename+. Return nil if
   # there was a problem. If a file named filename is not found, the
-  # function will look for it in the $: path array.
+  # function will look for it in the $: array.
   # 
   # Examples:
   # 
-  #  lines = LineCache::getline('/tmp/myfile.rb)
+  #  lines = LineCache::getline('/tmp/myfile.rb')
   #  # Same as above
   #  $: << '/tmp'
-  #  lines = Dir.chdir('/tmp') do 
-  #     lines = LineCache::getlines ('myfile.rb')
-  #  end
+  #  lines = LineCache.getlines('myfile.rb')
   #
-  def getline(filename, line_number, reload_on_change=true)
-    filename = unmap_file(filename)
-    filename, line_number = unmap_file_line(filename, line_number)
-    lines = getlines(filename, reload_on_change)
+  def getline(file_or_script, line_number, opts=true)
+    reload_on_change = 
+      if opts.kind_of?(Hash)
+        opts[:reload_on_change]
+      else
+        opts
+      end
+    lines = 
+      if file_or_script.kind_of?(String)
+        filename = unmap_file(file_or_script)
+        filename, line_number = unmap_file_line(filename, line_number)
+        getlines(filename, opts)
+      else
+        script_getlines(file_or_script)
+      end
     if lines and (1..lines.size) === line_number
         return lines[line_number-1]
     else
         return nil
     end
   end
-  module_function :getline
 
   # Read lines of +filename+ and cache the results. However +filename+ was
   # previously cached use the results from the cache. Return nil
   # if we can't get lines
-  def getlines(filename, reload_on_change=false)
-    filename = unmap_file(filename)
+  def getlines(filename, opts=false)
+    if opts.kind_of?(Hash)
+      reload_on_change, use_script_lines = 
+        [opts[:reload_on_change], opts[:use_script_lines]]
+    else
+      reload_on_change, use_script_lines = [opts, false]
+      opts = {:reload_on_change => reload_on_change}
+    end
     checkcache(filename) if reload_on_change
+    format = opts[:output] || :plain
     if @@file_cache.member?(filename)
-      return @@file_cache[filename].lines
+      lines = @@file_cache[filename].lines
+      if opts[:output] && !lines[format]
+        lines[format] = 
+          highlight_string(lines[:plain].join(''), format).split(/\n/)
+      end
+      return lines[format]
     else
-      update_cache(filename, true)
-      return @@file_cache[filename].lines if @@file_cache.member?(filename)
+      opts[:use_script_lines] = true
+      update_cache(filename, opts)
+      if @@file_cache.member?(filename)
+        return @@file_cache[filename].lines[format]
+      else
+        return nil
+      end
     end
   end
-  module_function :getlines
+
+  def highlight_string(string, output_type)
+    require 'rubygems'
+    begin
+      require 'coderay'
+      require 'term/ansicolor'
+    rescue LoadError
+      return string
+    end
+    @@ruby_highlighter ||= CodeRay::Duo[:ruby, output_type]
+    @@ruby_highlighter.encode(string)
+  end
 
   # Return full filename path for filename
   def path(filename)
+    return unless filename.kind_of?(String)
     filename = unmap_file(filename)
     return nil unless @@file_cache.member?(filename)
     @@file_cache[filename].path
   end
-  module_function :path
 
   def remap_file(from_file, to_file)
-    @@file2file_remap[to_file] = from_file
+    @@file2file_remap[from_file] = to_file
+    cache_file(to_file)
   end
-  module_function :remap_file
 
   def remap_file_lines(from_file, to_file, range, start)
-    range = (range..range) if range.is_a?(Fixnum)
+    range = (range..range) if range.kind_of?(Fixnum)
     to_file = from_file unless to_file
     if @@file2file_remap_lines[to_file] 
       # FIXME: need to check for overwriting ranges: whether
@@ -243,21 +382,25 @@ module LineCache
     return @@file_cache[filename].sha1.hexdigest if 
       @@file_cache[filename].sha1
     sha1 = Digest::SHA1.new
-    @@file_cache[filename].lines.each do |line|
-      sha1 << line
+    @@file_cache[filename].lines[:plain].each do |line|
+      sha1 << line + "\n"
     end
     @@file_cache[filename].sha1 = sha1
     sha1.hexdigest
   end
-  module_function :sha1
       
   # Return the number of lines in filename
-  def size(filename)
-    filename = unmap_file(filename)
-    return nil unless @@file_cache.member?(filename)
-    @@file_cache[filename].lines.length
+  def size(file_or_script)
+    cache(file_or_script)
+    if file_or_script.kind_of?(String)
+      file_or_script = unmap_file(file_or_script)
+      return nil unless @@file_cache.member?(file_or_script)
+      @@file_cache[file_or_script].lines[:plain].length
+    else
+      return nil unless @@script_cache.member?(file_or_script)
+      @@script_cache[file_or_script].lines[:plain].length
+    end
   end
-  module_function :size
 
   # Return File.stat in the cache for filename.
   def stat(filename)
@@ -276,17 +419,16 @@ module LineCache
     e = @@file_cache[filename]
     unless e.line_numbers
       e.line_numbers = 
-        TraceLineNumbers.lnums_for_str_array(e.lines)
+        TraceLineNumbers.lnums_for_str_array(e.lines[:plain])
       e.line_numbers = false unless e.line_numbers
     end
     e.line_numbers
   end
-  module_function :trace_line_numbers
     
   def unmap_file(file)
     @@file2file_remap[file] ? @@file2file_remap[file] : file
   end
-  module_function :unmap_file
+  alias :map_file :unmap_file
 
   def unmap_file_line(file, line)
     if @@file2file_remap_lines[file]
@@ -299,13 +441,32 @@ module LineCache
     end
     return [file, line]
   end
-  module_function :unmap_file_line
+
+  # Update a cache entry.  If something is wrong, return nil. Return
+  # true if the cache was updated and false if not. 
+  def update_script_cache(script, opts)
+    # return false unless script_is_eval?(script)
+    # string = opts[:string] || script.eval_source
+    lines = {:plain => string.split(/\n/)}
+    lines[opts[:output]] = highlight_string(string, opts[:output]) if
+      opts[:output]
+    @@script_cache[script] = 
+      LineCacheInfo.new(nil, nil, lines, nil, opts[:sha1], 
+                        opts[:compiled_method])
+    return true
+  end
 
   # Update a cache entry.  If something's
   # wrong, return nil. Return true if the cache was updated and false
   # if not.  If use_script_lines is true, use that as the source for the
   # lines of the file
-  def update_cache(filename, use_script_lines=false)
+  def update_cache(filename, opts=false)
+      if opts.kind_of?(Hash)
+        use_script_lines = opts[:use_script_lines]
+      else
+        use_script_lines = opts
+        opts = {:use_script_lines => use_script_lines}
+      end
 
     return nil unless filename
 
@@ -322,7 +483,11 @@ module LineCache
           rescue
             stat = nil
           end
-          lines = SCRIPT_LINES__[name]
+          raw_lines = SCRIPT_LINES__[name]
+          lines = {:plain => raw_lines}
+          lines[opts[:output]] =
+            highlight_string(raw_lines.join, opts[:output]).split(/\n/) if 
+            opts[:output]
           @@file_cache[filename] = LineCacheInfo.new(stat, nil, lines, path, nil)
           @@file2file_remap[path] = filename
           return true
@@ -346,8 +511,13 @@ module LineCache
     end
     begin
       fp = File.open(path, 'r')
-      lines = fp.readlines()
+      raw_string = fp.read
+      fp.rewind
+      lines = {:plain => fp.readlines}
       fp.close()
+      lines[opts[:output]] = 
+        highlight_string(raw_string, opts[:output]).split(/\n/) if 
+        opts[:output]
     rescue 
       ##  print '*** cannot open', path, ':', msg
       return nil
@@ -358,8 +528,6 @@ module LineCache
     return true
   end
 
-  module_function :update_cache
-
 end
 
 # example usage

data/lib/version.rb

@@ -0,0 +1,3 @@
+module LineCache
+  VERSION = '0.45'
+end

data/test/test-linecache.rb

@@ -127,7 +127,7 @@ class TestLineCache < Test::Unit::TestCase
 
   def test_path
     assert_equal(nil, LineCache::path(__FILE__),
-                 "path for #{__FILE__} shouldn't be nil - just cleared cache.")
+                 "path for #{__FILE__} should be nil - just cleared cache.")
     path = LineCache::cache(__FILE__)
     assert path
     assert_equal(path, LineCache::path(__FILE__),
@@ -144,7 +144,7 @@ class TestLineCache < Test::Unit::TestCase
   def test_sha1
     test_file = File.join(@@TEST_DIR, 'short-file') 
     LineCache::cache(test_file)
-    assert_equal('1134f95ea84a3dcc67d7d1bf41390ee1a03af6d2',
+    assert_equal('3e1d87f3399fc73ae5683e106bce1b5ba823fc50',
                  LineCache::sha1(test_file))
   end
 

metadata

@@ -1,33 +1,36 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: linecache
 version: !ruby/object:Gem::Version 
-  version: "0.43"
-date: 2008-06-12 00:00:00 -04:00
-summary: Read file with caching
-require_paths: 
-- lib
-email: rockyb@rubyforge.net
-homepage: http://rubyforge.org/projects/rocky-hacks/linecache
-rubyforge_project: rocky-hacks
-description: LineCache is a module for reading and caching lines. This may be useful for example in a debugger where the same lines are shown many times.
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: 1.8.2
-  version: 
+  hash: 81
+  prerelease: 
+  segments: 
+  - 0
+  - 45
+  version: "0.45"
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - R. Bernstein
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-11 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: |
+  LineCache is a module for reading and caching lines. This may be useful for
+  example in a debugger where the same lines are shown many times.
+
+email: rockyb@rubyforge.net
+executables: []
+
+extensions: 
+- ext/extconf.rb
+extra_rdoc_files: 
+- README
+- lib/linecache.rb
+- lib/tracelines.rb
 files: 
 - AUTHORS
 - COPYING
@@ -35,64 +38,86 @@ files:
 - NEWS
 - README
 - Rakefile
-- VERSION
 - ext/trace_nums.c
 - ext/trace_nums.h
 - ext/extconf.rb
+- lib/version.rb
 - lib/tracelines.rb
 - lib/linecache.rb
+- test/parse-show.rb
+- test/lnum-diag.rb
 - test/rcov-bug.rb
-- test/test-tracelines.rb
 - test/test-lnum.rb
 - test/test-linecache.rb
-- test/parse-show.rb
-- test/lnum-diag.rb
-- test/data/for1.rb
-- test/data/if6.rb
+- test/test-tracelines.rb
+- test/data/if1.rb
 - test/data/comments1.rb
-- test/data/if3.rb
-- test/data/if5.rb
-- test/data/begin3.rb
-- test/data/end.rb
-- test/data/case1.rb
-- test/data/match.rb
-- test/data/begin2.rb
-- test/data/match3.rb
-- test/data/case5.rb
 - test/data/not-lit.rb
-- test/data/match3a.rb
-- test/data/if7.rb
-- test/data/if4.rb
-- test/data/case2.rb
+- test/data/begin2.rb
 - test/data/block2.rb
+- test/data/if6.rb
+- test/data/end.rb
+- test/data/case4.rb
 - test/data/begin1.rb
-- test/data/def1.rb
-- test/data/if1.rb
+- test/data/for1.rb
+- test/data/match.rb
+- test/data/match3a.rb
 - test/data/class1.rb
-- test/data/if2.rb
+- test/data/if3.rb
+- test/data/if5.rb
+- test/data/case1.rb
+- test/data/def1.rb
+- test/data/if7.rb
 - test/data/block1.rb
+- test/data/begin3.rb
 - test/data/case3.rb
+- test/data/case2.rb
 - test/data/each1.rb
-- test/data/case4.rb
+- test/data/if2.rb
+- test/data/match3.rb
+- test/data/if4.rb
+- test/data/case5.rb
 - test/short-file
-test_files: 
-- test/rcov-bug.rb
-- test/test-tracelines.rb
-- test/test-lnum.rb
-- test/test-linecache.rb
-- test/parse-show.rb
-- test/lnum-diag.rb
-rdoc_options: []
+has_rdoc: true
+homepage: http://rubyforge.org/projects/rocky-hacks/linecache
+licenses: []
 
-extra_rdoc_files: 
-- README
-- lib/linecache.rb
-- lib/tracelines.rb
-executables: []
+post_install_message: 
+rdoc_options: []
 
-extensions: 
-- ext/extconf.rb
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 51
+      segments: 
+      - 1
+      - 8
+      - 2
+      version: 1.8.2
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
 
-dependencies: []
-
+rubyforge_project: rocky-hacks
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: Read file with caching
+test_files: 
+- test/parse-show.rb
+- test/lnum-diag.rb
+- test/rcov-bug.rb
+- test/test-lnum.rb
+- test/test-linecache.rb
+- test/test-tracelines.rb

data/VERSION

@@ -1 +0,0 @@
-0.43