123456789_123456789_123456789_123456789_123456789_

Class: YARD::Parser::Base Abstract

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
C::CParser, Ruby::RubyParser, Ruby::Legacy::RubyParser
Inherits: Object
Defined in: lib/yard/parser/base.rb

Overview

This class is abstract.

Represents the abstract base parser class that parses source code in a specific way. A parser should implement #parse, #tokenize and #enumerator.

Registering a Custom Parser

To register a parser, see SourceParser.register_parser_type

See Also:

Since:

  • 0.5.6

Class Method Summary

Instance Method Summary

  • #enumerator ⇒ Array? abstract

    This method should be implemented to return a list of semantic tokens representing the source code to be post-processed.

  • #parse ⇒ Base abstract

    This method should be implemented to parse the source and return itself.

  • #tokenize ⇒ Array abstract

    This method should be implemented to tokenize given source.

Constructor Details

.new(source, filename) ⇒ Base

This default constructor does nothing. The subclass is responsible for storing the source contents and filename if they are required.

Parameters:

  • source (String) —

    the source contents

  • filename (String) —

    the name of the file if from disk

Raises:

  • (NotImplementedError)

Since:

  • 0.5.6

[ GitHub ] 

  


# File 'lib/yard/parser/base.rb', line 26



def initialize(source, filename) # rubocop:disable Lint/UnusedMethodArgument
  raise NotImplementedError, "invalid parser implementation"
end


  







Class Method Details



  

    .parse(source, filename = nil)  
  



  

    
Convenience method to create a new parser and #parse


  





  
Since:


    
  
  • 
    
    0.5.6
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/yard/parser/base.rb', line 18



def self.parse(source, filename = nil)
  new(source, filename).parse
end


  







Instance Method Details



  

    #enumerator  ⇒ Array? 
  



  

    

  This method is abstract.
  




This method should be implemented to return a list of semantic tokens
representing the source code to be post-processed. Otherwise the method
should return nil.


  





  
Returns:


    
  
  • 
    (Array)
—    
    a list of semantic tokens representing the source code
to be post-processed
    

    
  
    • 
  
  • 
    (nil)
—    
    if no post-processing should be done
    

    
  
    • 



Since:


    
  
  • 
    
    0.5.6
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/yard/parser/base.rb', line 52



def enumerator
  nil
end


  








  

    #parse  ⇒ Base 
  



  

    

  This method is abstract.
  




This method should be implemented to parse the source and return itself.


  





  
Returns:


    
  
  • 
    (Base)
—    
    this method should return itself
    

    
  
    • 



Raises:


    
  
  • 
    (NotImplementedError)
  
    • 



Since:


    
  
  • 
    
    0.5.6
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/yard/parser/base.rb', line 33



def parse
  raise NotImplementedError, "#{self.class} must implement #parse"
end


  








  

    #tokenize  ⇒ Array 
  



  

    

  This method is abstract.
  




This method should be implemented to tokenize given source


  





  
Returns:


    
  
  • 
    (Array)
—    
    a list/tree of lexical tokens
    

    
  
    • 



Raises:


    
  
  • 
    (NotImplementedError)
  
    • 



Since:


    
  
  • 
    
    0.5.6
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/yard/parser/base.rb', line 40



def tokenize
  raise NotImplementedError, "#{self.class} does not support tokenization"
end