Flutter Impeller
impeller::compiler::Switches Class Reference

#include <switches.h>

Public Member Functions

 Switches ()
 
 ~Switches ()
 
 Switches (const fml::CommandLine &command_line)
 
bool AreValid (std::ostream &explain) const
 
std::vector< TargetPlatformPlatformsToCompile () const
 A vector containing at least one valid platform. More...
 
TargetPlatform SelectDefaultTargetPlatform () const
 
SourceOptions CreateSourceOptions (std::optional< TargetPlatform > target_platform=std::nullopt) const
 

Static Public Member Functions

static void PrintHelp (std::ostream &stream)
 

Public Attributes

std::shared_ptr< fml::UniqueFD > working_directory = nullptr
 
std::vector< IncludeDirinclude_directories = {}
 
std::string source_file_name = ""
 
SourceType input_type = SourceType::kUnknown
 
std::string sl_file_name = ""
 
bool iplr = false
 
std::string shader_bundle = ""
 
std::string spirv_file_name = ""
 
std::string reflection_json_name = ""
 
std::string reflection_header_name = ""
 
std::string reflection_cc_name = ""
 
std::string 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 = ""
 
bool use_half_textures = false
 
bool require_framebuffer_fetch = false
 

Detailed Description

Definition at line 21 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 159 of file switches.cc.

160  : working_directory(std::make_shared<fml::UniqueFD>(fml::OpenDirectory(
161  Utf8FromPath(std::filesystem::current_path()).c_str(),
162  false, // create if necessary,
163  fml::FilePermission::kRead))),
164  source_file_name(command_line.GetOptionValueWithDefault("input", "")),
165  input_type(SourceTypeFromCommandLine(command_line)),
166  sl_file_name(command_line.GetOptionValueWithDefault("sl", "")),
167  iplr(command_line.HasOption("iplr")),
169  command_line.GetOptionValueWithDefault("shader-bundle", "")),
170  spirv_file_name(command_line.GetOptionValueWithDefault("spirv", "")),
172  command_line.GetOptionValueWithDefault("reflection-json", "")),
174  command_line.GetOptionValueWithDefault("reflection-header", "")),
176  command_line.GetOptionValueWithDefault("reflection-cc", "")),
177  depfile_path(command_line.GetOptionValueWithDefault("depfile", "")),
178  json_format(command_line.HasOption("json")),
180  stoi(command_line.GetOptionValueWithDefault("gles-language-version",
181  "0"))),
183  command_line.GetOptionValueWithDefault("metal-version", "1.2")),
184  entry_point(
185  command_line.GetOptionValueWithDefault("entry-point", "main")),
186  use_half_textures(command_line.HasOption("use-half-textures")),
188  command_line.HasOption("require-framebuffer-fetch")),
189  target_platform_(TargetPlatformFromCommandLine(command_line)),
190  runtime_stages_(RuntimeStagesFromCommandLine(command_line)) {
191  auto language = ToLowerCase(
192  command_line.GetOptionValueWithDefault("source-language", "glsl"));
193 
194  source_language = ToSourceLanguage(language);
195 
196  if (!working_directory || !working_directory->is_valid()) {
197  return;
198  }
199 
200  for (const auto& include_dir_path : command_line.GetOptionValues("include")) {
201  if (!include_dir_path.data()) {
202  continue;
203  }
204 
205  // fml::OpenDirectoryReadOnly for Windows doesn't handle relative paths
206  // beginning with `../` well, so we build an absolute path.
207 
208  // Get the current working directory as a utf8 encoded string.
209  // Note that the `include_dir_path` is already utf8 encoded, and so we
210  // mustn't attempt to double-convert it to utf8 lest multi-byte characters
211  // will become mangled.
212  std::filesystem::path include_dir_absolute;
213  if (std::filesystem::path(include_dir_path).is_absolute()) {
214  include_dir_absolute = std::filesystem::path(include_dir_path);
215  } else {
216  auto cwd = Utf8FromPath(std::filesystem::current_path());
217  include_dir_absolute = std::filesystem::absolute(
218  std::filesystem::path(cwd) / include_dir_path);
219  }
220 
221  auto dir = std::make_shared<fml::UniqueFD>(fml::OpenDirectoryReadOnly(
222  *working_directory, include_dir_absolute.string().c_str()));
223  if (!dir || !dir->is_valid()) {
224  continue;
225  }
226 
227  IncludeDir dir_entry;
228  dir_entry.name = include_dir_path;
229  dir_entry.dir = std::move(dir);
230 
231  include_directories.emplace_back(std::move(dir_entry));
232  }
233 
234  for (const auto& define : command_line.GetOptionValues("define")) {
235  defines.emplace_back(define);
236  }
237 }

References defines, impeller::compiler::IncludeDir::dir, include_directories, impeller::compiler::IncludeDir::name, 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 239 of file switches.cc.

239  {
240  // When producing a shader bundle, all flags related to single shader inputs
241  // and outputs such as `--input` and `--spirv-file-name` are ignored. Instead,
242  // input files are read from the shader bundle spec and a single flatbuffer
243  // containing all compiled shaders and reflection state is output to `--sl`.
244  const bool shader_bundle_mode = !shader_bundle.empty();
245 
246  bool valid = true;
247  if (target_platform_ == TargetPlatform::kUnknown && runtime_stages_.empty() &&
248  !shader_bundle_mode) {
249  explain << "Either a target platform was not specified, or no runtime "
250  "stages were specified."
251  << std::endl;
252  valid = false;
253  }
254 
255  if (source_language == SourceLanguage::kUnknown && !shader_bundle_mode) {
256  explain << "Invalid source language type." << std::endl;
257  valid = false;
258  }
259 
260  if (!working_directory || !working_directory->is_valid()) {
261  explain << "Could not open the working directory: \""
262  << Utf8FromPath(std::filesystem::current_path()).c_str() << "\""
263  << std::endl;
264  valid = false;
265  }
266 
267  if (source_file_name.empty() && !shader_bundle_mode) {
268  explain << "Input file name was empty." << std::endl;
269  valid = false;
270  }
271 
272  if (sl_file_name.empty()) {
273  explain << "Target shading language file name was empty." << std::endl;
274  valid = false;
275  }
276 
277  if (spirv_file_name.empty() && !shader_bundle_mode) {
278  explain << "Spirv file name was empty." << std::endl;
279  valid = false;
280  }
281 
282  if (iplr && shader_bundle_mode) {
283  explain << "--iplr and --shader-bundle flag cannot be specified at the "
284  "same time"
285  << std::endl;
286  valid = false;
287  }
288 
289  return valid;
290 }

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(), and impeller::compiler::testing::TEST().

◆ CreateSourceOptions()

SourceOptions impeller::compiler::Switches::CreateSourceOptions ( std::optional< TargetPlatform target_platform = std::nullopt) const

Definition at line 307 of file switches.cc.

308  {
309  SourceOptions options;
310  options.target_platform =
311  target_platform.value_or(SelectDefaultTargetPlatform());
312  options.source_language = source_language;
315  } else {
316  options.type = input_type;
317  }
318  options.working_directory = working_directory;
319  options.file_name = source_file_name;
320  options.include_dirs = include_directories;
321  options.defines = defines;
322  options.entry_point_name = EntryPointFunctionNameFromSourceName(
323  source_file_name, options.type, options.source_language, entry_point);
324  options.json_format = json_format;
325  options.gles_language_version = gles_language_version;
326  options.metal_version = metal_version;
327  options.use_half_textures = use_half_textures;
328  options.require_framebuffer_fetch = require_framebuffer_fetch;
329  return options;
330 }

References impeller::compiler::SourceOptions::defines, defines, entry_point, impeller::compiler::SourceOptions::entry_point_name, impeller::compiler::EntryPointFunctionNameFromSourceName(), impeller::compiler::SourceOptions::file_name, impeller::compiler::SourceOptions::gles_language_version, gles_language_version, include_directories, impeller::compiler::SourceOptions::include_dirs, input_type, impeller::compiler::SourceOptions::json_format, json_format, impeller::compiler::kUnknown, impeller::compiler::SourceOptions::metal_version, metal_version, impeller::compiler::SourceOptions::require_framebuffer_fetch, require_framebuffer_fetch, SelectDefaultTargetPlatform(), source_file_name, impeller::compiler::SourceOptions::source_language, source_language, impeller::compiler::SourceTypeFromFileName(), impeller::compiler::SourceOptions::target_platform, impeller::compiler::SourceOptions::type, impeller::compiler::SourceOptions::use_half_textures, use_half_textures, working_directory, and impeller::compiler::SourceOptions::working_directory.

Referenced by impeller::compiler::CompileSkSL(), impeller::compiler::GenerateShaderBundle(), impeller::compiler::Main(), and impeller::compiler::OutputIPLR().

◆ PlatformsToCompile()

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

A vector containing at least one valid platform.

Definition at line 292 of file switches.cc.

292  {
293  if (target_platform_ == TargetPlatform::kUnknown) {
294  return runtime_stages_;
295  }
296  return {target_platform_};
297 }

References impeller::compiler::kUnknown.

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

◆ PrintHelp()

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

Definition at line 41 of file switches.cc.

41  {
42  // clang-format off
43  const std::string optional_prefix = "[optional] ";
44  const std::string optional_multiple_prefix = "[optional,multiple] ";
45  // clang-format on
46 
47  stream << std::endl;
48  stream << "ImpellerC is an offline shader processor and reflection engine."
49  << std::endl;
50  stream << "---------------------------------------------------------------"
51  << std::endl;
52  stream << "Expected invocation is:" << std::endl << std::endl;
53  stream << "./impellerc <One platform or multiple runtime stages> "
54  "--input=<source_file> --sl=<sl_output_file> <optional arguments>"
55  << std::endl
56  << std::endl;
57 
58  stream << "Valid platforms are:" << std::endl << std::endl;
59  stream << "One of [";
60  for (const auto& platform : kKnownPlatforms) {
61  stream << " --" << platform.first;
62  }
63  stream << " ]" << std::endl << std::endl;
64 
65  stream << "Valid runtime stages are:" << std::endl << std::endl;
66  stream << "At least one of [";
67  for (const auto& platform : kKnownRuntimeStages) {
68  stream << " --" << platform.first;
69  }
70  stream << " ]" << std::endl << std::endl;
71 
72  stream << "Optional arguments:" << std::endl << std::endl;
73  stream << optional_prefix
74  << "--spirv=<spirv_output_file> (ignored for --shader-bundle)"
75  << std::endl;
76  stream << optional_prefix << "--input-type={";
77  for (const auto& source_type : kKnownSourceTypes) {
78  stream << source_type.first << ", ";
79  }
80  stream << "}" << std::endl;
81  stream << optional_prefix << "--source-language=glsl|hlsl (default: glsl)"
82  << std::endl;
83  stream << optional_prefix
84  << "--entry-point=<entry_point_name> (default: main; "
85  "ignored for glsl)"
86  << std::endl;
87  stream << optional_prefix
88  << "--iplr (causes --sl file to be emitted in "
89  "iplr format)"
90  << std::endl;
91  stream << optional_prefix
92  << "--shader-bundle=<bundle_spec> (causes --sl "
93  "file to be "
94  "emitted in Flutter GPU's shader bundle format)"
95  << std::endl;
96  stream << optional_prefix << "--reflection-json=<reflection_json_file>"
97  << std::endl;
98  stream << optional_prefix << "--reflection-header=<reflection_header_file>"
99  << std::endl;
100  stream << optional_prefix << "--reflection-cc=<reflection_cc_file>"
101  << std::endl;
102  stream << optional_multiple_prefix << "--include=<include_directory>"
103  << std::endl;
104  stream << optional_multiple_prefix << "--define=<define>" << std::endl;
105  stream << optional_prefix << "--depfile=<depfile_path>" << std::endl;
106  stream << optional_prefix << "--gles-language-version=<number>" << std::endl;
107  stream << optional_prefix << "--json" << std::endl;
108  stream << optional_prefix
109  << "--use-half-textures (force openGL semantics when "
110  "targeting metal)"
111  << std::endl;
112  stream << optional_prefix << "--require-framebuffer-fetch" << std::endl;
113 }

References impeller::compiler::kKnownPlatforms, impeller::compiler::kKnownRuntimeStages, and impeller::compiler::kKnownSourceTypes.

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

◆ SelectDefaultTargetPlatform()

TargetPlatform impeller::compiler::Switches::SelectDefaultTargetPlatform ( ) const

Definition at line 299 of file switches.cc.

299  {
300  if (target_platform_ == TargetPlatform::kUnknown &&
301  !runtime_stages_.empty()) {
302  return runtime_stages_.front();
303  }
304  return target_platform_;
305 }

References impeller::compiler::kUnknown.

Referenced by CreateSourceOptions(), impeller::compiler::OutputDepfile(), and impeller::compiler::OutputIPLR().

Member Data Documentation

◆ defines

std::vector<std::string> impeller::compiler::Switches::defines = {}

Definition at line 38 of file switches.h.

Referenced by CreateSourceOptions(), and Switches().

◆ depfile_path

std::string impeller::compiler::Switches::depfile_path = ""

Definition at line 37 of file switches.h.

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

◆ entry_point

std::string impeller::compiler::Switches::entry_point = ""

Definition at line 43 of file switches.h.

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

◆ gles_language_version

uint32_t impeller::compiler::Switches::gles_language_version = 0

Definition at line 41 of file switches.h.

Referenced by CreateSourceOptions().

◆ include_directories

std::vector<IncludeDir> impeller::compiler::Switches::include_directories = {}

Definition at line 24 of file switches.h.

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

◆ input_type

SourceType impeller::compiler::Switches::input_type = SourceType::kUnknown

Definition at line 26 of file switches.h.

Referenced by CreateSourceOptions().

◆ iplr

bool impeller::compiler::Switches::iplr = false

Definition at line 31 of file switches.h.

Referenced by AreValid(), impeller::compiler::Main(), and impeller::compiler::OutputIPLR().

◆ json_format

bool impeller::compiler::Switches::json_format = false

Definition at line 39 of file switches.h.

Referenced by CreateSourceOptions(), and impeller::compiler::OutputIPLR().

◆ metal_version

std::string impeller::compiler::Switches::metal_version = ""

Definition at line 42 of file switches.h.

Referenced by CreateSourceOptions().

◆ reflection_cc_name

std::string impeller::compiler::Switches::reflection_cc_name = ""

Definition at line 36 of file switches.h.

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

◆ reflection_header_name

std::string impeller::compiler::Switches::reflection_header_name = ""

◆ reflection_json_name

std::string impeller::compiler::Switches::reflection_json_name = ""

Definition at line 34 of file switches.h.

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

◆ require_framebuffer_fetch

bool impeller::compiler::Switches::require_framebuffer_fetch = false

Definition at line 45 of file switches.h.

Referenced by CreateSourceOptions().

◆ shader_bundle

std::string impeller::compiler::Switches::shader_bundle = ""

◆ sl_file_name

std::string impeller::compiler::Switches::sl_file_name = ""

The raw shader file output by the compiler. For –iplr and –shader-bundle modes, this is used as the filename for the output flatbuffer output.

Definition at line 30 of file switches.h.

Referenced by AreValid(), impeller::compiler::GenerateShaderBundle(), impeller::compiler::OutputDepfile(), impeller::compiler::OutputIPLR(), and impeller::compiler::OutputSLFile().

◆ source_file_name

std::string impeller::compiler::Switches::source_file_name = ""

◆ source_language

SourceLanguage impeller::compiler::Switches::source_language = SourceLanguage::kUnknown

◆ spirv_file_name

std::string impeller::compiler::Switches::spirv_file_name = ""

◆ use_half_textures

bool impeller::compiler::Switches::use_half_textures = false

Definition at line 44 of file switches.h.

Referenced by CreateSourceOptions().

◆ working_directory


The documentation for this class was generated from the following files:
impeller::compiler::Switches::reflection_cc_name
std::string reflection_cc_name
Definition: switches.h:36
impeller::compiler::RuntimeStagesFromCommandLine
static std::vector< TargetPlatform > RuntimeStagesFromCommandLine(const fml::CommandLine &command_line)
Definition: switches.cc:137
impeller::compiler::Switches::reflection_header_name
std::string reflection_header_name
Definition: switches.h:35
impeller::compiler::ToLowerCase
std::string ToLowerCase(std::string_view string)
Definition: utilities.cc:62
impeller::compiler::SourceType::kUnknown
@ kUnknown
impeller::compiler::Switches::SelectDefaultTargetPlatform
TargetPlatform SelectDefaultTargetPlatform() const
Definition: switches.cc:299
impeller::compiler::Switches::metal_version
std::string metal_version
Definition: switches.h:42
impeller::compiler::Switches::gles_language_version
uint32_t gles_language_version
Definition: switches.h:41
impeller::compiler::Switches::spirv_file_name
std::string spirv_file_name
Definition: switches.h:33
impeller::compiler::kKnownPlatforms
static const std::map< std::string, TargetPlatform > kKnownPlatforms
Definition: switches.cc:20
impeller::compiler::Switches::json_format
bool json_format
Definition: switches.h:39
impeller::compiler::Switches::use_half_textures
bool use_half_textures
Definition: switches.h:44
impeller::compiler::Switches::reflection_json_name
std::string reflection_json_name
Definition: switches.h:34
impeller::compiler::TargetPlatformFromCommandLine
static TargetPlatform TargetPlatformFromCommandLine(const fml::CommandLine &command_line)
Definition: switches.cc:119
impeller::compiler::ToSourceLanguage
SourceLanguage ToSourceLanguage(const std::string &source_language)
Definition: types.cc:64
impeller::compiler::Switches::require_framebuffer_fetch
bool require_framebuffer_fetch
Definition: switches.h:45
impeller::compiler::Switches::defines
std::vector< std::string > defines
Definition: switches.h:38
impeller::compiler::EntryPointFunctionNameFromSourceName
std::string EntryPointFunctionNameFromSourceName(const std::string &file_name, SourceType type, SourceLanguage source_language, const std::string &entry_point_name)
Definition: types.cc:111
impeller::compiler::SourceLanguage::kUnknown
@ kUnknown
impeller::compiler::Switches::sl_file_name
std::string sl_file_name
Definition: switches.h:30
impeller::compiler::SourceTypeFromFileName
SourceType SourceTypeFromFileName(const std::string &file_name)
Definition: types.cc:30
impeller::compiler::Switches::iplr
bool iplr
Definition: switches.h:31
impeller::compiler::Switches::input_type
SourceType input_type
Definition: switches.h:26
impeller::compiler::SourceTypeFromCommandLine
static SourceType SourceTypeFromCommandLine(const fml::CommandLine &command_line)
Definition: switches.cc:148
impeller::compiler::TargetPlatform::kUnknown
@ kUnknown
impeller::compiler::Switches::source_language
SourceLanguage source_language
Definition: switches.h:40
impeller::compiler::Switches::entry_point
std::string entry_point
Definition: switches.h:43
impeller::compiler::kKnownSourceTypes
static const std::map< std::string, SourceType > kKnownSourceTypes
Definition: switches.cc:35
impeller::compiler::Utf8FromPath
std::string Utf8FromPath(const std::filesystem::path &path)
Converts a native format path to a utf8 string.
Definition: utilities.cc:30
impeller::compiler::Switches::include_directories
std::vector< IncludeDir > include_directories
Definition: switches.h:24
impeller::compiler::Switches::depfile_path
std::string depfile_path
Definition: switches.h:37
impeller::compiler::kKnownRuntimeStages
static const std::map< std::string, TargetPlatform > kKnownRuntimeStages
Definition: switches.cc:28
impeller::compiler::Switches::source_file_name
std::string source_file_name
Definition: switches.h:25
impeller::compiler::Switches::working_directory
std::shared_ptr< fml::UniqueFD > working_directory
Definition: switches.h:23
impeller::compiler::Switches::shader_bundle
std::string shader_bundle
Definition: switches.h:32