ruby/yarp/templates/template.rb

#!/usr/bin/env ruby

require "erb"
require "fileutils"
require "yaml"

COMMON_FLAGS = 1

class Param
  attr_reader :name, :options

  def initialize(name:, type:, **options)
    @name, @type, @options = name, type, options
  end
end

module KindTypes
  def c_type
    if options[:kind]
      "yp_#{options[:kind].gsub(/(?<=.)[A-Z]/, "_\\0").downcase}"
    else
      "yp_node"
    end
  end

  def ruby_type
    options[:kind] || "Node"
  end

  def java_type
    options[:kind] || "Node"
  end

  def java_cast
    if options[:kind]
      "(Nodes.#{options[:kind]}) "
    else
      ""
    end
  end
end

# This represents a parameter to a node that is itself a node. We pass them as
# references and store them as references.
class NodeParam < Param
  include KindTypes

  def rbs_class
    ruby_type
  end
end

# This represents a parameter to a node that is itself a node and can be
# optionally null. We pass them as references and store them as references.
class OptionalNodeParam < Param
  include KindTypes

  def rbs_class
    "#{ruby_type}?"
  end
end

SingleNodeParam = -> (node) { NodeParam === node or OptionalNodeParam === node }

# This represents a parameter to a node that is a list of nodes. We pass them as
# references and store them as references.
class NodeListParam < Param
  def rbs_class
    "Array[Node]"
  end

  def java_type
    "Node[]"
  end
end

# This represents a parameter to a node that is a list of locations.
class LocationListParam < Param
  def rbs_class
    "Array[Location]"
  end

  def java_type
    "Location[]"
  end
end

# This represents a parameter to a node that is the ID of a string interned
# through the parser's constant pool.
class ConstantParam < Param
  def rbs_class
    "Symbol"
  end

  def java_type
    "byte[]"
  end
end

# This represents a parameter to a node that is a list of IDs that are
# associated with strings interned through the parser's constant pool.
class ConstantListParam < Param
  def rbs_class
    "Array[Symbol]"
  end

  def java_type
    "byte[][]"
  end
end

# This represents a parameter to a node that is a string.
class StringParam < Param
  def rbs_class
    "String"
  end

  def java_type
    "byte[]"
  end
end

# This represents a parameter to a node that is a location.
class LocationParam < Param
  def rbs_class
    "Location"
  end

  def java_type
    "Location"
  end
end

# This represents a parameter to a node that is a location that is optional.
class OptionalLocationParam < Param
  def rbs_class
    "Location?"
  end

  def java_type
    "Location"
  end
end

# This represents an integer parameter.
class UInt32Param < Param
  def rbs_class
    "Integer"
  end

  def java_type
    "int"
  end
end

# This represents a set of flags. It is very similar to the UInt32Param, but can
# be directly embedded into the flags field on the struct and provides
# convenient methods for checking if a flag is set.
class FlagsParam < Param
  def rbs_class
    "Integer"
  end

  def java_type
    "short"
  end

  def kind
    options.fetch(:kind)
  end
end

PARAM_TYPES = {
  "node" => NodeParam,
  "node?" => OptionalNodeParam,
  "node[]" => NodeListParam,
  "string" => StringParam,
  "location[]" => LocationListParam,
  "constant" => ConstantParam,
  "constant[]" => ConstantListParam,
  "location" => LocationParam,
  "location?" => OptionalLocationParam,
  "uint32" => UInt32Param,
  "flags" => FlagsParam
}

# This class represents a node in the tree, configured by the config.yml file in
# YAML format. It contains information about the name of the node and the
# various child nodes it contains.
class NodeType
  attr_reader :name, :type, :human, :params, :newline, :comment

  def initialize(config)
    @name = config.fetch("name")

    type = @name.gsub(/(?<=.)[A-Z]/, "_\\0")
    @type = "YP_NODE_#{type.upcase}"
    @human = type.downcase
    @params = config.fetch("child_nodes", []).map do |param|
      param_type = PARAM_TYPES[param.fetch("type")] ||
                   raise("Unknown param type: #{param["type"].inspect}")
      param_type.new(**param.transform_keys(&:to_sym))
    end
    @newline = config.fetch("newline", true)
    @comment = config.fetch("comment")
  end

  # Should emit serialized length of node so implementations can skip
  # the node to enable lazy parsing.
  def needs_serialized_length?
    @name == "DefNode"
  end
end

# This represents a token in the lexer. They are configured through the
# config.yml file for now, but this will probably change as we transition to
# storing semantic strings instead of the lexer tokens.
class Token
  attr_reader :name, :value, :comment

  def initialize(config)
    @name = config.fetch("name")
    @value = config["value"]
    @comment = config.fetch("comment")
  end

  def declaration
    output = []
    output << "YP_TOKEN_#{name}"
    output << " = #{value}" if value
    output << ", // #{comment}"
    output.join
  end
end

# Represents a set of flags that should be internally represented with an enum.
class Flags
  attr_reader :name, :human, :values

  def initialize(config)
    @name = config.fetch("name")
    @human = @name.gsub(/(?<=.)[A-Z]/, "_\\0").downcase
    @values = config.fetch("values").map { |flag| Flag.new(flag) }
  end
end

class Flag
  attr_reader :name, :camelcase, :comment

  def initialize(config)
    @name = config.fetch("name")
    @camelcase = @name.split("_").map(&:capitalize).join
    @comment = config.fetch("comment")
  end
end

# This templates out a file using ERB with the given locals. The locals are
# derived from the config.yml file.
def template(name, locals, write_to: nil)
  filepath = "templates/#{name}.erb"
  template = File.expand_path("../#{filepath}", __dir__)
  write_to ||= File.expand_path("../#{name}", __dir__)

  if ERB.instance_method(:initialize).parameters.assoc(:key) # Ruby 2.6+
    erb = ERB.new(File.read(template), trim_mode: "-")
  else
    erb = ERB.new(File.read(template), nil, "-")
  end
  erb.filename = template

  non_ruby_heading = <<~HEADING
  /******************************************************************************/
  /* This file is generated by the templates/template.rb script and should not  */
  /* be modified manually. See                                                  */
  /* #{filepath + " " * (74 - filepath.size) } */
  /* if you are looking to modify the                                           */
  /* template                                                                   */
  /******************************************************************************/
  HEADING

  ruby_heading = <<~HEADING
  # frozen_string_literal: true
  =begin
  This file is generated by the templates/template.rb script and should not be
  modified manually. See #{filepath}
  if you are looking to modify the template
  =end

  HEADING

  heading = if File.extname(filepath.gsub(".erb", "")) == ".rb"
      ruby_heading
    else
      non_ruby_heading
    end

  contents = heading + erb.result_with_hash(locals)
  FileUtils.mkdir_p(File.dirname(write_to))
  File.write(write_to, contents)
end

def locals
  config = YAML.load_file(File.expand_path("../config.yml", __dir__))

  {
    nodes: config.fetch("nodes").map { |node| NodeType.new(node) }.sort_by(&:name),
    tokens: config.fetch("tokens").map { |token| Token.new(token) },
    flags: config.fetch("flags").map { |flags| Flags.new(flags) }
  }
end

TEMPLATES = [
  "ext/yarp/api_node.c",
  "include/yarp/ast.h",
  "java/org/yarp/Loader.java",
  "java/org/yarp/Nodes.java",
  "java/org/yarp/AbstractNodeVisitor.java",
  "lib/yarp/mutation_visitor.rb",
  "lib/yarp/node.rb",
  "lib/yarp/serialize.rb",
  "src/node.c",
  "src/prettyprint.c",
  "src/serialize.c",
  "src/token_type.c"
]

if __FILE__ == $0
  if ARGV.empty?
    TEMPLATES.each { |f| template(f, locals) }
  else
    name, write_to = ARGV
    template(name, locals, write_to: write_to)
  end
end