main.cpp 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833
  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 <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");
  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::");
  65. builder.append(endpoint);
  66. builder.append("::");
  67. builder.append(pascal_case(message));
  68. if (is_response)
  69. builder.append("Response");
  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("() {}");
  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(", ");
  239. }
  240. builder.append(") : ");
  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(", ");
  246. }
  247. builder.append(" {}");
  248. return builder.to_string();
  249. }
  250. void do_message(SourceGenerator message_generator, const String& name, const Vector<Parameter>& parameters, const String& 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. virtual ~@message.pascal_name@() override {}
  270. virtual u32 endpoint_magic() const override { return @endpoint.magic@; }
  271. virtual i32 message_id() const override { return (int)MessageID::@message.pascal_name@; }
  272. static i32 static_message_id() { return (int)MessageID::@message.pascal_name@; }
  273. virtual const char* message_name() const override { return "@endpoint.name@::@message.pascal_name@"; }
  274. static OwnPtr<@message.pascal_name@> decode(InputMemoryStream& stream, Core::Stream::LocalSocket& socket)
  275. {
  276. IPC::Decoder decoder { stream, socket };)~~~");
  277. for (auto const& parameter : parameters) {
  278. auto parameter_generator = message_generator.fork();
  279. parameter_generator.set("parameter.type", parameter.type);
  280. parameter_generator.set("parameter.name", parameter.name);
  281. if (parameter.type == "bool")
  282. parameter_generator.set("parameter.initial_value", "false");
  283. else
  284. parameter_generator.set("parameter.initial_value", "{}");
  285. parameter_generator.appendln(R"~~~(
  286. @parameter.type@ @parameter.name@ = @parameter.initial_value@;
  287. if (decoder.decode(@parameter.name@).is_error())
  288. return {};)~~~");
  289. if (parameter.attributes.contains_slow("UTF8")) {
  290. parameter_generator.appendln(R"~~~(
  291. if (!Utf8View(@parameter.name@).validate())
  292. return {};)~~~");
  293. }
  294. }
  295. StringBuilder builder;
  296. for (size_t i = 0; i < parameters.size(); ++i) {
  297. auto const& parameter = parameters[i];
  298. builder.appendff("move({})", parameter.name);
  299. if (i != parameters.size() - 1)
  300. builder.append(", ");
  301. }
  302. message_generator.set("message.constructor_call_parameters", builder.build());
  303. message_generator.appendln(R"~~~(
  304. return make<@message.pascal_name@>(@message.constructor_call_parameters@);
  305. })~~~");
  306. message_generator.appendln(R"~~~(
  307. virtual bool valid() const override { return m_ipc_message_valid; }
  308. virtual IPC::MessageBuffer encode() const override
  309. {
  310. VERIFY(valid());
  311. IPC::MessageBuffer buffer;
  312. IPC::Encoder stream(buffer);
  313. stream << endpoint_magic();
  314. stream << (int)MessageID::@message.pascal_name@;)~~~");
  315. for (auto const& parameter : parameters) {
  316. auto parameter_generator = message_generator.fork();
  317. parameter_generator.set("parameter.name", parameter.name);
  318. parameter_generator.appendln(R"~~~(
  319. stream << m_@parameter.name@;)~~~");
  320. }
  321. message_generator.appendln(R"~~~(
  322. return buffer;
  323. })~~~");
  324. for (auto const& 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. parameter_generator.appendln(R"~~~(
  329. const @parameter.type@& @parameter.name@() const { return m_@parameter.name@; }
  330. @parameter.type@ take_@parameter.name@() { return move(m_@parameter.name@); })~~~");
  331. }
  332. message_generator.appendln(R"~~~(
  333. private:
  334. bool m_ipc_message_valid { true };)~~~");
  335. for (auto const& parameter : parameters) {
  336. auto parameter_generator = message_generator.fork();
  337. parameter_generator.set("parameter.type", parameter.type);
  338. parameter_generator.set("parameter.name", parameter.name);
  339. parameter_generator.appendln(R"~~~(
  340. @parameter.type@ m_@parameter.name@ {};)~~~");
  341. }
  342. message_generator.appendln("\n};");
  343. }
  344. void do_message_for_proxy(SourceGenerator message_generator, Endpoint const& endpoint, Message const& message)
  345. {
  346. auto do_implement_proxy = [&](String const& name, Vector<Parameter> const& parameters, bool is_synchronous, bool is_try) {
  347. String return_type = "void";
  348. if (is_synchronous) {
  349. if (message.outputs.size() == 1)
  350. return_type = message.outputs[0].type;
  351. else if (!message.outputs.is_empty())
  352. return_type = message_name(endpoint.name, message.name, true);
  353. }
  354. String inner_return_type = return_type;
  355. if (is_try)
  356. return_type = String::formatted("IPC::IPCErrorOr<{}>", return_type);
  357. message_generator.set("message.name", message.name);
  358. message_generator.set("message.pascal_name", pascal_case(message.name));
  359. message_generator.set("message.complex_return_type", return_type);
  360. message_generator.set("async_prefix_maybe", is_synchronous ? "" : "async_");
  361. message_generator.set("try_prefix_maybe", is_try ? "try_" : "");
  362. message_generator.set("handler_name", name);
  363. message_generator.appendln(R"~~~(
  364. @message.complex_return_type@ @try_prefix_maybe@@async_prefix_maybe@@handler_name@()~~~");
  365. for (size_t i = 0; i < parameters.size(); ++i) {
  366. auto const& parameter = parameters[i];
  367. auto argument_generator = message_generator.fork();
  368. argument_generator.set("argument.type", parameter.type);
  369. argument_generator.set("argument.name", parameter.name);
  370. argument_generator.append("@argument.type@ @argument.name@");
  371. if (i != parameters.size() - 1)
  372. argument_generator.append(", ");
  373. }
  374. message_generator.append(") {");
  375. if (is_synchronous && !is_try) {
  376. if (return_type != "void") {
  377. message_generator.append(R"~~~(
  378. return )~~~");
  379. if (message.outputs.size() != 1)
  380. message_generator.append("move(*");
  381. } else {
  382. message_generator.append(R"~~~(
  383. (void) )~~~");
  384. }
  385. message_generator.append("m_connection.template send_sync<Messages::@endpoint.name@::@message.pascal_name@>(");
  386. } else if (is_try) {
  387. message_generator.append(R"~~~(
  388. auto result = m_connection.template send_sync_but_allow_failure<Messages::@endpoint.name@::@message.pascal_name@>()~~~");
  389. } else {
  390. message_generator.append(R"~~~(
  391. // FIXME: Handle post_message failures.
  392. (void) m_connection.post_message(Messages::@endpoint.name@::@message.pascal_name@ { )~~~");
  393. }
  394. for (size_t i = 0; i < parameters.size(); ++i) {
  395. auto const& parameter = parameters[i];
  396. auto argument_generator = message_generator.fork();
  397. argument_generator.set("argument.name", parameter.name);
  398. if (is_primitive_type(parameters[i].type))
  399. argument_generator.append("@argument.name@");
  400. else
  401. argument_generator.append("move(@argument.name@)");
  402. if (i != parameters.size() - 1)
  403. argument_generator.append(", ");
  404. }
  405. if (is_synchronous && !is_try) {
  406. if (return_type != "void") {
  407. message_generator.append(")");
  408. }
  409. if (message.outputs.size() == 1) {
  410. message_generator.append("->take_");
  411. message_generator.append(message.outputs[0].name);
  412. message_generator.append("()");
  413. } else
  414. message_generator.append(")");
  415. message_generator.append(";");
  416. } else if (is_try) {
  417. message_generator.append(R"~~~();
  418. if (!result)
  419. return IPC::ErrorCode::PeerDisconnected;)~~~");
  420. if (inner_return_type != "void") {
  421. message_generator.appendln(R"~~~(
  422. return move(*result);)~~~");
  423. } else {
  424. message_generator.appendln(R"~~~(
  425. return { };)~~~");
  426. }
  427. } else {
  428. message_generator.appendln(" });");
  429. }
  430. message_generator.appendln(R"~~~(
  431. })~~~");
  432. };
  433. do_implement_proxy(message.name, message.inputs, message.is_synchronous, false);
  434. if (message.is_synchronous) {
  435. do_implement_proxy(message.name, message.inputs, false, false);
  436. do_implement_proxy(message.name, message.inputs, true, true);
  437. }
  438. }
  439. void build_endpoint(SourceGenerator generator, Endpoint const& endpoint)
  440. {
  441. generator.set("endpoint.name", endpoint.name);
  442. generator.set("endpoint.magic", String::number(endpoint.magic));
  443. generator.appendln("\nnamespace Messages::@endpoint.name@ {");
  444. HashMap<String, int> message_ids = build_message_ids_for_endpoint(generator.fork(), endpoint);
  445. for (auto const& message : endpoint.messages) {
  446. String response_name;
  447. if (message.is_synchronous) {
  448. response_name = message.response_name();
  449. do_message(generator.fork(), response_name, message.outputs);
  450. }
  451. do_message(generator.fork(), message.name, message.inputs, response_name);
  452. }
  453. generator.appendln(R"~~~(
  454. } // namespace Messages::@endpoint.name@
  455. template<typename LocalEndpoint, typename PeerEndpoint>
  456. class @endpoint.name@Proxy {
  457. public:
  458. // Used to disambiguate the constructor call.
  459. struct Tag { };
  460. @endpoint.name@Proxy(IPC::Connection<LocalEndpoint, PeerEndpoint>& connection, Tag)
  461. : m_connection(connection)
  462. { })~~~");
  463. for (auto const& message : endpoint.messages)
  464. do_message_for_proxy(generator.fork(), endpoint, message);
  465. generator.appendln(R"~~~(
  466. private:
  467. IPC::Connection<LocalEndpoint, PeerEndpoint>& m_connection;
  468. };)~~~");
  469. generator.appendln(R"~~~(
  470. template<typename LocalEndpoint, typename PeerEndpoint>
  471. class @endpoint.name@Proxy;
  472. class @endpoint.name@Stub;
  473. class @endpoint.name@Endpoint {
  474. public:
  475. template<typename LocalEndpoint>
  476. using Proxy = @endpoint.name@Proxy<LocalEndpoint, @endpoint.name@Endpoint>;
  477. using Stub = @endpoint.name@Stub;
  478. static u32 static_magic() { return @endpoint.magic@; }
  479. static OwnPtr<IPC::Message> decode_message(ReadonlyBytes buffer, [[maybe_unused]] Core::Stream::LocalSocket& socket)
  480. {
  481. InputMemoryStream stream { buffer };
  482. u32 message_endpoint_magic = 0;
  483. stream >> message_endpoint_magic;
  484. if (stream.handle_any_error()) {)~~~");
  485. if constexpr (GENERATE_DEBUG) {
  486. generator.appendln(R"~~~(
  487. dbgln(\"Failed to read message endpoint magic\"))~~~");
  488. }
  489. generator.appendln(R"~~~(
  490. return {};
  491. }
  492. if (message_endpoint_magic != @endpoint.magic@) {)~~~");
  493. if constexpr (GENERATE_DEBUG) {
  494. generator.appendln(R"~~~(
  495. dbgln(\"@endpoint.name@: Endpoint magic number message_endpoint_magic != @endpoint.magic@, not my message! (the other endpoint may have handled it)\"))~~~");
  496. }
  497. generator.appendln(R"~~~(
  498. return {};
  499. }
  500. i32 message_id = 0;
  501. stream >> message_id;
  502. if (stream.handle_any_error()) {)~~~");
  503. if constexpr (GENERATE_DEBUG) {
  504. generator.appendln(R"~~~(
  505. dbgln(\"Failed to read message ID\"))~~~");
  506. }
  507. generator.appendln(R"~~~(
  508. return {};
  509. }
  510. OwnPtr<IPC::Message> message;
  511. switch (message_id) {)~~~");
  512. for (auto const& message : endpoint.messages) {
  513. auto do_decode_message = [&](const String& name) {
  514. auto message_generator = generator.fork();
  515. message_generator.set("message.name", name);
  516. message_generator.set("message.pascal_name", pascal_case(name));
  517. message_generator.appendln(R"~~~(
  518. case (int)Messages::@endpoint.name@::MessageID::@message.pascal_name@:
  519. message = Messages::@endpoint.name@::@message.pascal_name@::decode(stream, socket);
  520. break;)~~~");
  521. };
  522. do_decode_message(message.name);
  523. if (message.is_synchronous)
  524. do_decode_message(message.response_name());
  525. }
  526. generator.appendln(R"~~~(
  527. default:)~~~");
  528. if constexpr (GENERATE_DEBUG) {
  529. generator.appendln(R"~~~(
  530. dbgln(\"Failed to decode @endpoint.name@.({})\", message_id))~~~");
  531. }
  532. generator.appendln(R"~~~(
  533. return {};
  534. }
  535. if (stream.handle_any_error()) {)~~~");
  536. if constexpr (GENERATE_DEBUG) {
  537. generator.appendln(R"~~~(
  538. dbgln(\"Failed to read the message\");)~~~");
  539. }
  540. generator.appendln(R"~~~(
  541. return {};
  542. }
  543. return message;
  544. }
  545. };
  546. class @endpoint.name@Stub : public IPC::Stub {
  547. public:
  548. @endpoint.name@Stub() { }
  549. virtual ~@endpoint.name@Stub() override { }
  550. virtual u32 magic() const override { return @endpoint.magic@; }
  551. virtual String name() const override { return "@endpoint.name@"; }
  552. virtual OwnPtr<IPC::MessageBuffer> handle(const IPC::Message& message) override
  553. {
  554. switch (message.message_id()) {)~~~");
  555. for (auto const& message : endpoint.messages) {
  556. auto do_handle_message = [&](String const& name, Vector<Parameter> const& parameters, bool returns_something) {
  557. auto message_generator = generator.fork();
  558. StringBuilder argument_generator;
  559. for (size_t i = 0; i < parameters.size(); ++i) {
  560. auto const& parameter = parameters[i];
  561. argument_generator.append("request.");
  562. argument_generator.append(parameter.name);
  563. argument_generator.append("()");
  564. if (i != parameters.size() - 1)
  565. argument_generator.append(", ");
  566. }
  567. message_generator.set("message.pascal_name", pascal_case(name));
  568. message_generator.set("message.response_type", pascal_case(message.response_name()));
  569. message_generator.set("handler_name", name);
  570. message_generator.set("arguments", argument_generator.to_string());
  571. message_generator.appendln(R"~~~(
  572. case (int)Messages::@endpoint.name@::MessageID::@message.pascal_name@: {)~~~");
  573. if (returns_something) {
  574. if (message.outputs.is_empty()) {
  575. message_generator.appendln(R"~~~(
  576. [[maybe_unused]] auto& request = static_cast<const Messages::@endpoint.name@::@message.pascal_name@&>(message);
  577. @handler_name@(@arguments@);
  578. auto response = Messages::@endpoint.name@::@message.response_type@ { };
  579. return make<IPC::MessageBuffer>(response.encode());)~~~");
  580. } else {
  581. message_generator.appendln(R"~~~(
  582. [[maybe_unused]] auto& request = static_cast<const Messages::@endpoint.name@::@message.pascal_name@&>(message);
  583. auto response = @handler_name@(@arguments@);
  584. if (!response.valid())
  585. return {};
  586. return make<IPC::MessageBuffer>(response.encode());)~~~");
  587. }
  588. } else {
  589. message_generator.appendln(R"~~~(
  590. [[maybe_unused]] auto& request = static_cast<const Messages::@endpoint.name@::@message.pascal_name@&>(message);
  591. @handler_name@(@arguments@);
  592. return {};)~~~");
  593. }
  594. message_generator.appendln(R"~~~(
  595. })~~~");
  596. };
  597. do_handle_message(message.name, message.inputs, message.is_synchronous);
  598. }
  599. generator.appendln(R"~~~(
  600. default:
  601. return {};
  602. }
  603. })~~~");
  604. for (auto const& message : endpoint.messages) {
  605. auto message_generator = generator.fork();
  606. auto do_handle_message_decl = [&](String const& name, Vector<Parameter> const& parameters, bool is_response) {
  607. String return_type = "void";
  608. if (message.is_synchronous && !message.outputs.is_empty() && !is_response)
  609. return_type = message_name(endpoint.name, message.name, true);
  610. message_generator.set("message.complex_return_type", return_type);
  611. message_generator.set("handler_name", name);
  612. message_generator.appendln(R"~~~(
  613. virtual @message.complex_return_type@ @handler_name@()~~~");
  614. auto make_argument_type = [](String const& type) {
  615. StringBuilder builder;
  616. bool const_ref = !is_primitive_type(type);
  617. builder.append(type);
  618. if (const_ref)
  619. builder.append(" const&");
  620. return builder.to_string();
  621. };
  622. for (size_t i = 0; i < parameters.size(); ++i) {
  623. auto const& parameter = parameters[i];
  624. auto argument_generator = message_generator.fork();
  625. argument_generator.set("argument.type", make_argument_type(parameter.type));
  626. argument_generator.set("argument.name", parameter.name);
  627. argument_generator.append("[[maybe_unused]] @argument.type@ @argument.name@");
  628. if (i != parameters.size() - 1)
  629. argument_generator.append(", ");
  630. }
  631. if (is_response) {
  632. message_generator.append(") { };");
  633. } else {
  634. message_generator.appendln(") = 0;");
  635. }
  636. };
  637. do_handle_message_decl(message.name, message.inputs, false);
  638. }
  639. generator.appendln(R"~~~(
  640. private:
  641. };
  642. #ifdef __clang__
  643. #pragma clang diagnostic pop
  644. #endif)~~~");
  645. }
  646. void build(StringBuilder& builder, Vector<Endpoint> const& endpoints)
  647. {
  648. SourceGenerator generator { builder };
  649. generator.appendln("#pragma once");
  650. // This must occur before LibIPC/Decoder.h
  651. for (auto const& endpoint : endpoints) {
  652. for (auto const& include : endpoint.includes) {
  653. generator.appendln(include);
  654. }
  655. }
  656. generator.appendln(R"~~~(#include <AK/MemoryStream.h>
  657. #include <AK/OwnPtr.h>
  658. #include <AK/Result.h>
  659. #include <AK/Utf8View.h>
  660. #include <LibIPC/Connection.h>
  661. #include <LibIPC/Decoder.h>
  662. #include <LibIPC/Dictionary.h>
  663. #include <LibIPC/Encoder.h>
  664. #include <LibIPC/File.h>
  665. #include <LibIPC/Message.h>
  666. #include <LibIPC/Stub.h>
  667. #ifdef __clang__
  668. #pragma clang diagnostic push
  669. #pragma clang diagnostic ignored "-Wdefaulted-function-deleted"
  670. #endif)~~~");
  671. for (auto const& endpoint : endpoints)
  672. build_endpoint(generator.fork(), endpoint);
  673. }
  674. ErrorOr<int> serenity_main(Main::Arguments arguments)
  675. {
  676. if (arguments.argc != 2) {
  677. outln("usage: {} <IPC endpoint definition file>", arguments.strings[0]);
  678. return 1;
  679. }
  680. auto file = TRY(Core::File::open(arguments.strings[1], Core::OpenMode::ReadOnly));
  681. auto file_contents = file->read_all();
  682. auto endpoints = parse(file_contents);
  683. StringBuilder builder;
  684. build(builder, endpoints);
  685. outln("{}", builder.string_view());
  686. if constexpr (GENERATE_DEBUG) {
  687. for (auto& endpoint : endpoints) {
  688. warnln("Endpoint '{}' (magic: {})", endpoint.name, endpoint.magic);
  689. for (auto& message : endpoint.messages) {
  690. warnln(" Message: '{}'", message.name);
  691. warnln(" Sync: {}", message.is_synchronous);
  692. warnln(" Inputs:");
  693. for (auto& parameter : message.inputs)
  694. warnln(" Parameter: {} ({})", parameter.name, parameter.type);
  695. if (message.inputs.is_empty())
  696. warnln(" (none)");
  697. if (message.is_synchronous) {
  698. warnln(" Outputs:");
  699. for (auto& parameter : message.outputs)
  700. warnln(" Parameter: {} ({})", parameter.name, parameter.type);
  701. if (message.outputs.is_empty())
  702. warnln(" (none)");
  703. }
  704. }
  705. }
  706. }
  707. return 0;
  708. }