Class: YARD::Parser::Ruby::Legacy::RubyToken::Token

Inherits:
Object
  • Object
show all
Defined in:
lib/yard/parser/ruby/legacy/ruby_lex.rb

Overview

Represents a token in the Ruby lexer

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(line_no, char_no) ⇒ Token

Creates a new Token object

Parameters:

  • line_no (Integer) —

    the line number to initialize the token to

  • char_no (Integer) —

    the char number to initialize the token to



38
39
40
41
42
 
# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 38

def initialize(line_no, char_no)
  @line_no = line_no
  @char_no = char_no
  @text    = NO_TEXT
end

Instance Attribute Details

#char_no ⇒ Integer (readonly)

Returns the character number in the file/stream the token is located.

Returns:

  • (Integer) —

    the character number in the file/stream the token is located.



24
25
26
 
# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 24

def char_no
  @char_no
end

#lex_state ⇒ Symbol

Returns the lexical state at the token.

Returns:

  • (Symbol) —

    the lexical state at the token



30
31
32
 
# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 30

def lex_state
  @lex_state
end

#line_no ⇒ Integer (readonly)

Returns the line number in the file/stream the token is located.

Returns:

  • (Integer) —

    the line number in the file/stream the token is located.



20
21
22
 
# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 20

def line_no
  @line_no
end

#text ⇒ String (readonly)

Returns the token text value.

Returns:

  • (String) —

    the token text value



27
28
29
 
# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 27

def text
  @text
end

Instance Method Details

#set_text(text) ⇒ Token

Chainable way to sets the text attribute

Parameters:

  • text (String) —

    the new text

Returns:

  • (Token) —

    this token object



48
49
50
51
 
# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 48

def set_text(text)
  @text = text
  self
end