123456789_123456789_123456789_123456789_123456789_

Module: YARD::Parser::Ruby

Relationships & Source Files
Namespace Children
Modules:
Legacy
Classes:
AstNode, ClassNode, CommentNode, ConditionalNode, KeywordNode, LiteralNode, LoopNode, MethodCallNode, MethodDefinitionNode, ModuleNode, ParameterNode, ReferenceNode, RipperParser, RubyParser, TokenResolver
Extension / Inclusion / Inheritance Descendants
Extended In:
::YARD::Handlers::Ruby::AliasHandler, ::YARD::Handlers::Ruby::AttributeHandler, ::YARD::Handlers::Ruby::Base, ::YARD::Handlers::Ruby::ClassConditionHandler, ::YARD::Handlers::Ruby::ClassHandler, ::YARD::Handlers::Ruby::ClassVariableHandler, ::YARD::Handlers::Ruby::CommentHandler, ::YARD::Handlers::Ruby::ConstantHandler, ::YARD::Handlers::Ruby::DSLHandler, ::YARD::Handlers::Ruby::ExceptionHandler, ::YARD::Handlers::Ruby::ExtendHandler, ::YARD::Handlers::Ruby::MethodConditionHandler, ::YARD::Handlers::Ruby::MethodHandler, ::YARD::Handlers::Ruby::MixinHandler, ::YARD::Handlers::Ruby::ModuleFunctionHandler, ::YARD::Handlers::Ruby::ModuleHandler, ::YARD::Handlers::Ruby::PrivateClassMethodHandler, ::YARD::Handlers::Ruby::PrivateConstantHandler, ::YARD::Handlers::Ruby::PublicClassMethodHandler, ::YARD::Handlers::Ruby::VisibilityHandler, ::YARD::Handlers::Ruby::YieldHandler
Included In:
::YARD::Handlers::Ruby::AliasHandler, ::YARD::Handlers::Ruby::AttributeHandler, ::YARD::Handlers::Ruby::Base, ::YARD::Handlers::Ruby::ClassConditionHandler, ::YARD::Handlers::Ruby::ClassHandler, ::YARD::Handlers::Ruby::ClassVariableHandler, ::YARD::Handlers::Ruby::CommentHandler, ::YARD::Handlers::Ruby::ConstantHandler, ::YARD::Handlers::Ruby::DSLHandler, ::YARD::Handlers::Ruby::ExceptionHandler, ::YARD::Handlers::Ruby::ExtendHandler, ::YARD::Handlers::Ruby::MethodConditionHandler, ::YARD::Handlers::Ruby::MethodHandler, ::YARD::Handlers::Ruby::MixinHandler, ::YARD::Handlers::Ruby::ModuleFunctionHandler, ::YARD::Handlers::Ruby::ModuleHandler, ::YARD::Handlers::Ruby::PrivateClassMethodHandler, ::YARD::Handlers::Ruby::PrivateConstantHandler, ::YARD::Handlers::Ruby::PublicClassMethodHandler, ::YARD::Handlers::Ruby::VisibilityHandler, ::YARD::Handlers::Ruby::YieldHandler
Defined in: lib/yard/autoload.rb,
lib/yard/parser/ruby/ast_node.rb,
lib/yard/parser/ruby/ruby_parser.rb,
lib/yard/parser/ruby/token_resolver.rb,
lib/yard/parser/ruby/legacy/ruby_parser.rb

Overview

Ruby parsing components.

Instance Method Summary

Instance Method Details

#s(*nodes, opts = {}) ⇒ AstNode #s(type, *children, opts = {}) ⇒ AstNode

Builds and s-expression by creating Ruby::AstNode objects with the type provided by the first argument.

Examples:

An implicit list of keywords

ast = s(s(:kw, "if"), s(:kw, "else"))
ast.type # => :list

A method call

s(:command, s(:var_ref, "mymethod"))

Overloads:

  • #s(*nodes, opts = {}) ⇒ AstNode

    Parameters:

    • nodes (Array<AstNode>) —

      a list of nodes.

    • opts (Hash) (defaults to: {}) —

      any extra options (docstring, file, source) to set on the object

    Returns:

    • (AstNode) —

      an implicit node where node.type == :list

  • #s(type, *children, opts = {}) ⇒ AstNode

    Parameters:

    • type (Symbol) —

      the node type

    • children (Array<AstNode>) —

      any child nodes inside this one

    • opts (Hash) (defaults to: {}) —

      any extra options to set on the object

    Returns:

    • (AstNode) —

      a node of type type.

See Also:

  • AstNode#initialize
[ GitHub ] 

  


# File 'lib/yard/parser/ruby/ast_node.rb', line 25



def s(*args)
  type = Symbol === args.first ? args.shift : :list
  opts = Hash === args.last ? args.pop : {}
  AstNode.node_class_for(type).new(type, args, opts)
end