GenerateWebGLRenderingContext.cpp 39 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000
  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/WebGLShader.h>
  327. #include <LibWeb/WebGL/WebGLShaderPrecisionFormat.h>
  328. #include <LibWeb/WebGL/WebGLTexture.h>
  329. #include <LibWeb/WebGL/WebGLUniformLocation.h>
  330. #include <LibWeb/WebGL/WebGLVertexArrayObject.h>
  331. #include <LibWeb/WebIDL/Buffers.h>
  332. namespace Web::WebGL {
  333. static Vector<GLchar> null_terminated_string(StringView string)
  334. {
  335. Vector<GLchar> result;
  336. for (auto c : string.bytes())
  337. result.append(c);
  338. result.append('\\0');
  339. return result;
  340. }
  341. @class_name@::@class_name@(JS::Realm& realm, NonnullOwnPtr<OpenGLContext> context)
  342. : m_realm(realm)
  343. , m_context(move(context))
  344. {
  345. }
  346. )~~~");
  347. header_file_generator.append(R"~~~(
  348. #pragma once
  349. #include <AK/NonnullOwnPtr.h>
  350. #include <LibGC/Ptr.h>
  351. #include <LibGfx/Bitmap.h>
  352. #include <LibWeb/Bindings/PlatformObject.h>
  353. #include <LibWeb/Forward.h>
  354. #include <LibWeb/WebIDL/Types.h>
  355. namespace Web::WebGL {
  356. using namespace Web::HTML;
  357. class @class_name@ {
  358. public:
  359. @class_name@(JS::Realm&, NonnullOwnPtr<OpenGLContext>);
  360. OpenGLContext& context() { return *m_context; }
  361. virtual void present() = 0;
  362. virtual void needs_to_present() = 0;
  363. virtual void set_error(GLenum) = 0;
  364. )~~~");
  365. for (auto const& function : interface.functions) {
  366. if (function.extended_attributes.contains("FIXME")) {
  367. continue;
  368. }
  369. if (function.name == "getSupportedExtensions"sv || function.name == "getExtension"sv || function.name == "getContextAttributes"sv || function.name == "isContextLost"sv) {
  370. // Implemented in WebGLRenderingContext
  371. continue;
  372. }
  373. StringBuilder function_declaration;
  374. StringBuilder function_parameters;
  375. for (size_t i = 0; i < function.parameters.size(); ++i) {
  376. auto const& parameter = function.parameters[i];
  377. function_parameters.append(to_cpp_type(*parameter.type, interface));
  378. function_parameters.append(" "sv);
  379. function_parameters.append(parameter.name.to_snakecase());
  380. if (i != function.parameters.size() - 1) {
  381. function_parameters.append(", "sv);
  382. }
  383. }
  384. auto function_name = function.name.to_snakecase();
  385. function_declaration.append(to_cpp_type(*function.return_type, interface));
  386. function_declaration.append(" "sv);
  387. function_declaration.append(function_name);
  388. function_declaration.append("("sv);
  389. function_declaration.append(function_parameters.string_view());
  390. function_declaration.append(");"sv);
  391. header_file_generator.append(" "sv);
  392. header_file_generator.append(function_declaration.string_view());
  393. header_file_generator.append("\n"sv);
  394. StringBuilder function_impl;
  395. SourceGenerator function_impl_generator { function_impl };
  396. function_impl_generator.set("class_name", class_name);
  397. ScopeGuard function_guard { [&] {
  398. function_impl_generator.append("}\n"sv);
  399. implementation_file_generator.append(function_impl_generator.as_string_view().bytes());
  400. } };
  401. function_impl_generator.set("function_name", function_name);
  402. function_impl_generator.set("function_parameters", function_parameters.string_view());
  403. function_impl_generator.set("function_return_type", to_cpp_type(*function.return_type, interface));
  404. function_impl_generator.append(R"~~~(
  405. @function_return_type@ @class_name@::@function_name@(@function_parameters@)
  406. {
  407. m_context->make_current();
  408. )~~~");
  409. if (gl_function_modifies_framebuffer(function.name)) {
  410. function_impl_generator.append(" m_context->notify_content_will_change();\n"sv);
  411. }
  412. if (function.name == "createBuffer"sv) {
  413. function_impl_generator.append(R"~~~(
  414. GLuint handle = 0;
  415. glGenBuffers(1, &handle);
  416. return WebGLBuffer::create(m_realm, handle);
  417. )~~~");
  418. continue;
  419. }
  420. if (function.name == "createTexture"sv) {
  421. function_impl_generator.append(R"~~~(
  422. GLuint handle = 0;
  423. glGenTextures(1, &handle);
  424. return WebGLTexture::create(m_realm, handle);
  425. )~~~");
  426. continue;
  427. }
  428. if (function.name == "createFramebuffer"sv) {
  429. function_impl_generator.append(R"~~~(
  430. GLuint handle = 0;
  431. glGenFramebuffers(1, &handle);
  432. return WebGLFramebuffer::create(m_realm, handle);
  433. )~~~");
  434. continue;
  435. }
  436. if (function.name == "createRenderbuffer"sv) {
  437. function_impl_generator.append(R"~~~(
  438. GLuint handle = 0;
  439. glGenRenderbuffers(1, &handle);
  440. return WebGLRenderbuffer::create(m_realm, handle);
  441. )~~~");
  442. continue;
  443. }
  444. if (function.name == "createVertexArray"sv) {
  445. function_impl_generator.append(R"~~~(
  446. GLuint handle = 0;
  447. glGenVertexArrays(1, &handle);
  448. return WebGLVertexArrayObject::create(m_realm, handle);
  449. )~~~");
  450. continue;
  451. }
  452. if (function.name == "shaderSource"sv) {
  453. function_impl_generator.append(R"~~~(
  454. Vector<GLchar*> strings;
  455. auto string = null_terminated_string(source);
  456. strings.append(string.data());
  457. Vector<GLint> length;
  458. length.append(source.bytes().size());
  459. glShaderSource(shader->handle(), 1, strings.data(), length.data());
  460. )~~~");
  461. continue;
  462. }
  463. if (function.name == "vertexAttribPointer"sv) {
  464. function_impl_generator.append(R"~~~(
  465. glVertexAttribPointer(index, size, type, normalized, stride, reinterpret_cast<void*>(offset));
  466. )~~~");
  467. continue;
  468. }
  469. if (function.name == "texStorage2D") {
  470. function_impl_generator.append(R"~~~(
  471. glTexStorage2D(target, levels, internalformat, width, height);
  472. )~~~");
  473. continue;
  474. }
  475. if (function.name == "texImage2D"sv && function.overload_index == 0) {
  476. function_impl_generator.append(R"~~~(
  477. void const* pixels_ptr = nullptr;
  478. if (pixels) {
  479. auto const& viewed_array_buffer = pixels->viewed_array_buffer();
  480. auto const& byte_buffer = viewed_array_buffer->buffer();
  481. pixels_ptr = byte_buffer.data();
  482. }
  483. glTexImage2D(target, level, internalformat, width, height, border, format, type, pixels_ptr);
  484. )~~~");
  485. continue;
  486. }
  487. if (function.name == "texImage3D"sv) {
  488. // FIXME: If a WebGLBuffer is bound to the PIXEL_UNPACK_BUFFER target, generates an INVALID_OPERATION error.
  489. // FIXME: If srcData is null, a buffer of sufficient size initialized to 0 is passed.
  490. // FIXME: If type is specified as FLOAT_32_UNSIGNED_INT_24_8_REV, srcData must be null; otherwise, generates an INVALID_OPERATION error.
  491. // 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.
  492. // FIXME: If an attempt is made to call this function with no WebGLTexture bound (see above), generates an INVALID_OPERATION error.
  493. // FIXME: If there's not enough data in srcData starting at srcOffset, generate INVALID_OPERATION.
  494. function_impl_generator.append(R"~~~(
  495. void const* src_data_ptr = nullptr;
  496. if (src_data) {
  497. auto const& viewed_array_buffer = src_data->viewed_array_buffer();
  498. auto const& byte_buffer = viewed_array_buffer->buffer();
  499. src_data_ptr = byte_buffer.data();
  500. }
  501. glTexImage3D(target, level, internalformat, width, height, depth, border, format, type, src_data_ptr);
  502. )~~~");
  503. continue;
  504. }
  505. if (function.name == "texImage2D"sv && function.overload_index == 1) {
  506. // FIXME: If this function is called with an ImageData whose data attribute has been neutered,
  507. // an INVALID_VALUE error is generated.
  508. // FIXME: If this function is called with an ImageBitmap that has been neutered, an INVALID_VALUE
  509. // error is generated.
  510. // FIXME: If this function is called with an HTMLImageElement or HTMLVideoElement whose origin
  511. // differs from the origin of the containing Document, or with an HTMLCanvasElement,
  512. // ImageBitmap or OffscreenCanvas whose bitmap's origin-clean flag is set to false,
  513. // a SECURITY_ERR exception must be thrown. See Origin Restrictions.
  514. // FIXME: If source is null then an INVALID_VALUE error is generated.
  515. function_impl_generator.append(R"~~~(
  516. auto bitmap = source.visit(
  517. [](GC::Root<HTMLImageElement> const& source) -> RefPtr<Gfx::ImmutableBitmap> {
  518. return source->immutable_bitmap();
  519. },
  520. [](GC::Root<HTMLCanvasElement> const& source) -> RefPtr<Gfx::ImmutableBitmap> {
  521. auto surface = source->surface();
  522. if (!surface)
  523. return {};
  524. auto bitmap = MUST(Gfx::Bitmap::create(Gfx::BitmapFormat::RGBA8888, Gfx::AlphaType::Premultiplied, surface->size()));
  525. surface->read_into_bitmap(*bitmap);
  526. return Gfx::ImmutableBitmap::create(*bitmap);
  527. },
  528. [](GC::Root<HTMLVideoElement> const& source) -> RefPtr<Gfx::ImmutableBitmap> {
  529. return Gfx::ImmutableBitmap::create(*source->bitmap());
  530. },
  531. [](GC::Root<ImageBitmap> const& source) -> RefPtr<Gfx::ImmutableBitmap> {
  532. return Gfx::ImmutableBitmap::create(*source->bitmap());
  533. },
  534. [](GC::Root<ImageData> const& source) -> RefPtr<Gfx::ImmutableBitmap> {
  535. return Gfx::ImmutableBitmap::create(source->bitmap());
  536. });
  537. if (!bitmap)
  538. return;
  539. void const* pixels_ptr = bitmap->bitmap()->begin();
  540. int width = bitmap->width();
  541. int height = bitmap->height();
  542. glTexImage2D(target, level, internalformat, width, height, 0, format, type, pixels_ptr);
  543. )~~~");
  544. continue;
  545. }
  546. if (function.name == "texSubImage2D"sv && function.overload_index == 0) {
  547. function_impl_generator.append(R"~~~(
  548. void const* pixels_ptr = nullptr;
  549. if (pixels) {
  550. auto const& viewed_array_buffer = pixels->viewed_array_buffer();
  551. auto const& byte_buffer = viewed_array_buffer->buffer();
  552. pixels_ptr = byte_buffer.data();
  553. }
  554. glTexSubImage2D(target, level, xoffset, yoffset, width, height, format, type, pixels_ptr);
  555. )~~~");
  556. continue;
  557. }
  558. if (function.name == "getShaderParameter"sv) {
  559. function_impl_generator.append(R"~~~(
  560. GLint result = 0;
  561. glGetShaderiv(shader->handle(), pname, &result);
  562. return JS::Value(result);
  563. )~~~");
  564. continue;
  565. }
  566. if (function.name == "getProgramParameter"sv) {
  567. function_impl_generator.append(R"~~~(
  568. GLint result = 0;
  569. glGetProgramiv(program->handle(), pname, &result);
  570. return JS::Value(result);
  571. )~~~");
  572. continue;
  573. }
  574. if (function.name == "bufferData"sv && function.overload_index == 0) {
  575. function_impl_generator.append(R"~~~(
  576. glBufferData(target, size, 0, usage);
  577. )~~~");
  578. continue;
  579. }
  580. if (function.name == "readPixels"sv) {
  581. function_impl_generator.append(R"~~~(
  582. if (!pixels) {
  583. return;
  584. }
  585. void *ptr = nullptr;
  586. if (pixels->is_data_view()) {
  587. auto& data_view = static_cast<JS::DataView&>(*pixels->raw_object());
  588. ptr = data_view.viewed_array_buffer()->buffer().data();
  589. } else if (pixels->is_typed_array_base()) {
  590. auto& typed_array_base = static_cast<JS::TypedArrayBase&>(*pixels->raw_object());
  591. ptr = typed_array_base.viewed_array_buffer()->buffer().data();
  592. } else {
  593. VERIFY_NOT_REACHED();
  594. }
  595. glReadPixels(x, y, width, height, format, type, ptr);
  596. )~~~");
  597. continue;
  598. }
  599. if (function.name == "drawElements"sv) {
  600. function_impl_generator.append(R"~~~(
  601. glDrawElements(mode, count, type, reinterpret_cast<void*>(offset));
  602. needs_to_present();
  603. )~~~");
  604. continue;
  605. }
  606. if (function.name == "drawBuffers"sv) {
  607. function_impl_generator.append(R"~~~(
  608. glDrawBuffers(buffers.size(), buffers.data());
  609. )~~~");
  610. continue;
  611. }
  612. if (function.name.starts_with("uniformMatrix"sv)) {
  613. auto number_of_matrix_elements = function.name.substring_view(13, 1);
  614. function_impl_generator.set("number_of_matrix_elements", number_of_matrix_elements);
  615. if (webgl_version == 1) {
  616. function_impl_generator.set("array_argument_name", "value");
  617. } else {
  618. function_impl_generator.set("array_argument_name", "data");
  619. }
  620. function_impl_generator.append(R"~~~(
  621. auto matrix_size = @number_of_matrix_elements@ * @number_of_matrix_elements@;
  622. float const* raw_data = nullptr;
  623. u64 count = 0;
  624. if (@array_argument_name@.has<Vector<float>>()) {
  625. auto& vector_data = @array_argument_name@.get<Vector<float>>();
  626. raw_data = vector_data.data();
  627. count = vector_data.size() / matrix_size;
  628. } else {
  629. auto& typed_array_base = static_cast<JS::TypedArrayBase&>(*@array_argument_name@.get<GC::Root<WebIDL::BufferSource>>()->raw_object());
  630. auto& float32_array = verify_cast<JS::Float32Array>(typed_array_base);
  631. raw_data = float32_array.data().data();
  632. count = float32_array.array_length().length() / matrix_size;
  633. }
  634. )~~~");
  635. if (webgl_version == 2) {
  636. function_impl_generator.append(R"~~~(
  637. raw_data += src_offset;
  638. if (src_length == 0) {
  639. count -= src_offset;
  640. }
  641. if (src_offset + src_length <= count) {
  642. set_error(GL_INVALID_VALUE);
  643. return;
  644. }
  645. )~~~");
  646. }
  647. function_impl_generator.append(R"~~~(
  648. glUniformMatrix@number_of_matrix_elements@fv(location->handle(), count, transpose, raw_data);
  649. )~~~");
  650. continue;
  651. }
  652. 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) {
  653. auto number_of_vector_elements = function.name.substring_view(7, 1);
  654. auto element_type = function.name.substring_view(8, 1);
  655. if (element_type == "f"sv) {
  656. function_impl_generator.set("cpp_element_type", "float"sv);
  657. function_impl_generator.set("typed_array_type", "Float32Array"sv);
  658. function_impl_generator.set("gl_postfix", "f"sv);
  659. } else if (element_type == "i"sv) {
  660. function_impl_generator.set("cpp_element_type", "int"sv);
  661. function_impl_generator.set("typed_array_type", "Int32Array"sv);
  662. function_impl_generator.set("gl_postfix", "i"sv);
  663. } else {
  664. VERIFY_NOT_REACHED();
  665. }
  666. function_impl_generator.set("number_of_vector_elements", number_of_vector_elements);
  667. function_impl_generator.append(R"~~~(
  668. @cpp_element_type@ const* data = nullptr;
  669. size_t count = 0;
  670. if (v.has<Vector<@cpp_element_type@>>()) {
  671. auto& vector = v.get<Vector<@cpp_element_type@>>();
  672. data = vector.data();
  673. count = vector.size();
  674. } else if (v.has<GC::Root<WebIDL::BufferSource>>()) {
  675. auto& typed_array_base = static_cast<JS::TypedArrayBase&>(*v.get<GC::Root<WebIDL::BufferSource>>()->raw_object());
  676. auto& typed_array = verify_cast<JS::@typed_array_type@>(typed_array_base);
  677. data = typed_array.data().data();
  678. count = typed_array.array_length().length();
  679. } else {
  680. VERIFY_NOT_REACHED();
  681. }
  682. )~~~");
  683. if (webgl_version == 2) {
  684. function_impl_generator.append(R"~~~(
  685. data += src_offset;
  686. if (src_length == 0) {
  687. count -= src_offset;
  688. }
  689. if (src_offset + src_length <= count) {
  690. set_error(GL_INVALID_VALUE);
  691. return;
  692. }
  693. )~~~");
  694. }
  695. function_impl_generator.append(R"~~~(
  696. glUniform@number_of_vector_elements@@gl_postfix@v(location->handle(), count / @number_of_vector_elements@, data);
  697. )~~~");
  698. continue;
  699. }
  700. if (function.name == "vertexAttrib1fv"sv || function.name == "vertexAttrib2fv"sv || function.name == "vertexAttrib3fv"sv || function.name == "vertexAttrib4fv"sv) {
  701. auto number_of_vector_elements = function.name.substring_view(12, 1);
  702. function_impl_generator.set("number_of_vector_elements", number_of_vector_elements);
  703. function_impl_generator.append(R"~~~(
  704. if (values.has<Vector<float>>()) {
  705. auto& data = values.get<Vector<float>>();
  706. glVertexAttrib@number_of_vector_elements@fv(index, data.data());
  707. return;
  708. }
  709. auto& typed_array_base = static_cast<JS::TypedArrayBase&>(*values.get<GC::Root<WebIDL::BufferSource>>()->raw_object());
  710. auto& float32_array = verify_cast<JS::Float32Array>(typed_array_base);
  711. float const* data = float32_array.data().data();
  712. glVertexAttrib@number_of_vector_elements@fv(index, data);
  713. )~~~");
  714. continue;
  715. }
  716. if (function.name == "getParameter"sv) {
  717. generate_get_parameter(function_impl_generator);
  718. continue;
  719. }
  720. if (function.name == "getBufferParameter"sv) {
  721. generate_get_buffer_parameter(function_impl_generator);
  722. continue;
  723. }
  724. if (function.name == "getActiveUniform"sv) {
  725. function_impl_generator.append(R"~~~(
  726. GLint size = 0;
  727. GLenum type = 0;
  728. GLsizei buf_size = 256;
  729. GLsizei length = 0;
  730. GLchar name[256];
  731. glGetActiveUniform(program->handle(), index, buf_size, &length, &size, &type, name);
  732. auto readonly_bytes = ReadonlyBytes { name, static_cast<size_t>(length) };
  733. return WebGLActiveInfo::create(m_realm, String::from_utf8_without_validation(readonly_bytes), type, size);
  734. )~~~");
  735. continue;
  736. }
  737. if (function.name == "getActiveAttrib"sv) {
  738. function_impl_generator.append(R"~~~(
  739. GLint size = 0;
  740. GLenum type = 0;
  741. GLsizei buf_size = 256;
  742. GLsizei length = 0;
  743. GLchar name[256];
  744. glGetActiveAttrib(program->handle(), index, buf_size, &length, &size, &type, name);
  745. auto readonly_bytes = ReadonlyBytes { name, static_cast<size_t>(length) };
  746. return WebGLActiveInfo::create(m_realm, String::from_utf8_without_validation(readonly_bytes), type, size);
  747. )~~~");
  748. continue;
  749. }
  750. if (function.name == "getShaderInfoLog"sv) {
  751. function_impl_generator.append(R"~~~(
  752. GLint info_log_length = 0;
  753. glGetShaderiv(shader->handle(), GL_INFO_LOG_LENGTH, &info_log_length);
  754. Vector<GLchar> info_log;
  755. info_log.resize(info_log_length);
  756. if (!info_log_length)
  757. return String {};
  758. glGetShaderInfoLog(shader->handle(), info_log_length, nullptr, info_log.data());
  759. return String::from_utf8_without_validation(ReadonlyBytes { info_log.data(), static_cast<size_t>(info_log_length - 1) });
  760. )~~~");
  761. continue;
  762. }
  763. if (function.name == "getProgramInfoLog"sv) {
  764. function_impl_generator.append(R"~~~(
  765. GLint info_log_length = 0;
  766. glGetProgramiv(program->handle(), GL_INFO_LOG_LENGTH, &info_log_length);
  767. Vector<GLchar> info_log;
  768. info_log.resize(info_log_length);
  769. if (!info_log_length)
  770. return String {};
  771. glGetProgramInfoLog(program->handle(), info_log_length, nullptr, info_log.data());
  772. return String::from_utf8_without_validation(ReadonlyBytes { info_log.data(), static_cast<size_t>(info_log_length - 1) });
  773. )~~~");
  774. continue;
  775. }
  776. if (function.name == "getShaderPrecisionFormat"sv) {
  777. function_impl_generator.append(R"~~~(
  778. GLint range[2];
  779. GLint precision;
  780. glGetShaderPrecisionFormat(shadertype, precisiontype, range, &precision);
  781. return WebGLShaderPrecisionFormat::create(m_realm, range[0], range[1], precision);
  782. )~~~");
  783. continue;
  784. }
  785. if (function.name == "deleteBuffer"sv) {
  786. function_impl_generator.append(R"~~~(
  787. auto handle = buffer ? buffer->handle() : 0;
  788. glDeleteBuffers(1, &handle);
  789. )~~~");
  790. continue;
  791. }
  792. if (function.name == "deleteFramebuffer"sv) {
  793. function_impl_generator.append(R"~~~(
  794. auto handle = framebuffer ? framebuffer->handle() : 0;
  795. glDeleteFramebuffers(1, &handle);
  796. )~~~");
  797. continue;
  798. }
  799. if (function.name == "deleteTexture"sv) {
  800. function_impl_generator.append(R"~~~(
  801. auto handle = texture ? texture->handle() : 0;
  802. glDeleteTextures(1, &handle);
  803. )~~~");
  804. continue;
  805. }
  806. if (function.name == "deleteVertexArray"sv) {
  807. function_impl_generator.append(R"~~~(
  808. auto handle = vertex_array ? vertex_array->handle() : 0;
  809. glDeleteVertexArrays(1, &handle);
  810. )~~~");
  811. continue;
  812. }
  813. Vector<ByteString> gl_call_arguments;
  814. for (size_t i = 0; i < function.parameters.size(); ++i) {
  815. auto const& parameter = function.parameters[i];
  816. auto parameter_name = parameter.name.to_snakecase();
  817. if (parameter.type->is_numeric() || parameter.type->is_boolean()) {
  818. gl_call_arguments.append(parameter_name);
  819. continue;
  820. }
  821. if (parameter.type->is_string()) {
  822. function_impl_generator.set("parameter_name", parameter_name);
  823. function_impl_generator.append(R"~~~(
  824. auto @parameter_name@_null_terminated = null_terminated_string(@parameter_name@);
  825. )~~~");
  826. gl_call_arguments.append(ByteString::formatted("{}_null_terminated.data()", parameter_name));
  827. continue;
  828. }
  829. if (is_webgl_object_type(parameter.type->name())) {
  830. gl_call_arguments.append(ByteString::formatted("{} ? {}->handle() : 0", parameter_name, parameter_name));
  831. continue;
  832. }
  833. if (parameter.type->name() == "BufferSource"sv) {
  834. function_impl_generator.set("buffer_source_name", parameter_name);
  835. function_impl_generator.append(R"~~~(
  836. void const* ptr = nullptr;
  837. size_t byte_size = 0;
  838. if (@buffer_source_name@->is_typed_array_base()) {
  839. auto& typed_array_base = static_cast<JS::TypedArrayBase&>(*@buffer_source_name@->raw_object());
  840. ptr = typed_array_base.viewed_array_buffer()->buffer().data();
  841. byte_size = typed_array_base.viewed_array_buffer()->byte_length();
  842. } else if (@buffer_source_name@->is_data_view()) {
  843. auto& data_view = static_cast<JS::DataView&>(*@buffer_source_name@->raw_object());
  844. ptr = data_view.viewed_array_buffer()->buffer().data();
  845. byte_size = data_view.viewed_array_buffer()->byte_length();
  846. } else if (@buffer_source_name@->is_array_buffer()) {
  847. auto& array_buffer = static_cast<JS::ArrayBuffer&>(*@buffer_source_name@->raw_object());
  848. ptr = array_buffer.buffer().data();
  849. byte_size = array_buffer.byte_length();
  850. } else {
  851. VERIFY_NOT_REACHED();
  852. }
  853. )~~~");
  854. gl_call_arguments.append(ByteString::formatted("byte_size"));
  855. gl_call_arguments.append(ByteString::formatted("ptr"));
  856. continue;
  857. }
  858. VERIFY_NOT_REACHED();
  859. }
  860. StringBuilder gl_call_arguments_string_builder;
  861. gl_call_arguments_string_builder.join(", "sv, gl_call_arguments);
  862. auto gl_call_string = ByteString::formatted("{}({})", idl_to_gl_function_name(function.name), gl_call_arguments_string_builder.string_view());
  863. function_impl_generator.set("call_string", gl_call_string);
  864. if (gl_function_modifies_framebuffer(function.name)) {
  865. function_impl_generator.append(" needs_to_present();\n"sv);
  866. }
  867. if (function.return_type->name() == "undefined"sv) {
  868. function_impl_generator.append(" @call_string@;"sv);
  869. } else if (function.return_type->is_integer() || function.return_type->is_boolean()) {
  870. function_impl_generator.append(" return @call_string@;"sv);
  871. } else if (is_webgl_object_type(function.return_type->name())) {
  872. function_impl_generator.set("return_type_name", function.return_type->name());
  873. function_impl_generator.append(" return @return_type_name@::create(m_realm, @call_string@);"sv);
  874. } else {
  875. VERIFY_NOT_REACHED();
  876. }
  877. function_impl_generator.append("\n"sv);
  878. }
  879. header_file_generator.append(R"~~~(
  880. private:
  881. GC::Ref<JS::Realm> m_realm;
  882. NonnullOwnPtr<OpenGLContext> m_context;
  883. };
  884. }
  885. )~~~");
  886. implementation_file_generator.append(R"~~~(
  887. }
  888. )~~~");
  889. MUST(generated_header_file->write_until_depleted(header_file_generator.as_string_view().bytes()));
  890. MUST(generated_implementation_file->write_until_depleted(implementation_file_generator.as_string_view().bytes()));
  891. return 0;
  892. }