main.cpp 29 KB

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