main.cpp 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841
  1. /*
  2. * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <AK/Debug.h>
  7. #include <AK/Function.h>
  8. #include <AK/GenericLexer.h>
  9. #include <AK/HashMap.h>
  10. #include <AK/SourceGenerator.h>
  11. #include <AK/StringBuilder.h>
  12. #include <LibCore/File.h>
  13. #include <ctype.h>
  14. #include <stdio.h>
  15. #ifndef GENERATE_DEBUG_CODE
  16. # define GENERATE_DEBUG_CODE 0
  17. #endif
  18. struct Parameter {
  19. Vector<String> attributes;
  20. String type;
  21. String name;
  22. };
  23. static String pascal_case(String const& identifier)
  24. {
  25. StringBuilder builder;
  26. bool was_new_word = true;
  27. for (auto ch : identifier) {
  28. if (ch == '_') {
  29. was_new_word = true;
  30. continue;
  31. }
  32. if (was_new_word) {
  33. builder.append(toupper(ch));
  34. was_new_word = false;
  35. } else
  36. builder.append(ch);
  37. }
  38. return builder.to_string();
  39. }
  40. struct Message {
  41. String name;
  42. bool is_synchronous { false };
  43. Vector<Parameter> inputs;
  44. Vector<Parameter> outputs;
  45. String response_name() const
  46. {
  47. StringBuilder builder;
  48. builder.append(pascal_case(name));
  49. builder.append("Response");
  50. return builder.to_string();
  51. }
  52. };
  53. struct Endpoint {
  54. String name;
  55. u32 magic;
  56. Vector<Message> messages;
  57. };
  58. bool is_primitive_type(String const& type)
  59. {
  60. return (type == "u8" || type == "i8" || type == "u16" || type == "i16"
  61. || type == "u32" || type == "i32" || type == "bool" || type == "double"
  62. || type == "float" || type == "int" || type == "unsigned" || type == "unsigned int");
  63. }
  64. String message_name(String const& endpoint, String& message, bool is_response)
  65. {
  66. StringBuilder builder;
  67. builder.append("Messages::");
  68. builder.append(endpoint);
  69. builder.append("::");
  70. builder.append(pascal_case(message));
  71. if (is_response)
  72. builder.append("Response");
  73. return builder.to_string();
  74. }
  75. int main(int argc, char** argv)
  76. {
  77. if (argc != 2) {
  78. outln("usage: {} <IPC endpoint definition file>", argv[0]);
  79. return 0;
  80. }
  81. auto file = Core::File::construct(argv[1]);
  82. if (!file->open(Core::IODevice::ReadOnly)) {
  83. warnln("Error: Cannot open {}: {}", argv[1], file->error_string());
  84. return 1;
  85. }
  86. auto file_contents = file->read_all();
  87. GenericLexer lexer(file_contents);
  88. Vector<Endpoint> endpoints;
  89. auto assert_specific = [&](char ch) {
  90. if (lexer.peek() != ch)
  91. warnln("assert_specific: wanted '{}', but got '{}' at index {}", ch, lexer.peek(), lexer.tell());
  92. bool saw_expected = lexer.consume_specific(ch);
  93. VERIFY(saw_expected);
  94. };
  95. auto consume_whitespace = [&] {
  96. lexer.ignore_while([](char ch) { return isspace(ch); });
  97. if (lexer.peek() == '/' && lexer.peek(1) == '/')
  98. lexer.ignore_until([](char ch) { return ch == '\n'; });
  99. };
  100. auto parse_parameter = [&](Vector<Parameter>& storage) {
  101. for (;;) {
  102. Parameter parameter;
  103. consume_whitespace();
  104. if (lexer.peek() == ')')
  105. break;
  106. if (lexer.consume_specific('[')) {
  107. for (;;) {
  108. if (lexer.consume_specific(']')) {
  109. consume_whitespace();
  110. break;
  111. }
  112. if (lexer.consume_specific(',')) {
  113. consume_whitespace();
  114. }
  115. auto attribute = lexer.consume_until([](char ch) { return ch == ']' || ch == ','; });
  116. parameter.attributes.append(attribute);
  117. consume_whitespace();
  118. }
  119. }
  120. parameter.type = lexer.consume_until([](char ch) { return isspace(ch); });
  121. consume_whitespace();
  122. parameter.name = lexer.consume_until([](char ch) { return isspace(ch) || ch == ',' || ch == ')'; });
  123. consume_whitespace();
  124. storage.append(move(parameter));
  125. if (lexer.consume_specific(','))
  126. continue;
  127. if (lexer.peek() == ')')
  128. break;
  129. }
  130. };
  131. auto parse_parameters = [&](Vector<Parameter>& storage) {
  132. for (;;) {
  133. consume_whitespace();
  134. parse_parameter(storage);
  135. consume_whitespace();
  136. if (lexer.consume_specific(','))
  137. continue;
  138. if (lexer.peek() == ')')
  139. break;
  140. }
  141. };
  142. auto parse_message = [&] {
  143. Message message;
  144. consume_whitespace();
  145. message.name = lexer.consume_until([](char ch) { return isspace(ch) || ch == '('; });
  146. consume_whitespace();
  147. assert_specific('(');
  148. parse_parameters(message.inputs);
  149. assert_specific(')');
  150. consume_whitespace();
  151. assert_specific('=');
  152. auto type = lexer.consume();
  153. if (type == '>')
  154. message.is_synchronous = true;
  155. else if (type == '|')
  156. message.is_synchronous = false;
  157. else
  158. VERIFY_NOT_REACHED();
  159. consume_whitespace();
  160. if (message.is_synchronous) {
  161. assert_specific('(');
  162. parse_parameters(message.outputs);
  163. assert_specific(')');
  164. }
  165. consume_whitespace();
  166. endpoints.last().messages.append(move(message));
  167. };
  168. auto parse_messages = [&] {
  169. for (;;) {
  170. consume_whitespace();
  171. parse_message();
  172. consume_whitespace();
  173. if (lexer.peek() == '}')
  174. break;
  175. }
  176. };
  177. auto parse_endpoint = [&] {
  178. endpoints.empend();
  179. consume_whitespace();
  180. lexer.consume_specific("endpoint");
  181. consume_whitespace();
  182. endpoints.last().name = lexer.consume_while([](char ch) { return !isspace(ch); });
  183. endpoints.last().magic = Traits<String>::hash(endpoints.last().name);
  184. consume_whitespace();
  185. if (lexer.peek() == '[') {
  186. // This only supports a single parameter for now, and adding multiple
  187. // endpoint parameter support is left as an exercise for the reader. :^)
  188. lexer.consume_specific('[');
  189. consume_whitespace();
  190. auto parameter = lexer.consume_while([](char ch) { return !isspace(ch) && ch != '='; });
  191. consume_whitespace();
  192. assert_specific('=');
  193. consume_whitespace();
  194. if (parameter == "magic") {
  195. // "magic" overwrites the default magic with a hardcoded one.
  196. auto magic_string = lexer.consume_while([](char ch) { return !isspace(ch) && ch != ']'; });
  197. endpoints.last().magic = magic_string.to_uint().value();
  198. } else {
  199. warnln("parse_endpoint: unknown parameter '{}' passed", parameter);
  200. VERIFY_NOT_REACHED();
  201. }
  202. assert_specific(']');
  203. consume_whitespace();
  204. }
  205. assert_specific('{');
  206. parse_messages();
  207. assert_specific('}');
  208. consume_whitespace();
  209. };
  210. while (lexer.tell() < file_contents.size())
  211. parse_endpoint();
  212. StringBuilder builder;
  213. SourceGenerator generator { builder };
  214. generator.append(R"~~~(
  215. #pragma once
  216. #include <AK/MemoryStream.h>
  217. #include <AK/OwnPtr.h>
  218. #include <AK/URL.h>
  219. #include <AK/Utf8View.h>
  220. #include <LibCore/AnonymousBuffer.h>
  221. #include <LibGfx/Color.h>
  222. #include <LibGfx/Rect.h>
  223. #include <LibGfx/ShareableBitmap.h>
  224. #include <LibIPC/Connection.h>
  225. #include <LibIPC/Decoder.h>
  226. #include <LibIPC/Dictionary.h>
  227. #include <LibIPC/Encoder.h>
  228. #include <LibIPC/File.h>
  229. #include <LibIPC/Message.h>
  230. #include <LibIPC/Stub.h>
  231. )~~~");
  232. for (auto& endpoint : endpoints) {
  233. auto endpoint_generator = generator.fork();
  234. endpoint_generator.set("endpoint.name", endpoint.name);
  235. endpoint_generator.set("endpoint.magic", String::number(endpoint.magic));
  236. endpoint_generator.append(R"~~~(
  237. namespace Messages::@endpoint.name@ {
  238. )~~~");
  239. HashMap<String, int> message_ids;
  240. endpoint_generator.append(R"~~~(
  241. enum class MessageID : i32 {
  242. )~~~");
  243. for (auto& message : endpoint.messages) {
  244. auto message_generator = endpoint_generator.fork();
  245. message_ids.set(message.name, message_ids.size() + 1);
  246. message_generator.set("message.name", message.name);
  247. message_generator.set("message.pascal_name", pascal_case(message.name));
  248. message_generator.set("message.id", String::number(message_ids.size()));
  249. message_generator.append(R"~~~(
  250. @message.pascal_name@ = @message.id@,
  251. )~~~");
  252. if (message.is_synchronous) {
  253. message_ids.set(message.response_name(), message_ids.size() + 1);
  254. message_generator.set("message.name", message.response_name());
  255. message_generator.set("message.pascal_name", pascal_case(message.response_name()));
  256. message_generator.set("message.id", String::number(message_ids.size()));
  257. message_generator.append(R"~~~(
  258. @message.pascal_name@ = @message.id@,
  259. )~~~");
  260. }
  261. }
  262. endpoint_generator.append(R"~~~(
  263. };
  264. )~~~");
  265. auto constructor_for_message = [&](const String& name, const Vector<Parameter>& parameters) {
  266. StringBuilder builder;
  267. builder.append(name);
  268. if (parameters.is_empty()) {
  269. builder.append("() {}");
  270. return builder.to_string();
  271. }
  272. builder.append('(');
  273. for (size_t i = 0; i < parameters.size(); ++i) {
  274. auto& parameter = parameters[i];
  275. builder.append(parameter.type);
  276. builder.append(" ");
  277. builder.append(parameter.name);
  278. if (i != parameters.size() - 1)
  279. builder.append(", ");
  280. }
  281. builder.append(") : ");
  282. for (size_t i = 0; i < parameters.size(); ++i) {
  283. auto& parameter = parameters[i];
  284. builder.append("m_");
  285. builder.append(parameter.name);
  286. builder.append("(move(");
  287. builder.append(parameter.name);
  288. builder.append("))");
  289. if (i != parameters.size() - 1)
  290. builder.append(", ");
  291. }
  292. builder.append(" {}");
  293. return builder.to_string();
  294. };
  295. auto do_message = [&](const String& name, const Vector<Parameter>& parameters, const String& response_type = {}) {
  296. auto message_generator = endpoint_generator.fork();
  297. auto pascal_name = pascal_case(name);
  298. message_generator.set("message.name", name);
  299. message_generator.set("message.pascal_name", pascal_name);
  300. message_generator.set("message.response_type", response_type);
  301. message_generator.set("message.constructor", constructor_for_message(pascal_name, parameters));
  302. message_generator.append(R"~~~(
  303. class @message.pascal_name@ final : public IPC::Message {
  304. public:
  305. )~~~");
  306. if (!response_type.is_null())
  307. message_generator.append(R"~~~(
  308. typedef class @message.response_type@ ResponseType;
  309. )~~~");
  310. message_generator.append(R"~~~(
  311. @message.pascal_name@(decltype(nullptr)) : m_ipc_message_valid(false) { }
  312. @message.pascal_name@(@message.pascal_name@ const&) = default;
  313. @message.pascal_name@(@message.pascal_name@&&) = default;
  314. @message.pascal_name@& operator=(@message.pascal_name@ const&) = default;
  315. @message.constructor@
  316. virtual ~@message.pascal_name@() override {}
  317. virtual u32 endpoint_magic() const override { return @endpoint.magic@; }
  318. virtual i32 message_id() const override { return (int)MessageID::@message.pascal_name@; }
  319. static i32 static_message_id() { return (int)MessageID::@message.pascal_name@; }
  320. virtual const char* message_name() const override { return "@endpoint.name@::@message.pascal_name@"; }
  321. static OwnPtr<@message.pascal_name@> decode(InputMemoryStream& stream, int sockfd)
  322. {
  323. IPC::Decoder decoder { stream, sockfd };
  324. )~~~");
  325. for (auto& parameter : parameters) {
  326. auto parameter_generator = message_generator.fork();
  327. parameter_generator.set("parameter.type", parameter.type);
  328. parameter_generator.set("parameter.name", parameter.name);
  329. if (parameter.type == "bool")
  330. parameter_generator.set("parameter.initial_value", "false");
  331. else
  332. parameter_generator.set("parameter.initial_value", "{}");
  333. parameter_generator.append(R"~~~(
  334. @parameter.type@ @parameter.name@ = @parameter.initial_value@;
  335. if (!decoder.decode(@parameter.name@))
  336. return {};
  337. )~~~");
  338. if (parameter.attributes.contains_slow("UTF8")) {
  339. parameter_generator.append(R"~~~(
  340. if (!Utf8View(@parameter.name@).validate())
  341. return {};
  342. )~~~");
  343. }
  344. }
  345. StringBuilder builder;
  346. for (size_t i = 0; i < parameters.size(); ++i) {
  347. auto& parameter = parameters[i];
  348. builder.append("move(");
  349. builder.append(parameter.name);
  350. builder.append(")");
  351. if (i != parameters.size() - 1)
  352. builder.append(", ");
  353. }
  354. message_generator.set("message.constructor_call_parameters", builder.build());
  355. message_generator.append(R"~~~(
  356. return make<@message.pascal_name@>(@message.constructor_call_parameters@);
  357. }
  358. )~~~");
  359. message_generator.append(R"~~~(
  360. virtual bool valid() const { return m_ipc_message_valid; }
  361. virtual IPC::MessageBuffer encode() const override
  362. {
  363. VERIFY(valid());
  364. IPC::MessageBuffer buffer;
  365. IPC::Encoder stream(buffer);
  366. stream << endpoint_magic();
  367. stream << (int)MessageID::@message.pascal_name@;
  368. )~~~");
  369. for (auto& parameter : parameters) {
  370. auto parameter_generator = message_generator.fork();
  371. parameter_generator.set("parameter.name", parameter.name);
  372. parameter_generator.append(R"~~~(
  373. stream << m_@parameter.name@;
  374. )~~~");
  375. }
  376. message_generator.append(R"~~~(
  377. return buffer;
  378. }
  379. )~~~");
  380. for (auto& parameter : parameters) {
  381. auto parameter_generator = message_generator.fork();
  382. parameter_generator.set("parameter.type", parameter.type);
  383. parameter_generator.set("parameter.name", parameter.name);
  384. parameter_generator.append(R"~~~(
  385. const @parameter.type@& @parameter.name@() const { return m_@parameter.name@; }
  386. )~~~");
  387. }
  388. message_generator.append(R"~~~(
  389. private:
  390. bool m_ipc_message_valid { true };
  391. )~~~");
  392. for (auto& parameter : parameters) {
  393. auto parameter_generator = message_generator.fork();
  394. parameter_generator.set("parameter.type", parameter.type);
  395. parameter_generator.set("parameter.name", parameter.name);
  396. parameter_generator.append(R"~~~(
  397. @parameter.type@ m_@parameter.name@;
  398. )~~~");
  399. }
  400. message_generator.append(R"~~~(
  401. };
  402. )~~~");
  403. };
  404. for (auto& message : endpoint.messages) {
  405. String response_name;
  406. if (message.is_synchronous) {
  407. response_name = message.response_name();
  408. do_message(response_name, message.outputs);
  409. }
  410. do_message(message.name, message.inputs, response_name);
  411. }
  412. endpoint_generator.append(R"~~~(
  413. } // namespace Messages::@endpoint.name@
  414. )~~~");
  415. endpoint_generator.append(R"~~~(
  416. template<typename LocalEndpoint, typename PeerEndpoint>
  417. class @endpoint.name@Proxy {
  418. public:
  419. // Used to disambiguate the constructor call.
  420. struct Tag { };
  421. @endpoint.name@Proxy(IPC::Connection<LocalEndpoint, PeerEndpoint>& connection, Tag)
  422. : m_connection(connection)
  423. { }
  424. )~~~");
  425. for (auto& message : endpoint.messages) {
  426. auto message_generator = endpoint_generator.fork();
  427. auto do_implement_proxy = [&](String const& name, Vector<Parameter> const& parameters, bool is_synchronous) {
  428. String return_type = "void";
  429. if (is_synchronous) {
  430. if (message.outputs.size() == 1)
  431. return_type = message.outputs[0].type;
  432. else if (!message.outputs.is_empty())
  433. return_type = message_name(endpoint.name, message.name, true);
  434. }
  435. message_generator.set("message.name", message.name);
  436. message_generator.set("message.pascal_name", pascal_case(message.name));
  437. message_generator.set("message.complex_return_type", return_type);
  438. message_generator.set("async_prefix_maybe", is_synchronous ? "" : "async_");
  439. message_generator.set("handler_name", name);
  440. message_generator.append(R"~~~(
  441. @message.complex_return_type@ @async_prefix_maybe@@handler_name@()~~~");
  442. for (size_t i = 0; i < parameters.size(); ++i) {
  443. auto& parameter = parameters[i];
  444. auto argument_generator = message_generator.fork();
  445. argument_generator.set("argument.type", parameter.type);
  446. argument_generator.set("argument.name", parameter.name);
  447. argument_generator.append("@argument.type@ @argument.name@");
  448. if (i != parameters.size() - 1)
  449. argument_generator.append(", ");
  450. }
  451. message_generator.append(") {");
  452. if (is_synchronous) {
  453. if (return_type != "void") {
  454. message_generator.append(R"~~~(
  455. return )~~~");
  456. if (message.outputs.size() != 1)
  457. message_generator.append(" move(*");
  458. } else {
  459. message_generator.append(R"~~~(
  460. )~~~");
  461. }
  462. message_generator.append("m_connection.template send_sync<Messages::@endpoint.name@::@message.pascal_name@>(");
  463. } else {
  464. message_generator.append(R"~~~(
  465. m_connection.post_message(Messages::@endpoint.name@::@message.pascal_name@ { )~~~");
  466. }
  467. for (size_t i = 0; i < parameters.size(); ++i) {
  468. auto& parameter = parameters[i];
  469. auto argument_generator = message_generator.fork();
  470. argument_generator.set("argument.name", parameter.name);
  471. if (is_primitive_type(parameters[i].type))
  472. argument_generator.append("@argument.name@");
  473. else
  474. argument_generator.append("move(@argument.name@)");
  475. if (i != parameters.size() - 1)
  476. argument_generator.append(", ");
  477. }
  478. if (is_synchronous) {
  479. if (return_type != "void") {
  480. message_generator.append(")");
  481. }
  482. if (message.outputs.size() == 1) {
  483. message_generator.append("->");
  484. message_generator.append(message.outputs[0].name);
  485. message_generator.append("()");
  486. } else
  487. message_generator.append(")");
  488. message_generator.append(R"~~~(;
  489. }
  490. )~~~");
  491. } else {
  492. message_generator.append(R"~~~( });
  493. }
  494. )~~~");
  495. }
  496. };
  497. do_implement_proxy(message.name, message.inputs, message.is_synchronous);
  498. if (message.is_synchronous)
  499. do_implement_proxy(message.name, message.inputs, false);
  500. }
  501. endpoint_generator.append(R"~~~(
  502. private:
  503. IPC::Connection<LocalEndpoint, PeerEndpoint>& m_connection;
  504. };
  505. )~~~");
  506. endpoint_generator.append(R"~~~(
  507. template<typename LocalEndpoint, typename PeerEndpoint>
  508. class @endpoint.name@Proxy;
  509. class @endpoint.name@Stub;
  510. class @endpoint.name@Endpoint {
  511. public:
  512. template<typename LocalEndpoint>
  513. using Proxy = @endpoint.name@Proxy<LocalEndpoint, @endpoint.name@Endpoint>;
  514. using Stub = @endpoint.name@Stub;
  515. static u32 static_magic() { return @endpoint.magic@; }
  516. static OwnPtr<IPC::Message> decode_message(ReadonlyBytes buffer, int sockfd)
  517. {
  518. InputMemoryStream stream { buffer };
  519. u32 message_endpoint_magic = 0;
  520. stream >> message_endpoint_magic;
  521. if (stream.handle_any_error()) {
  522. )~~~");
  523. if constexpr (GENERATE_DEBUG_CODE) {
  524. endpoint_generator.append(R"~~~(
  525. dbgln("Failed to read message endpoint magic");
  526. )~~~");
  527. }
  528. endpoint_generator.append(R"~~~(
  529. return {};
  530. }
  531. if (message_endpoint_magic != @endpoint.magic@) {
  532. )~~~");
  533. if constexpr (GENERATE_DEBUG_CODE) {
  534. endpoint_generator.append(R"~~~(
  535. dbgln("@endpoint.name@: Endpoint magic number message_endpoint_magic != @endpoint.magic@, not my message! (the other endpoint may have handled it)");
  536. )~~~");
  537. }
  538. endpoint_generator.append(R"~~~(
  539. return {};
  540. }
  541. i32 message_id = 0;
  542. stream >> message_id;
  543. if (stream.handle_any_error()) {
  544. )~~~");
  545. if constexpr (GENERATE_DEBUG_CODE) {
  546. endpoint_generator.append(R"~~~(
  547. dbgln("Failed to read message ID");
  548. )~~~");
  549. }
  550. endpoint_generator.append(R"~~~(
  551. return {};
  552. }
  553. OwnPtr<IPC::Message> message;
  554. switch (message_id) {
  555. )~~~");
  556. for (auto& message : endpoint.messages) {
  557. auto do_decode_message = [&](const String& name) {
  558. auto message_generator = endpoint_generator.fork();
  559. message_generator.set("message.name", name);
  560. message_generator.set("message.pascal_name", pascal_case(name));
  561. message_generator.append(R"~~~(
  562. case (int)Messages::@endpoint.name@::MessageID::@message.pascal_name@:
  563. message = Messages::@endpoint.name@::@message.pascal_name@::decode(stream, sockfd);
  564. break;
  565. )~~~");
  566. };
  567. do_decode_message(message.name);
  568. if (message.is_synchronous)
  569. do_decode_message(message.response_name());
  570. }
  571. endpoint_generator.append(R"~~~(
  572. default:
  573. )~~~");
  574. if constexpr (GENERATE_DEBUG_CODE) {
  575. endpoint_generator.append(R"~~~(
  576. dbgln("Failed to decode @endpoint.name@.({})", message_id);
  577. )~~~");
  578. }
  579. endpoint_generator.append(R"~~~(
  580. return {};
  581. }
  582. if (stream.handle_any_error()) {
  583. )~~~");
  584. if constexpr (GENERATE_DEBUG_CODE) {
  585. endpoint_generator.append(R"~~~(
  586. dbgln("Failed to read the message");
  587. )~~~");
  588. }
  589. endpoint_generator.append(R"~~~(
  590. return {};
  591. }
  592. return message;
  593. }
  594. };
  595. class @endpoint.name@Stub : public IPC::Stub {
  596. public:
  597. @endpoint.name@Stub() { }
  598. virtual ~@endpoint.name@Stub() override { }
  599. virtual u32 magic() const override { return @endpoint.magic@; }
  600. virtual String name() const override { return "@endpoint.name@"; }
  601. virtual OwnPtr<IPC::MessageBuffer> handle(const IPC::Message& message) override
  602. {
  603. switch (message.message_id()) {
  604. )~~~");
  605. for (auto& message : endpoint.messages) {
  606. auto do_handle_message = [&](String const& name, Vector<Parameter> const& parameters, bool returns_something) {
  607. auto message_generator = endpoint_generator.fork();
  608. StringBuilder argument_generator;
  609. for (size_t i = 0; i < parameters.size(); ++i) {
  610. auto& parameter = parameters[i];
  611. argument_generator.append("request.");
  612. argument_generator.append(parameter.name);
  613. argument_generator.append("()");
  614. if (i != parameters.size() - 1)
  615. argument_generator.append(", ");
  616. }
  617. message_generator.set("message.pascal_name", pascal_case(name));
  618. message_generator.set("message.response_type", pascal_case(message.response_name()));
  619. message_generator.set("handler_name", name);
  620. message_generator.set("arguments", argument_generator.to_string());
  621. message_generator.append(R"~~~(
  622. case (int)Messages::@endpoint.name@::MessageID::@message.pascal_name@: {
  623. )~~~");
  624. if (returns_something) {
  625. if (message.outputs.is_empty()) {
  626. message_generator.append(R"~~~(
  627. [[maybe_unused]] auto& request = static_cast<const Messages::@endpoint.name@::@message.pascal_name@&>(message);
  628. @handler_name@(@arguments@);
  629. auto response = Messages::@endpoint.name@::@message.response_type@ { };
  630. return make<IPC::MessageBuffer>(response.encode());
  631. )~~~");
  632. } else {
  633. message_generator.append(R"~~~(
  634. [[maybe_unused]] auto& request = static_cast<const Messages::@endpoint.name@::@message.pascal_name@&>(message);
  635. auto response = @handler_name@(@arguments@);
  636. if (!response.valid())
  637. return {};
  638. return make<IPC::MessageBuffer>(response.encode());
  639. )~~~");
  640. }
  641. } else {
  642. message_generator.append(R"~~~(
  643. [[maybe_unused]] auto& request = static_cast<const Messages::@endpoint.name@::@message.pascal_name@&>(message);
  644. @handler_name@(@arguments@);
  645. return {};
  646. )~~~");
  647. }
  648. message_generator.append(R"~~~(
  649. }
  650. )~~~");
  651. };
  652. do_handle_message(message.name, message.inputs, message.is_synchronous);
  653. }
  654. endpoint_generator.append(R"~~~(
  655. default:
  656. return {};
  657. }
  658. }
  659. )~~~");
  660. for (auto& message : endpoint.messages) {
  661. auto message_generator = endpoint_generator.fork();
  662. auto do_handle_message_decl = [&](String const& name, Vector<Parameter> const& parameters, bool is_response) {
  663. String return_type = "void";
  664. if (message.is_synchronous && !message.outputs.is_empty() && !is_response)
  665. return_type = message_name(endpoint.name, message.name, true);
  666. message_generator.set("message.complex_return_type", return_type);
  667. message_generator.set("handler_name", name);
  668. message_generator.append(R"~~~(
  669. virtual @message.complex_return_type@ @handler_name@()~~~");
  670. auto make_argument_type = [](String const& type) {
  671. StringBuilder builder;
  672. bool const_ref = !is_primitive_type(type);
  673. builder.append(type);
  674. if (const_ref)
  675. builder.append(" const&");
  676. return builder.to_string();
  677. };
  678. for (size_t i = 0; i < parameters.size(); ++i) {
  679. auto& parameter = parameters[i];
  680. auto argument_generator = message_generator.fork();
  681. argument_generator.set("argument.type", make_argument_type(parameter.type));
  682. argument_generator.set("argument.name", parameter.name);
  683. argument_generator.append("[[maybe_unused]] @argument.type@ @argument.name@");
  684. if (i != parameters.size() - 1)
  685. argument_generator.append(", ");
  686. }
  687. if (is_response) {
  688. message_generator.append(R"~~~() { };
  689. )~~~");
  690. } else {
  691. message_generator.append(R"~~~() = 0;
  692. )~~~");
  693. }
  694. };
  695. do_handle_message_decl(message.name, message.inputs, false);
  696. }
  697. endpoint_generator.append(R"~~~(
  698. private:
  699. };
  700. )~~~");
  701. }
  702. outln("{}", generator.as_string_view());
  703. #ifdef DEBUG
  704. for (auto& endpoint : endpoints) {
  705. warnln("Endpoint '{}' (magic: {})", endpoint.name, endpoint.magic);
  706. for (auto& message : endpoint.messages) {
  707. warnln(" Message: '{}'", message.name);
  708. warnln(" Sync: {}", message.is_synchronous);
  709. warnln(" Inputs:");
  710. for (auto& parameter : message.inputs)
  711. warnln(" Parameter: {} ({})", parameter.name, parameter.type);
  712. if (message.inputs.is_empty())
  713. warnln(" (none)");
  714. if (message.is_synchronous) {
  715. warnln(" Outputs:");
  716. for (auto& parameter : message.outputs)
  717. warnln(" Parameter: {} ({})", parameter.name, parameter.type);
  718. if (message.outputs.is_empty())
  719. warnln(" (none)");
  720. }
  721. }
  722. }
  723. #endif
  724. }