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 160 of file switches.cc.

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

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 240 of file switches.cc.

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

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 308 of file switches.cc.

309  {
310  SourceOptions options;
311  options.target_platform =
312  target_platform.value_or(SelectDefaultTargetPlatform());
313  options.source_language = source_language;
316  } else {
317  options.type = input_type;
318  }
319  options.working_directory = working_directory;
320  options.file_name = source_file_name;
321  options.include_dirs = include_directories;
322  options.defines = defines;
323  options.entry_point_name = EntryPointFunctionNameFromSourceName(
324  source_file_name, options.type, options.source_language, entry_point);
325  options.json_format = json_format;
326  options.gles_language_version = gles_language_version;
327  options.metal_version = metal_version;
328  options.use_half_textures = use_half_textures;
329  options.require_framebuffer_fetch = require_framebuffer_fetch;
330  return options;
331 }
TargetPlatform SelectDefaultTargetPlatform() const
Definition: switches.cc:300
SourceType SourceTypeFromFileName(const std::string &file_name)
Definition: types.cc:30
std::string EntryPointFunctionNameFromSourceName(const std::string &file_name, SourceType type, SourceLanguage source_language, const std::string &entry_point_name)
Definition: types.cc:113

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, impeller::compiler::SourceOptions::working_directory, and 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 293 of file switches.cc.

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

References impeller::compiler::kUnknown.

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

◆ PrintHelp()

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

Definition at line 42 of file switches.cc.

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

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 300 of file switches.cc.

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

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: