Crystal::Macros::ASTNode

Returns true if this node's textual representation is not the same as the other node.

Returns true if this node's textual representation is the same as the other node.

Returns a StringLiteral that contains this node's name.

macro test
  {{ "foo".class_name }}
end

puts test # => prints StringLiteral

Returns the column number where this node begins. Might return nil if the location is not known.

The first column number in a line is 1.

Returns a StringLiteral that contains the documentation comments attached to this node, or an empty string if there are none.

WARNING: The return value will be an empty string when executed outside of the crystal docs command.

Returns a MacroId that contains the documentation comments attached to this node, or an empty MacroId if there are none. Each line is prefixed with a # character to allow the output to be used directly within another node's documentation comment.

A common use case is combining this method with the @caller macro instance variable in order to allow merging macro expansion and call comments.

WARNING: The return value will be empty when executed outside of the crystal docs command.

Returns the column number where this node ends. Might return nil if the location is not known.

The first column number in a line is 1.

Returns the line number where this node ends. Might return nil if the location is not known.

The first line number in a file is 1.

Returns the filename where this node is located. Might return nil if the location is not known.

Returns this node as a MacroId. Useful when you need an identifier out of a StringLiteral, SymbolLiteral, Var or Call.

macro define_method(name, content)
  def {{name.id}}
    {{content}}
  end
end

define_method :foo, 1
define_method "bar", 2
define_method baz, 3

puts foo # => prints 1
puts bar # => prints 2
puts baz # => prints 3

Returns true if this node's type is the given type or any of its subclasses.

type always refers to an AST node type, never a type in the program.

{{ 1.is_a?(NumberLiteral) }} # => true
{{ 1.is_a?(BoolLiteral) }}   # => false
{{ 1.is_a?(ASTNode) }}       # => true
{{ 1.is_a?(Int32) }}         # => false

NOTE: This is a pseudo-method provided directly by the Crystal compiler. It cannot be redefined nor overridden.

Returns the line number where this node begins. Might return nil if the location is not known.

The first line number in a file is 1.

Returns true if this node is a NilLiteral or Nop. NOTE: This is a pseudo-method provided directly by the Crystal compiler. It cannot be redefined nor overridden.

Gives a compile-time error with the given message. This will highlight this node in the error message.

Returns a StringLiteral that contains this node's textual representation. Note that invoking stringify on a string literal will return a StringLiteral that contains a string literal.

macro test
  {{ "foo".stringify }}
end

puts test # prints "foo" (including the double quotes)

Returns a SymbolLiteral that contains this node's textual representation.

{{ "foo".id.symbolize }} # => :foo

Emits a compile-time warning with the given message. This will highlight this node in the warning message.