main.cpp 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876
  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. struct Parameter {
  16. Vector<String> attributes;
  17. String type;
  18. String name;
  19. };
  20. static String pascal_case(String const& identifier)
  21. {
  22. StringBuilder builder;
  23. bool was_new_word = true;
  24. for (auto ch : identifier) {
  25. if (ch == '_') {
  26. was_new_word = true;
  27. continue;
  28. }
  29. if (was_new_word) {
  30. builder.append(toupper(ch));
  31. was_new_word = false;
  32. } else
  33. builder.append(ch);
  34. }
  35. return builder.to_string();
  36. }
  37. struct Message {
  38. String name;
  39. bool is_synchronous { false };
  40. Vector<Parameter> inputs;
  41. Vector<Parameter> outputs;
  42. String response_name() const
  43. {
  44. StringBuilder builder;
  45. builder.append(pascal_case(name));
  46. builder.append("Response");
  47. return builder.to_string();
  48. }
  49. };
  50. struct Endpoint {
  51. Vector<String> includes;
  52. String name;
  53. u32 magic;
  54. Vector<Message> messages;
  55. };
  56. static bool is_primitive_type(String const& type)
  57. {
  58. return type.is_one_of("u8", "i8", "u16", "i16", "u32", "i32", "u64", "i64", "bool", "double", "float", "int", "unsigned", "unsigned int");
  59. }
  60. static String message_name(String const& endpoint, String& message, bool is_response)
  61. {
  62. StringBuilder builder;
  63. builder.append("Messages::");
  64. builder.append(endpoint);
  65. builder.append("::");
  66. builder.append(pascal_case(message));
  67. if (is_response)
  68. builder.append("Response");
  69. return builder.to_string();
  70. }
  71. int main(int argc, char** argv)
  72. {
  73. if (argc != 2) {
  74. outln("usage: {} <IPC endpoint definition file>", argv[0]);
  75. return 0;
  76. }
  77. auto file = Core::File::construct(argv[1]);
  78. if (!file->open(Core::OpenMode::ReadOnly)) {
  79. warnln("Error: Cannot open {}: {}", argv[1], file->error_string());
  80. return 1;
  81. }
  82. auto file_contents = file->read_all();
  83. GenericLexer lexer(file_contents);
  84. Vector<Endpoint> endpoints;
  85. auto assert_specific = [&](char ch) {
  86. if (lexer.peek() != ch)
  87. warnln("assert_specific: wanted '{}', but got '{}' at index {}", ch, lexer.peek(), lexer.tell());
  88. bool saw_expected = lexer.consume_specific(ch);
  89. VERIFY(saw_expected);
  90. };
  91. auto consume_whitespace = [&] {
  92. lexer.ignore_while([](char ch) { return isspace(ch); });
  93. if (lexer.peek() == '/' && lexer.peek(1) == '/')
  94. lexer.ignore_until([](char ch) { return ch == '\n'; });
  95. };
  96. auto parse_parameter = [&](Vector<Parameter>& storage) {
  97. for (;;) {
  98. Parameter parameter;
  99. consume_whitespace();
  100. if (lexer.peek() == ')')
  101. break;
  102. if (lexer.consume_specific('[')) {
  103. for (;;) {
  104. if (lexer.consume_specific(']')) {
  105. consume_whitespace();
  106. break;
  107. }
  108. if (lexer.consume_specific(',')) {
  109. consume_whitespace();
  110. }
  111. auto attribute = lexer.consume_until([](char ch) { return ch == ']' || ch == ','; });
  112. parameter.attributes.append(attribute);
  113. consume_whitespace();
  114. }
  115. }
  116. parameter.type = lexer.consume_until([](char ch) { return isspace(ch); });
  117. consume_whitespace();
  118. parameter.name = lexer.consume_until([](char ch) { return isspace(ch) || ch == ',' || ch == ')'; });
  119. consume_whitespace();
  120. storage.append(move(parameter));
  121. if (lexer.consume_specific(','))
  122. continue;
  123. if (lexer.peek() == ')')
  124. break;
  125. }
  126. };
  127. auto parse_parameters = [&](Vector<Parameter>& storage) {
  128. for (;;) {
  129. consume_whitespace();
  130. parse_parameter(storage);
  131. consume_whitespace();
  132. if (lexer.consume_specific(','))
  133. continue;
  134. if (lexer.peek() == ')')
  135. break;
  136. }
  137. };
  138. auto parse_message = [&] {
  139. Message message;
  140. consume_whitespace();
  141. message.name = lexer.consume_until([](char ch) { return isspace(ch) || ch == '('; });
  142. consume_whitespace();
  143. assert_specific('(');
  144. parse_parameters(message.inputs);
  145. assert_specific(')');
  146. consume_whitespace();
  147. assert_specific('=');
  148. auto type = lexer.consume();
  149. if (type == '>')
  150. message.is_synchronous = true;
  151. else if (type == '|')
  152. message.is_synchronous = false;
  153. else
  154. VERIFY_NOT_REACHED();
  155. consume_whitespace();
  156. if (message.is_synchronous) {
  157. assert_specific('(');
  158. parse_parameters(message.outputs);
  159. assert_specific(')');
  160. }
  161. consume_whitespace();
  162. endpoints.last().messages.append(move(message));
  163. };
  164. auto parse_messages = [&] {
  165. for (;;) {
  166. consume_whitespace();
  167. if (lexer.peek() == '}')
  168. break;
  169. parse_message();
  170. consume_whitespace();
  171. }
  172. };
  173. auto parse_include = [&] {
  174. String include;
  175. consume_whitespace();
  176. include = lexer.consume_while([](char ch) { return ch != '\n'; });
  177. consume_whitespace();
  178. endpoints.last().includes.append(move(include));
  179. };
  180. auto parse_includes = [&] {
  181. for (;;) {
  182. consume_whitespace();
  183. if (lexer.peek() != '#')
  184. break;
  185. parse_include();
  186. consume_whitespace();
  187. }
  188. };
  189. auto parse_endpoint = [&] {
  190. endpoints.empend();
  191. consume_whitespace();
  192. parse_includes();
  193. consume_whitespace();
  194. lexer.consume_specific("endpoint");
  195. consume_whitespace();
  196. endpoints.last().name = lexer.consume_while([](char ch) { return !isspace(ch); });
  197. endpoints.last().magic = Traits<String>::hash(endpoints.last().name);
  198. consume_whitespace();
  199. assert_specific('{');
  200. parse_messages();
  201. assert_specific('}');
  202. consume_whitespace();
  203. };
  204. while (lexer.tell() < file_contents.size())
  205. parse_endpoint();
  206. StringBuilder builder;
  207. SourceGenerator generator { builder };
  208. generator.append("#pragma once\n");
  209. // This must occur before LibIPC/Decoder.h
  210. for (auto& endpoint : endpoints) {
  211. for (auto& include : endpoint.includes) {
  212. generator.append(include);
  213. generator.append("\n");
  214. }
  215. }
  216. generator.append(R"~~~(#include <AK/MemoryStream.h>
  217. #include <AK/OwnPtr.h>
  218. #include <AK/Result.h>
  219. #include <AK/Utf8View.h>
  220. #include <LibIPC/Connection.h>
  221. #include <LibIPC/Decoder.h>
  222. #include <LibIPC/Dictionary.h>
  223. #include <LibIPC/Encoder.h>
  224. #include <LibIPC/File.h>
  225. #include <LibIPC/Message.h>
  226. #include <LibIPC/Stub.h>
  227. #ifdef __clang__
  228. #pragma clang diagnostic push
  229. #pragma clang diagnostic ignored "-Wdefaulted-function-deleted"
  230. #endif
  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, [[maybe_unused]] 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@).is_error())
  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 override { 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. @parameter.type@ take_@parameter.name@() { return move(m_@parameter.name@); }
  387. )~~~");
  388. }
  389. message_generator.append(R"~~~(
  390. private:
  391. bool m_ipc_message_valid { true };
  392. )~~~");
  393. for (auto& parameter : parameters) {
  394. auto parameter_generator = message_generator.fork();
  395. parameter_generator.set("parameter.type", parameter.type);
  396. parameter_generator.set("parameter.name", parameter.name);
  397. parameter_generator.append(R"~~~(
  398. @parameter.type@ m_@parameter.name@;
  399. )~~~");
  400. }
  401. message_generator.append(R"~~~(
  402. };
  403. )~~~");
  404. };
  405. for (auto& message : endpoint.messages) {
  406. String response_name;
  407. if (message.is_synchronous) {
  408. response_name = message.response_name();
  409. do_message(response_name, message.outputs);
  410. }
  411. do_message(message.name, message.inputs, response_name);
  412. }
  413. endpoint_generator.append(R"~~~(
  414. } // namespace Messages::@endpoint.name@
  415. )~~~");
  416. endpoint_generator.append(R"~~~(
  417. template<typename LocalEndpoint, typename PeerEndpoint>
  418. class @endpoint.name@Proxy {
  419. public:
  420. // Used to disambiguate the constructor call.
  421. struct Tag { };
  422. @endpoint.name@Proxy(IPC::Connection<LocalEndpoint, PeerEndpoint>& connection, Tag)
  423. : m_connection(connection)
  424. { }
  425. )~~~");
  426. for (auto& message : endpoint.messages) {
  427. auto message_generator = endpoint_generator.fork();
  428. auto do_implement_proxy = [&](String const& name, Vector<Parameter> const& parameters, bool is_synchronous, bool is_try) {
  429. String return_type = "void";
  430. if (is_synchronous) {
  431. if (message.outputs.size() == 1)
  432. return_type = message.outputs[0].type;
  433. else if (!message.outputs.is_empty())
  434. return_type = message_name(endpoint.name, message.name, true);
  435. }
  436. String inner_return_type = return_type;
  437. if (is_try) {
  438. StringBuilder builder;
  439. builder.append("Result<");
  440. builder.append(return_type);
  441. builder.append(", IPC::ErrorCode>");
  442. return_type = builder.to_string();
  443. }
  444. message_generator.set("message.name", message.name);
  445. message_generator.set("message.pascal_name", pascal_case(message.name));
  446. message_generator.set("message.complex_return_type", return_type);
  447. message_generator.set("async_prefix_maybe", is_synchronous ? "" : "async_");
  448. message_generator.set("try_prefix_maybe", is_try ? "try_" : "");
  449. message_generator.set("handler_name", name);
  450. message_generator.append(R"~~~(
  451. @message.complex_return_type@ @try_prefix_maybe@@async_prefix_maybe@@handler_name@()~~~");
  452. for (size_t i = 0; i < parameters.size(); ++i) {
  453. auto& parameter = parameters[i];
  454. auto argument_generator = message_generator.fork();
  455. argument_generator.set("argument.type", parameter.type);
  456. argument_generator.set("argument.name", parameter.name);
  457. argument_generator.append("@argument.type@ @argument.name@");
  458. if (i != parameters.size() - 1)
  459. argument_generator.append(", ");
  460. }
  461. message_generator.append(") {");
  462. if (is_synchronous && !is_try) {
  463. if (return_type != "void") {
  464. message_generator.append(R"~~~(
  465. return )~~~");
  466. if (message.outputs.size() != 1)
  467. message_generator.append("move(*");
  468. } else {
  469. message_generator.append(R"~~~(
  470. (void) )~~~");
  471. }
  472. message_generator.append("m_connection.template send_sync<Messages::@endpoint.name@::@message.pascal_name@>(");
  473. } else if (is_try) {
  474. message_generator.append(R"~~~(
  475. auto result = m_connection.template send_sync_but_allow_failure<Messages::@endpoint.name@::@message.pascal_name@>()~~~");
  476. } else {
  477. message_generator.append(R"~~~(
  478. // FIXME: Handle post_message failures.
  479. (void) m_connection.post_message(Messages::@endpoint.name@::@message.pascal_name@ { )~~~");
  480. }
  481. for (size_t i = 0; i < parameters.size(); ++i) {
  482. auto& parameter = parameters[i];
  483. auto argument_generator = message_generator.fork();
  484. argument_generator.set("argument.name", parameter.name);
  485. if (is_primitive_type(parameters[i].type))
  486. argument_generator.append("@argument.name@");
  487. else
  488. argument_generator.append("move(@argument.name@)");
  489. if (i != parameters.size() - 1)
  490. argument_generator.append(", ");
  491. }
  492. if (is_synchronous && !is_try) {
  493. if (return_type != "void") {
  494. message_generator.append(")");
  495. }
  496. if (message.outputs.size() == 1) {
  497. message_generator.append("->take_");
  498. message_generator.append(message.outputs[0].name);
  499. message_generator.append("()");
  500. } else
  501. message_generator.append(")");
  502. message_generator.append(";");
  503. } else if (is_try) {
  504. message_generator.append(R"~~~();
  505. if (!result)
  506. return IPC::ErrorCode::PeerDisconnected;
  507. )~~~");
  508. if (inner_return_type != "void") {
  509. message_generator.append(R"~~~(
  510. return move(*result);
  511. )~~~");
  512. } else {
  513. message_generator.append(R"~~~(
  514. return { };
  515. )~~~");
  516. }
  517. } else {
  518. message_generator.append(R"~~~( });
  519. )~~~");
  520. }
  521. message_generator.append(R"~~~(
  522. }
  523. )~~~");
  524. };
  525. do_implement_proxy(message.name, message.inputs, message.is_synchronous, false);
  526. if (message.is_synchronous) {
  527. do_implement_proxy(message.name, message.inputs, false, false);
  528. do_implement_proxy(message.name, message.inputs, true, true);
  529. }
  530. }
  531. endpoint_generator.append(R"~~~(
  532. private:
  533. IPC::Connection<LocalEndpoint, PeerEndpoint>& m_connection;
  534. };
  535. )~~~");
  536. endpoint_generator.append(R"~~~(
  537. template<typename LocalEndpoint, typename PeerEndpoint>
  538. class @endpoint.name@Proxy;
  539. class @endpoint.name@Stub;
  540. class @endpoint.name@Endpoint {
  541. public:
  542. template<typename LocalEndpoint>
  543. using Proxy = @endpoint.name@Proxy<LocalEndpoint, @endpoint.name@Endpoint>;
  544. using Stub = @endpoint.name@Stub;
  545. static u32 static_magic() { return @endpoint.magic@; }
  546. static OwnPtr<IPC::Message> decode_message(ReadonlyBytes buffer, [[maybe_unused]] int sockfd)
  547. {
  548. InputMemoryStream stream { buffer };
  549. u32 message_endpoint_magic = 0;
  550. stream >> message_endpoint_magic;
  551. if (stream.handle_any_error()) {
  552. )~~~");
  553. if constexpr (GENERATE_DEBUG) {
  554. endpoint_generator.append(R"~~~(
  555. dbgln("Failed to read message endpoint magic");
  556. )~~~");
  557. }
  558. endpoint_generator.append(R"~~~(
  559. return {};
  560. }
  561. if (message_endpoint_magic != @endpoint.magic@) {
  562. )~~~");
  563. if constexpr (GENERATE_DEBUG) {
  564. endpoint_generator.append(R"~~~(
  565. dbgln("@endpoint.name@: Endpoint magic number message_endpoint_magic != @endpoint.magic@, not my message! (the other endpoint may have handled it)");
  566. )~~~");
  567. }
  568. endpoint_generator.append(R"~~~(
  569. return {};
  570. }
  571. i32 message_id = 0;
  572. stream >> message_id;
  573. if (stream.handle_any_error()) {
  574. )~~~");
  575. if constexpr (GENERATE_DEBUG) {
  576. endpoint_generator.append(R"~~~(
  577. dbgln("Failed to read message ID");
  578. )~~~");
  579. }
  580. endpoint_generator.append(R"~~~(
  581. return {};
  582. }
  583. OwnPtr<IPC::Message> message;
  584. switch (message_id) {
  585. )~~~");
  586. for (auto& message : endpoint.messages) {
  587. auto do_decode_message = [&](const String& name) {
  588. auto message_generator = endpoint_generator.fork();
  589. message_generator.set("message.name", name);
  590. message_generator.set("message.pascal_name", pascal_case(name));
  591. message_generator.append(R"~~~(
  592. case (int)Messages::@endpoint.name@::MessageID::@message.pascal_name@:
  593. message = Messages::@endpoint.name@::@message.pascal_name@::decode(stream, sockfd);
  594. break;
  595. )~~~");
  596. };
  597. do_decode_message(message.name);
  598. if (message.is_synchronous)
  599. do_decode_message(message.response_name());
  600. }
  601. endpoint_generator.append(R"~~~(
  602. default:
  603. )~~~");
  604. if constexpr (GENERATE_DEBUG) {
  605. endpoint_generator.append(R"~~~(
  606. dbgln("Failed to decode @endpoint.name@.({})", message_id);
  607. )~~~");
  608. }
  609. endpoint_generator.append(R"~~~(
  610. return {};
  611. }
  612. if (stream.handle_any_error()) {
  613. )~~~");
  614. if constexpr (GENERATE_DEBUG) {
  615. endpoint_generator.append(R"~~~(
  616. dbgln("Failed to read the message");
  617. )~~~");
  618. }
  619. endpoint_generator.append(R"~~~(
  620. return {};
  621. }
  622. return message;
  623. }
  624. };
  625. class @endpoint.name@Stub : public IPC::Stub {
  626. public:
  627. @endpoint.name@Stub() { }
  628. virtual ~@endpoint.name@Stub() override { }
  629. virtual u32 magic() const override { return @endpoint.magic@; }
  630. virtual String name() const override { return "@endpoint.name@"; }
  631. virtual OwnPtr<IPC::MessageBuffer> handle(const IPC::Message& message) override
  632. {
  633. switch (message.message_id()) {
  634. )~~~");
  635. for (auto& message : endpoint.messages) {
  636. auto do_handle_message = [&](String const& name, Vector<Parameter> const& parameters, bool returns_something) {
  637. auto message_generator = endpoint_generator.fork();
  638. StringBuilder argument_generator;
  639. for (size_t i = 0; i < parameters.size(); ++i) {
  640. auto& parameter = parameters[i];
  641. argument_generator.append("request.");
  642. argument_generator.append(parameter.name);
  643. argument_generator.append("()");
  644. if (i != parameters.size() - 1)
  645. argument_generator.append(", ");
  646. }
  647. message_generator.set("message.pascal_name", pascal_case(name));
  648. message_generator.set("message.response_type", pascal_case(message.response_name()));
  649. message_generator.set("handler_name", name);
  650. message_generator.set("arguments", argument_generator.to_string());
  651. message_generator.append(R"~~~(
  652. case (int)Messages::@endpoint.name@::MessageID::@message.pascal_name@: {
  653. )~~~");
  654. if (returns_something) {
  655. if (message.outputs.is_empty()) {
  656. message_generator.append(R"~~~(
  657. [[maybe_unused]] auto& request = static_cast<const Messages::@endpoint.name@::@message.pascal_name@&>(message);
  658. @handler_name@(@arguments@);
  659. auto response = Messages::@endpoint.name@::@message.response_type@ { };
  660. return make<IPC::MessageBuffer>(response.encode());
  661. )~~~");
  662. } else {
  663. message_generator.append(R"~~~(
  664. [[maybe_unused]] auto& request = static_cast<const Messages::@endpoint.name@::@message.pascal_name@&>(message);
  665. auto response = @handler_name@(@arguments@);
  666. if (!response.valid())
  667. return {};
  668. return make<IPC::MessageBuffer>(response.encode());
  669. )~~~");
  670. }
  671. } else {
  672. message_generator.append(R"~~~(
  673. [[maybe_unused]] auto& request = static_cast<const Messages::@endpoint.name@::@message.pascal_name@&>(message);
  674. @handler_name@(@arguments@);
  675. return {};
  676. )~~~");
  677. }
  678. message_generator.append(R"~~~(
  679. }
  680. )~~~");
  681. };
  682. do_handle_message(message.name, message.inputs, message.is_synchronous);
  683. }
  684. endpoint_generator.append(R"~~~(
  685. default:
  686. return {};
  687. }
  688. }
  689. )~~~");
  690. for (auto& message : endpoint.messages) {
  691. auto message_generator = endpoint_generator.fork();
  692. auto do_handle_message_decl = [&](String const& name, Vector<Parameter> const& parameters, bool is_response) {
  693. String return_type = "void";
  694. if (message.is_synchronous && !message.outputs.is_empty() && !is_response)
  695. return_type = message_name(endpoint.name, message.name, true);
  696. message_generator.set("message.complex_return_type", return_type);
  697. message_generator.set("handler_name", name);
  698. message_generator.append(R"~~~(
  699. virtual @message.complex_return_type@ @handler_name@()~~~");
  700. auto make_argument_type = [](String const& type) {
  701. StringBuilder builder;
  702. bool const_ref = !is_primitive_type(type);
  703. builder.append(type);
  704. if (const_ref)
  705. builder.append(" const&");
  706. return builder.to_string();
  707. };
  708. for (size_t i = 0; i < parameters.size(); ++i) {
  709. auto& parameter = parameters[i];
  710. auto argument_generator = message_generator.fork();
  711. argument_generator.set("argument.type", make_argument_type(parameter.type));
  712. argument_generator.set("argument.name", parameter.name);
  713. argument_generator.append("[[maybe_unused]] @argument.type@ @argument.name@");
  714. if (i != parameters.size() - 1)
  715. argument_generator.append(", ");
  716. }
  717. if (is_response) {
  718. message_generator.append(R"~~~() { };
  719. )~~~");
  720. } else {
  721. message_generator.append(R"~~~() = 0;
  722. )~~~");
  723. }
  724. };
  725. do_handle_message_decl(message.name, message.inputs, false);
  726. }
  727. endpoint_generator.append(R"~~~(
  728. private:
  729. };
  730. #ifdef __clang__
  731. #pragma clang diagnostic pop
  732. #endif
  733. )~~~");
  734. }
  735. outln("{}", generator.as_string_view());
  736. if constexpr (GENERATE_DEBUG) {
  737. for (auto& endpoint : endpoints) {
  738. warnln("Endpoint '{}' (magic: {})", endpoint.name, endpoint.magic);
  739. for (auto& message : endpoint.messages) {
  740. warnln(" Message: '{}'", message.name);
  741. warnln(" Sync: {}", message.is_synchronous);
  742. warnln(" Inputs:");
  743. for (auto& parameter : message.inputs)
  744. warnln(" Parameter: {} ({})", parameter.name, parameter.type);
  745. if (message.inputs.is_empty())
  746. warnln(" (none)");
  747. if (message.is_synchronous) {
  748. warnln(" Outputs:");
  749. for (auto& parameter : message.outputs)
  750. warnln(" Parameter: {} ({})", parameter.name, parameter.type);
  751. if (message.outputs.is_empty())
  752. warnln(" (none)");
  753. }
  754. }
  755. }
  756. }
  757. }