Parent

Class/Module Index [+]

Quicksearch

YARD::Handlers::Processor

Iterates over all statements in a file and delegates them to the {Handlers::Base} objects that are registered to handle the statement.

This class is passed to each handler and keeps overall processing state. For example, if the {visibility} is set in a handler, all following statements will have access to this state. This allows "public", "protected" and "private" statements to be handled in classes and modules. In addition, the {namespace} can be set during parsing to control where objects are being created from. You can also access extra stateful properties that any handler can set during the duration of the post processing of a file from {extra_state}. If you need to access state across different files, look at {globals}.

@see Handlers::Base

Attributes

namespace_for_handler[R]

@return [Hash] a list of registered parser type extensions @private @since 0.6.0

extra_state[RW]

Share state across different handlers inside of a file. This attribute is similar to {visibility}, {scope}, {namespace} and {owner}, in that they all maintain state across all handlers for the entire source file. Use this attribute to store any data your handler might need to save during the parsing of a file. If you need to save state across files, see {globals}.

@return [OpenStruct] an open structure that can store arbitrary data @see globals

file[RW]

@return [String] the filename

globals[RW]

Handlers can share state for the entire post processing stage through this attribute. Note that post processing stage spans multiple files. To share state only within a single file, use {extra_state}

@example Sharing state among two handlers

class Handler1 < YARD::Handlers::Ruby::Base
  handles :class
  process { globals.foo = :bar }
end

class Handler2 < YARD::Handlers::Ruby::Base
  handles :method
  process { puts globals.foo }
end

@return [OpenStruct] global shared state for post-processing stage @see extra_state

load_order_errors[RW]

@return [Boolean] whether or not {Parser::LoadOrderError} is raised

namespace[RW]

@return [CodeObjects::NamespaceObject] the current namespace

owner[RW]

@return [CodeObjects::Base, nil] unlike the namespace, the owner

is a non-namespace object that should be stored between statements.
For instance, when parsing a method body, the {CodeObjects::MethodObject}
is set as the owner, in case any extra method information is processed.
parser_type[RW]

@return [Symbol] the parser type (:ruby, :ruby18, :c)

scope[RW]

@return [Symbol] the current scope (class, instance)

visibility[RW]

@return [Symbol] the current visibility (public, private, protected)

Public Class Methods

new(file = nil, load_order_errors = false, parser_type = Parser::SourceParser.parser_type, globals = nil) click to toggle source

Creates a new Processor for a file.

@param [String] file the name of the file that is being processed.

uses '(stdin)' if file is nil.

@param [Boolean] load_order_error whether or not to raise {Parser::LoadOrderError}

when a file has unresolved references that need to be parsed first.
If these errors are raised, the processor will attempt to load all
other files before continuing to parse the file.

@param [Symbol] parser_type the parser type (:ruby, :ruby18, :c) from

the parser. Used to select the handler (since handlers are specific
to a parser type).

@param [OpenStruct] globals the object holding all state during the

post processing stage
# File lib/yard/handlers/processor.rb, line 105
def initialize(file = nil, load_order_errors = false, parser_type = Parser::SourceParser.parser_type, globals = nil)
  @file = file || "(stdin)"
  @namespace = YARD::Registry.root
  @visibility = :public
  @scope = :instance
  @owner = @namespace
  @load_order_errors = load_order_errors
  @parser_type = parser_type
  @handlers_loaded = {}
  @globals = globals || OpenStruct.new
  @extra_state = OpenStruct.new
  load_handlers
end
register_handler_namespace(type, ns) click to toggle source

Registers a new namespace for handlers of the given type. @since 0.6.0

# File lib/yard/handlers/processor.rb, line 24
def register_handler_namespace(type, ns)
  namespace_for_handler[type] = ns
end

Public Instance Methods

find_handlers(statement) click to toggle source

Searches for all handlers in {Base.subclasses} that match the statement

@param statement the statement object to match. @return [Array<Base>] a list of handlers to process the statement with.

# File lib/yard/handlers/processor.rb, line 152
def find_handlers(statement)
  Base.subclasses.find_all do |handler|
    handler_base_class > handler &&
    (handler.namespace_only? ? owner.is_a?(CodeObjects::NamespaceObject) : true) &&
    handler.matches_file?(file) && handler.handles?(statement)
  end
end
process(statements) click to toggle source

Processes a list of statements by finding handlers to process each one.

@param [Array] statements a list of statements @return [void]

# File lib/yard/handlers/processor.rb, line 124
def process(statements)
  statements.each_with_index do |stmt, index|
    find_handlers(stmt).each do |handler|
      begin
        handler.new(self, stmt).process
      rescue Parser::LoadOrderError => loaderr
        raise # Pass this up
      rescue NamespaceMissingError => missingerr
        log.warn "The #{missingerr.object.type} #{missingerr.object.path} has not yet been recognized."
        log.warn "If this class/method is part of your source tree, this will affect your documentation results."
        log.warn "You can correct this issue by loading the source file for this object before `#{file}'"
        log.warn
      rescue Parser::UndocumentableError => undocerr
        log.warn "in #{handler.to_s}: Undocumentable #{undocerr.message}"
        log.warn "\tin file '#{file}':#{stmt.line}:\n\n" + stmt.show + "\n"
      rescue => e
        log.error "Unhandled exception in #{handler.to_s}:"
        log.error "  in `#{file}`:#{stmt.line}:\n\n#{stmt.show}\n"
        log.backtrace(e)
      end
    end
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.