main.cpp 30 KB

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