| 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 18 of file compiler_test.h.

## Constructor & Destructor Documentation

## ◆ CompilerTest()

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

Definition at line 26 of file compiler_test.cc.

26 : intermediates_path_(GetIntermediatesPath()) {
27 intermediates_directory_ =
28 fml::OpenDirectory(intermediates_path_.c_str(),
29 true, // create if necessary
30 fml::FilePermission::kReadWrite);
31 FML_CHECK(intermediates_directory_.is_valid());
32 }

## ◆ ~CompilerTest()

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

Definition at line 34 of file compiler_test.cc.

34 {
35 intermediates_directory_.reset();
36
37 std::filesystem::remove_all(std::filesystem::path(intermediates_path_));
38 }

## 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 86 of file compiler_test.cc.

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

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 71 of file compiler_test.cc.

72 {
73 auto filename = ReflectionJSONName(fixture_name);
74 auto fd = fml::OpenFileReadOnly(intermediates_directory_, filename.c_str());
75 return fml::FileMapping::CreateReadOnly(fd);
76 }

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 78 of file compiler_test.cc.

80 {
81 auto filename = SLFileName(fixture_name, platform);
82 auto fd = fml::OpenFileReadOnly(intermediates_directory_, filename.c_str());
83 return fml::FileMapping::CreateReadOnly(fd);
84 }

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:64
impeller::compiler::testing::ReflectionCCName
static std::string ReflectionCCName(const char *fixture_name)
Definition: compiler_test.cc:46
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:40
impeller::compiler::testing::SPIRVFileName
static std::string SPIRVFileName(const char *fixture_name)
Definition: compiler_test.cc:58
impeller::compiler::testing::ReflectionJSONName
static std::string ReflectionJSONName(const char *fixture_name)
Definition: compiler_test.cc:52
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:91
impeller::compiler::testing::GetIntermediatesPath
static std::string GetIntermediatesPath()
Definition: compiler_test.cc:16