Parser.h 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383
  1. /*
  2. * Copyright (c) 2020-2021, the SerenityOS developers.
  3. * Copyright (c) 2021-2023, Sam Atkins <atkinssj@serenityos.org>
  4. *
  5. * SPDX-License-Identifier: BSD-2-Clause
  6. */
  7. #pragma once
  8. #include <AK/Error.h>
  9. #include <AK/RefPtr.h>
  10. #include <AK/Vector.h>
  11. #include <LibWeb/CSS/CSSStyleDeclaration.h>
  12. #include <LibWeb/CSS/FontFace.h>
  13. #include <LibWeb/CSS/GeneralEnclosed.h>
  14. #include <LibWeb/CSS/MediaQuery.h>
  15. #include <LibWeb/CSS/Parser/Block.h>
  16. #include <LibWeb/CSS/Parser/ComponentValue.h>
  17. #include <LibWeb/CSS/Parser/Declaration.h>
  18. #include <LibWeb/CSS/Parser/DeclarationOrAtRule.h>
  19. #include <LibWeb/CSS/Parser/Function.h>
  20. #include <LibWeb/CSS/Parser/Rule.h>
  21. #include <LibWeb/CSS/Parser/TokenStream.h>
  22. #include <LibWeb/CSS/Parser/Tokenizer.h>
  23. #include <LibWeb/CSS/Ratio.h>
  24. #include <LibWeb/CSS/Selector.h>
  25. #include <LibWeb/CSS/StyleValue.h>
  26. #include <LibWeb/CSS/Supports.h>
  27. #include <LibWeb/CSS/UnicodeRange.h>
  28. #include <LibWeb/Forward.h>
  29. namespace Web::CSS::Parser {
  30. class ParsingContext {
  31. public:
  32. explicit ParsingContext(JS::Realm&);
  33. explicit ParsingContext(DOM::Document const&);
  34. explicit ParsingContext(DOM::Document const&, AK::URL);
  35. explicit ParsingContext(DOM::ParentNode&);
  36. bool in_quirks_mode() const;
  37. DOM::Document const* document() const { return m_document; }
  38. AK::URL complete_url(StringView) const;
  39. PropertyID current_property_id() const { return m_current_property_id; }
  40. void set_current_property_id(PropertyID property_id) { m_current_property_id = property_id; }
  41. JS::Realm& realm() const { return m_realm; }
  42. private:
  43. JS::NonnullGCPtr<JS::Realm> m_realm;
  44. JS::GCPtr<DOM::Document const> m_document;
  45. PropertyID m_current_property_id { PropertyID::Invalid };
  46. AK::URL m_url;
  47. };
  48. class Parser {
  49. public:
  50. static ErrorOr<Parser> create(ParsingContext const&, StringView input, StringView encoding = "utf-8"sv);
  51. Parser(Parser&&);
  52. CSSStyleSheet* parse_as_css_stylesheet(Optional<AK::URL> location);
  53. ElementInlineCSSStyleDeclaration* parse_as_style_attribute(DOM::Element&);
  54. CSSRule* parse_as_css_rule();
  55. Optional<StyleProperty> parse_as_supports_condition();
  56. enum class SelectorParsingMode {
  57. Standard,
  58. // `<forgiving-selector-list>` and `<forgiving-relative-selector-list>`
  59. // are handled with this parameter, not as separate functions.
  60. // https://drafts.csswg.org/selectors/#forgiving-selector
  61. Forgiving
  62. };
  63. // Contrary to the name, these parse a comma-separated list of selectors, according to the spec.
  64. Optional<SelectorList> parse_as_selector(SelectorParsingMode = SelectorParsingMode::Standard);
  65. Optional<SelectorList> parse_as_relative_selector(SelectorParsingMode = SelectorParsingMode::Standard);
  66. Vector<NonnullRefPtr<MediaQuery>> parse_as_media_query_list();
  67. RefPtr<MediaQuery> parse_as_media_query();
  68. RefPtr<Supports> parse_as_supports();
  69. RefPtr<StyleValue> parse_as_css_value(PropertyID);
  70. static RefPtr<StyleValue> parse_css_value(Badge<StyleComputer>, ParsingContext const&, PropertyID, Vector<ComponentValue> const&);
  71. static RefPtr<CalculatedStyleValue> parse_calculated_value(Badge<StyleComputer>, ParsingContext const&, Vector<ComponentValue> const&);
  72. private:
  73. Parser(ParsingContext const&, Vector<Token>);
  74. enum class ParseError {
  75. IncludesIgnoredVendorPrefix,
  76. SyntaxError,
  77. };
  78. template<typename T>
  79. using ParseErrorOr = ErrorOr<T, ParseError>;
  80. // "Parse a stylesheet" is intended to be the normal parser entry point, for parsing stylesheets.
  81. struct ParsedStyleSheet {
  82. Optional<AK::URL> location;
  83. Vector<NonnullRefPtr<Rule>> rules;
  84. };
  85. template<typename T>
  86. ParsedStyleSheet parse_a_stylesheet(TokenStream<T>&, Optional<AK::URL> location);
  87. // "Parse a list of rules" is intended for the content of at-rules such as @media. It differs from "Parse a stylesheet" in the handling of <CDO-token> and <CDC-token>.
  88. template<typename T>
  89. Vector<NonnullRefPtr<Rule>> parse_a_list_of_rules(TokenStream<T>&);
  90. // "Parse a rule" is intended for use by the CSSStyleSheet#insertRule method, and similar functions which might exist, which parse text into a single rule.
  91. template<typename T>
  92. RefPtr<Rule> parse_a_rule(TokenStream<T>&);
  93. // "Parse a declaration" is used in @supports conditions. [CSS3-CONDITIONAL]
  94. template<typename T>
  95. Optional<Declaration> parse_a_declaration(TokenStream<T>&);
  96. template<typename T>
  97. Vector<DeclarationOrAtRule> parse_a_style_blocks_contents(TokenStream<T>&);
  98. // "Parse a list of declarations" is for the contents of a style attribute, which parses text into the contents of a single style rule.
  99. template<typename T>
  100. Vector<DeclarationOrAtRule> parse_a_list_of_declarations(TokenStream<T>&);
  101. // "Parse a component value" is for things that need to consume a single value, like the parsing rules for attr().
  102. template<typename T>
  103. Optional<ComponentValue> parse_a_component_value(TokenStream<T>&);
  104. // "Parse a list of component values" is for the contents of presentational attributes, which parse text into a single declaration’s value, or for parsing a stand-alone selector [SELECT] or list of Media Queries [MEDIAQ], as in Selectors API or the media HTML attribute.
  105. template<typename T>
  106. Vector<ComponentValue> parse_a_list_of_component_values(TokenStream<T>&);
  107. template<typename T>
  108. Vector<Vector<ComponentValue>> parse_a_comma_separated_list_of_component_values(TokenStream<T>&);
  109. enum class SelectorType {
  110. Standalone,
  111. Relative
  112. };
  113. template<typename T>
  114. ParseErrorOr<SelectorList> parse_a_selector_list(TokenStream<T>&, SelectorType, SelectorParsingMode = SelectorParsingMode::Standard);
  115. template<typename T>
  116. Vector<NonnullRefPtr<MediaQuery>> parse_a_media_query_list(TokenStream<T>&);
  117. template<typename T>
  118. RefPtr<Supports> parse_a_supports(TokenStream<T>&);
  119. Optional<Selector::SimpleSelector::ANPlusBPattern> parse_a_n_plus_b_pattern(TokenStream<ComponentValue>&);
  120. enum class TopLevel {
  121. No,
  122. Yes
  123. };
  124. template<typename T>
  125. [[nodiscard]] Vector<NonnullRefPtr<Rule>> consume_a_list_of_rules(TokenStream<T>&, TopLevel);
  126. template<typename T>
  127. [[nodiscard]] NonnullRefPtr<Rule> consume_an_at_rule(TokenStream<T>&);
  128. template<typename T>
  129. RefPtr<Rule> consume_a_qualified_rule(TokenStream<T>&);
  130. template<typename T>
  131. [[nodiscard]] Vector<DeclarationOrAtRule> consume_a_style_blocks_contents(TokenStream<T>&);
  132. template<typename T>
  133. [[nodiscard]] Vector<DeclarationOrAtRule> consume_a_list_of_declarations(TokenStream<T>&);
  134. template<typename T>
  135. Optional<Declaration> consume_a_declaration(TokenStream<T>&);
  136. template<typename T>
  137. [[nodiscard]] ComponentValue consume_a_component_value(TokenStream<T>&);
  138. template<typename T>
  139. NonnullRefPtr<Block> consume_a_simple_block(TokenStream<T>&);
  140. template<typename T>
  141. NonnullRefPtr<Function> consume_a_function(TokenStream<T>&);
  142. Optional<GeneralEnclosed> parse_general_enclosed(TokenStream<ComponentValue>&);
  143. CSSRule* parse_font_face_rule(TokenStream<ComponentValue>&);
  144. Vector<FontFace::Source> parse_font_face_src(TokenStream<ComponentValue>&);
  145. CSSRule* convert_to_rule(NonnullRefPtr<Rule>);
  146. PropertyOwningCSSStyleDeclaration* convert_to_style_declaration(Vector<DeclarationOrAtRule> const& declarations);
  147. Optional<StyleProperty> convert_to_style_property(Declaration const&);
  148. class Dimension {
  149. public:
  150. Dimension(Angle&& value)
  151. : m_value(move(value))
  152. {
  153. }
  154. Dimension(Frequency&& value)
  155. : m_value(move(value))
  156. {
  157. }
  158. Dimension(Length&& value)
  159. : m_value(move(value))
  160. {
  161. }
  162. Dimension(Percentage&& value)
  163. : m_value(move(value))
  164. {
  165. }
  166. Dimension(Resolution&& value)
  167. : m_value(move(value))
  168. {
  169. }
  170. Dimension(Time&& value)
  171. : m_value(move(value))
  172. {
  173. }
  174. bool is_angle() const;
  175. Angle angle() const;
  176. bool is_angle_percentage() const;
  177. AnglePercentage angle_percentage() const;
  178. bool is_frequency() const;
  179. Frequency frequency() const;
  180. bool is_frequency_percentage() const;
  181. FrequencyPercentage frequency_percentage() const;
  182. bool is_length() const;
  183. Length length() const;
  184. bool is_length_percentage() const;
  185. LengthPercentage length_percentage() const;
  186. bool is_percentage() const;
  187. Percentage percentage() const;
  188. bool is_resolution() const;
  189. Resolution resolution() const;
  190. bool is_time() const;
  191. Time time() const;
  192. bool is_time_percentage() const;
  193. TimePercentage time_percentage() const;
  194. private:
  195. Variant<Angle, Frequency, Length, Percentage, Resolution, Time> m_value;
  196. };
  197. Optional<Dimension> parse_dimension(ComponentValue const&);
  198. Optional<Color> parse_rgb_or_hsl_color(StringView function_name, Vector<ComponentValue> const&);
  199. Optional<Color> parse_color(ComponentValue const&);
  200. Optional<Length> parse_length(ComponentValue const&);
  201. Optional<Ratio> parse_ratio(TokenStream<ComponentValue>&);
  202. Optional<UnicodeRange> parse_unicode_range(TokenStream<ComponentValue>&);
  203. Optional<UnicodeRange> parse_unicode_range(StringView);
  204. Optional<GridSize> parse_grid_size(ComponentValue const&);
  205. Optional<GridMinMax> parse_min_max(Vector<ComponentValue> const&);
  206. Optional<GridRepeat> parse_repeat(Vector<ComponentValue> const&);
  207. Optional<ExplicitGridTrack> parse_track_sizing_function(ComponentValue const&);
  208. Optional<PositionValue> parse_position(TokenStream<ComponentValue>&, PositionValue initial_value = PositionValue::center());
  209. enum class AllowedDataUrlType {
  210. None,
  211. Image,
  212. Font,
  213. };
  214. Optional<AK::URL> parse_url_function(ComponentValue const&, AllowedDataUrlType = AllowedDataUrlType::None);
  215. Optional<Vector<LinearColorStopListElement>> parse_linear_color_stop_list(TokenStream<ComponentValue>&);
  216. Optional<Vector<AngularColorStopListElement>> parse_angular_color_stop_list(TokenStream<ComponentValue>&);
  217. RefPtr<StyleValue> parse_linear_gradient_function(ComponentValue const&);
  218. RefPtr<StyleValue> parse_conic_gradient_function(ComponentValue const&);
  219. RefPtr<StyleValue> parse_radial_gradient_function(ComponentValue const&);
  220. ParseErrorOr<NonnullRefPtr<StyleValue>> parse_css_value(PropertyID, TokenStream<ComponentValue>&);
  221. RefPtr<StyleValue> parse_css_value(ComponentValue const&);
  222. RefPtr<StyleValue> parse_builtin_value(ComponentValue const&);
  223. RefPtr<StyleValue> parse_dynamic_value(ComponentValue const&);
  224. RefPtr<CalculatedStyleValue> parse_calculated_value(Vector<ComponentValue> const&);
  225. RefPtr<StyleValue> parse_dimension_value(ComponentValue const&);
  226. RefPtr<StyleValue> parse_numeric_value(ComponentValue const&);
  227. RefPtr<StyleValue> parse_identifier_value(ComponentValue const&);
  228. RefPtr<StyleValue> parse_color_value(ComponentValue const&);
  229. RefPtr<StyleValue> parse_rect_value(ComponentValue const&);
  230. RefPtr<StyleValue> parse_string_value(ComponentValue const&);
  231. RefPtr<StyleValue> parse_image_value(ComponentValue const&);
  232. template<typename ParseFunction>
  233. RefPtr<StyleValue> parse_comma_separated_value_list(Vector<ComponentValue> const&, ParseFunction);
  234. RefPtr<StyleValue> parse_simple_comma_separated_value_list(Vector<ComponentValue> const&);
  235. RefPtr<StyleValue> parse_filter_value_list_value(Vector<ComponentValue> const&);
  236. RefPtr<StyleValue> parse_background_value(Vector<ComponentValue> const&);
  237. RefPtr<StyleValue> parse_single_background_position_value(TokenStream<ComponentValue>&);
  238. RefPtr<StyleValue> parse_single_background_repeat_value(TokenStream<ComponentValue>&);
  239. RefPtr<StyleValue> parse_single_background_size_value(TokenStream<ComponentValue>&);
  240. RefPtr<StyleValue> parse_border_value(Vector<ComponentValue> const&);
  241. RefPtr<StyleValue> parse_border_radius_value(Vector<ComponentValue> const&);
  242. RefPtr<StyleValue> parse_border_radius_shorthand_value(Vector<ComponentValue> const&);
  243. RefPtr<StyleValue> parse_content_value(Vector<ComponentValue> const&);
  244. RefPtr<StyleValue> parse_flex_value(Vector<ComponentValue> const&);
  245. RefPtr<StyleValue> parse_flex_flow_value(Vector<ComponentValue> const&);
  246. RefPtr<StyleValue> parse_font_value(Vector<ComponentValue> const&);
  247. RefPtr<StyleValue> parse_font_family_value(Vector<ComponentValue> const&, size_t start_index = 0);
  248. RefPtr<StyleValue> parse_list_style_value(Vector<ComponentValue> const&);
  249. RefPtr<StyleValue> parse_overflow_value(Vector<ComponentValue> const&);
  250. enum class AllowInsetKeyword {
  251. No,
  252. Yes,
  253. };
  254. RefPtr<StyleValue> parse_shadow_value(Vector<ComponentValue> const&, AllowInsetKeyword);
  255. RefPtr<StyleValue> parse_single_shadow_value(TokenStream<ComponentValue>&, AllowInsetKeyword);
  256. RefPtr<StyleValue> parse_text_decoration_value(Vector<ComponentValue> const&);
  257. RefPtr<StyleValue> parse_text_decoration_line_value(TokenStream<ComponentValue>&);
  258. RefPtr<StyleValue> parse_transform_value(Vector<ComponentValue> const&);
  259. RefPtr<StyleValue> parse_transform_origin_value(Vector<ComponentValue> const&);
  260. RefPtr<StyleValue> parse_grid_track_sizes(Vector<ComponentValue> const&);
  261. RefPtr<StyleValue> parse_grid_track_placement(Vector<ComponentValue> const&);
  262. RefPtr<StyleValue> parse_grid_track_placement_shorthand_value(Vector<ComponentValue> const&);
  263. RefPtr<StyleValue> parse_grid_template_areas_value(Vector<ComponentValue> const&);
  264. RefPtr<StyleValue> parse_grid_area_shorthand_value(Vector<ComponentValue> const&);
  265. // calc() parsing, according to https://www.w3.org/TR/css-values-3/#calc-syntax
  266. OwnPtr<CalculatedStyleValue::CalcSum> parse_calc_sum(TokenStream<ComponentValue>&);
  267. OwnPtr<CalculatedStyleValue::CalcProduct> parse_calc_product(TokenStream<ComponentValue>&);
  268. Optional<CalculatedStyleValue::CalcValue> parse_calc_value(TokenStream<ComponentValue>&);
  269. OwnPtr<CalculatedStyleValue::CalcNumberSum> parse_calc_number_sum(TokenStream<ComponentValue>&);
  270. OwnPtr<CalculatedStyleValue::CalcNumberProduct> parse_calc_number_product(TokenStream<ComponentValue>&);
  271. Optional<CalculatedStyleValue::CalcNumberValue> parse_calc_number_value(TokenStream<ComponentValue>&);
  272. OwnPtr<CalculatedStyleValue::CalcProductPartWithOperator> parse_calc_product_part_with_operator(TokenStream<ComponentValue>&);
  273. OwnPtr<CalculatedStyleValue::CalcSumPartWithOperator> parse_calc_sum_part_with_operator(TokenStream<ComponentValue>&);
  274. OwnPtr<CalculatedStyleValue::CalcNumberProductPartWithOperator> parse_calc_number_product_part_with_operator(TokenStream<ComponentValue>& tokens);
  275. OwnPtr<CalculatedStyleValue::CalcNumberSumPartWithOperator> parse_calc_number_sum_part_with_operator(TokenStream<ComponentValue>&);
  276. OwnPtr<CalculatedStyleValue::CalcSum> parse_calc_expression(Vector<ComponentValue> const&);
  277. ParseErrorOr<NonnullRefPtr<Selector>> parse_complex_selector(TokenStream<ComponentValue>&, SelectorType);
  278. ParseErrorOr<Optional<Selector::CompoundSelector>> parse_compound_selector(TokenStream<ComponentValue>&);
  279. Optional<Selector::Combinator> parse_selector_combinator(TokenStream<ComponentValue>&);
  280. ParseErrorOr<Selector::SimpleSelector> parse_attribute_simple_selector(ComponentValue const&);
  281. ParseErrorOr<Selector::SimpleSelector> parse_pseudo_simple_selector(TokenStream<ComponentValue>&);
  282. ParseErrorOr<Optional<Selector::SimpleSelector>> parse_simple_selector(TokenStream<ComponentValue>&);
  283. NonnullRefPtr<MediaQuery> parse_media_query(TokenStream<ComponentValue>&);
  284. OwnPtr<MediaCondition> parse_media_condition(TokenStream<ComponentValue>&, MediaCondition::AllowOr allow_or);
  285. Optional<MediaFeature> parse_media_feature(TokenStream<ComponentValue>&);
  286. Optional<MediaQuery::MediaType> parse_media_type(TokenStream<ComponentValue>&);
  287. OwnPtr<MediaCondition> parse_media_in_parens(TokenStream<ComponentValue>&);
  288. Optional<MediaFeatureValue> parse_media_feature_value(MediaFeatureID, TokenStream<ComponentValue>&);
  289. OwnPtr<Supports::Condition> parse_supports_condition(TokenStream<ComponentValue>&);
  290. Optional<Supports::InParens> parse_supports_in_parens(TokenStream<ComponentValue>&);
  291. Optional<Supports::Feature> parse_supports_feature(TokenStream<ComponentValue>&);
  292. static bool has_ignored_vendor_prefix(StringView);
  293. static bool is_builtin(StringView);
  294. struct PropertiesAndCustomProperties {
  295. Vector<StyleProperty> properties;
  296. HashMap<DeprecatedString, StyleProperty> custom_properties;
  297. };
  298. PropertiesAndCustomProperties extract_properties(Vector<DeclarationOrAtRule> const&);
  299. ParsingContext m_context;
  300. Vector<Token> m_tokens;
  301. TokenStream<Token> m_token_stream;
  302. };
  303. }
  304. namespace Web {
  305. CSS::CSSStyleSheet* parse_css_stylesheet(CSS::Parser::ParsingContext const&, StringView, Optional<AK::URL> location = {});
  306. CSS::ElementInlineCSSStyleDeclaration* parse_css_style_attribute(CSS::Parser::ParsingContext const&, StringView, DOM::Element&);
  307. RefPtr<CSS::StyleValue> parse_css_value(CSS::Parser::ParsingContext const&, StringView, CSS::PropertyID property_id = CSS::PropertyID::Invalid);
  308. Optional<CSS::SelectorList> parse_selector(CSS::Parser::ParsingContext const&, StringView);
  309. CSS::CSSRule* parse_css_rule(CSS::Parser::ParsingContext const&, StringView);
  310. RefPtr<CSS::MediaQuery> parse_media_query(CSS::Parser::ParsingContext const&, StringView);
  311. Vector<NonnullRefPtr<CSS::MediaQuery>> parse_media_query_list(CSS::Parser::ParsingContext const&, StringView);
  312. RefPtr<CSS::Supports> parse_css_supports(CSS::Parser::ParsingContext const&, StringView);
  313. Optional<CSS::StyleProperty> parse_css_supports_condition(CSS::Parser::ParsingContext const&, StringView);
  314. }