Project

linecache2

0.0
No release in over 3 years
Low commit activity in last 3 years
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. This version works only with a Ruby 2.0 or greater.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.7
 Project Readme

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, and we also cache syntax formatting.

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.

Example:

    require 'linecache'
    lines = LineCache::getlines('/tmp/myruby.rb')
    # The following lines have same effect as the above.
    $: << '/tmp'
    Dir.chdir('/tmp') {lines = LineCache::getlines('myruby.rb')

    line = LineCache::getline('/tmp/myruby.rb', 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.

This code is for Ruby version 2 and greater.