GenerateAriaRoles.cpp 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389
  1. /*
  2. * Copyright (c) 2023, Jonah Shafran <jonahshafran@gmail.com>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include "GeneratorUtil.h"
  7. #include <AK/SourceGenerator.h>
  8. #include <AK/String.h>
  9. #include <LibCore/ArgsParser.h>
  10. #include <LibMain/Main.h>
  11. ErrorOr<void> generate_header_file(JsonObject& roles_data, Core::File& file);
  12. ErrorOr<void> generate_implementation_file(JsonObject& roles_data, Core::File& file);
  13. ErrorOr<int> serenity_main(Main::Arguments arguments)
  14. {
  15. StringView generated_header_path;
  16. StringView generated_implementation_path;
  17. StringView identifiers_json_path;
  18. Core::ArgsParser args_parser;
  19. args_parser.add_option(generated_header_path, "Path to the TransformFunctions header file to generate", "generated-header-path", 'h', "generated-header-path");
  20. args_parser.add_option(generated_implementation_path, "Path to the TransformFunctions implementation file to generate", "generated-implementation-path", 'c', "generated-implementation-path");
  21. args_parser.add_option(identifiers_json_path, "Path to the JSON file to read from", "json-path", 'j', "json-path");
  22. args_parser.parse(arguments);
  23. auto json = TRY(read_entire_file_as_json(identifiers_json_path));
  24. VERIFY(json.is_object());
  25. auto roles_data = json.as_object();
  26. auto generated_header_file = TRY(Core::File::open(generated_header_path, Core::File::OpenMode::Write));
  27. auto generated_implementation_file = TRY(Core::File::open(generated_implementation_path, Core::File::OpenMode::Write));
  28. TRY(generate_header_file(roles_data, *generated_header_file));
  29. TRY(generate_implementation_file(roles_data, *generated_implementation_file));
  30. return 0;
  31. }
  32. ErrorOr<void> generate_header_file(JsonObject& roles_data, Core::File& file)
  33. {
  34. StringBuilder builder;
  35. SourceGenerator generator { builder };
  36. generator.append(R"~~~(
  37. #pragma once
  38. #include <LibWeb/ARIA/RoleType.h>
  39. namespace Web::ARIA {
  40. )~~~");
  41. roles_data.for_each_member([&](auto& name, auto& value) -> void {
  42. VERIFY(value.is_object());
  43. JsonObject const& value_object = value.as_object();
  44. auto class_definition_generator = generator.fork();
  45. class_definition_generator.set("spec_link"sv, value_object.get_deprecated_string("specLink"sv).value());
  46. class_definition_generator.set("description"sv, value_object.get_deprecated_string("description"sv).value());
  47. class_definition_generator.set("name"sv, name);
  48. class_definition_generator.append(R"~~~(
  49. // @spec_link@
  50. // @description@
  51. class @name@ :
  52. )~~~");
  53. JsonArray const& super_classes = value_object.get_array("superClassRoles"sv).value();
  54. bool first = true;
  55. super_classes.for_each([&](JsonValue const& value) {
  56. VERIFY(value.is_string());
  57. class_definition_generator.append(first ? " "sv : ", "sv);
  58. class_definition_generator.append(MUST(String::formatted("public {}", value.as_string())));
  59. first = false;
  60. });
  61. class_definition_generator.append(R"~~~(
  62. {
  63. public:
  64. @name@(AriaData const&);
  65. virtual HashTable<StateAndProperties> const& supported_states() const override;
  66. virtual HashTable<StateAndProperties> const& supported_properties() const override;
  67. virtual HashTable<StateAndProperties> const& required_states() const override;
  68. virtual HashTable<StateAndProperties> const& required_properties() const override;
  69. virtual HashTable<StateAndProperties> const& prohibited_properties() const override;
  70. virtual HashTable<StateAndProperties> const& prohibited_states() const override;
  71. virtual HashTable<Role> const& required_context_roles() const override;
  72. virtual HashTable<Role> const& required_owned_elements() const override;
  73. virtual bool accessible_name_required() const override;
  74. virtual bool children_are_presentational() const override;
  75. virtual DefaultValueType default_value_for_property_or_state(StateAndProperties) const override;
  76. protected:
  77. @name@();
  78. )~~~");
  79. auto name_from_source = value.as_object().get("nameFromSource"sv).value();
  80. if (!name_from_source.is_null())
  81. class_definition_generator.append(R"~~~(
  82. public:
  83. virtual NameFromSource name_from_source() const override;
  84. )~~~");
  85. class_definition_generator.appendln("};");
  86. });
  87. generator.appendln("}");
  88. TRY(file.write_until_depleted((generator.as_string_view().bytes())));
  89. return {};
  90. }
  91. String generate_hash_table_population(JsonArray const& values, StringView hash_table_name, StringView enum_class)
  92. {
  93. StringBuilder builder;
  94. values.for_each([&](auto& value) {
  95. VERIFY(value.is_string());
  96. builder.appendff(" {}.set({}::{});\n", hash_table_name, enum_class, value.as_string());
  97. });
  98. return MUST(builder.to_string());
  99. }
  100. void generate_hash_table_member(SourceGenerator& generator, StringView member_name, StringView hash_table_name, StringView enum_class, JsonArray const& values)
  101. {
  102. auto member_generator = generator.fork();
  103. member_generator.set("member_name"sv, member_name);
  104. member_generator.set("hash_table_name"sv, hash_table_name);
  105. member_generator.set("enum_class"sv, enum_class);
  106. member_generator.set("hash_table_size"sv, MUST(String::number(values.size())));
  107. if (values.size() == 0) {
  108. member_generator.append(R"~~~(
  109. HashTable<@enum_class@> const& @name@::@member_name@() const
  110. {
  111. static HashTable<@enum_class@> @hash_table_name@;
  112. return @hash_table_name@;
  113. }
  114. )~~~");
  115. return;
  116. }
  117. member_generator.append(R"~~~(
  118. HashTable<@enum_class@> const& @name@::@member_name@() const
  119. {
  120. static HashTable<@enum_class@> @hash_table_name@;
  121. if (@hash_table_name@.is_empty()) {
  122. @hash_table_name@.ensure_capacity(@hash_table_size@);
  123. )~~~");
  124. member_generator.append(generate_hash_table_population(values, hash_table_name, enum_class));
  125. member_generator.append(R"~~~(
  126. }
  127. return @hash_table_name@;
  128. }
  129. )~~~");
  130. }
  131. StringView aria_name_to_enum_name(StringView name)
  132. {
  133. if (name == "aria-activedescendant"sv) {
  134. return "AriaActiveDescendant"sv;
  135. } else if (name == "aria-atomic"sv) {
  136. return "AriaAtomic"sv;
  137. } else if (name == "aria-autocomplete"sv) {
  138. return "AriaAutoComplete"sv;
  139. } else if (name == "aria-busy"sv) {
  140. return "AriaBusy"sv;
  141. } else if (name == "aria-checked"sv) {
  142. return "AriaChecked"sv;
  143. } else if (name == "aria-colcount"sv) {
  144. return "AriaColCount"sv;
  145. } else if (name == "aria-colindex"sv) {
  146. return "AriaColIndex"sv;
  147. } else if (name == "aria-colspan"sv) {
  148. return "AriaColSpan"sv;
  149. } else if (name == "aria-controls"sv) {
  150. return "AriaControls"sv;
  151. } else if (name == "aria-current"sv) {
  152. return "AriaCurrent"sv;
  153. } else if (name == "aria-describedby"sv) {
  154. return "AriaDescribedBy"sv;
  155. } else if (name == "aria-details"sv) {
  156. return "AriaDetails"sv;
  157. } else if (name == "aria-disabled"sv) {
  158. return "AriaDisabled"sv;
  159. } else if (name == "aria-dropeffect"sv) {
  160. return "AriaDropEffect"sv;
  161. } else if (name == "aria-errormessage"sv) {
  162. return "AriaErrorMessage"sv;
  163. } else if (name == "aria-expanded"sv) {
  164. return "AriaExpanded"sv;
  165. } else if (name == "aria-flowto"sv) {
  166. return "AriaFlowTo"sv;
  167. } else if (name == "aria-grabbed"sv) {
  168. return "AriaGrabbed"sv;
  169. } else if (name == "aria-haspopup"sv) {
  170. return "AriaHasPopup"sv;
  171. } else if (name == "aria-hidden"sv) {
  172. return "AriaHidden"sv;
  173. } else if (name == "aria-invalid"sv) {
  174. return "AriaInvalid"sv;
  175. } else if (name == "aria-keyshortcuts"sv) {
  176. return "AriaKeyShortcuts"sv;
  177. } else if (name == "aria-label"sv) {
  178. return "AriaLabel"sv;
  179. } else if (name == "aria-labelledby"sv) {
  180. return "AriaLabelledBy"sv;
  181. } else if (name == "aria-level"sv) {
  182. return "AriaLevel"sv;
  183. } else if (name == "aria-live"sv) {
  184. return "AriaLive"sv;
  185. } else if (name == "aria-modal"sv) {
  186. return "AriaModal"sv;
  187. } else if (name == "aria-multiline"sv) {
  188. return "AriaMultiLine"sv;
  189. } else if (name == "aria-multiselectable"sv) {
  190. return "AriaMultiSelectable"sv;
  191. } else if (name == "aria-orientation"sv) {
  192. return "AriaOrientation"sv;
  193. } else if (name == "aria-owns"sv) {
  194. return "AriaOwns"sv;
  195. } else if (name == "aria-placeholder"sv) {
  196. return "AriaPlaceholder"sv;
  197. } else if (name == "aria-posinset"sv) {
  198. return "AriaPosInSet"sv;
  199. } else if (name == "aria-pressed"sv) {
  200. return "AriaPressed"sv;
  201. } else if (name == "aria-readonly"sv) {
  202. return "AriaReadOnly"sv;
  203. } else if (name == "aria-relevant"sv) {
  204. return "AriaRelevant"sv;
  205. } else if (name == "aria-required"sv) {
  206. return "AriaRequired"sv;
  207. } else if (name == "aria-roledescription"sv) {
  208. return "AriaRoleDescription"sv;
  209. } else if (name == "aria-rowcount"sv) {
  210. return "AriaRowCount"sv;
  211. } else if (name == "aria-rowindex"sv) {
  212. return "AriaRowIndex"sv;
  213. } else if (name == "aria-rowspan"sv) {
  214. return "AriaRowSpan"sv;
  215. } else if (name == "aria-selected"sv) {
  216. return "AriaSelected"sv;
  217. } else if (name == "aria-setsize"sv) {
  218. return "AriaSetSize"sv;
  219. } else if (name == "aria-sort"sv) {
  220. return "AriaSort"sv;
  221. } else if (name == "aria-valuemax"sv) {
  222. return "AriaValueMax"sv;
  223. } else if (name == "aria-valuemin"sv) {
  224. return "AriaValueMin"sv;
  225. } else if (name == "aria-valuenow"sv) {
  226. return "AriaValueNow"sv;
  227. } else if (name == "aria-valuetext"sv) {
  228. return "AriaValueText"sv;
  229. } else {
  230. VERIFY_NOT_REACHED();
  231. }
  232. }
  233. JsonArray translate_aria_names_to_enum(JsonArray const& names)
  234. {
  235. JsonArray translated_names;
  236. names.for_each([&](JsonValue const& value) {
  237. VERIFY(value.is_string());
  238. auto name = value.as_string();
  239. MUST(translated_names.append(aria_name_to_enum_name(name)));
  240. });
  241. return translated_names;
  242. }
  243. ErrorOr<void> generate_implementation_file(JsonObject& roles_data, Core::File& file)
  244. {
  245. StringBuilder builder;
  246. SourceGenerator generator { builder };
  247. generator.append(R"~~~(
  248. #include <LibWeb/ARIA/AriaRoles.h>
  249. namespace Web::ARIA {
  250. )~~~");
  251. roles_data.for_each_member([&](auto& name, auto& value) -> void {
  252. VERIFY(value.is_object());
  253. auto member_generator = generator.fork();
  254. member_generator.set("name"sv, name);
  255. JsonObject const& value_object = value.as_object();
  256. JsonArray const& supported_states = translate_aria_names_to_enum(value_object.get_array("supportedStates"sv).value());
  257. generate_hash_table_member(member_generator, "supported_states"sv, "states"sv, "StateAndProperties"sv, supported_states);
  258. JsonArray const& supported_properties = translate_aria_names_to_enum(value_object.get_array("supportedProperties"sv).value());
  259. generate_hash_table_member(member_generator, "supported_properties"sv, "properties"sv, "StateAndProperties"sv, supported_properties);
  260. JsonArray const& required_states = translate_aria_names_to_enum(value_object.get_array("requiredStates"sv).value());
  261. generate_hash_table_member(member_generator, "required_states"sv, "states"sv, "StateAndProperties"sv, required_states);
  262. JsonArray const& required_properties = translate_aria_names_to_enum(value_object.get_array("requiredProperties"sv).value());
  263. generate_hash_table_member(member_generator, "required_properties"sv, "properties"sv, "StateAndProperties"sv, required_properties);
  264. JsonArray const& prohibited_states = translate_aria_names_to_enum(value_object.get_array("prohibitedStates"sv).value());
  265. generate_hash_table_member(member_generator, "prohibited_states"sv, "states"sv, "StateAndProperties"sv, prohibited_states);
  266. JsonArray const& prohibited_properties = translate_aria_names_to_enum(value_object.get_array("prohibitedProperties"sv).value());
  267. generate_hash_table_member(member_generator, "prohibited_properties"sv, "properties"sv, "StateAndProperties"sv, prohibited_properties);
  268. JsonArray const& required_context_roles = value_object.get_array("requiredContextRoles"sv).value();
  269. generate_hash_table_member(member_generator, "required_context_roles"sv, "roles"sv, "Role"sv, required_context_roles);
  270. JsonArray const& required_owned_elements = value_object.get_array("requiredOwnedElements"sv).value();
  271. generate_hash_table_member(member_generator, "required_owned_elements"sv, "roles"sv, "Role"sv, required_owned_elements);
  272. bool accessible_name_required = value_object.get_bool("accessibleNameRequired"sv).value();
  273. member_generator.set("accessible_name_required"sv, accessible_name_required ? "true"sv : "false"sv);
  274. bool children_are_presentational = value_object.get_bool("childrenArePresentational"sv).value();
  275. member_generator.set("children_are_presentational", children_are_presentational ? "true"sv : "false"sv);
  276. JsonArray const& super_classes = value.as_object().get_array("superClassRoles"sv).value();
  277. member_generator.set("parent", super_classes.at(0).as_string());
  278. member_generator.append(R"~~~(
  279. @name@::@name@() { }
  280. @name@::@name@(AriaData const& data)
  281. : @parent@(data)
  282. {
  283. }
  284. bool @name@::accessible_name_required() const
  285. {
  286. return @accessible_name_required@;
  287. }
  288. bool @name@::children_are_presentational() const
  289. {
  290. return @children_are_presentational@;
  291. }
  292. )~~~");
  293. JsonObject const& implicit_value_for_role = value_object.get_object("implicitValueForRole"sv).value();
  294. if (implicit_value_for_role.size() == 0) {
  295. member_generator.append(R"~~~(
  296. DefaultValueType @name@::default_value_for_property_or_state(StateAndProperties) const
  297. {
  298. return {};
  299. }
  300. )~~~");
  301. } else {
  302. member_generator.append(R"~~~(
  303. DefaultValueType @name@::default_value_for_property_or_state(StateAndProperties state_or_property) const
  304. {
  305. switch (state_or_property) {
  306. )~~~");
  307. implicit_value_for_role.for_each_member([&](auto& name, auto& value) {
  308. auto case_generator = member_generator.fork();
  309. VERIFY(value.is_string());
  310. case_generator.set("state_or_property"sv, aria_name_to_enum_name(name));
  311. case_generator.set("implicit_value"sv, value.as_string());
  312. case_generator.append(R"~~~(
  313. case StateAndProperties::@state_or_property@:
  314. return @implicit_value@;
  315. )~~~");
  316. });
  317. member_generator.append(R"~~~(
  318. default:
  319. return {};
  320. }
  321. }
  322. )~~~");
  323. }
  324. JsonValue const& name_from_source = value.as_object().get("nameFromSource"sv).value();
  325. if (!name_from_source.is_null()) {
  326. member_generator.set("name_from_source"sv, name_from_source.as_string());
  327. member_generator.append(R"~~~(
  328. NameFromSource @name@::name_from_source() const
  329. {
  330. return NameFromSource::@name_from_source@;
  331. }
  332. )~~~");
  333. }
  334. });
  335. generator.append("}");
  336. TRY(file.write_until_depleted(generator.as_string_view().bytes()));
  337. return {};
  338. }