#include <switches.h>

Public Member Functions
	Switches ()

	~Switches ()

	Switches (const fml::CommandLine &command_line)

bool	AreValid (std::ostream &explain) const

std::vector< TargetPlatform >	PlatformsToCompile () const
	A vector containing at least one valid platform.

SourceOptions	CreateSourceOptions () const

Static Public Member Functions
static void	PrintHelp (std::ostream &stream)

Public Attributes
std::shared_ptr< fml::UniqueFD >	working_directory = nullptr

std::vector< IncludeDir >	include_directories = {}

std::filesystem::path	source_file_name

SourceType	input_type = SourceType::kUnknown

std::filesystem::path	sl_file_name

bool	iplr = false

std::string	shader_bundle = ""

std::filesystem::path	spirv_file_name

std::filesystem::path	reflection_json_name

std::filesystem::path	reflection_header_name

std::filesystem::path	reflection_cc_name

std::filesystem::path	depfile_path

std::vector< std::string >	defines = {}

bool	json_format = false

SourceLanguage	source_language = SourceLanguage::kUnknown

uint32_t	gles_language_version = 0

std::string	metal_version = ""

std::string	entry_point = ""

std::string	entry_point_prefix = ""

bool	use_half_textures = false

bool	require_framebuffer_fetch = false

bool	verbose = false

Detailed Description

Definition at line 22 of file switches.h.

Constructor & Destructor Documentation

◆ Switches() [1/2]

impeller::compiler::Switches::Switches ( )

default

◆ ~Switches()

impeller::compiler::Switches::~Switches ( )

default

◆ Switches() [2/2]

impeller::compiler::Switches::Switches ( const fml::CommandLine & command_line )

explicit

Definition at line 178 of file switches.cc.

    : working_directory(std::make_shared<fml::UniqueFD>(fml::OpenDirectory(
          Utf8FromPath(std::filesystem::current_path()).c_str(),
          false,  // create if necessary,
          fml::FilePermission::kRead))),
      source_file_name(GetOptionAsPath(command_line, "input")),
      input_type(SourceTypeFromCommandLine(command_line)),
      sl_file_name(GetOptionAsPath(command_line, "sl")),
      iplr(command_line.HasOption("iplr")),
      shader_bundle(
          command_line.GetOptionValueWithDefault("shader-bundle", "")),
      spirv_file_name(GetOptionAsPath(command_line, "spirv")),
      reflection_json_name(GetOptionAsPath(command_line, "reflection-json")),
      reflection_header_name(
          GetOptionAsPath(command_line, "reflection-header")),
      reflection_cc_name(GetOptionAsPath(command_line, "reflection-cc")),
      depfile_path(GetOptionAsPath(command_line, "depfile")),
      json_format(command_line.HasOption("json")),
      gles_language_version(
          stoi(command_line.GetOptionValueWithDefault("gles-language-version",
                                                      "0"))),
      metal_version(
          command_line.GetOptionValueWithDefault("metal-version", "1.2")),
      entry_point(
          command_line.GetOptionValueWithDefault("entry-point", "main")),
      entry_point_prefix(
          command_line.GetOptionValueWithDefault("entry-point-prefix", "")),
      use_half_textures(command_line.HasOption("use-half-textures")),
      require_framebuffer_fetch(
          command_line.HasOption("require-framebuffer-fetch")),
      verbose(command_line.HasOption("verbose")),
      target_platform_(TargetPlatformFromCommandLine(command_line)),
      runtime_stages_(RuntimeStagesFromCommandLine(command_line)) {
  auto language = ToLowerCase(
      command_line.GetOptionValueWithDefault("source-language", "glsl"));
 
  source_language = ToSourceLanguage(language);
 
  if (!working_directory || !working_directory->is_valid()) {
    return;
  }
 
  for (const auto& include_dir_path : command_line.GetOptionValues("include")) {
    if (!include_dir_path.data()) {
      continue;
    }
 
    // fml::OpenDirectoryReadOnly for Windows doesn't handle relative paths
    // beginning with `../` well, so we build an absolute path.
 
    // Get the current working directory as a utf8 encoded string.
    // Note that the `include_dir_path` is already utf8 encoded, and so we
    // mustn't attempt to double-convert it to utf8 lest multi-byte characters
    // will become mangled.
    std::filesystem::path include_dir_absolute;
    if (std::filesystem::path(include_dir_path).is_absolute()) {
      include_dir_absolute = std::filesystem::path(include_dir_path);
    } else {
      auto cwd = Utf8FromPath(std::filesystem::current_path());
      include_dir_absolute = std::filesystem::absolute(
          std::filesystem::path(cwd) / include_dir_path);
    }
 
    auto dir = std::make_shared<fml::UniqueFD>(fml::OpenDirectoryReadOnly(
        *working_directory, include_dir_absolute.string().c_str()));
    if (!dir || !dir->is_valid()) {
      continue;
    }
 
    IncludeDir dir_entry;
    dir_entry.name = include_dir_path;
    dir_entry.dir = std::move(dir);
 
    include_directories.emplace_back(std::move(dir_entry));
  }
 
  for (const auto& define : command_line.GetOptionValues("define")) {
    defines.emplace_back(define);
  }
}

References defines, impeller::compiler::IncludeDir::dir, fml::CommandLine::GetOptionValues(), fml::CommandLine::GetOptionValueWithDefault(), include_directories, impeller::compiler::IncludeDir::name, fml::OpenDirectoryReadOnly(), source_language, impeller::compiler::ToLowerCase(), impeller::compiler::ToSourceLanguage(), impeller::compiler::Utf8FromPath(), and working_directory.

Member Function Documentation

◆ AreValid()

bool impeller::compiler::Switches::AreValid ( std::ostream & explain ) const

Definition at line 259 of file switches.cc.

                                                 {
  // When producing a shader bundle, all flags related to single shader inputs
  // and outputs such as `--input` and `--spirv-file-name` are ignored. Instead,
  // input files are read from the shader bundle spec and a single flatbuffer
  // containing all compiled shaders and reflection state is output to `--sl`.
  const bool shader_bundle_mode = !shader_bundle.empty();
 
  bool valid = true;
  if (target_platform_ == TargetPlatform::kUnknown && runtime_stages_.empty() &&
      !shader_bundle_mode) {
    explain << "Either a target platform was not specified, or no runtime "
               "stages were specified."
            << std::endl;
    valid = false;
  }
 
  if (source_language == SourceLanguage::kUnknown && !shader_bundle_mode) {
    explain << "Invalid source language type." << std::endl;
    valid = false;
  }
 
  if (!working_directory || !working_directory->is_valid()) {
    explain << "Could not open the working directory: \""
            << Utf8FromPath(std::filesystem::current_path()).c_str() << "\""
            << std::endl;
    valid = false;
  }
 
  if (source_file_name.empty() && !shader_bundle_mode) {
    explain << "Input file name was empty." << std::endl;
    valid = false;
  }
 
  if (sl_file_name.empty()) {
    explain << "Target shading language file name was empty." << std::endl;
    valid = false;
  }
 
  if (spirv_file_name.empty() && !shader_bundle_mode) {
    explain << "Spirv file name was empty." << std::endl;
    valid = false;
  }
 
  if (iplr && shader_bundle_mode) {
    explain << "--iplr and --shader-bundle flag cannot be specified at the "
               "same time"
            << std::endl;
    valid = false;
  }
 
  return valid;
}

References iplr, impeller::compiler::kUnknown, shader_bundle, sl_file_name, source_file_name, source_language, spirv_file_name, impeller::compiler::Utf8FromPath(), and working_directory.

Referenced by impeller::compiler::Main(), impeller::compiler::testing::TEST(), impeller::compiler::testing::TEST(), impeller::compiler::testing::TEST(), impeller::compiler::testing::TEST(), impeller::compiler::testing::TEST(), impeller::compiler::testing::TEST(), impeller::compiler::testing::TEST(), and impeller::compiler::testing::TEST().

◆ CreateSourceOptions()

SourceOptions impeller::compiler::Switches::CreateSourceOptions ( ) const

Creates source options from these switches. The returned options does not have a set TargetPlatform because that cannot be determined based purely on the switches. Clients must set a valid TargetPlatform on the returned options before before it is used.

Definition at line 319 of file switches.cc.

                                                  {
  SourceOptions options;
  options.source_language = source_language;
  if (input_type == SourceType::kUnknown) {
    options.type = SourceTypeFromFileName(source_file_name);
  } else {
    options.type = input_type;
  }
  options.working_directory = working_directory;
  options.file_name = source_file_name;
  options.include_dirs = include_directories;
  options.defines = defines;
  options.entry_point_name =
      entry_point_prefix +
      EntryPointFunctionNameFromSourceName(
          source_file_name, options.type, options.source_language, entry_point);
  options.json_format = json_format;
  options.gles_language_version = gles_language_version;
  options.metal_version = metal_version;
  options.use_half_textures = use_half_textures;
  options.require_framebuffer_fetch = require_framebuffer_fetch;
  return options;
}

Referenced by impeller::compiler::GenerateShaderBundle(), and impeller::compiler::testing::TEST().

◆ PlatformsToCompile()

std::vector< TargetPlatform > impeller::compiler::Switches::PlatformsToCompile ( ) const

A vector containing at least one valid platform.

Definition at line 312 of file switches.cc.

                                                             {
  if (target_platform_ == TargetPlatform::kUnknown) {
    return runtime_stages_;
  }
  return {target_platform_};
}

References impeller::compiler::kUnknown.

Referenced by impeller::compiler::Main().

◆ PrintHelp()

void impeller::compiler::Switches::PrintHelp ( std::ostream & stream )

static

Definition at line 43 of file switches.cc.

                                           {
  // clang-format off
  const std::string optional_prefix =          "[optional]          ";
  const std::string optional_multiple_prefix = "[optional,multiple] ";
  // clang-format on
 
  stream << std::endl;
  stream << "ImpellerC is an offline shader processor and reflection engine."
         << std::endl;
  stream << "---------------------------------------------------------------"
         << std::endl;
  stream << "Expected invocation is:" << std::endl << std::endl;
  stream << "./impellerc <One platform or multiple runtime stages> "
            "--input=<source_file> --sl=<sl_output_file> <optional arguments>"
         << std::endl
         << std::endl;
 
  stream << "Valid platforms are:" << std::endl << std::endl;
  stream << "One of [";
  for (const auto& platform : kKnownPlatforms) {
    stream << " --" << platform.first;
  }
  stream << " ]" << std::endl << std::endl;
 
  stream << "Valid runtime stages are:" << std::endl << std::endl;
  stream << "At least one of [";
  for (const auto& platform : kKnownRuntimeStages) {
    stream << " --" << platform.first;
  }
  stream << " ]" << std::endl << std::endl;
 
  stream << "Optional arguments:" << std::endl << std::endl;
  stream << optional_prefix
         << "--spirv=<spirv_output_file> (ignored for --shader-bundle)"
         << std::endl;
  stream << optional_prefix << "--input-type={";
  for (const auto& source_type : kKnownSourceTypes) {
    stream << source_type.first << ", ";
  }
  stream << "}" << std::endl;
  stream << optional_prefix << "--source-language=glsl|hlsl (default: glsl)"
         << std::endl;
  stream << optional_prefix
         << "--entry-point=<entry_point_name> (default: main; "
            "ignored for glsl)"
         << std::endl;
  stream << optional_prefix
         << "--entry-point-prefix=<entry_point_prefix> (default: empty)"
         << std::endl;
  stream << optional_prefix
         << "--iplr (causes --sl file to be emitted in "
            "iplr format)"
         << std::endl;
  stream << optional_prefix
         << "--shader-bundle=<bundle_spec> (causes --sl "
            "file to be "
            "emitted in Flutter GPU's shader bundle format)"
         << std::endl;
  stream << optional_prefix << "--reflection-json=<reflection_json_file>"
         << std::endl;
  stream << optional_prefix << "--reflection-header=<reflection_header_file>"
         << std::endl;
  stream << optional_prefix << "--reflection-cc=<reflection_cc_file>"
         << std::endl;
  stream << optional_multiple_prefix << "--include=<include_directory>"
         << std::endl;
  stream << optional_multiple_prefix << "--define=<define>" << std::endl;
  stream << optional_prefix << "--depfile=<depfile_path>" << std::endl;
  stream << optional_prefix << "--gles-language-version=<number>" << std::endl;
  stream << optional_prefix << "--json" << std::endl;
  stream << optional_prefix
         << "--use-half-textures (force openGL semantics when "
            "targeting metal)"
         << std::endl;
  stream << optional_prefix << "--require-framebuffer-fetch" << std::endl;
  stream << optional_prefix
         << "--verbose (output full error messages in stderr. If not set, long "
            "error messages are written to a file, and a truncated version is "
            "output to stderr)"
         << std::endl;
}