Class: Ibex::Frontend::SourceSpan

Inherits:
Object
  • Object
show all
Defined in:
lib/ibex/frontend/source_span.rb,
sig/ibex/frontend/source_span.rbs

Overview

An immutable half-open byte span in one grammar source.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(file:, start:, finish:) ⇒ SourceSpan

Returns a new instance of SourceSpan.

RBS:

  • (file: String, start: SourcePosition, finish: SourcePosition) -> void

Parameters:



54
55
56
57
58
59
60
61
 
# File 'lib/ibex/frontend/source_span.rb', line 54

def initialize(file:, start:, finish:)
  raise ArgumentError, "span end precedes its start" if finish.byte_offset < start.byte_offset

  @file = file.dup.freeze
  @start = start
  @finish = finish
  freeze
end

Instance Attribute Details

#file ⇒ String (readonly)

Signature:

  • String

Returns:

  • (String) 


49
50
51
 
# File 'lib/ibex/frontend/source_span.rb', line 49

def file
  @file
end

#finish ⇒ SourcePosition (readonly)

Signature:

  • SourcePosition

Returns:



51
52
53
 
# File 'lib/ibex/frontend/source_span.rb', line 51

def finish
  @finish
end

#start ⇒ SourcePosition (readonly)

Signature:

  • SourcePosition

Returns:



50
51
52
 
# File 'lib/ibex/frontend/source_span.rb', line 50

def start
  @start
end

Instance Method Details

#empty? ⇒ Boolean

RBS:

  • () -> bool

Returns:

  • (Boolean) 


79
80
81
 
# File 'lib/ibex/frontend/source_span.rb', line 79

def empty?
  length.zero?
end

#end_byte ⇒ Integer

RBS:

  • () -> Integer

Returns:

  • (Integer) 


69
70
71
 
# File 'lib/ibex/frontend/source_span.rb', line 69

def end_byte
  finish.byte_offset
end

#length ⇒ Integer

RBS:

  • () -> Integer

Returns:

  • (Integer) 


74
75
76
 
# File 'lib/ibex/frontend/source_span.rb', line 74

def length
  end_byte - start_byte
end

#start_byte ⇒ Integer

RBS:

  • () -> Integer

Returns:

  • (Integer) 


64
65
66
 
# File 'lib/ibex/frontend/source_span.rb', line 64

def start_byte
  start.byte_offset
end

#to_h ⇒ Hash[Symbol, Object?]

RBS:

  • () -> Hash[Symbol, Object?]

Returns:

  • (Hash[Symbol, Object?]) 


84
85
86
 
# File 'lib/ibex/frontend/source_span.rb', line 84

def to_h
  { file: file, start: start.to_h, end: finish.to_h }
end