GenerateWebGLRenderingContext.cpp 39 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010
  1. /*
  2. * Copyright (c) 2024, Aliaksandr Kalenik <kalenik.aliaksandr@gmail.com>
  3. * Copyright (c) 2024, Luke Wilde <luke@ladybird.org>
  4. *
  5. * SPDX-License-Identifier: BSD-2-Clause
  6. */
  7. #include "BindingsGenerator/IDLGenerators.h"
  8. #include <AK/LexicalPath.h>
  9. #include <AK/SourceGenerator.h>
  10. #include <AK/StringBuilder.h>
  11. #include <LibCore/ArgsParser.h>
  12. #include <LibCore/File.h>
  13. #include <LibIDL/IDLParser.h>
  14. #include <LibMain/Main.h>
  15. static bool is_webgl_object_type(StringView type_name)
  16. {
  17. return type_name == "WebGLBuffer"sv
  18. || type_name == "WebGLFramebuffer"sv
  19. || type_name == "WebGLProgram"sv
  20. || type_name == "WebGLRenderbuffer"sv
  21. || type_name == "WebGLShader"sv
  22. || type_name == "WebGLTexture"sv
  23. || type_name == "WebGLUniformLocation"sv
  24. || type_name == "WebGLVertexArrayObject"sv;
  25. }
  26. static bool gl_function_modifies_framebuffer(StringView function_name)
  27. {
  28. return function_name == "clearColor"sv || function_name == "drawArrays"sv || function_name == "drawElements"sv;
  29. }
  30. static ByteString to_cpp_type(const IDL::Type& type, const IDL::Interface& interface)
  31. {
  32. if (type.name() == "undefined"sv)
  33. return "void"sv;
  34. if (type.name() == "object"sv) {
  35. if (type.is_nullable())
  36. return "JS::Object*"sv;
  37. return "JS::Object&"sv;
  38. }
  39. if (type.name() == "DOMString"sv) {
  40. if (type.is_nullable())
  41. return "Optional<String>"sv;
  42. return "String"sv;
  43. }
  44. auto cpp_type = idl_type_name_to_cpp_type(type, interface);
  45. return cpp_type.name;
  46. }
  47. static ByteString idl_to_gl_function_name(StringView function_name)
  48. {
  49. StringBuilder gl_function_name_builder;
  50. gl_function_name_builder.append("gl"sv);
  51. for (size_t i = 0; i < function_name.length(); ++i) {
  52. if (i == 0) {
  53. gl_function_name_builder.append(to_ascii_uppercase(function_name[i]));
  54. } else {
  55. gl_function_name_builder.append(function_name[i]);
  56. }
  57. }
  58. if (function_name == "clearDepth"sv || function_name == "depthRange"sv) {
  59. gl_function_name_builder.append("f"sv);
  60. }
  61. return gl_function_name_builder.to_byte_string();
  62. }
  63. struct NameAndType {
  64. StringView name;
  65. struct {
  66. StringView type;
  67. int element_count { 0 };
  68. } return_type;
  69. };
  70. static void generate_get_parameter(SourceGenerator& generator)
  71. {
  72. Vector<NameAndType> const name_to_type = {
  73. { "ACTIVE_TEXTURE"sv, { "GLenum"sv } },
  74. { "ALIASED_LINE_WIDTH_RANGE"sv, { "Float32Array"sv, 2 } },
  75. { "ALIASED_POINT_SIZE_RANGE"sv, { "Float32Array"sv, 2 } },
  76. { "ALPHA_BITS"sv, { "GLint"sv } },
  77. { "ARRAY_BUFFER_BINDING"sv, { "WebGLBuffer"sv } },
  78. { "BLEND"sv, { "GLboolean"sv } },
  79. { "BLEND_COLOR"sv, { "Float32Array"sv, 4 } },
  80. { "BLEND_DST_ALPHA"sv, { "GLenum"sv } },
  81. { "BLEND_DST_RGB"sv, { "GLenum"sv } },
  82. { "BLEND_EQUATION_ALPHA"sv, { "GLenum"sv } },
  83. { "BLEND_EQUATION_RGB"sv, { "GLenum"sv } },
  84. { "BLEND_SRC_ALPHA"sv, { "GLenum"sv } },
  85. { "BLEND_SRC_RGB"sv, { "GLenum"sv } },
  86. { "BLUE_BITS"sv, { "GLint"sv } },
  87. { "COLOR_CLEAR_VALUE"sv, { "Float32Array"sv, 4 } },
  88. // FIXME: { "COLOR_WRITEMASK"sv, { "sequence<GLboolean>"sv, 4 } },
  89. // FIXME: { "COMPRESSED_TEXTURE_FORMATS"sv, { "Uint32Array"sv } },
  90. { "CULL_FACE"sv, { "GLboolean"sv } },
  91. { "CULL_FACE_MODE"sv, { "GLenum"sv } },
  92. { "CURRENT_PROGRAM"sv, { "WebGLProgram"sv } },
  93. { "DEPTH_BITS"sv, { "GLint"sv } },
  94. { "DEPTH_CLEAR_VALUE"sv, { "GLfloat"sv } },
  95. { "DEPTH_FUNC"sv, { "GLenum"sv } },
  96. { "DEPTH_RANGE"sv, { "Float32Array"sv, 2 } },
  97. { "DEPTH_TEST"sv, { "GLboolean"sv } },
  98. { "DEPTH_WRITEMASK"sv, { "GLboolean"sv } },
  99. { "DITHER"sv, { "GLboolean"sv } },
  100. { "ELEMENT_ARRAY_BUFFER_BINDING"sv, { "WebGLBuffer"sv } },
  101. { "FRAMEBUFFER_BINDING"sv, { "WebGLFramebuffer"sv } },
  102. { "FRONT_FACE"sv, { "GLenum"sv } },
  103. { "GENERATE_MIPMAP_HINT"sv, { "GLenum"sv } },
  104. { "GREEN_BITS"sv, { "GLint"sv } },
  105. { "IMPLEMENTATION_COLOR_READ_FORMAT"sv, { "GLenum"sv } },
  106. { "IMPLEMENTATION_COLOR_READ_TYPE"sv, { "GLenum"sv } },
  107. { "LINE_WIDTH"sv, { "GLfloat"sv } },
  108. { "MAX_COMBINED_TEXTURE_IMAGE_UNITS"sv, { "GLint"sv } },
  109. { "MAX_CUBE_MAP_TEXTURE_SIZE"sv, { "GLint"sv } },
  110. { "MAX_FRAGMENT_UNIFORM_VECTORS"sv, { "GLint"sv } },
  111. { "MAX_RENDERBUFFER_SIZE"sv, { "GLint"sv } },
  112. { "MAX_TEXTURE_IMAGE_UNITS"sv, { "GLint"sv } },
  113. { "MAX_TEXTURE_SIZE"sv, { "GLint"sv } },
  114. { "MAX_VARYING_VECTORS"sv, { "GLint"sv } },
  115. { "MAX_VERTEX_ATTRIBS"sv, { "GLint"sv } },
  116. { "MAX_VERTEX_TEXTURE_IMAGE_UNITS"sv, { "GLint"sv } },
  117. { "MAX_VERTEX_UNIFORM_VECTORS"sv, { "GLint"sv } },
  118. { "MAX_VIEWPORT_DIMS"sv, { "Int32Array"sv, 2 } },
  119. { "PACK_ALIGNMENT"sv, { "GLint"sv } },
  120. { "POLYGON_OFFSET_FACTOR"sv, { "GLfloat"sv } },
  121. { "POLYGON_OFFSET_FILL"sv, { "GLboolean"sv } },
  122. { "POLYGON_OFFSET_UNITS"sv, { "GLfloat"sv } },
  123. { "RED_BITS"sv, { "GLint"sv } },
  124. { "RENDERBUFFER_BINDING"sv, { "WebGLRenderbuffer"sv } },
  125. { "RENDERER"sv, { "DOMString"sv } },
  126. { "SAMPLE_ALPHA_TO_COVERAGE"sv, { "GLboolean"sv } },
  127. { "SAMPLE_BUFFERS"sv, { "GLint"sv } },
  128. { "SAMPLE_COVERAGE"sv, { "GLboolean"sv } },
  129. { "SAMPLE_COVERAGE_INVERT"sv, { "GLboolean"sv } },
  130. { "SAMPLE_COVERAGE_VALUE"sv, { "GLfloat"sv } },
  131. { "SAMPLES"sv, { "GLint"sv } },
  132. { "SCISSOR_BOX"sv, { "Int32Array"sv, 4 } },
  133. { "SCISSOR_TEST"sv, { "GLboolean"sv } },
  134. { "SHADING_LANGUAGE_VERSION"sv, { "DOMString"sv } },
  135. { "STENCIL_BACK_FAIL"sv, { "GLenum"sv } },
  136. { "STENCIL_BACK_FUNC"sv, { "GLenum"sv } },
  137. { "STENCIL_BACK_PASS_DEPTH_FAIL"sv, { "GLenum"sv } },
  138. { "STENCIL_BACK_PASS_DEPTH_PASS"sv, { "GLenum"sv } },
  139. { "STENCIL_BACK_REF"sv, { "GLint"sv } },
  140. { "STENCIL_BACK_VALUE_MASK"sv, { "GLuint"sv } },
  141. { "STENCIL_BACK_WRITEMASK"sv, { "GLuint"sv } },
  142. { "STENCIL_BITS"sv, { "GLint"sv } },
  143. { "STENCIL_CLEAR_VALUE"sv, { "GLint"sv } },
  144. { "STENCIL_FAIL"sv, { "GLenum"sv } },
  145. { "STENCIL_FUNC"sv, { "GLenum"sv } },
  146. { "STENCIL_PASS_DEPTH_FAIL"sv, { "GLenum"sv } },
  147. { "STENCIL_PASS_DEPTH_PASS"sv, { "GLenum"sv } },
  148. { "STENCIL_REF"sv, { "GLint"sv } },
  149. { "STENCIL_TEST"sv, { "GLboolean"sv } },
  150. { "STENCIL_VALUE_MASK"sv, { "GLuint"sv } },
  151. { "STENCIL_WRITEMASK"sv, { "GLuint"sv } },
  152. { "SUBPIXEL_BITS"sv, { "GLint"sv } },
  153. { "TEXTURE_BINDING_2D"sv, { "WebGLTexture"sv } },
  154. { "TEXTURE_BINDING_CUBE_MAP"sv, { "WebGLTexture"sv } },
  155. { "UNPACK_ALIGNMENT"sv, { "GLint"sv } },
  156. // FIXME: { "UNPACK_COLORSPACE_CONVERSION_WEBGL"sv, { "GLenum"sv } },
  157. // FIXME: { "UNPACK_FLIP_Y_WEBGL"sv, { "GLboolean"sv } },
  158. // FIXME: { "UNPACK_PREMULTIPLY_ALPHA_WEBGL"sv, { "GLboolean"sv } },
  159. { "VENDOR"sv, { "DOMString"sv } },
  160. { "VERSION"sv, { "DOMString"sv } },
  161. { "VIEWPORT"sv, { "Int32Array"sv, 4 } },
  162. };
  163. auto is_primitive_type = [](StringView type) {
  164. return type == "GLboolean"sv || type == "GLint"sv || type == "GLfloat"sv || type == "GLenum"sv || type == "GLuint"sv;
  165. };
  166. generator.append(" switch (pname) {");
  167. for (auto const& name_and_type : name_to_type) {
  168. auto const& parameter_name = name_and_type.name;
  169. auto const& type_name = name_and_type.return_type.type;
  170. StringBuilder string_builder;
  171. SourceGenerator impl_generator { string_builder };
  172. impl_generator.set("parameter_name", parameter_name);
  173. impl_generator.set("type_name", type_name);
  174. impl_generator.append(R"~~~(
  175. case GL_@parameter_name@: {)~~~");
  176. if (is_primitive_type(type_name)) {
  177. impl_generator.append(R"~~~(
  178. GLint result;
  179. glGetIntegerv(GL_@parameter_name@, &result);
  180. return JS::Value(result);
  181. )~~~");
  182. } else if (type_name == "DOMString"sv) {
  183. impl_generator.append(R"~~~(
  184. auto result = reinterpret_cast<const char*>(glGetString(GL_@parameter_name@));
  185. return JS::PrimitiveString::create(m_realm->vm(), ByteString { result });)~~~");
  186. } else if (type_name == "Float32Array"sv || type_name == "Int32Array"sv) {
  187. auto element_count = name_and_type.return_type.element_count;
  188. impl_generator.set("element_count", MUST(String::formatted("{}", element_count)));
  189. if (type_name == "Int32Array"sv) {
  190. impl_generator.set("gl_function_name", "glGetIntegerv"sv);
  191. impl_generator.set("element_type", "GLint"sv);
  192. } else if (type_name == "Float32Array"sv) {
  193. impl_generator.set("gl_function_name", "glGetFloatv"sv);
  194. impl_generator.set("element_type", "GLfloat"sv);
  195. } else {
  196. VERIFY_NOT_REACHED();
  197. }
  198. impl_generator.append(R"~~~(
  199. Array<@element_type@, @element_count@> result;
  200. @gl_function_name@(GL_@parameter_name@, result.data());
  201. auto byte_buffer = MUST(ByteBuffer::copy(result.data(), @element_count@ * sizeof(@element_type@)));
  202. auto array_buffer = JS::ArrayBuffer::create(m_realm, move(byte_buffer));
  203. return JS::@type_name@::create(m_realm, @element_count@, array_buffer);
  204. )~~~");
  205. } else if (type_name == "WebGLProgram"sv || type_name == "WebGLBuffer"sv || type_name == "WebGLTexture"sv || type_name == "WebGLFramebuffer"sv || type_name == "WebGLRenderbuffer"sv) {
  206. impl_generator.append(R"~~~(
  207. GLint result;
  208. glGetIntegerv(GL_@parameter_name@, &result);
  209. if (!result)
  210. return JS::js_null();
  211. return @type_name@::create(m_realm, result);
  212. )~~~");
  213. } else {
  214. VERIFY_NOT_REACHED();
  215. }
  216. impl_generator.append(" }");
  217. generator.append(string_builder.string_view());
  218. }
  219. generator.appendln(R"~~~(
  220. default:
  221. dbgln("Unknown WebGL parameter name: {:x}", pname);
  222. set_error(GL_INVALID_ENUM);
  223. return JS::js_null();
  224. })~~~");
  225. }
  226. static void generate_get_buffer_parameter(SourceGenerator& generator)
  227. {
  228. Vector<NameAndType> const name_to_type = {
  229. { "BUFFER_SIZE"sv, { "GLint"sv } },
  230. { "BUFFER_USAGE"sv, { "GLenum"sv } },
  231. };
  232. generator.append(" switch (pname) {");
  233. for (auto const& name_and_type : name_to_type) {
  234. auto const& parameter_name = name_and_type.name;
  235. auto const& type_name = name_and_type.return_type.type;
  236. StringBuilder string_builder;
  237. SourceGenerator impl_generator { string_builder };
  238. impl_generator.set("parameter_name", parameter_name);
  239. impl_generator.set("type_name", type_name);
  240. impl_generator.append(R"~~~(
  241. case GL_@parameter_name@: {
  242. GLint result;
  243. glGetBufferParameteriv(target, GL_@parameter_name@, &result);
  244. return JS::Value(result);
  245. }
  246. )~~~");
  247. generator.append(string_builder.string_view());
  248. }
  249. generator.appendln(R"~~~(
  250. default:
  251. TODO();
  252. })~~~");
  253. }
  254. ErrorOr<int> serenity_main(Main::Arguments arguments)
  255. {
  256. StringView generated_header_path;
  257. StringView generated_implementation_path;
  258. Vector<ByteString> base_paths;
  259. StringView webgl_context_idl_path;
  260. Core::ArgsParser args_parser;
  261. args_parser.add_option(webgl_context_idl_path, "Path to the WebGLRenderingContext idl file", "webgl-idl-path", 'i', "webgl-idl-path");
  262. args_parser.add_option(Core::ArgsParser::Option {
  263. .argument_mode = Core::ArgsParser::OptionArgumentMode::Required,
  264. .help_string = "Path to root of IDL file tree(s)",
  265. .long_name = "base-path",
  266. .short_name = 'b',
  267. .value_name = "base-path",
  268. .accept_value = [&](StringView s) {
  269. base_paths.append(s);
  270. return true;
  271. },
  272. });
  273. args_parser.add_option(generated_header_path, "Path to the header file to generate", "generated-header-path", 'h', "generated-header-path");
  274. args_parser.add_option(generated_implementation_path, "Path to the implementation file to generate", "generated-implementation-path", 'c', "generated-implementation-path");
  275. args_parser.parse(arguments);
  276. auto generated_header_file = TRY(Core::File::open(generated_header_path, Core::File::OpenMode::Write));
  277. auto generated_implementation_file = TRY(Core::File::open(generated_implementation_path, Core::File::OpenMode::Write));
  278. auto idl_file = MUST(Core::File::open(webgl_context_idl_path, Core::File::OpenMode::Read));
  279. auto webgl_context_idl_file_content = MUST(idl_file->read_until_eof());
  280. Vector<ByteString> import_base_paths;
  281. for (auto const& base_path : base_paths) {
  282. VERIFY(!base_path.is_empty());
  283. import_base_paths.append(base_path);
  284. }
  285. IDL::Parser parser(webgl_context_idl_path, StringView(webgl_context_idl_file_content), import_base_paths);
  286. auto const& interface = parser.parse();
  287. auto path = LexicalPath(generated_header_path);
  288. auto title = path.title();
  289. auto first_dot = title.find('.');
  290. ByteString class_name = title;
  291. if (first_dot.has_value())
  292. class_name = title.substring_view(0, *first_dot);
  293. StringBuilder header_file_string_builder;
  294. SourceGenerator header_file_generator { header_file_string_builder };
  295. header_file_generator.set("class_name", class_name);
  296. StringBuilder implementation_file_string_builder;
  297. SourceGenerator implementation_file_generator { implementation_file_string_builder };
  298. implementation_file_generator.set("class_name", class_name);
  299. auto webgl_version = class_name == "WebGLRenderingContextImpl" ? 1 : 2;
  300. if (webgl_version == 1) {
  301. implementation_file_generator.append(R"~~~(
  302. #include <GLES2/gl2.h>
  303. #include <GLES2/gl2ext.h>
  304. )~~~");
  305. } else {
  306. implementation_file_generator.append(R"~~~(
  307. #include <GLES3/gl3.h>
  308. )~~~");
  309. }
  310. implementation_file_generator.append(R"~~~(
  311. #include <LibJS/Runtime/ArrayBuffer.h>
  312. #include <LibJS/Runtime/DataView.h>
  313. #include <LibJS/Runtime/TypedArray.h>
  314. #include <LibWeb/HTML/HTMLCanvasElement.h>
  315. #include <LibWeb/HTML/HTMLImageElement.h>
  316. #include <LibWeb/HTML/HTMLVideoElement.h>
  317. #include <LibWeb/HTML/ImageBitmap.h>
  318. #include <LibWeb/HTML/ImageData.h>
  319. #include <LibWeb/WebGL/OpenGLContext.h>
  320. #include <LibWeb/WebGL/WebGLActiveInfo.h>
  321. #include <LibWeb/WebGL/WebGLBuffer.h>
  322. #include <LibWeb/WebGL/WebGLFramebuffer.h>
  323. #include <LibWeb/WebGL/WebGLProgram.h>
  324. #include <LibWeb/WebGL/WebGLRenderbuffer.h>
  325. #include <LibWeb/WebGL/@class_name@.h>
  326. #include <LibWeb/WebGL/WebGLSampler.h>
  327. #include <LibWeb/WebGL/WebGLShader.h>
  328. #include <LibWeb/WebGL/WebGLShaderPrecisionFormat.h>
  329. #include <LibWeb/WebGL/WebGLTexture.h>
  330. #include <LibWeb/WebGL/WebGLUniformLocation.h>
  331. #include <LibWeb/WebGL/WebGLVertexArrayObject.h>
  332. #include <LibWeb/WebIDL/Buffers.h>
  333. namespace Web::WebGL {
  334. static Vector<GLchar> null_terminated_string(StringView string)
  335. {
  336. Vector<GLchar> result;
  337. for (auto c : string.bytes())
  338. result.append(c);
  339. result.append('\\0');
  340. return result;
  341. }
  342. @class_name@::@class_name@(JS::Realm& realm, NonnullOwnPtr<OpenGLContext> context)
  343. : m_realm(realm)
  344. , m_context(move(context))
  345. {
  346. }
  347. )~~~");
  348. header_file_generator.append(R"~~~(
  349. #pragma once
  350. #include <AK/NonnullOwnPtr.h>
  351. #include <LibGC/Ptr.h>
  352. #include <LibGfx/Bitmap.h>
  353. #include <LibWeb/Bindings/PlatformObject.h>
  354. #include <LibWeb/Forward.h>
  355. #include <LibWeb/WebIDL/Types.h>
  356. namespace Web::WebGL {
  357. using namespace Web::HTML;
  358. class @class_name@ {
  359. public:
  360. @class_name@(JS::Realm&, NonnullOwnPtr<OpenGLContext>);
  361. OpenGLContext& context() { return *m_context; }
  362. virtual void present() = 0;
  363. virtual void needs_to_present() = 0;
  364. virtual void set_error(GLenum) = 0;
  365. )~~~");
  366. for (auto const& function : interface.functions) {
  367. if (function.extended_attributes.contains("FIXME")) {
  368. continue;
  369. }
  370. if (function.name == "getSupportedExtensions"sv || function.name == "getExtension"sv || function.name == "getContextAttributes"sv || function.name == "isContextLost"sv) {
  371. // Implemented in WebGLRenderingContext
  372. continue;
  373. }
  374. StringBuilder function_declaration;
  375. StringBuilder function_parameters;
  376. for (size_t i = 0; i < function.parameters.size(); ++i) {
  377. auto const& parameter = function.parameters[i];
  378. function_parameters.append(to_cpp_type(*parameter.type, interface));
  379. function_parameters.append(" "sv);
  380. function_parameters.append(parameter.name.to_snakecase());
  381. if (i != function.parameters.size() - 1) {
  382. function_parameters.append(", "sv);
  383. }
  384. }
  385. auto function_name = function.name.to_snakecase();
  386. function_declaration.append(to_cpp_type(*function.return_type, interface));
  387. function_declaration.append(" "sv);
  388. function_declaration.append(function_name);
  389. function_declaration.append("("sv);
  390. function_declaration.append(function_parameters.string_view());
  391. function_declaration.append(");"sv);
  392. header_file_generator.append(" "sv);
  393. header_file_generator.append(function_declaration.string_view());
  394. header_file_generator.append("\n"sv);
  395. StringBuilder function_impl;
  396. SourceGenerator function_impl_generator { function_impl };
  397. function_impl_generator.set("class_name", class_name);
  398. ScopeGuard function_guard { [&] {
  399. function_impl_generator.append("}\n"sv);
  400. implementation_file_generator.append(function_impl_generator.as_string_view().bytes());
  401. } };
  402. function_impl_generator.set("function_name", function_name);
  403. function_impl_generator.set("function_parameters", function_parameters.string_view());
  404. function_impl_generator.set("function_return_type", to_cpp_type(*function.return_type, interface));
  405. function_impl_generator.append(R"~~~(
  406. @function_return_type@ @class_name@::@function_name@(@function_parameters@)
  407. {
  408. m_context->make_current();
  409. )~~~");
  410. if (gl_function_modifies_framebuffer(function.name)) {
  411. function_impl_generator.append(" m_context->notify_content_will_change();\n"sv);
  412. }
  413. if (function.name == "createBuffer"sv) {
  414. function_impl_generator.append(R"~~~(
  415. GLuint handle = 0;
  416. glGenBuffers(1, &handle);
  417. return WebGLBuffer::create(m_realm, handle);
  418. )~~~");
  419. continue;
  420. }
  421. if (function.name == "createTexture"sv) {
  422. function_impl_generator.append(R"~~~(
  423. GLuint handle = 0;
  424. glGenTextures(1, &handle);
  425. return WebGLTexture::create(m_realm, handle);
  426. )~~~");
  427. continue;
  428. }
  429. if (function.name == "createFramebuffer"sv) {
  430. function_impl_generator.append(R"~~~(
  431. GLuint handle = 0;
  432. glGenFramebuffers(1, &handle);
  433. return WebGLFramebuffer::create(m_realm, handle);
  434. )~~~");
  435. continue;
  436. }
  437. if (function.name == "createRenderbuffer"sv) {
  438. function_impl_generator.append(R"~~~(
  439. GLuint handle = 0;
  440. glGenRenderbuffers(1, &handle);
  441. return WebGLRenderbuffer::create(m_realm, handle);
  442. )~~~");
  443. continue;
  444. }
  445. if (function.name == "createVertexArray"sv) {
  446. function_impl_generator.append(R"~~~(
  447. GLuint handle = 0;
  448. glGenVertexArrays(1, &handle);
  449. return WebGLVertexArrayObject::create(m_realm, handle);
  450. )~~~");
  451. continue;
  452. }
  453. if (function.name == "createSampler"sv) {
  454. function_impl_generator.append(R"~~~(
  455. GLuint handle = 0;
  456. glGenSamplers(1, &handle);
  457. return WebGLSampler::create(m_realm, handle);
  458. )~~~");
  459. continue;
  460. }
  461. if (function.name == "shaderSource"sv) {
  462. function_impl_generator.append(R"~~~(
  463. Vector<GLchar*> strings;
  464. auto string = null_terminated_string(source);
  465. strings.append(string.data());
  466. Vector<GLint> length;
  467. length.append(source.bytes().size());
  468. glShaderSource(shader->handle(), 1, strings.data(), length.data());
  469. )~~~");
  470. continue;
  471. }
  472. if (function.name == "vertexAttribPointer"sv) {
  473. function_impl_generator.append(R"~~~(
  474. glVertexAttribPointer(index, size, type, normalized, stride, reinterpret_cast<void*>(offset));
  475. )~~~");
  476. continue;
  477. }
  478. if (function.name == "texStorage2D") {
  479. function_impl_generator.append(R"~~~(
  480. glTexStorage2D(target, levels, internalformat, width, height);
  481. )~~~");
  482. continue;
  483. }
  484. if (function.name == "texImage2D"sv && function.overload_index == 0) {
  485. function_impl_generator.append(R"~~~(
  486. void const* pixels_ptr = nullptr;
  487. if (pixels) {
  488. auto const& viewed_array_buffer = pixels->viewed_array_buffer();
  489. auto const& byte_buffer = viewed_array_buffer->buffer();
  490. pixels_ptr = byte_buffer.data();
  491. }
  492. glTexImage2D(target, level, internalformat, width, height, border, format, type, pixels_ptr);
  493. )~~~");
  494. continue;
  495. }
  496. if (function.name == "texImage3D"sv) {
  497. // FIXME: If a WebGLBuffer is bound to the PIXEL_UNPACK_BUFFER target, generates an INVALID_OPERATION error.
  498. // FIXME: If srcData is null, a buffer of sufficient size initialized to 0 is passed.
  499. // FIXME: If type is specified as FLOAT_32_UNSIGNED_INT_24_8_REV, srcData must be null; otherwise, generates an INVALID_OPERATION error.
  500. // FIXME: If srcData is non-null, the type of srcData must match the type according to the above table; otherwise, generate an INVALID_OPERATION error.
  501. // FIXME: If an attempt is made to call this function with no WebGLTexture bound (see above), generates an INVALID_OPERATION error.
  502. // FIXME: If there's not enough data in srcData starting at srcOffset, generate INVALID_OPERATION.
  503. function_impl_generator.append(R"~~~(
  504. void const* src_data_ptr = nullptr;
  505. if (src_data) {
  506. auto const& viewed_array_buffer = src_data->viewed_array_buffer();
  507. auto const& byte_buffer = viewed_array_buffer->buffer();
  508. src_data_ptr = byte_buffer.data();
  509. }
  510. glTexImage3D(target, level, internalformat, width, height, depth, border, format, type, src_data_ptr);
  511. )~~~");
  512. continue;
  513. }
  514. if (function.name == "texImage2D"sv && function.overload_index == 1) {
  515. // FIXME: If this function is called with an ImageData whose data attribute has been neutered,
  516. // an INVALID_VALUE error is generated.
  517. // FIXME: If this function is called with an ImageBitmap that has been neutered, an INVALID_VALUE
  518. // error is generated.
  519. // FIXME: If this function is called with an HTMLImageElement or HTMLVideoElement whose origin
  520. // differs from the origin of the containing Document, or with an HTMLCanvasElement,
  521. // ImageBitmap or OffscreenCanvas whose bitmap's origin-clean flag is set to false,
  522. // a SECURITY_ERR exception must be thrown. See Origin Restrictions.
  523. // FIXME: If source is null then an INVALID_VALUE error is generated.
  524. function_impl_generator.append(R"~~~(
  525. auto bitmap = source.visit(
  526. [](GC::Root<HTMLImageElement> const& source) -> RefPtr<Gfx::ImmutableBitmap> {
  527. return source->immutable_bitmap();
  528. },
  529. [](GC::Root<HTMLCanvasElement> const& source) -> RefPtr<Gfx::ImmutableBitmap> {
  530. auto surface = source->surface();
  531. if (!surface)
  532. return {};
  533. auto bitmap = MUST(Gfx::Bitmap::create(Gfx::BitmapFormat::RGBA8888, Gfx::AlphaType::Premultiplied, surface->size()));
  534. surface->read_into_bitmap(*bitmap);
  535. return Gfx::ImmutableBitmap::create(*bitmap);
  536. },
  537. [](GC::Root<HTMLVideoElement> const& source) -> RefPtr<Gfx::ImmutableBitmap> {
  538. return Gfx::ImmutableBitmap::create(*source->bitmap());
  539. },
  540. [](GC::Root<ImageBitmap> const& source) -> RefPtr<Gfx::ImmutableBitmap> {
  541. return Gfx::ImmutableBitmap::create(*source->bitmap());
  542. },
  543. [](GC::Root<ImageData> const& source) -> RefPtr<Gfx::ImmutableBitmap> {
  544. return Gfx::ImmutableBitmap::create(source->bitmap());
  545. });
  546. if (!bitmap)
  547. return;
  548. void const* pixels_ptr = bitmap->bitmap()->begin();
  549. int width = bitmap->width();
  550. int height = bitmap->height();
  551. glTexImage2D(target, level, internalformat, width, height, 0, format, type, pixels_ptr);
  552. )~~~");
  553. continue;
  554. }
  555. if (function.name == "texSubImage2D"sv && function.overload_index == 0) {
  556. function_impl_generator.append(R"~~~(
  557. void const* pixels_ptr = nullptr;
  558. if (pixels) {
  559. auto const& viewed_array_buffer = pixels->viewed_array_buffer();
  560. auto const& byte_buffer = viewed_array_buffer->buffer();
  561. pixels_ptr = byte_buffer.data();
  562. }
  563. glTexSubImage2D(target, level, xoffset, yoffset, width, height, format, type, pixels_ptr);
  564. )~~~");
  565. continue;
  566. }
  567. if (function.name == "getShaderParameter"sv) {
  568. function_impl_generator.append(R"~~~(
  569. GLint result = 0;
  570. glGetShaderiv(shader->handle(), pname, &result);
  571. return JS::Value(result);
  572. )~~~");
  573. continue;
  574. }
  575. if (function.name == "getProgramParameter"sv) {
  576. function_impl_generator.append(R"~~~(
  577. GLint result = 0;
  578. glGetProgramiv(program->handle(), pname, &result);
  579. return JS::Value(result);
  580. )~~~");
  581. continue;
  582. }
  583. if (function.name == "bufferData"sv && function.overload_index == 0) {
  584. function_impl_generator.append(R"~~~(
  585. glBufferData(target, size, 0, usage);
  586. )~~~");
  587. continue;
  588. }
  589. if (function.name == "readPixels"sv) {
  590. function_impl_generator.append(R"~~~(
  591. if (!pixels) {
  592. return;
  593. }
  594. void *ptr = nullptr;
  595. if (pixels->is_data_view()) {
  596. auto& data_view = static_cast<JS::DataView&>(*pixels->raw_object());
  597. ptr = data_view.viewed_array_buffer()->buffer().data();
  598. } else if (pixels->is_typed_array_base()) {
  599. auto& typed_array_base = static_cast<JS::TypedArrayBase&>(*pixels->raw_object());
  600. ptr = typed_array_base.viewed_array_buffer()->buffer().data();
  601. } else {
  602. VERIFY_NOT_REACHED();
  603. }
  604. glReadPixels(x, y, width, height, format, type, ptr);
  605. )~~~");
  606. continue;
  607. }
  608. if (function.name == "drawElements"sv) {
  609. function_impl_generator.append(R"~~~(
  610. glDrawElements(mode, count, type, reinterpret_cast<void*>(offset));
  611. needs_to_present();
  612. )~~~");
  613. continue;
  614. }
  615. if (function.name == "drawBuffers"sv) {
  616. function_impl_generator.append(R"~~~(
  617. glDrawBuffers(buffers.size(), buffers.data());
  618. )~~~");
  619. continue;
  620. }
  621. if (function.name.starts_with("uniformMatrix"sv)) {
  622. auto number_of_matrix_elements = function.name.substring_view(13, 1);
  623. function_impl_generator.set("number_of_matrix_elements", number_of_matrix_elements);
  624. if (webgl_version == 1) {
  625. function_impl_generator.set("array_argument_name", "value");
  626. } else {
  627. function_impl_generator.set("array_argument_name", "data");
  628. }
  629. function_impl_generator.append(R"~~~(
  630. auto matrix_size = @number_of_matrix_elements@ * @number_of_matrix_elements@;
  631. float const* raw_data = nullptr;
  632. u64 count = 0;
  633. if (@array_argument_name@.has<Vector<float>>()) {
  634. auto& vector_data = @array_argument_name@.get<Vector<float>>();
  635. raw_data = vector_data.data();
  636. count = vector_data.size() / matrix_size;
  637. } else {
  638. auto& typed_array_base = static_cast<JS::TypedArrayBase&>(*@array_argument_name@.get<GC::Root<WebIDL::BufferSource>>()->raw_object());
  639. auto& float32_array = verify_cast<JS::Float32Array>(typed_array_base);
  640. raw_data = float32_array.data().data();
  641. count = float32_array.array_length().length() / matrix_size;
  642. }
  643. )~~~");
  644. if (webgl_version == 2) {
  645. function_impl_generator.append(R"~~~(
  646. raw_data += src_offset;
  647. if (src_length == 0) {
  648. count -= src_offset;
  649. }
  650. if (src_offset + src_length <= count) {
  651. set_error(GL_INVALID_VALUE);
  652. return;
  653. }
  654. )~~~");
  655. }
  656. function_impl_generator.append(R"~~~(
  657. glUniformMatrix@number_of_matrix_elements@fv(location->handle(), count, transpose, raw_data);
  658. )~~~");
  659. continue;
  660. }
  661. if (function.name == "uniform1fv"sv || function.name == "uniform2fv"sv || function.name == "uniform3fv"sv || function.name == "uniform4fv"sv || function.name == "uniform1iv"sv || function.name == "uniform2iv"sv || function.name == "uniform3iv"sv || function.name == "uniform4iv"sv) {
  662. auto number_of_vector_elements = function.name.substring_view(7, 1);
  663. auto element_type = function.name.substring_view(8, 1);
  664. if (element_type == "f"sv) {
  665. function_impl_generator.set("cpp_element_type", "float"sv);
  666. function_impl_generator.set("typed_array_type", "Float32Array"sv);
  667. function_impl_generator.set("gl_postfix", "f"sv);
  668. } else if (element_type == "i"sv) {
  669. function_impl_generator.set("cpp_element_type", "int"sv);
  670. function_impl_generator.set("typed_array_type", "Int32Array"sv);
  671. function_impl_generator.set("gl_postfix", "i"sv);
  672. } else {
  673. VERIFY_NOT_REACHED();
  674. }
  675. function_impl_generator.set("number_of_vector_elements", number_of_vector_elements);
  676. function_impl_generator.append(R"~~~(
  677. @cpp_element_type@ const* data = nullptr;
  678. size_t count = 0;
  679. if (v.has<Vector<@cpp_element_type@>>()) {
  680. auto& vector = v.get<Vector<@cpp_element_type@>>();
  681. data = vector.data();
  682. count = vector.size();
  683. } else if (v.has<GC::Root<WebIDL::BufferSource>>()) {
  684. auto& typed_array_base = static_cast<JS::TypedArrayBase&>(*v.get<GC::Root<WebIDL::BufferSource>>()->raw_object());
  685. auto& typed_array = verify_cast<JS::@typed_array_type@>(typed_array_base);
  686. data = typed_array.data().data();
  687. count = typed_array.array_length().length();
  688. } else {
  689. VERIFY_NOT_REACHED();
  690. }
  691. )~~~");
  692. if (webgl_version == 2) {
  693. function_impl_generator.append(R"~~~(
  694. data += src_offset;
  695. if (src_length == 0) {
  696. count -= src_offset;
  697. }
  698. if (src_offset + src_length <= count) {
  699. set_error(GL_INVALID_VALUE);
  700. return;
  701. }
  702. )~~~");
  703. }
  704. function_impl_generator.append(R"~~~(
  705. glUniform@number_of_vector_elements@@gl_postfix@v(location->handle(), count / @number_of_vector_elements@, data);
  706. )~~~");
  707. continue;
  708. }
  709. if (function.name == "vertexAttrib1fv"sv || function.name == "vertexAttrib2fv"sv || function.name == "vertexAttrib3fv"sv || function.name == "vertexAttrib4fv"sv) {
  710. auto number_of_vector_elements = function.name.substring_view(12, 1);
  711. function_impl_generator.set("number_of_vector_elements", number_of_vector_elements);
  712. function_impl_generator.append(R"~~~(
  713. if (values.has<Vector<float>>()) {
  714. auto& data = values.get<Vector<float>>();
  715. glVertexAttrib@number_of_vector_elements@fv(index, data.data());
  716. return;
  717. }
  718. auto& typed_array_base = static_cast<JS::TypedArrayBase&>(*values.get<GC::Root<WebIDL::BufferSource>>()->raw_object());
  719. auto& float32_array = verify_cast<JS::Float32Array>(typed_array_base);
  720. float const* data = float32_array.data().data();
  721. glVertexAttrib@number_of_vector_elements@fv(index, data);
  722. )~~~");
  723. continue;
  724. }
  725. if (function.name == "getParameter"sv) {
  726. generate_get_parameter(function_impl_generator);
  727. continue;
  728. }
  729. if (function.name == "getBufferParameter"sv) {
  730. generate_get_buffer_parameter(function_impl_generator);
  731. continue;
  732. }
  733. if (function.name == "getActiveUniform"sv) {
  734. function_impl_generator.append(R"~~~(
  735. GLint size = 0;
  736. GLenum type = 0;
  737. GLsizei buf_size = 256;
  738. GLsizei length = 0;
  739. GLchar name[256];
  740. glGetActiveUniform(program->handle(), index, buf_size, &length, &size, &type, name);
  741. auto readonly_bytes = ReadonlyBytes { name, static_cast<size_t>(length) };
  742. return WebGLActiveInfo::create(m_realm, String::from_utf8_without_validation(readonly_bytes), type, size);
  743. )~~~");
  744. continue;
  745. }
  746. if (function.name == "getActiveAttrib"sv) {
  747. function_impl_generator.append(R"~~~(
  748. GLint size = 0;
  749. GLenum type = 0;
  750. GLsizei buf_size = 256;
  751. GLsizei length = 0;
  752. GLchar name[256];
  753. glGetActiveAttrib(program->handle(), index, buf_size, &length, &size, &type, name);
  754. auto readonly_bytes = ReadonlyBytes { name, static_cast<size_t>(length) };
  755. return WebGLActiveInfo::create(m_realm, String::from_utf8_without_validation(readonly_bytes), type, size);
  756. )~~~");
  757. continue;
  758. }
  759. if (function.name == "getShaderInfoLog"sv) {
  760. function_impl_generator.append(R"~~~(
  761. GLint info_log_length = 0;
  762. glGetShaderiv(shader->handle(), GL_INFO_LOG_LENGTH, &info_log_length);
  763. Vector<GLchar> info_log;
  764. info_log.resize(info_log_length);
  765. if (!info_log_length)
  766. return String {};
  767. glGetShaderInfoLog(shader->handle(), info_log_length, nullptr, info_log.data());
  768. return String::from_utf8_without_validation(ReadonlyBytes { info_log.data(), static_cast<size_t>(info_log_length - 1) });
  769. )~~~");
  770. continue;
  771. }
  772. if (function.name == "getProgramInfoLog"sv) {
  773. function_impl_generator.append(R"~~~(
  774. GLint info_log_length = 0;
  775. glGetProgramiv(program->handle(), GL_INFO_LOG_LENGTH, &info_log_length);
  776. Vector<GLchar> info_log;
  777. info_log.resize(info_log_length);
  778. if (!info_log_length)
  779. return String {};
  780. glGetProgramInfoLog(program->handle(), info_log_length, nullptr, info_log.data());
  781. return String::from_utf8_without_validation(ReadonlyBytes { info_log.data(), static_cast<size_t>(info_log_length - 1) });
  782. )~~~");
  783. continue;
  784. }
  785. if (function.name == "getShaderPrecisionFormat"sv) {
  786. function_impl_generator.append(R"~~~(
  787. GLint range[2];
  788. GLint precision;
  789. glGetShaderPrecisionFormat(shadertype, precisiontype, range, &precision);
  790. return WebGLShaderPrecisionFormat::create(m_realm, range[0], range[1], precision);
  791. )~~~");
  792. continue;
  793. }
  794. if (function.name == "deleteBuffer"sv) {
  795. function_impl_generator.append(R"~~~(
  796. auto handle = buffer ? buffer->handle() : 0;
  797. glDeleteBuffers(1, &handle);
  798. )~~~");
  799. continue;
  800. }
  801. if (function.name == "deleteFramebuffer"sv) {
  802. function_impl_generator.append(R"~~~(
  803. auto handle = framebuffer ? framebuffer->handle() : 0;
  804. glDeleteFramebuffers(1, &handle);
  805. )~~~");
  806. continue;
  807. }
  808. if (function.name == "deleteTexture"sv) {
  809. function_impl_generator.append(R"~~~(
  810. auto handle = texture ? texture->handle() : 0;
  811. glDeleteTextures(1, &handle);
  812. )~~~");
  813. continue;
  814. }
  815. if (function.name == "deleteVertexArray"sv) {
  816. function_impl_generator.append(R"~~~(
  817. auto handle = vertex_array ? vertex_array->handle() : 0;
  818. glDeleteVertexArrays(1, &handle);
  819. )~~~");
  820. continue;
  821. }
  822. Vector<ByteString> gl_call_arguments;
  823. for (size_t i = 0; i < function.parameters.size(); ++i) {
  824. auto const& parameter = function.parameters[i];
  825. auto parameter_name = parameter.name.to_snakecase();
  826. if (parameter.type->is_numeric() || parameter.type->is_boolean()) {
  827. gl_call_arguments.append(parameter_name);
  828. continue;
  829. }
  830. if (parameter.type->is_string()) {
  831. function_impl_generator.set("parameter_name", parameter_name);
  832. function_impl_generator.append(R"~~~(
  833. auto @parameter_name@_null_terminated = null_terminated_string(@parameter_name@);
  834. )~~~");
  835. gl_call_arguments.append(ByteString::formatted("{}_null_terminated.data()", parameter_name));
  836. continue;
  837. }
  838. if (is_webgl_object_type(parameter.type->name())) {
  839. gl_call_arguments.append(ByteString::formatted("{} ? {}->handle() : 0", parameter_name, parameter_name));
  840. continue;
  841. }
  842. if (parameter.type->name() == "BufferSource"sv) {
  843. function_impl_generator.set("buffer_source_name", parameter_name);
  844. function_impl_generator.append(R"~~~(
  845. void const* ptr = nullptr;
  846. size_t byte_size = 0;
  847. if (@buffer_source_name@->is_typed_array_base()) {
  848. auto& typed_array_base = static_cast<JS::TypedArrayBase&>(*@buffer_source_name@->raw_object());
  849. ptr = typed_array_base.viewed_array_buffer()->buffer().data();
  850. byte_size = typed_array_base.viewed_array_buffer()->byte_length();
  851. } else if (@buffer_source_name@->is_data_view()) {
  852. auto& data_view = static_cast<JS::DataView&>(*@buffer_source_name@->raw_object());
  853. ptr = data_view.viewed_array_buffer()->buffer().data();
  854. byte_size = data_view.viewed_array_buffer()->byte_length();
  855. } else if (@buffer_source_name@->is_array_buffer()) {
  856. auto& array_buffer = static_cast<JS::ArrayBuffer&>(*@buffer_source_name@->raw_object());
  857. ptr = array_buffer.buffer().data();
  858. byte_size = array_buffer.byte_length();
  859. } else {
  860. VERIFY_NOT_REACHED();
  861. }
  862. )~~~");
  863. gl_call_arguments.append(ByteString::formatted("byte_size"));
  864. gl_call_arguments.append(ByteString::formatted("ptr"));
  865. continue;
  866. }
  867. VERIFY_NOT_REACHED();
  868. }
  869. StringBuilder gl_call_arguments_string_builder;
  870. gl_call_arguments_string_builder.join(", "sv, gl_call_arguments);
  871. auto gl_call_string = ByteString::formatted("{}({})", idl_to_gl_function_name(function.name), gl_call_arguments_string_builder.string_view());
  872. function_impl_generator.set("call_string", gl_call_string);
  873. if (gl_function_modifies_framebuffer(function.name)) {
  874. function_impl_generator.append(" needs_to_present();\n"sv);
  875. }
  876. if (function.return_type->name() == "undefined"sv) {
  877. function_impl_generator.append(" @call_string@;"sv);
  878. } else if (function.return_type->is_integer() || function.return_type->is_boolean()) {
  879. function_impl_generator.append(" return @call_string@;"sv);
  880. } else if (is_webgl_object_type(function.return_type->name())) {
  881. function_impl_generator.set("return_type_name", function.return_type->name());
  882. function_impl_generator.append(" return @return_type_name@::create(m_realm, @call_string@);"sv);
  883. } else {
  884. VERIFY_NOT_REACHED();
  885. }
  886. function_impl_generator.append("\n"sv);
  887. }
  888. header_file_generator.append(R"~~~(
  889. private:
  890. GC::Ref<JS::Realm> m_realm;
  891. NonnullOwnPtr<OpenGLContext> m_context;
  892. };
  893. }
  894. )~~~");
  895. implementation_file_generator.append(R"~~~(
  896. }
  897. )~~~");
  898. MUST(generated_header_file->write_until_depleted(header_file_generator.as_string_view().bytes()));
  899. MUST(generated_implementation_file->write_until_depleted(implementation_file_generator.as_string_view().bytes()));
  900. return 0;
  901. }