MarkupGenerator.cpp 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254
  1. /*
  2. * Copyright (c) 2020, Hunter Salyer <thefalsehonesty@gmail.com>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <AK/HashTable.h>
  7. #include <AK/StringBuilder.h>
  8. #include <AK/TypeCasts.h>
  9. #include <LibJS/Lexer.h>
  10. #include <LibJS/MarkupGenerator.h>
  11. #include <LibJS/Runtime/Array.h>
  12. #include <LibJS/Runtime/Date.h>
  13. #include <LibJS/Runtime/DatePrototype.h>
  14. #include <LibJS/Runtime/Error.h>
  15. #include <LibJS/Runtime/Object.h>
  16. #include <LibJS/Runtime/VM.h>
  17. namespace JS {
  18. ErrorOr<String> MarkupGenerator::html_from_source(StringView source)
  19. {
  20. StringBuilder builder;
  21. auto lexer = Lexer(source);
  22. for (auto token = lexer.next(); token.type() != TokenType::Eof; token = lexer.next()) {
  23. TRY(builder.try_append(token.trivia()));
  24. TRY(builder.try_append(TRY(wrap_string_in_style(token.value(), style_type_for_token(token)))));
  25. }
  26. return builder.to_string();
  27. }
  28. ErrorOr<String> MarkupGenerator::html_from_value(Value value)
  29. {
  30. StringBuilder output_html;
  31. HashTable<Object*> seen_objects;
  32. TRY(value_to_html(value, output_html, seen_objects));
  33. return output_html.to_string();
  34. }
  35. ErrorOr<String> MarkupGenerator::html_from_error(Error const& object, bool in_promise)
  36. {
  37. StringBuilder output_html;
  38. TRY(error_to_html(object, output_html, in_promise));
  39. return output_html.to_string();
  40. }
  41. ErrorOr<void> MarkupGenerator::value_to_html(Value value, StringBuilder& output_html, HashTable<Object*>& seen_objects)
  42. {
  43. if (value.is_empty()) {
  44. TRY(output_html.try_append("&lt;empty&gt;"sv));
  45. return {};
  46. }
  47. if (value.is_object()) {
  48. if (seen_objects.contains(&value.as_object())) {
  49. // FIXME: Maybe we should only do this for circular references,
  50. // not for all reoccurring objects.
  51. TRY(output_html.try_appendff("&lt;already printed Object {:p}&gt;", &value.as_object()));
  52. return {};
  53. }
  54. seen_objects.set(&value.as_object());
  55. }
  56. if (value.is_object()) {
  57. auto& object = value.as_object();
  58. if (is<Array>(object))
  59. return array_to_html(static_cast<Array const&>(object), output_html, seen_objects);
  60. TRY(output_html.try_append(TRY(wrap_string_in_style(object.class_name(), StyleType::ObjectType))));
  61. if (object.is_function())
  62. return function_to_html(object, output_html, seen_objects);
  63. if (is<Date>(object))
  64. return date_to_html(object, output_html, seen_objects);
  65. return object_to_html(object, output_html, seen_objects);
  66. }
  67. if (value.is_string())
  68. TRY(output_html.try_append(TRY(open_style_type(StyleType::String))));
  69. else if (value.is_number())
  70. TRY(output_html.try_append(TRY(open_style_type(StyleType::Number))));
  71. else if (value.is_boolean() || value.is_nullish())
  72. TRY(output_html.try_append(TRY(open_style_type(StyleType::KeywordBold))));
  73. if (value.is_string())
  74. TRY(output_html.try_append('"'));
  75. TRY(output_html.try_append(escape_html_entities(value.to_string_without_side_effects())));
  76. if (value.is_string())
  77. TRY(output_html.try_append('"'));
  78. TRY(output_html.try_append("</span>"sv));
  79. return {};
  80. }
  81. ErrorOr<void> MarkupGenerator::array_to_html(Array const& array, StringBuilder& html_output, HashTable<Object*>& seen_objects)
  82. {
  83. TRY(html_output.try_append(TRY(wrap_string_in_style("[ "sv, StyleType::Punctuation))));
  84. bool first = true;
  85. for (auto it = array.indexed_properties().begin(false); it != array.indexed_properties().end(); ++it) {
  86. if (!first)
  87. TRY(html_output.try_append(TRY(wrap_string_in_style(", "sv, StyleType::Punctuation))));
  88. first = false;
  89. // FIXME: Exception check
  90. TRY(value_to_html(array.get(it.index()).release_value(), html_output, seen_objects));
  91. }
  92. TRY(html_output.try_append(TRY(wrap_string_in_style(" ]"sv, StyleType::Punctuation))));
  93. return {};
  94. }
  95. ErrorOr<void> MarkupGenerator::object_to_html(Object const& object, StringBuilder& html_output, HashTable<Object*>& seen_objects)
  96. {
  97. TRY(html_output.try_append(TRY(wrap_string_in_style("{ "sv, StyleType::Punctuation))));
  98. bool first = true;
  99. for (auto& entry : object.indexed_properties()) {
  100. if (!first)
  101. TRY(html_output.try_append(TRY(wrap_string_in_style(", "sv, StyleType::Punctuation))));
  102. first = false;
  103. TRY(html_output.try_append(TRY(wrap_string_in_style(TRY(String::number(entry.index())), StyleType::Number))));
  104. TRY(html_output.try_append(TRY(wrap_string_in_style(": "sv, StyleType::Punctuation))));
  105. // FIXME: Exception check
  106. TRY(value_to_html(object.get(entry.index()).release_value(), html_output, seen_objects));
  107. }
  108. if (!object.indexed_properties().is_empty() && object.shape().property_count())
  109. TRY(html_output.try_append(TRY(wrap_string_in_style(", "sv, StyleType::Punctuation))));
  110. size_t index = 0;
  111. for (auto& it : object.shape().property_table()) {
  112. TRY(html_output.try_append(TRY(wrap_string_in_style(TRY(String::formatted("\"{}\"", escape_html_entities(it.key.to_display_string()))), StyleType::String))));
  113. TRY(html_output.try_append(TRY(wrap_string_in_style(": "sv, StyleType::Punctuation))));
  114. TRY(value_to_html(object.get_direct(it.value.offset), html_output, seen_objects));
  115. if (index != object.shape().property_count() - 1)
  116. TRY(html_output.try_append(TRY(wrap_string_in_style(", "sv, StyleType::Punctuation))));
  117. ++index;
  118. }
  119. TRY(html_output.try_append(TRY(wrap_string_in_style(" }"sv, StyleType::Punctuation))));
  120. return {};
  121. }
  122. ErrorOr<void> MarkupGenerator::function_to_html(Object const& function, StringBuilder& html_output, HashTable<Object*>&)
  123. {
  124. TRY(html_output.try_appendff("[{}]", function.class_name()));
  125. return {};
  126. }
  127. ErrorOr<void> MarkupGenerator::date_to_html(Object const& date, StringBuilder& html_output, HashTable<Object*>&)
  128. {
  129. TRY(html_output.try_appendff("Date {}", to_date_string(static_cast<Date const&>(date).date_value())));
  130. return {};
  131. }
  132. ErrorOr<void> MarkupGenerator::trace_to_html(TracebackFrame const& traceback_frame, StringBuilder& html_output)
  133. {
  134. auto function_name = escape_html_entities(traceback_frame.function_name);
  135. auto [line, column, _] = traceback_frame.source_range().start;
  136. auto get_filename_from_path = [&](StringView filename) -> StringView {
  137. auto last_slash_index = filename.find_last('/');
  138. return last_slash_index.has_value() ? filename.substring_view(*last_slash_index + 1) : filename;
  139. };
  140. auto filename = escape_html_entities(get_filename_from_path(traceback_frame.source_range().filename()));
  141. auto trace = TRY(String::formatted("at {} ({}:{}:{})", function_name, filename, line, column));
  142. TRY(html_output.try_appendff("&nbsp;&nbsp;{}<br>", trace));
  143. return {};
  144. }
  145. ErrorOr<void> MarkupGenerator::error_to_html(Error const& error, StringBuilder& html_output, bool in_promise)
  146. {
  147. auto& vm = error.vm();
  148. auto name = error.get_without_side_effects(vm.names.name).value_or(js_undefined());
  149. auto message = error.get_without_side_effects(vm.names.message).value_or(js_undefined());
  150. auto name_string = name.to_string_without_side_effects();
  151. auto message_string = message.to_string_without_side_effects();
  152. auto uncaught_message = TRY(String::formatted("Uncaught {}[{}]: ", in_promise ? "(in promise) " : "", name_string));
  153. TRY(html_output.try_append(TRY(wrap_string_in_style(uncaught_message, StyleType::Invalid)).bytes_as_string_view()));
  154. TRY(html_output.try_appendff("{}<br>", message_string.is_empty() ? "\"\"" : escape_html_entities(message_string)));
  155. for (size_t i = 0; i < error.traceback().size() - min(error.traceback().size(), 3); i++) {
  156. auto& traceback_frame = error.traceback().at(i);
  157. TRY(trace_to_html(traceback_frame, html_output));
  158. }
  159. return {};
  160. }
  161. StringView MarkupGenerator::style_from_style_type(StyleType type)
  162. {
  163. switch (type) {
  164. case StyleType::Invalid:
  165. return "color: red;"sv;
  166. case StyleType::String:
  167. return "color: -libweb-palette-syntax-string;"sv;
  168. case StyleType::Number:
  169. return "color: -libweb-palette-syntax-number;"sv;
  170. case StyleType::KeywordBold:
  171. return "color: -libweb-palette-syntax-keyword; font-weight: bold;"sv;
  172. case StyleType::Punctuation:
  173. return "color: -libweb-palette-syntax-punctuation;"sv;
  174. case StyleType::Operator:
  175. return "color: -libweb-palette-syntax-operator;"sv;
  176. case StyleType::Keyword:
  177. return "color: -libweb-palette-syntax-keyword;"sv;
  178. case StyleType::ControlKeyword:
  179. return "color: -libweb-palette-syntax-control-keyword;"sv;
  180. case StyleType::Identifier:
  181. return "color: -libweb-palette-syntax-identifier;"sv;
  182. case StyleType::ObjectType:
  183. return "padding: 2px; background-color: #ddf; color: black; font-weight: bold;"sv;
  184. default:
  185. VERIFY_NOT_REACHED();
  186. }
  187. }
  188. MarkupGenerator::StyleType MarkupGenerator::style_type_for_token(Token token)
  189. {
  190. switch (token.category()) {
  191. case TokenCategory::Invalid:
  192. return StyleType::Invalid;
  193. case TokenCategory::Number:
  194. return StyleType::Number;
  195. case TokenCategory::String:
  196. return StyleType::String;
  197. case TokenCategory::Punctuation:
  198. return StyleType::Punctuation;
  199. case TokenCategory::Operator:
  200. return StyleType::Operator;
  201. case TokenCategory::Keyword:
  202. switch (token.type()) {
  203. case TokenType::BoolLiteral:
  204. case TokenType::NullLiteral:
  205. return StyleType::KeywordBold;
  206. default:
  207. return StyleType::Keyword;
  208. }
  209. case TokenCategory::ControlKeyword:
  210. return StyleType::ControlKeyword;
  211. case TokenCategory::Identifier:
  212. return StyleType::Identifier;
  213. default:
  214. dbgln("Unknown style type for token {}", token.name());
  215. VERIFY_NOT_REACHED();
  216. }
  217. }
  218. ErrorOr<String> MarkupGenerator::open_style_type(StyleType type)
  219. {
  220. return String::formatted("<span style=\"{}\">", style_from_style_type(type));
  221. }
  222. ErrorOr<String> MarkupGenerator::wrap_string_in_style(StringView source, StyleType type)
  223. {
  224. return String::formatted("<span style=\"{}\">{}</span>", style_from_style_type(type), escape_html_entities(source));
  225. }
  226. }