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

Inherits:

Object

• Object
• YARD::Parser::Ruby::Legacy::RubyToken::Token

Defined in:

lib/yard/parser/ruby/legacy/ruby_lex.rb

Overview

Represents a token in the Ruby lexer

Direct Known Subclasses

TkBlockContents, TkError, TkId, TkNode, TkOp, TkStatementEnd, TkUnknownChar, TkVal, TkWhitespace

Constant Summary

NO_TEXT =

"??".freeze

Instance Attribute Summary

• #char_no ⇒ Integer readonly

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

• #lex_state ⇒ Symbol

  The lexical state at the token.

• #line_no ⇒ Integer readonly

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

• #text ⇒ String readonly

  The token text value.

Instance Method Summary

• #initialize(line_no, char_no) ⇒ Token constructor

  Creates a new Token object.

• #set_text(text) ⇒ Token

  Chainable way to sets the text attribute.

Constructor Details

#initialize(line_no, char_no) ⇒ Token

Creates a new Token object

# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 37

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)

# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 23

def char_no
  @char_no
end

#lex_state ⇒ Symbol

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

def lex_state
  @lex_state
end

#line_no ⇒ Integer (readonly)

# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 19

def line_no
  @line_no
end

#text ⇒ String (readonly)

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

def text
  @text
end

Instance Method Details

#set_text(text) ⇒ Token

Chainable way to sets the text attribute

# File 'lib/yard/parser/ruby/legacy/ruby_lex.rb', line 47

def set_text(text)
  @text = text
  self
end