Module: LineCache

Defined in:
lib/linecache.rb

Overview

module LineCache

A module to read and cache lines of a Ruby program.

Defined Under Namespace

Classes: LineCacheInfo

Constant Summary collapse

VERSION = 
'1.2'
@@file_cache =

The file cache. The key is a name as would be given by Ruby for __FILE__. The value is a LineCacheInfo object.

{}
@@iseq_cache = 
{}
@@ruby_highlighter =

Used for CodeRay syntax highlighting

nil
@@file2file_remap =

Maps a string filename (a String) to a key in @@file_cache (a String).

One important use of @@file2file_remap is mapping the a full path of a file into the name stored in @@file_cache or given by Ruby’s __FILE__. Applications such as those that get input from users, may want canonicalize a file name before looking it up. This map gives a way to do that.

Another related use is when a template system is used. Here we’ll probably want to remap not only the file name but also line ranges. Will probably use this for that, but I’m not sure.

{}
@@file2file_remap_lines = 
{}
@@iseq2file = 
{}

Class Method Summary collapse

Class Method Details

.cache(file_or_iseq, reload_on_change = false) ⇒ Object

Cache file name or iseq object if it’s not already cached. Return the expanded filename for it in the cache if a filename, or the iseq, or nil if we can’t find the file.



198
199
200
201
202
203
204
 
# File 'lib/linecache.rb', line 198

def cache(file_or_iseq, reload_on_change=false)
  if file_or_iseq.kind_of?(String)
    cache_file(file_or_iseq, reload_on_change)
  else
    cache_iseq(file_or_iseq)
  end
end

.cache_file(filename, reload_on_change = false, opts = {}) ⇒ Object

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.



210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/linecache.rb', line 210

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

.cache_iseq(iseq, opts = {}) ⇒ Object

Cache iseq if it’s not already cached.



188
189
190
191
192
193
 
# File 'lib/linecache.rb', line 188

def cache_iseq(iseq, opts={})
  if !@@iseq_cache.member?(iseq)
    update_iseq_cache(iseq, opts)
  end
  iseq
end

.cached?(file_or_iseq) ⇒ Object

Return true if file_or_iseq is cached



225
226
227
228
229
230
231
 
# File 'lib/linecache.rb', line 225

def cached?(file_or_iseq)
  if file_or_iseq.kind_of?(String)
    @@file_cache.member?(map_file(file_or_iseq))
  else
    cached_iseq?(file_or_iseq)
  end
end

.cached_files ⇒ Object

Return an array of cached file names



145
146
147
 
# File 'lib/linecache.rb', line 145

def cached_files()
  @@file_cache.keys
end

.cached_script?(filename) ⇒ Object 



234
235
236
 
# File 'lib/linecache.rb', line 234

def cached_script?(filename)
  SCRIPT_LINES__.member?(map_file(filename))
end

.checkcache(filename = nil, opts = {}) ⇒ Object

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 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.



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/linecache.rb', line 155

def checkcache(filename=nil, opts={})

  if !filename
    filenames = @@file_cache.keys()
  elsif @@file_cache.member?(filename)
    filenames = [filename]
  else
    return nil
  end

  result = []
  for filename in filenames
    next unless @@file_cache.member?(filename)
    path = @@file_cache[filename].path
    if File.exist?(path)
      cache_info = @@file_cache[filename].stat
      stat = File.stat(path)
      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, opts)
      end
    end
  end
  return result
end

.clear_file_cache(filename = nil) ⇒ Object

Clear the file cache entirely.



126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/linecache.rb', line 126

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

.clear_file_format_cache ⇒ Object

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.



116
117
118
119
120
121
122
123
 
# File 'lib/linecache.rb', line 116

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_iseq_cache ⇒ Object

Clear the iseq cache entirely.



139
140
141
 
# File 'lib/linecache.rb', line 139

def clear_iseq_cache()
  @@iseq_cache = {}
end

.empty?(filename) ⇒ Object 



239
240
241
242
 
# File 'lib/linecache.rb', line 239

def empty?(filename)
  filename=map_file(filename)
  @@file_cache[filename].lines.empty?
end

.getline(file_or_iseq, line_number, opts = {}) ⇒ Object

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 $: array.

Examples:

lines = LineCache::getline('/tmp/myfile.rb')
# Same as above
$: << '/tmp'
lines = LineCache.getlines('myfile.rb')



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/linecache.rb', line 256

def getline(file_or_iseq, line_number, opts={})
  lines =
    if file_or_iseq.kind_of?(String)
      filename = map_file(file_or_iseq)
      filename, line_number = map_file_line(filename, line_number)
      getlines(filename, opts)
    else
      iseq_getlines(file_or_iseq)
    end
  if lines and (1..lines.size) === line_number
      return lines[line_number-1]
  else
      return nil
  end
end

.getlines(filename, opts = {}) ⇒ Object

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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/linecache.rb', line 300

def getlines(filename, opts={})
  filename = map_file(filename)
  checkcache(filename) if opts[:reload_on_change]
  format = opts[:output] || :plain
  if @@file_cache.member?(filename)
    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
    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

.highlight_string(string, output_type) ⇒ Object 



322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/linecache.rb', line 322

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

.iseq_getlines(iseq, opts = {}) ⇒ Object

Read lines of iseq and cache the results. However iseq was previously cached use the results from the cache. Return nil if we can’t get lines



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/linecache.rb', line 275

def iseq_getlines(iseq, opts={})
  return nil unless iseq.kind_of? RubyVM::InstructionSequence
  format = opts[:output] || :plain
  line_formats =
    if @@iseq_cache.member?(iseq)
      @@iseq_cache[iseq].lines
    else
      update_iseq_cache(iseq, opts)
      if @@iseq_cache.member?(iseq)
        @@iseq_cache[iseq].lines
      else
        nil
      end
    end
  return nil unless line_formats
  if format != :plain && !line_formats[format]
    highlight_string(line_formats[:plain].join('')).split(/\n/)
  else
    line_formats[format]
  end
end

.iseq_is_eval?(iseq) ⇒ Object 



443
444
445
 
# File 'lib/linecache.rb', line 443

def iseq_is_eval?(iseq)
  !!iseq.eval_source
end

.map_file(file) ⇒ Object 



409
410
411
 
# File 'lib/linecache.rb', line 409

def map_file(file)
  @@file2file_remap[file] ? @@file2file_remap[file] : file
end

.map_file_line(file, line) ⇒ Object 



430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/linecache.rb', line 430

def map_file_line(file, line)
  if @@file2file_remap_lines[file]
    @@file2file_remap_lines[file].each do |from_file, range, start|
      if range === line
        from_file = from_file || file
        return [from_file, start+line-range.begin]
      end
    end
  end
  return [map_file(file), line]
end

.map_iseq(iseq) ⇒ Object 



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/linecache.rb', line 413

def map_iseq(iseq)
  if @@iseq2file[iseq]
    @@iseq2file[iseq]
  else
    # Doc says there's new takes an optional string parameter
    # But it doesn't work for me
    sha1 = Digest::SHA1.new
    string = iseq.eval_source
    sha1 << iseq.eval_source
    tempfile = Tempfile.new(["eval-#{sha1.hexdigest[0...7]}-", '.rb'])
    tempfile.open.puts(string)
    tempfile.close
    @@iseq2file[iseq] = tempfile.path
    tempfile.path
  end
end

.path(filename) ⇒ Object

Return full filename path for filename



335
336
337
338
339
340
 
# File 'lib/linecache.rb', line 335

def path(filename)
  return unless filename.kind_of?(String)
  filename = map_file(filename)
  return nil unless @@file_cache.member?(filename)
  @@file_cache[filename].path
end

.remap_file(to_file, from_file) ⇒ Object 



342
343
344
 
# File 'lib/linecache.rb', line 342

def remap_file(to_file, from_file)
  @@file2file_remap[to_file] = from_file
end

.remap_file_lines(from_file, to_file, range, start) ⇒ Object 



346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/linecache.rb', line 346

def remap_file_lines(from_file, to_file, range, start)
  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
    # they intersect or one encompasses another.
    @@file2file_remap_lines[to_file] << [from_file, range, start]
  else
    @@file2file_remap_lines[to_file]  = [[from_file, range, start]]
  end
end

.remove_iseq_temps ⇒ Object 



104
105
106
107
108
 
# File 'lib/linecache.rb', line 104

def remove_iseq_temps
  @@iseq2file.values.each do |filename|
    File.unlink(filename) if File.exist?(filename)
  end
end

.sha1(filename) ⇒ Object

Return SHA1 of filename.



359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/linecache.rb', line 359

def sha1(filename)
  filename = map_file(filename)
  return nil unless @@file_cache.member?(filename)
  return @@file_cache[filename].sha1.hexdigest if
    @@file_cache[filename].sha1
  sha1 = Digest::SHA1.new
  @@file_cache[filename].lines[:plain].each do |line|
    sha1 << line + "\n"
  end
  @@file_cache[filename].sha1 = sha1
  sha1.hexdigest
end

.size(file_or_iseq) ⇒ Object

Return the number of lines in filename



373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/linecache.rb', line 373

def size(file_or_iseq)
  cache(file_or_iseq)
  if file_or_iseq.kind_of?(String)
    file_or_iseq = map_file(file_or_iseq)
    return nil unless @@file_cache.member?(file_or_iseq)
    @@file_cache[file_or_iseq].lines[:plain].length
  else
    return nil unless @@iseq_cache.member?(file_or_iseq)
    @@iseq_cache[file_or_iseq].lines.length
    @@script_cache[file_or_iseq].lines[:plain].length
  end
end

.stat(filename) ⇒ Object

Return File.stat in the cache for filename.



387
388
389
390
 
# File 'lib/linecache.rb', line 387

def stat(filename)
  return nil unless @@file_cache.member?(filename)
  @@file_cache[filename].stat
end

.trace_line_numbers(filename, reload_on_change = false) ⇒ Object

Return an Array of breakpoints in filename. The list will contain an entry for each distinct line event call so it is possible (and possibly useful) for a line number appear more than once.



397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/linecache.rb', line 397

def trace_line_numbers(filename, reload_on_change=false)
  fullname = cache(filename, reload_on_change)
  return nil unless fullname
  e = @@file_cache[filename]
  unless e.line_numbers
    e.line_numbers =
      TraceLineNumbers.lnums_for_str_array(e.lines[:plain])
    e.line_numbers = false unless e.line_numbers
  end
  e.line_numbers
end

.update_cache(filename, opts = {}) ⇒ Object

Update a cache entry. If something’s wrong, return nil. Return true if the cache was updated and false if not. If opts is true, use that as the source for the lines of the file



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/linecache.rb', line 465

def update_cache(filename, opts={})

  return nil unless filename

  @@file_cache.delete(filename)
  path = File.expand_path(filename)

  if File.exist?(path)
    stat = File.stat(path)
  elsif File.basename(filename) == filename
    # try looking through the search path.
    stat = nil
    for dirname in $:
      path = File.join(dirname, filename)
      if File.exist?(path)
          stat = File.stat(path)
          break
      end
    end
    return false unless stat
  end
  begin
    fp = File.open(path, 'r')
    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
  end
  @@file_cache[filename] = LineCacheInfo.new(File.stat(path), nil, lines,
                                             path, nil)
  @@file2file_remap[path] = filename
  return true
end

.update_iseq_cache(iseq, opts) ⇒ Object

Update a cache entry. If something is wrong, return nil. Return true if the cache was updated and false if not.



450
451
452
453
454
455
456
457
458
459
 
# File 'lib/linecache.rb', line 450

def update_iseq_cache(iseq, opts)
  return false unless iseq_is_eval?(iseq)
  string = opts[:string] || iseq.eval_source
  lines = {:plain => string.split(/\n/)}
  lines[opts[:output]] = highlight_string(string, opts[:output]) if
    opts[:output]
  @@iseq_cache[iseq] =
    LineCacheInfo.new(nil, nil, lines, nil, opts[:sha1])
  return true
end