class YARD::Handlers::C::Base

Public Class Methods

handles?(statement, processor) click to toggle source

@return [Boolean] whether the handler handles this statement

# File lib/yard/handlers/c/base.rb, line 10
def self.handles?(statement, processor)
  processor.globals.cruby_processed_files ||= {}
  processor.globals.cruby_processed_files[processor.file] = true

  src = statement.respond_to?(:declaration) ?
    statement.declaration : statement.source

  handlers.any? do |a_handler|
    statement_class >= statement.class &&
      case a_handler
      when String
        src == a_handler
      when Regexp
        src =~ a_handler
      end
  end
end
statement_class(type = nil) click to toggle source
# File lib/yard/handlers/c/base.rb, line 28
def self.statement_class(type = nil)
  if type
    @statement_class = type
  else
    (defined?(@statement_class) && @statement_class) || Statement
  end
end

Public Instance Methods

ensure_variable_defined!(var, max_retries = 1) click to toggle source
# File lib/yard/handlers/c/base.rb, line 70
def ensure_variable_defined!(var, max_retries = 1)
  retries = 0
  object = nil

  loop do
    object = namespace_for_variable(var)
    break unless object.is_a?(Proxy)

    raise NamespaceMissingError, object if retries > max_retries
    log.debug "Missing namespace variable #{var} in file `#{parser.file}', moving it to the back of the line."
    parser.parse_remaining_files
    retries += 1
  end

  object
end
namespace_for_variable(var) click to toggle source
# File lib/yard/handlers/c/base.rb, line 64
def namespace_for_variable(var)
  return namespaces[var] if namespaces[var]
  var = remove_var_prefix(var)
  var.empty? ? nil : P(var)
end
namespaces() click to toggle source
# File lib/yard/handlers/c/base.rb, line 87
def namespaces
  globals.cruby_namespaces ||= {}
end
override_comments() click to toggle source
# File lib/yard/handlers/c/base.rb, line 60
def override_comments
  globals.cruby_override_comments ||= []
end
parse_block(opts = {}) click to toggle source

@group Parsing an Inner Block

# File lib/yard/handlers/c/base.rb, line 97
def parse_block(opts = {})
  return if !statement.block || statement.block.empty?
  push_state(opts) do
    parser.process(statement.block)
  end
end
process_file(file, object) click to toggle source

@group Processing other files

# File lib/yard/handlers/c/base.rb, line 106
def process_file(file, object)
  file = File.cleanpath(file)
  return if processed_files[file]
  processed_files[file] = file
  begin
    log.debug "Processing embedded call to C source #{file}..."
    globals.ordered_parser.files.delete(file) if globals.ordered_parser
    parser.process(Parser::C::CParser.new(File.read(file), file).parse)
  rescue Errno::ENOENT
    log.warn "Missing source file `#{file}' when parsing #{object}"
  end
end
processed_files() click to toggle source
# File lib/yard/handlers/c/base.rb, line 91
def processed_files
  globals.cruby_processed_files ||= {}
end
register_docstring(object, docstring = nil, stmt = nil) click to toggle source

@group Registering objects

Calls superclass method YARD::Handlers::Base#register_docstring
# File lib/yard/handlers/c/base.rb, line 38
def register_docstring(object, docstring = nil, stmt = nil)
  super(object, docstring, stmt) if docstring
end
register_file_info(object, file = nil, line = nil, comments = nil) click to toggle source
Calls superclass method YARD::Handlers::Base#register_file_info
# File lib/yard/handlers/c/base.rb, line 42
def register_file_info(object, file = nil, line = nil, comments = nil)
  super(object, file, line, comments) if file
end
register_source(object, source = nil, type = nil) click to toggle source
Calls superclass method YARD::Handlers::Base#register_source
# File lib/yard/handlers/c/base.rb, line 46
def register_source(object, source = nil, type = nil)
  super(object, source, type) if source
end
register_visibility(object, visibility = nil) click to toggle source
# File lib/yard/handlers/c/base.rb, line 50
def register_visibility(object, visibility = nil)
  super(object, visibility) if visibility
end
symbols() click to toggle source

@group Looking up Symbol and Var Values

# File lib/yard/handlers/c/base.rb, line 56
def symbols
  globals.cruby_symbols ||= {}
end

Private Instance Methods

remove_var_prefix(var) click to toggle source

@endgroup

# File lib/yard/handlers/c/base.rb, line 123
def remove_var_prefix(var)
  var.gsub(/^rb_[mc]|^[a-z_]+/, '')
end