Module: IRB::Color
Relationships & Source Files | |
Namespace Children | |
Classes:
| |
Defined in: | lib/irb/color.rb |
Constant Summary
-
ALL =
private
A constant of all-bit 1 to match any Ripper’s state in
#dispatch_seq
-1
-
BLUE =
# File 'lib/irb/color.rb', line 1534
-
BOLD =
# File 'lib/irb/color.rb', line 91
-
CLEAR =
# File 'lib/irb/color.rb', line 80
-
CYAN =
# File 'lib/irb/color.rb', line 1736
-
ERROR_TOKENS =
private
# File 'lib/irb/color.rb', line 75TOKEN_SEQ_EXPRS.keys.select { |k| k.to_s.end_with?('error') }
-
GREEN =
# File 'lib/irb/color.rb', line 1332
-
MAGENTA =
# File 'lib/irb/color.rb', line 1635
-
RED =
# File 'lib/irb/color.rb', line 1231
-
REVERSE =
# File 'lib/irb/color.rb', line 117
-
TOKEN_KEYWORDS =
private
# File 'lib/irb/color.rb', line 19{ on_kw: ['nil', 'self', 'true', 'false', '__FILE__', '__LINE__', '__ENCODING__'], on_const: ['ENV'], }
-
UNDERLINE =
# File 'lib/irb/color.rb', line 104
-
YELLOW =
# File 'lib/irb/color.rb', line 1433
Class Attribute Summary
- .colorable? ⇒ Boolean readonly
Class Method Summary
- .clear(colorable: colorable?) )
- .colorize(text, seq, colorable: colorable?) )
-
.colorize_code(code, complete: true, ignore_error: false, colorable: colorable?, , local_variables: [])
If
complete
is false (code is incomplete), this does not warn compile_error. - .inspect_colorable?(obj, seen: {}.compare_by_identity) ⇒ Boolean
- .dispatch_seq(token, expr, str, in_symbol:) private
- .scan(code, allow_last_error:) private
- .without_circular_ref(obj, seen:, &block) private
Class Attribute Details
.colorable? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/irb/color.rb', line 79
def colorable? supported = $stdout.tty? && (/mswin|mingw/ =~ RUBY_PLATFORM || (ENV.key?('TERM') && ENV['TERM'] != 'dumb')) # because ruby/debug also uses irb's color module selectively, # irb won't be activated in that case. if IRB.respond_to?(:conf) supported && IRB.conf.fetch(:USE_COLORIZE, true) else supported end end
Class Method Details
.clear(colorable: colorable?) )
[ GitHub ]# File 'lib/irb/color.rb', line 112
def clear(colorable: colorable?) return '' unless colorable "\e[#{CLEAR}m" end
.colorize(text, seq, colorable: colorable?) )
[ GitHub ]# File 'lib/irb/color.rb', line 117
def colorize(text, seq, colorable: colorable?) return text unless colorable seq = seq.map { |s| "\e[#{const_get(s)}m" }.join('') "#{seq}#{text}#{clear(colorable: colorable)}" end
.colorize_code(code, complete: true, ignore_error: false, colorable: colorable?, , local_variables: [])
If complete
is false (code is incomplete), this does not warn compile_error. This option is needed to avoid warning a user when the compile_error is happening because the input is not wrong but just incomplete.
# File 'lib/irb/color.rb', line 126
def colorize_code(code, complete: true, ignore_error: false, colorable: colorable?, local_variables: []) return code unless colorable symbol_state = SymbolState.new colored = +'' lvars_code = RubyLex.generate_local_variables_assign_code(local_variables) code_with_lvars = lvars_code ? "#{lvars_code}\n#{code}" : code scan(code_with_lvars, allow_last_error: !complete) do |token, str, expr| # handle uncolorable code if token.nil? colored << Reline::Unicode.escape_for_print(str) next end # IRB::ColorPrinter skips colorizing fragments with any invalid token if ignore_error && ERROR_TOKENS.include?(token) return Reline::Unicode.escape_for_print(code) end in_symbol = symbol_state.scan_token(token) str.each_line do |line| line = Reline::Unicode.escape_for_print(line) if seq = dispatch_seq(token, expr, line, in_symbol: in_symbol) colored << seq.map { |s| "\e[#{s}m" }.join('') colored << line.sub(/\Z/, clear(colorable: colorable)) else colored << line end end end if lvars_code raise "#{lvars_code.dump} should have no \\n" if lvars_code.include?("\n") colored.sub!(/\A.+\n/, '') # delete_prefix lvars_code with colors end colored end
.dispatch_seq(token, expr, str, in_symbol:) (private)
[ GitHub ]# File 'lib/irb/color.rb', line 217
def dispatch_seq(token, expr, str, in_symbol:) if ERROR_TOKENS.include?(token) TOKEN_SEQ_EXPRS[token][0] elsif in_symbol [YELLOW] elsif TOKEN_KEYWORDS.fetch(token, []).include?(str) [CYAN, BOLD] elsif (seq, exprs = TOKEN_SEQ_EXPRS[token]; (expr & (exprs || 0)) != 0) seq else nil end end
.inspect_colorable?(obj, seen: {}.compare_by_identity) ⇒ Boolean
# File 'lib/irb/color.rb', line 91
def inspect_colorable?(obj, seen: {}.compare_by_identity) case obj when String, Symbol, Regexp, Integer, Float, FalseClass, TrueClass, NilClass true when Hash without_circular_ref(obj, seen: seen) do obj.all? { |k, v| inspect_colorable?(k, seen: seen) && inspect_colorable?(v, seen: seen) } end when Array without_circular_ref(obj, seen: seen) do obj.all? { |o| inspect_colorable?(o, seen: seen) } end when Range inspect_colorable?(obj.begin, seen: seen) && inspect_colorable?(obj.end, seen: seen) when Module !obj.name.nil? else false end end
.scan(code, allow_last_error:) (private)
[ GitHub ]# File 'lib/irb/color.rb', line 175
def scan(code, allow_last_error:) verbose, $VERBOSE = $VERBOSE, nil RubyLex.compile_with_errors_suppressed(code) do |inner_code, line_no| lexer = Ripper::Lexer.new(inner_code, '(ripper)', line_no) byte_pos = 0 line_positions = [0] inner_code.lines.each do |line| line_positions << line_positions.last + line.bytesize end on_scan = proc do |elem| start_pos = line_positions[elem.pos[0] - 1] + elem.pos[1] # yield uncolorable code if byte_pos < start_pos yield(nil, inner_code.byteslice(byte_pos...start_pos), nil) end if byte_pos <= start_pos str = elem.tok yield(elem.event, str, elem.state) byte_pos = start_pos + str.bytesize end end if lexer.respond_to?(:scan) # Ruby 2.7+ lexer.scan.each do |elem| next if allow_last_error and /meets end of file|unexpected end-of-input/ =~ elem. on_scan.call(elem) end else lexer.parse.sort_by(&:pos).each do |elem| on_scan.call(elem) end end # yield uncolorable DATA section yield(nil, inner_code.byteslice(byte_pos...inner_code.bytesize), nil) if byte_pos < inner_code.bytesize end ensure $VERBOSE = verbose end
.without_circular_ref(obj, seen:, &block) (private)
[ GitHub ]# File 'lib/irb/color.rb', line 167
def without_circular_ref(obj, seen:, &block) return false if seen.key?(obj) seen[obj] = true block.call ensure seen.delete(obj) end