Class: Hind::SCIP::Generator::ScipVisitor

Inherits:
Prism::Visitor
  • Object
show all
Defined in:
lib/hind/scip/generator.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(file_path, options = {}) ⇒ ScipVisitor

Returns a new instance of ScipVisitor.



106
107
108
109
110
111
112
113
114
 
# File 'lib/hind/scip/generator.rb', line 106

def initialize(file_path, options = {})
  @file_path = file_path
  @mode = options[:mode] || :emit # :index or :emit
  package_info = options[:package_info] || {}
  @occurrences = []
  @symbols = []
  @current_scope = []
  @package_prefix = "scip-ruby rubygems #{package_info[:name] || "hind"} #{package_info[:version] || "0.1.0"} "
end

Instance Attribute Details

#occurrences ⇒ Object (readonly)

Returns the value of attribute occurrences.



104
105
106
 
# File 'lib/hind/scip/generator.rb', line 104

def occurrences
  @occurrences
end

#symbols ⇒ Object (readonly)

Returns the value of attribute symbols.



104
105
106
 
# File 'lib/hind/scip/generator.rb', line 104

def symbols
  @symbols
end

Instance Method Details

#visit_call_and_write_node(node) ⇒ Object 



303
304
305
306
307
308
 
# File 'lib/hind/scip/generator.rb', line 303

def visit_call_and_write_node(node)
  return super if @mode == :index
  register_scip_call_reference(node, name_override: node.read_name.to_s)
  register_scip_call_reference(node, name_override: node.write_name.to_s)
  super
end

#visit_call_node(node) ⇒ Object 



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/hind/scip/generator.rb', line 282

def visit_call_node(node)
  # Handle attr_accessor, attr_reader, attr_writer
  index_attribute_helpers(node)
  index_ancestor_helpers(node)

  return super if @mode == :index

  # Skip common methods
  return super if %w[new puts p print].include?(node.name.to_s)

  register_scip_call_reference(node)
  super
end

#visit_call_operator_write_node(node) ⇒ Object 



296
297
298
299
300
301
 
# File 'lib/hind/scip/generator.rb', line 296

def visit_call_operator_write_node(node)
  return super if @mode == :index
  register_scip_call_reference(node, name_override: node.read_name.to_s)
  register_scip_call_reference(node, name_override: node.write_name.to_s)
  super
end

#visit_call_or_write_node(node) ⇒ Object 



310
311
312
313
314
315
 
# File 'lib/hind/scip/generator.rb', line 310

def visit_call_or_write_node(node)
  return super if @mode == :index
  register_scip_call_reference(node, name_override: node.read_name.to_s)
  register_scip_call_reference(node, name_override: node.write_name.to_s)
  super
end

#visit_class_node(node) ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/hind/scip/generator.rb', line 116

def visit_class_node(node)
  name = scip_name(node.constant_path.slice)
  @current_scope.push(name)
  symbol = "#{@package_prefix}#{@current_scope.join("#")}#"

  if @mode == :index
    GlobalState.instance.add_symbol(current_scope_name, symbol)
  else
    # Definition role = 1
    range = [
      node.constant_path.location.start_line - 1,
      node.constant_path.location.start_column,
      node.constant_path.location.end_column
    ]

    @occurrences << Occurrence.new(
      range: range,
      symbol: symbol,
      symbol_roles: 1,
      syntax_kind: SyntaxKind::Identifier
    )

    unless GlobalState.instance.emitted?(symbol)
      @symbols << SymbolInformation.new(
        symbol: symbol,
        documentation: ["class #{node.constant_path.slice}"],
        kind: SymbolInformation::Kind::Class
      )
      GlobalState.instance.mark_emitted(symbol)
    end
  end

  super
  @current_scope.pop
end

#visit_constant_path_node(node) ⇒ Object 



277
278
279
280
 
# File 'lib/hind/scip/generator.rb', line 277

def visit_constant_path_node(node)
  # Ensure we visit parts for better indexing
  super
end

#visit_constant_read_node(node) ⇒ Object 



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/hind/scip/generator.rb', line 255

def visit_constant_read_node(node)
  return if @mode == :index

  # Try to resolve constant
  symbol = GlobalState.instance.find_symbol(node.name.to_s, current_scope_name)
  if symbol
    range = [
      node.location.start_line - 1,
      node.location.start_column,
      node.location.end_column
    ]

    @occurrences << Occurrence.new(
      range: range,
      symbol: symbol,
      symbol_roles: 0, # Reference
      syntax_kind: SyntaxKind::Identifier
    )
  end
  super
end

#visit_constant_write_node(node) ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/hind/scip/generator.rb', line 187

def visit_constant_write_node(node)
  name = scip_name(node.name.to_s)
  suffix = @current_scope.empty? ? '' : '#'
  symbol = "#{@package_prefix}#{@current_scope.join("#")}#{suffix}#{name}."

  if @mode == :index
    GlobalState.instance.add_symbol("#{current_scope_name}::#{node.name}", symbol)
  else
    range = [
      node.name_loc.start_line - 1,
      node.name_loc.start_column,
      node.name_loc.end_column
    ]

    @occurrences << Occurrence.new(
      range: range,
      symbol: symbol,
      symbol_roles: 1,
      syntax_kind: SyntaxKind::Identifier
    )

    unless GlobalState.instance.emitted?(symbol)
      @symbols << SymbolInformation.new(
        symbol: symbol,
        documentation: ["constant #{node.name}"],
        kind: SymbolInformation::Kind::Package # fallback
      )
      GlobalState.instance.mark_emitted(symbol)
    end
  end
  super
end

#visit_def_node(node) ⇒ Object 



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/hind/scip/generator.rb', line 220

def visit_def_node(node)
  name = scip_name(node.name.to_s)
  suffix = @current_scope.empty? ? '' : '#'
  symbol = "#{@package_prefix}#{@current_scope.join("#")}#{suffix}#{name}."

  if @mode == :index
    # Register both qualified and simple name for speculative resolution
    GlobalState.instance.add_symbol("#{current_scope_name}##{node.name}", symbol)
    GlobalState.instance.add_symbol("##{node.name}", symbol)
  else
    range = [
      node.name_loc.start_line - 1,
      node.name_loc.start_column,
      node.name_loc.end_column
    ]

    @occurrences << Occurrence.new(
      range: range,
      symbol: symbol,
      symbol_roles: 1,
      syntax_kind: SyntaxKind::Identifier
    )

    unless GlobalState.instance.emitted?(symbol)
      @symbols << SymbolInformation.new(
        symbol: symbol,
        documentation: ["def #{node.name}"],
        kind: SymbolInformation::Kind::Method
      )
      GlobalState.instance.mark_emitted(symbol)
    end
  end
  super
end

#visit_index_and_write_node(node) ⇒ Object 



324
325
326
327
328
329
 
# File 'lib/hind/scip/generator.rb', line 324

def visit_index_and_write_node(node)
  return super if @mode == :index
  register_scip_call_reference(node, name_override: "[]")
  register_scip_call_reference(node, name_override: "[]=")
  super
end

#visit_index_operator_write_node(node) ⇒ Object 



317
318
319
320
321
322
 
# File 'lib/hind/scip/generator.rb', line 317

def visit_index_operator_write_node(node)
  return super if @mode == :index
  register_scip_call_reference(node, name_override: "[]")
  register_scip_call_reference(node, name_override: "[]=")
  super
end

#visit_index_or_write_node(node) ⇒ Object 



331
332
333
334
335
336
 
# File 'lib/hind/scip/generator.rb', line 331

def visit_index_or_write_node(node)
  return super if @mode == :index
  register_scip_call_reference(node, name_override: "[]")
  register_scip_call_reference(node, name_override: "[]=")
  super
end

#visit_module_node(node) ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/hind/scip/generator.rb', line 152

def visit_module_node(node)
  name = scip_name(node.constant_path.slice)
  @current_scope.push(name)
  symbol = "#{@package_prefix}#{@current_scope.join("#")}#"

  if @mode == :index
    GlobalState.instance.add_symbol(current_scope_name, symbol)
  else
    range = [
      node.constant_path.location.start_line - 1,
      node.constant_path.location.start_column,
      node.constant_path.location.end_column
    ]

    @occurrences << Occurrence.new(
      range: range,
      symbol: symbol,
      symbol_roles: 1,
      syntax_kind: SyntaxKind::Identifier
    )

    unless GlobalState.instance.emitted?(symbol)
      @symbols << SymbolInformation.new(
        symbol: symbol,
        documentation: ["module #{node.constant_path.slice}"],
        kind: SymbolInformation::Kind::Module
      )
      GlobalState.instance.mark_emitted(symbol)
    end
  end

  super
  @current_scope.pop
end