Class: Prism::Token

Inherits:
Object
  • Object
show all
Defined in:
lib/prism/parse_result.rb,
ext/prism/extension.c

Overview

This represents a token from the Ruby source.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, type, value, location) ⇒ Token

Create a new token object with the given type, value, and location.



829
830
831
832
833
834
 
# File 'lib/prism/parse_result.rb', line 829

def initialize(source, type, value, location)
  @source = source
  @type = type
  @value = value
  @location = location
end

Instance Attribute Details

#type ⇒ Object (readonly)

The type of token that this token is.



823
824
825
 
# File 'lib/prism/parse_result.rb', line 823

def type
  @type
end

#value ⇒ Object (readonly)

A byteslice of the source that this token represents.



826
827
828
 
# File 'lib/prism/parse_result.rb', line 826

def value
  @value
end

Instance Method Details

#==(other) ⇒ Object

Returns true if the given other token is equal to this token.



864
865
866
867
868
 
# File 'lib/prism/parse_result.rb', line 864

def ==(other)
  Token === other &&
    other.type == type &&
    other.value == value
end

#deconstruct_keys(keys) ⇒ Object

Implement the hash pattern matching interface for Token.



837
838
839
 
# File 'lib/prism/parse_result.rb', line 837

def deconstruct_keys(keys)
  { type: type, value: value, location: location }
end

#deep_freeze ⇒ Object

Freeze this object and the objects it contains.



877
878
879
880
881
 
# File 'lib/prism/parse_result.rb', line 877

def deep_freeze
  value.freeze
  location.freeze
  freeze
end

#inspect ⇒ Object

Returns a string representation of this token.



871
872
873
874
 
# File 'lib/prism/parse_result.rb', line 871

def inspect
  location
  super
end

#location ⇒ Object

A Location object representing the location of this token in the source.



842
843
844
845
846
 
# File 'lib/prism/parse_result.rb', line 842

def location
  location = @location
  return location if location.is_a?(Location)
  @location = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#pretty_print(q) ⇒ Object

Implement the pretty print interface for Token.



849
850
851
852
853
854
855
856
857
858
859
860
861
 
# File 'lib/prism/parse_result.rb', line 849

def pretty_print(q)
  q.group do
    q.text(type.to_s)
    self.location.pretty_print(q)
    q.text("(")
    q.nest(2) do
      q.breakable("")
      q.pp(value)
    end
    q.breakable("")
    q.text(")")
  end
end