class Crystal::Macros::MacroId

Overview

A fictitious node representing an idenfitifer like, foo, Bar or something_else.

The parser doesn't create this nodes. Instead, you create them by invoking #id on some nodes. For example, invoking #id on a StringLiteral returns a MacroId for the string's content. Similarly, invoking ID on a SymbolLiteral, Call, Var and Path return MacroIds for the node's content.

This allows you to treat strings, symbols, variables and calls uniformly. For example:

macro getter(name)
  def {{name.id}}
    @{{name.id}}
  end
end

getter unicorns
getter :unicorns
getter "unicorns"

All of the above macro calls work because we invoked #id, and the generated code looks like this:

def unicorns
  @unicorns
end

If we hand't use #id, the generated code would have been this:

def unicorns
  @unicorns
end

def :unicorns
  @:unicorns
end

def "unicorns"
  @"unicorns"
end

The last two definitions are invalid and so will give a compile-time error.

Defined in:

compiler/crystal/macros.cr

Instance Method Summary

Instance methods inherited from class Crystal::Macros::ASTNode

!=(other : ASTNode) : BoolLiteral !=, ==(other : ASTNode) : BoolLiteral ==, class_name : StringLiteral class_name, column_number : StringLiteral | NilLiteral column_number, end_column_number : StringLiteral | NilLiteral end_column_number, end_line_number : StringLiteral | NilLiteral end_line_number, filename : StringLiteral | NilLiteral filename, id : MacroId id, line_number : StringLiteral | NilLiteral line_number, raise(message) : NoReturn raise, stringify : StringLiteral stringify, symbolize : SymbolLiteral symbolize

Instance methods inherited from class Reference

==(other : self)
==(other : JSON::Any)
==(other : YAML::Any)
==(other) ==, dup dup, hash(hasher) hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference)
same?(other : Nil) same?, to_s(io : IO) : Nil to_s

Constructor methods inherited from class Reference

new new

Instance methods inherited from class Object

!=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other) ===, =~(other) =~, class class, dup dup, hash(hasher)
hash hash, inspect(io : IO)
inspect inspect, itself itself, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, tap(&block) tap, to_json(io : IO)
to_json to_json, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ") to_pretty_json, to_s
to_s(io : IO) to_s, to_yaml(io : IO)
to_yaml to_yaml, try(&block) try, unsafe_as(type : T.class) forall T unsafe_as

Constructor methods inherited from class Object

from_json(string_or_io, root : String) : self
from_json(string_or_io) : self from_json, from_yaml(string_or_io : String | IO) : self from_yaml

Instance Method Detail

def +(other : StringLiteral | CharLiteral) : MacroId #

Similar to String#+.


[View source]
def =~(range : RegexLiteral) : BoolLiteral #

Similar to String#=~.


[View source]
def [](range : RangeLiteral) : MacroId #

Similar to String#[].


[View source]
def capitalize : MacroId #

Similar to String#capitalize.


[View source]
def chars : Crystal::Macros::ArrayLiteral(CharLiteral) #

Similar to String#chars.


[View source]
def chomp : MacroId #

Similar to String#chomp.


[View source]
def downcase : MacroId #

Similar to String#downcase.


[View source]
def empty? : BoolLiteral #

Similar to String#empty?.


[View source]
def ends_with?(other : StringLiteral | CharLiteral) : BoolLiteral #

Similar to String#ends_with?.


[View source]
def gsub(regex : RegexLiteral, replacement : StringLiteral) : MacroId #

Similar to String#gsub.


[View source]
def id : MacroId #

Returns self.


[View source]
def includes?(search : StringLiteral | CharLiteral) : BoolLiteral #

Similar to String#includes?.


[View source]
def lines : Crystal::Macros::ArrayLiteral(StringLiteral) #

Similar to String#lines.


[View source]
def size : NumberLiteral #

Similar to String#size.


[View source]
def split(node : ASTNode) : Crystal::Macros::ArrayLiteral(StringLiteral) #

Similar to String#split.


[View source]
def split : Crystal::Macros::ArrayLiteral(StringLiteral) #

Similar to String#split.


[View source]
def starts_with?(other : StringLiteral | CharLiteral) : BoolLiteral #

Similar to String#starts_with?.


[View source]
def strip : MacroId #

Similar to String#strip.


[View source]
def tr(from : StringLiteral, to : StringLiteral) : MacroId #

Similar to String#tr.


[View source]
def upcase : MacroId #

Similar to String#upcase.


[View source]