module Jazzy::SymbolGraph

Public Class Methods

arguments(module_config, output_path) click to toggle source

Figure out the args to pass to symbolgraph-extract

# File lib/jazzy/symbol_graph.rb, line 40
def self.arguments(module_config, output_path)
  if module_config.module_name.empty?
    raise 'error: `--swift-build-tool symbolgraph` requires `--module`.'
  end

  user_args = module_config.build_tool_arguments.join

  if user_args =~ /-(?:module-name|minimum-access-level|output-dir)/
    raise 'error: `--build-tool-arguments` for ' \
      "`--swift-build-tool symbolgraph` can't use `-module`, " \
      '`-minimum-access-level`, or `-output-dir`.'
  end

  # Default set
  args = [
    '-module-name', module_config.module_name,
    '-minimum-access-level', 'private',
    '-output-dir', output_path,
    '-skip-synthesized-members'
  ]

  # Things user can override
  args += ['-sdk', sdk(module_config)] unless user_args =~ /-sdk/
  args += ['-target', target] unless user_args =~ /-target/
  args += ['-F', module_config.source_directory.to_s] unless user_args =~ /-F(?!s)/
  args += ['-I', module_config.source_directory.to_s] unless user_args =~ /-I/

  args + module_config.build_tool_arguments
end
build(module_config) click to toggle source

Find swift symbol graph files, either having been passed in directly, or generated by running`swift symbolgraph-extract` with configured args. Then parse the results, and return as JSON in SourceKit format.

# File lib/jazzy/symbol_graph.rb, line 23
def self.build(module_config)
  if module_config.symbolgraph_directory.nil?
    Dir.mktmpdir do |tmp_dir|
      args = arguments(module_config, tmp_dir)

      Executable.execute_command('swift',
                                 args.unshift('symbolgraph-extract'),
                                 true) # raise on error

      parse_symbols(tmp_dir)
    end
  else
    parse_symbols(module_config.symbolgraph_directory.to_s)
  end
end
demangle(usr) click to toggle source

This is a last-ditch fallback for when symbolgraph doesn’t provide a name - at least conforming external types to local protocols.

# File lib/jazzy/symbol_graph.rb, line 101
def self.demangle(usr)
  args = %w[demangle -simplified -compact].append(usr.sub(/^s:/, 's'))
  output, = Executable.execute_command('swift', args, true)
  output.chomp
rescue StandardError
  usr
end
parse_symbols(directory) click to toggle source

Parse the symbol files in the given directory

# File lib/jazzy/symbol_graph.rb, line 71
def self.parse_symbols(directory)
  Dir[directory + '/*.symbols.json'].sort.map do |filename|
    # The @ part is for extensions in our module (before the @)
    # of types in another module (after the @).
    File.basename(filename) =~ /(.*?)(@(.*?))?\.symbols/
    module_name = Regexp.last_match[1]
    ext_module_name = Regexp.last_match[3] || module_name
    json = File.read(filename)
    {
      filename =>
        Graph.new(json, module_name, ext_module_name).to_sourcekit,
    }
  end.to_json
end
sdk(module_config) click to toggle source

Get the SDK path. On !darwin this just isn’t needed.

# File lib/jazzy/symbol_graph.rb, line 87
def self.sdk(module_config)
  `xcrun --show-sdk-path --sdk #{module_config.sdk}`.chomp
end
target() click to toggle source

Guess a default LLVM target. Feels like the tool should figure this out from sdk + the binary somehow?

# File lib/jazzy/symbol_graph.rb, line 93
def self.target
  `swift -version` =~ /Target: (.*?)$/
  Regexp.last_match[1] || 'x86_64-apple-macosx10.15'
end