GenerateWebGLRenderingContext.cpp 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909
  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 == "WebGLRenderingContext" ? 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 == "texImage2D"sv && function.overload_index == 0) {
  470. function_impl_generator.append(R"~~~(
  471. void const* pixels_ptr = nullptr;
  472. if (pixels) {
  473. auto const& viewed_array_buffer = pixels->viewed_array_buffer();
  474. auto const& byte_buffer = viewed_array_buffer->buffer();
  475. pixels_ptr = byte_buffer.data();
  476. }
  477. glTexImage2D(target, level, internalformat, width, height, border, format, type, pixels_ptr);
  478. )~~~");
  479. continue;
  480. }
  481. if (function.name == "texImage2D"sv && function.overload_index == 1) {
  482. // FIXME: If this function is called with an ImageData whose data attribute has been neutered,
  483. // an INVALID_VALUE error is generated.
  484. // FIXME: If this function is called with an ImageBitmap that has been neutered, an INVALID_VALUE
  485. // error is generated.
  486. // FIXME: If this function is called with an HTMLImageElement or HTMLVideoElement whose origin
  487. // differs from the origin of the containing Document, or with an HTMLCanvasElement,
  488. // ImageBitmap or OffscreenCanvas whose bitmap's origin-clean flag is set to false,
  489. // a SECURITY_ERR exception must be thrown. See Origin Restrictions.
  490. // FIXME: If source is null then an INVALID_VALUE error is generated.
  491. function_impl_generator.append(R"~~~(
  492. auto bitmap = source.visit(
  493. [](GC::Root<HTMLImageElement> const& source) -> RefPtr<Gfx::ImmutableBitmap> {
  494. return source->immutable_bitmap();
  495. },
  496. [](GC::Root<HTMLCanvasElement> const& source) -> RefPtr<Gfx::ImmutableBitmap> {
  497. auto surface = source->surface();
  498. if (!surface)
  499. return {};
  500. auto bitmap = MUST(Gfx::Bitmap::create(Gfx::BitmapFormat::RGBA8888, Gfx::AlphaType::Premultiplied, surface->size()));
  501. surface->read_into_bitmap(*bitmap);
  502. return Gfx::ImmutableBitmap::create(*bitmap);
  503. },
  504. [](GC::Root<HTMLVideoElement> const& source) -> RefPtr<Gfx::ImmutableBitmap> {
  505. return Gfx::ImmutableBitmap::create(*source->bitmap());
  506. },
  507. [](GC::Root<ImageBitmap> const& source) -> RefPtr<Gfx::ImmutableBitmap> {
  508. return Gfx::ImmutableBitmap::create(*source->bitmap());
  509. },
  510. [](GC::Root<ImageData> const& source) -> RefPtr<Gfx::ImmutableBitmap> {
  511. return Gfx::ImmutableBitmap::create(source->bitmap());
  512. });
  513. if (!bitmap)
  514. return;
  515. void const* pixels_ptr = bitmap->bitmap()->begin();
  516. int width = bitmap->width();
  517. int height = bitmap->height();
  518. glTexImage2D(target, level, internalformat, width, height, 0, format, type, pixels_ptr);
  519. )~~~");
  520. continue;
  521. }
  522. if (function.name == "texSubImage2D"sv && function.overload_index == 0) {
  523. function_impl_generator.append(R"~~~(
  524. void const* pixels_ptr = nullptr;
  525. if (pixels) {
  526. auto const& viewed_array_buffer = pixels->viewed_array_buffer();
  527. auto const& byte_buffer = viewed_array_buffer->buffer();
  528. pixels_ptr = byte_buffer.data();
  529. }
  530. glTexSubImage2D(target, level, xoffset, yoffset, width, height, format, type, pixels_ptr);
  531. )~~~");
  532. continue;
  533. }
  534. if (function.name == "getShaderParameter"sv) {
  535. function_impl_generator.append(R"~~~(
  536. GLint result = 0;
  537. glGetShaderiv(shader->handle(), pname, &result);
  538. return JS::Value(result);
  539. )~~~");
  540. continue;
  541. }
  542. if (function.name == "getProgramParameter"sv) {
  543. function_impl_generator.append(R"~~~(
  544. GLint result = 0;
  545. glGetProgramiv(program->handle(), pname, &result);
  546. return JS::Value(result);
  547. )~~~");
  548. continue;
  549. }
  550. if (function.name == "bufferData"sv && function.overload_index == 0) {
  551. function_impl_generator.append(R"~~~(
  552. glBufferData(target, size, 0, usage);
  553. )~~~");
  554. continue;
  555. }
  556. if (function.name == "readPixels"sv) {
  557. function_impl_generator.append(R"~~~(
  558. if (!pixels) {
  559. return;
  560. }
  561. void *ptr = nullptr;
  562. if (pixels->is_data_view()) {
  563. auto& data_view = static_cast<JS::DataView&>(*pixels->raw_object());
  564. ptr = data_view.viewed_array_buffer()->buffer().data();
  565. } else if (pixels->is_typed_array_base()) {
  566. auto& typed_array_base = static_cast<JS::TypedArrayBase&>(*pixels->raw_object());
  567. ptr = typed_array_base.viewed_array_buffer()->buffer().data();
  568. } else {
  569. VERIFY_NOT_REACHED();
  570. }
  571. glReadPixels(x, y, width, height, format, type, ptr);
  572. )~~~");
  573. continue;
  574. }
  575. if (function.name == "drawElements"sv) {
  576. function_impl_generator.append(R"~~~(
  577. glDrawElements(mode, count, type, reinterpret_cast<void*>(offset));
  578. needs_to_present();
  579. )~~~");
  580. continue;
  581. }
  582. if (function.name.starts_with("uniformMatrix"sv)) {
  583. auto number_of_matrix_elements = function.name.substring_view(13, 1);
  584. function_impl_generator.set("number_of_matrix_elements", number_of_matrix_elements);
  585. function_impl_generator.append(R"~~~(
  586. auto matrix_size = @number_of_matrix_elements@ * @number_of_matrix_elements@;
  587. if (value.has<Vector<float>>()) {
  588. auto& data = value.get<Vector<float>>();
  589. glUniformMatrix@number_of_matrix_elements@fv(location->handle(), data.size() / matrix_size, transpose, data.data());
  590. return;
  591. }
  592. auto& typed_array_base = static_cast<JS::TypedArrayBase&>(*value.get<GC::Root<WebIDL::BufferSource>>()->raw_object());
  593. auto& float32_array = verify_cast<JS::Float32Array>(typed_array_base);
  594. float const* data = float32_array.data().data();
  595. auto count = float32_array.array_length().length() / matrix_size;
  596. glUniformMatrix@number_of_matrix_elements@fv(location->handle(), count, transpose, data);
  597. )~~~");
  598. continue;
  599. }
  600. if (function.name == "uniform1fv"sv || function.name == "uniform2fv"sv || function.name == "uniform3fv"sv || function.name == "uniform4fv"sv) {
  601. auto number_of_matrix_elements = function.name.substring_view(7, 1);
  602. function_impl_generator.set("number_of_matrix_elements", number_of_matrix_elements);
  603. function_impl_generator.append(R"~~~(
  604. if (v.has<Vector<float>>()) {
  605. auto& data = v.get<Vector<float>>();
  606. glUniform@number_of_matrix_elements@fv(location->handle(), data.size() / @number_of_matrix_elements@, data.data());
  607. return;
  608. }
  609. auto& typed_array_base = static_cast<JS::TypedArrayBase&>(*v.get<GC::Root<WebIDL::BufferSource>>()->raw_object());
  610. auto& float32_array = verify_cast<JS::Float32Array>(typed_array_base);
  611. float const* data = float32_array.data().data();
  612. auto count = float32_array.array_length().length() / @number_of_matrix_elements@;
  613. glUniform@number_of_matrix_elements@fv(location->handle(), count, data);
  614. )~~~");
  615. continue;
  616. }
  617. if (function.name == "uniform1iv"sv || function.name == "uniform2iv"sv || function.name == "uniform3iv"sv || function.name == "uniform4iv"sv) {
  618. auto number_of_matrix_elements = function.name.substring_view(7, 1);
  619. function_impl_generator.set("number_of_matrix_elements", number_of_matrix_elements);
  620. function_impl_generator.append(R"~~~(
  621. if (v.has<Vector<int>>()) {
  622. auto& data = v.get<Vector<int>>();
  623. glUniform@number_of_matrix_elements@iv(location->handle(), data.size() / @number_of_matrix_elements@, data.data());
  624. return;
  625. }
  626. auto& typed_array_base = static_cast<JS::TypedArrayBase&>(*v.get<GC::Root<WebIDL::BufferSource>>()->raw_object());
  627. auto& int32_array = verify_cast<JS::Int32Array>(typed_array_base);
  628. int const* data = int32_array.data().data();
  629. auto count = int32_array.array_length().length() / @number_of_matrix_elements@;
  630. glUniform@number_of_matrix_elements@iv(location->handle(), count, data);
  631. )~~~");
  632. continue;
  633. }
  634. if (function.name == "getParameter"sv) {
  635. generate_get_parameter(function_impl_generator);
  636. continue;
  637. }
  638. if (function.name == "getBufferParameter"sv) {
  639. generate_get_buffer_parameter(function_impl_generator);
  640. continue;
  641. }
  642. if (function.name == "getActiveUniform"sv) {
  643. function_impl_generator.append(R"~~~(
  644. GLint size = 0;
  645. GLenum type = 0;
  646. GLsizei buf_size = 256;
  647. GLsizei length = 0;
  648. GLchar name[256];
  649. glGetActiveUniform(program->handle(), index, buf_size, &length, &size, &type, name);
  650. auto readonly_bytes = ReadonlyBytes { name, static_cast<size_t>(length) };
  651. return WebGLActiveInfo::create(m_realm, String::from_utf8_without_validation(readonly_bytes), type, size);
  652. )~~~");
  653. continue;
  654. }
  655. if (function.name == "getActiveAttrib"sv) {
  656. function_impl_generator.append(R"~~~(
  657. GLint size = 0;
  658. GLenum type = 0;
  659. GLsizei buf_size = 256;
  660. GLsizei length = 0;
  661. GLchar name[256];
  662. glGetActiveAttrib(program->handle(), index, buf_size, &length, &size, &type, name);
  663. auto readonly_bytes = ReadonlyBytes { name, static_cast<size_t>(length) };
  664. return WebGLActiveInfo::create(m_realm, String::from_utf8_without_validation(readonly_bytes), type, size);
  665. )~~~");
  666. continue;
  667. }
  668. if (function.name == "getShaderInfoLog"sv) {
  669. function_impl_generator.append(R"~~~(
  670. GLint info_log_length = 0;
  671. glGetShaderiv(shader->handle(), GL_INFO_LOG_LENGTH, &info_log_length);
  672. Vector<GLchar> info_log;
  673. info_log.resize(info_log_length);
  674. if (!info_log_length)
  675. return String {};
  676. glGetShaderInfoLog(shader->handle(), info_log_length, nullptr, info_log.data());
  677. return String::from_utf8_without_validation(ReadonlyBytes { info_log.data(), static_cast<size_t>(info_log_length - 1) });
  678. )~~~");
  679. continue;
  680. }
  681. if (function.name == "getProgramInfoLog"sv) {
  682. function_impl_generator.append(R"~~~(
  683. GLint info_log_length = 0;
  684. glGetProgramiv(program->handle(), GL_INFO_LOG_LENGTH, &info_log_length);
  685. Vector<GLchar> info_log;
  686. info_log.resize(info_log_length);
  687. if (!info_log_length)
  688. return String {};
  689. glGetProgramInfoLog(program->handle(), info_log_length, nullptr, info_log.data());
  690. return String::from_utf8_without_validation(ReadonlyBytes { info_log.data(), static_cast<size_t>(info_log_length - 1) });
  691. )~~~");
  692. continue;
  693. }
  694. if (function.name == "getShaderPrecisionFormat"sv) {
  695. function_impl_generator.append(R"~~~(
  696. GLint range[2];
  697. GLint precision;
  698. glGetShaderPrecisionFormat(shadertype, precisiontype, range, &precision);
  699. return WebGLShaderPrecisionFormat::create(m_realm, range[0], range[1], precision);
  700. )~~~");
  701. continue;
  702. }
  703. if (function.name == "deleteBuffer"sv) {
  704. function_impl_generator.append(R"~~~(
  705. auto handle = buffer ? buffer->handle() : 0;
  706. glDeleteBuffers(1, &handle);
  707. )~~~");
  708. continue;
  709. }
  710. if (function.name == "deleteFramebuffer"sv) {
  711. function_impl_generator.append(R"~~~(
  712. auto handle = framebuffer ? framebuffer->handle() : 0;
  713. glDeleteFramebuffers(1, &handle);
  714. )~~~");
  715. continue;
  716. }
  717. if (function.name == "deleteTexture"sv) {
  718. function_impl_generator.append(R"~~~(
  719. auto handle = texture ? texture->handle() : 0;
  720. glDeleteTextures(1, &handle);
  721. )~~~");
  722. continue;
  723. }
  724. if (function.name == "deleteVertexArray"sv) {
  725. function_impl_generator.append(R"~~~(
  726. auto handle = vertex_array ? vertex_array->handle() : 0;
  727. glDeleteVertexArrays(1, &handle);
  728. )~~~");
  729. continue;
  730. }
  731. Vector<ByteString> gl_call_arguments;
  732. for (size_t i = 0; i < function.parameters.size(); ++i) {
  733. auto const& parameter = function.parameters[i];
  734. auto parameter_name = parameter.name.to_snakecase();
  735. if (parameter.type->is_numeric() || parameter.type->is_boolean()) {
  736. gl_call_arguments.append(parameter_name);
  737. continue;
  738. }
  739. if (parameter.type->is_string()) {
  740. function_impl_generator.set("parameter_name", parameter_name);
  741. function_impl_generator.append(R"~~~(
  742. auto @parameter_name@_null_terminated = null_terminated_string(@parameter_name@);
  743. )~~~");
  744. gl_call_arguments.append(ByteString::formatted("{}_null_terminated.data()", parameter_name));
  745. continue;
  746. }
  747. if (is_webgl_object_type(parameter.type->name())) {
  748. gl_call_arguments.append(ByteString::formatted("{} ? {}->handle() : 0", parameter_name, parameter_name));
  749. continue;
  750. }
  751. if (parameter.type->name() == "BufferSource"sv) {
  752. function_impl_generator.set("buffer_source_name", parameter_name);
  753. function_impl_generator.append(R"~~~(
  754. void const* ptr = nullptr;
  755. size_t byte_size = 0;
  756. if (@buffer_source_name@->is_typed_array_base()) {
  757. auto& typed_array_base = static_cast<JS::TypedArrayBase&>(*@buffer_source_name@->raw_object());
  758. ptr = typed_array_base.viewed_array_buffer()->buffer().data();
  759. byte_size = typed_array_base.viewed_array_buffer()->byte_length();
  760. } else if (@buffer_source_name@->is_data_view()) {
  761. auto& data_view = static_cast<JS::DataView&>(*@buffer_source_name@->raw_object());
  762. ptr = data_view.viewed_array_buffer()->buffer().data();
  763. byte_size = data_view.viewed_array_buffer()->byte_length();
  764. } else if (@buffer_source_name@->is_array_buffer()) {
  765. auto& array_buffer = static_cast<JS::ArrayBuffer&>(*@buffer_source_name@->raw_object());
  766. ptr = array_buffer.buffer().data();
  767. byte_size = array_buffer.byte_length();
  768. } else {
  769. VERIFY_NOT_REACHED();
  770. }
  771. )~~~");
  772. gl_call_arguments.append(ByteString::formatted("byte_size"));
  773. gl_call_arguments.append(ByteString::formatted("ptr"));
  774. continue;
  775. }
  776. VERIFY_NOT_REACHED();
  777. }
  778. StringBuilder gl_call_arguments_string_builder;
  779. gl_call_arguments_string_builder.join(", "sv, gl_call_arguments);
  780. auto gl_call_string = ByteString::formatted("{}({})", idl_to_gl_function_name(function.name), gl_call_arguments_string_builder.string_view());
  781. function_impl_generator.set("call_string", gl_call_string);
  782. if (gl_function_modifies_framebuffer(function.name)) {
  783. function_impl_generator.append(" needs_to_present();\n"sv);
  784. }
  785. if (function.return_type->name() == "undefined"sv) {
  786. function_impl_generator.append(" @call_string@;"sv);
  787. } else if (function.return_type->is_integer() || function.return_type->is_boolean()) {
  788. function_impl_generator.append(" return @call_string@;"sv);
  789. } else if (is_webgl_object_type(function.return_type->name())) {
  790. function_impl_generator.set("return_type_name", function.return_type->name());
  791. function_impl_generator.append(" return @return_type_name@::create(m_realm, @call_string@);"sv);
  792. } else {
  793. VERIFY_NOT_REACHED();
  794. }
  795. function_impl_generator.append("\n"sv);
  796. }
  797. header_file_generator.append(R"~~~(
  798. private:
  799. GC::Ref<JS::Realm> m_realm;
  800. NonnullOwnPtr<OpenGLContext> m_context;
  801. };
  802. }
  803. )~~~");
  804. implementation_file_generator.append(R"~~~(
  805. }
  806. )~~~");
  807. MUST(generated_header_file->write_until_depleted(header_file_generator.as_string_view().bytes()));
  808. MUST(generated_implementation_file->write_until_depleted(implementation_file_generator.as_string_view().bytes()));
  809. return 0;
  810. }