| Flutter Impeller |

Public Member Functions | List of all members
impeller::compiler::testing::CompilerTest Class Reference

`#include <compiler_test.h>`

Inheritance diagram for impeller::compiler::testing::CompilerTest:

## Public Member Functions
| CompilerTest ()
| ~CompilerTest ()
std::unique_ptr< fml::FileMapping > | GetReflectionJson (const char *fixture_name) const
std::unique_ptr< fml::FileMapping > | GetShaderFile (const char *fixture_name, TargetPlatform platform) const
bool | CanCompileAndReflect (const char *fixture_name, SourceType source_type=SourceType::kUnknown, SourceLanguage source_language=SourceLanguage::kGLSL, const char *entry_point_name="main") const

## Detailed Description

Definition at line 19 of file compiler_test.h.

## Constructor & Destructor Documentation

## ◆ CompilerTest()

impeller::compiler::testing::CompilerTest::CompilerTest | ( |  | ) |

Definition at line 23 of file compiler_test.cc.

24 : intermediates_directory_(CreateIntermediatesDirectory()) {
25 FML_CHECK(intermediates_directory_.is_valid());
26 }

## ◆ ~CompilerTest()

impeller::compiler::testing::CompilerTest::~CompilerTest | ( |  | ) |
| default

## Member Function Documentation

## ◆ CanCompileAndReflect()

bool impeller::compiler::testing::CompilerTest::CanCompileAndReflect | ( | const char * | fixture_name,
|  | SourceType | source_type = `SourceType::kUnknown`,
|  | SourceLanguage | source_language = `SourceLanguage::kGLSL`,
|  | const char * | entry_point_name = `"main"`
| ) |  | const

Definition at line 76 of file compiler_test.cc.

79 {
80 std::shared_ptr<fml::Mapping> fixture =
81 flutter::testing::OpenFixtureAsMapping(fixture_name);
82 if (!fixture || !fixture->GetMapping()) {
83 VALIDATION_LOG << "Could not find shader in fixtures: " << fixture_name;
84 return false;
85 }
86
87 SourceOptions source_options(fixture_name, source_type);
88 source_options.target_platform = GetParam();
89 source_options.source_language = source_language;
90 source_options.working_directory = std::make_shared<fml::UniqueFD>(
91 flutter::testing::OpenFixturesDirectory());
92 source_options.entry_point_name = EntryPointFunctionNameFromSourceName(
93 fixture_name, SourceTypeFromFileName(fixture_name), source_language,
94 entry_point_name);
95
96 Reflector::Options reflector_options;
97 reflector_options.header_file_name = ReflectionHeaderName(fixture_name);
98 reflector_options.shader_name = "shader_name";
99
100 Compiler compiler(fixture, source_options, reflector_options);
101 if (!compiler.IsValid()) {
102 VALIDATION_LOG << "Compilation failed: " << compiler.GetErrorMessages();
103 return false;
104 }
105
106 auto spirv_assembly = compiler.GetSPIRVAssembly();
107 if (!spirv_assembly) {
108 VALIDATION_LOG << "No spirv was generated.";
109 return false;
110 }
111
112 if (!fml::WriteAtomically(intermediates_directory_,
113 SPIRVFileName(fixture_name).c_str(),
114 *spirv_assembly)) {
115 VALIDATION_LOG << "Could not write SPIRV intermediates.";
116 return false;
117 }
118
119 auto sl_source = compiler.GetSLShaderSource();
120 if (!sl_source) {
121 VALIDATION_LOG << "No SL source was generated.";
122 return false;
123 }
124
125 if (!fml::WriteAtomically(intermediates_directory_,
126 SLFileName(fixture_name, GetParam()).c_str(),
127 *sl_source)) {
128 VALIDATION_LOG << "Could not write SL intermediates.";
129 return false;
130 }
131
132 if (TargetPlatformNeedsReflection(GetParam())) {
133 auto reflector = compiler.GetReflector();
134 if (!reflector) {
135 VALIDATION_LOG
136 << "No reflector was found for target platform SL compiler.";
137 return false;
138 }
139
140 auto reflection_json = reflector->GetReflectionJSON();
141 auto reflection_header = reflector->GetReflectionHeader();
142 auto reflection_source = reflector->GetReflectionCC();
143
144 if (!reflection_json) {
145 VALIDATION_LOG << "Reflection JSON was not found.";
146 return false;
147 }
148
149 if (!reflection_header) {
150 VALIDATION_LOG << "Reflection header was not found.";
151 return false;
152 }
153
154 if (!reflection_source) {
155 VALIDATION_LOG << "Reflection source was not found.";
156 return false;
157 }
158
159 if (!fml::WriteAtomically(intermediates_directory_,
160 ReflectionHeaderName(fixture_name).c_str(),
161 *reflection_header)) {
162 VALIDATION_LOG << "Could not write reflection header intermediates.";
163 return false;
164 }
165
166 if (!fml::WriteAtomically(intermediates_directory_,
167 ReflectionCCName(fixture_name).c_str(),
168 *reflection_source)) {
169 VALIDATION_LOG << "Could not write reflection CC intermediates.";
170 return false;
171 }
172
173 if (!fml::WriteAtomically(intermediates_directory_,
174 ReflectionJSONName(fixture_name).c_str(),
175 *reflection_json)) {
176 VALIDATION_LOG << "Could not write reflection json intermediates.";
177 return false;
178 }
179 }
180 return true;
181 }

References impeller::compiler::SourceOptions::entry_point_name, impeller::compiler::EntryPointFunctionNameFromSourceName(), impeller::compiler::Compiler::GetErrorMessages(), impeller::compiler::Compiler::GetReflector(), impeller::compiler::Compiler::GetSLShaderSource(), impeller::compiler::Compiler::GetSPIRVAssembly(), impeller::compiler::Reflector::Options::header_file_name, impeller::compiler::Compiler::IsValid(), impeller::compiler::testing::ReflectionCCName(), impeller::compiler::testing::ReflectionHeaderName(), impeller::compiler::testing::ReflectionJSONName(), impeller::compiler::Reflector::Options::shader_name, impeller::compiler::testing::SLFileName(), impeller::compiler::SourceOptions::source_language, impeller::compiler::SourceTypeFromFileName(), impeller::compiler::testing::SPIRVFileName(), impeller::compiler::SourceOptions::target_platform, impeller::compiler::TargetPlatformNeedsReflection(), VALIDATION_LOG, and impeller::compiler::SourceOptions::working_directory.

## ◆ GetReflectionJson()

std::unique_ptr< fml::FileMapping > impeller::compiler::testing::CompilerTest::GetReflectionJson | ( | const char * | fixture_name | ) | const

Definition at line 61 of file compiler_test.cc.

62 {
63 auto filename = ReflectionJSONName(fixture_name);
64 auto fd = fml::OpenFileReadOnly(intermediates_directory_, filename.c_str());
65 return fml::FileMapping::CreateReadOnly(fd);
66 }

References impeller::compiler::testing::ReflectionJSONName().

## ◆ GetShaderFile()

std::unique_ptr< fml::FileMapping > impeller::compiler::testing::CompilerTest::GetShaderFile | ( | const char * | fixture_name,
|  | TargetPlatform | platform
| ) |  | const

Definition at line 68 of file compiler_test.cc.

70 {
71 auto filename = SLFileName(fixture_name, platform);
72 auto fd = fml::OpenFileReadOnly(intermediates_directory_, filename.c_str());
73 return fml::FileMapping::CreateReadOnly(fd);
74 }

References impeller::compiler::testing::SLFileName().

The documentation for this class was generated from the following files:

- impeller/compiler/compiler_test.h
- impeller/compiler/compiler_test.cc

impeller::compiler::testing::SLFileName
static std::string SLFileName(const char *fixture_name, TargetPlatform platform)
Definition: compiler_test.cc:54
impeller::compiler::testing::ReflectionCCName
static std::string ReflectionCCName(const char *fixture_name)
Definition: compiler_test.cc:36
impeller::compiler::TargetPlatformNeedsReflection
bool TargetPlatformNeedsReflection(TargetPlatform platform)
Definition: types.cc:141
impeller::compiler::testing::ReflectionHeaderName
static std::string ReflectionHeaderName(const char *fixture_name)
Definition: compiler_test.cc:30
impeller::compiler::testing::SPIRVFileName
static std::string SPIRVFileName(const char *fixture_name)
Definition: compiler_test.cc:48
impeller::compiler::testing::ReflectionJSONName
static std::string ReflectionJSONName(const char *fixture_name)
Definition: compiler_test.cc:42
impeller::compiler::testing::CreateIntermediatesDirectory
static fml::UniqueFD CreateIntermediatesDirectory()
Definition: compiler_test.cc:13
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::SourceTypeFromFileName
SourceType SourceTypeFromFileName(const std::string &file_name)
Definition: types.cc:30
VALIDATION_LOG
#define VALIDATION_LOG
Definition: validation.h:67