CSSStyleValue.h 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383
  1. /*
  2. * Copyright (c) 2018-2023, Andreas Kling <kling@serenityos.org>
  3. * Copyright (c) 2021, Tobias Christiansen <tobyase@serenityos.org>
  4. * Copyright (c) 2021-2024, Sam Atkins <sam@ladybird.org>
  5. * Copyright (c) 2022-2023, MacDue <macdue@dueutil.tech>
  6. *
  7. * SPDX-License-Identifier: BSD-2-Clause
  8. */
  9. #pragma once
  10. #include <AK/Concepts.h>
  11. #include <AK/GenericShorthands.h>
  12. #include <AK/NonnullOwnPtr.h>
  13. #include <AK/RefCounted.h>
  14. #include <AK/RefPtr.h>
  15. #include <AK/String.h>
  16. #include <AK/StringView.h>
  17. #include <AK/Variant.h>
  18. #include <AK/Vector.h>
  19. #include <AK/WeakPtr.h>
  20. #include <LibGfx/Color.h>
  21. #include <LibURL/URL.h>
  22. #include <LibWeb/CSS/Enums.h>
  23. #include <LibWeb/CSS/Keyword.h>
  24. #include <LibWeb/CSS/Length.h>
  25. #include <LibWeb/Forward.h>
  26. namespace Web::CSS {
  27. template<typename T>
  28. struct ValueComparingNonnullRefPtr : public NonnullRefPtr<T> {
  29. using NonnullRefPtr<T>::NonnullRefPtr;
  30. ValueComparingNonnullRefPtr(NonnullRefPtr<T> const& other)
  31. : NonnullRefPtr<T>(other)
  32. {
  33. }
  34. ValueComparingNonnullRefPtr(NonnullRefPtr<T>&& other)
  35. : NonnullRefPtr<T>(move(other))
  36. {
  37. }
  38. bool operator==(ValueComparingNonnullRefPtr const& other) const
  39. {
  40. return this->ptr() == other.ptr() || this->ptr()->equals(*other);
  41. }
  42. private:
  43. using NonnullRefPtr<T>::operator==;
  44. };
  45. template<typename T>
  46. struct ValueComparingRefPtr : public RefPtr<T> {
  47. using RefPtr<T>::RefPtr;
  48. ValueComparingRefPtr(RefPtr<T> const& other)
  49. : RefPtr<T>(other)
  50. {
  51. }
  52. ValueComparingRefPtr(RefPtr<T>&& other)
  53. : RefPtr<T>(move(other))
  54. {
  55. }
  56. template<typename U>
  57. bool operator==(ValueComparingNonnullRefPtr<U> const& other) const
  58. {
  59. return this->ptr() == other.ptr() || (this->ptr() && this->ptr()->equals(*other));
  60. }
  61. bool operator==(ValueComparingRefPtr const& other) const
  62. {
  63. return this->ptr() == other.ptr() || (this->ptr() && other.ptr() && this->ptr()->equals(*other));
  64. }
  65. private:
  66. using RefPtr<T>::operator==;
  67. };
  68. using StyleValueVector = Vector<ValueComparingNonnullRefPtr<CSSStyleValue const>>;
  69. // https://drafts.css-houdini.org/css-typed-om-1/#cssstylevalue
  70. class CSSStyleValue : public RefCounted<CSSStyleValue> {
  71. public:
  72. virtual ~CSSStyleValue() = default;
  73. enum class Type {
  74. Angle,
  75. BackgroundRepeat,
  76. BackgroundSize,
  77. BasicShape,
  78. BorderRadius,
  79. Calculated,
  80. Color,
  81. ConicGradient,
  82. Content,
  83. Counter,
  84. CounterDefinitions,
  85. CustomIdent,
  86. Display,
  87. Easing,
  88. Edge,
  89. FilterValueList,
  90. Flex,
  91. Frequency,
  92. GridAutoFlow,
  93. GridTemplateArea,
  94. GridTrackPlacement,
  95. GridTrackSizeList,
  96. Image,
  97. Integer,
  98. Keyword,
  99. Length,
  100. LinearGradient,
  101. MathDepth,
  102. Number,
  103. Percentage,
  104. Position,
  105. RadialGradient,
  106. Ratio,
  107. Rect,
  108. Resolution,
  109. ScrollbarGutter,
  110. Shadow,
  111. Shorthand,
  112. String,
  113. Time,
  114. Transformation,
  115. Transition,
  116. Unresolved,
  117. URL,
  118. ValueList,
  119. };
  120. Type type() const { return m_type; }
  121. bool is_abstract_image() const
  122. {
  123. return AK::first_is_one_of(type(), Type::Image, Type::LinearGradient, Type::ConicGradient, Type::RadialGradient);
  124. }
  125. AbstractImageStyleValue const& as_abstract_image() const;
  126. AbstractImageStyleValue& as_abstract_image() { return const_cast<AbstractImageStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_abstract_image()); }
  127. bool is_angle() const { return type() == Type::Angle; }
  128. AngleStyleValue const& as_angle() const;
  129. AngleStyleValue& as_angle() { return const_cast<AngleStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_angle()); }
  130. bool is_background_repeat() const { return type() == Type::BackgroundRepeat; }
  131. BackgroundRepeatStyleValue const& as_background_repeat() const;
  132. BackgroundRepeatStyleValue& as_background_repeat() { return const_cast<BackgroundRepeatStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_background_repeat()); }
  133. bool is_background_size() const { return type() == Type::BackgroundSize; }
  134. BackgroundSizeStyleValue const& as_background_size() const;
  135. BackgroundSizeStyleValue& as_background_size() { return const_cast<BackgroundSizeStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_background_size()); }
  136. bool is_basic_shape() const { return type() == Type::BasicShape; }
  137. BasicShapeStyleValue const& as_basic_shape() const;
  138. BasicShapeStyleValue& as_basic_shape() { return const_cast<BasicShapeStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_basic_shape()); }
  139. bool is_border_radius() const { return type() == Type::BorderRadius; }
  140. BorderRadiusStyleValue const& as_border_radius() const;
  141. BorderRadiusStyleValue& as_border_radius() { return const_cast<BorderRadiusStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_border_radius()); }
  142. bool is_calculated() const { return type() == Type::Calculated; }
  143. CalculatedStyleValue const& as_calculated() const;
  144. CalculatedStyleValue& as_calculated() { return const_cast<CalculatedStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_calculated()); }
  145. bool is_color() const { return type() == Type::Color; }
  146. CSSColorValue const& as_color() const;
  147. CSSColorValue& as_color() { return const_cast<CSSColorValue&>(const_cast<CSSStyleValue const&>(*this).as_color()); }
  148. bool is_conic_gradient() const { return type() == Type::ConicGradient; }
  149. ConicGradientStyleValue const& as_conic_gradient() const;
  150. ConicGradientStyleValue& as_conic_gradient() { return const_cast<ConicGradientStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_conic_gradient()); }
  151. bool is_content() const { return type() == Type::Content; }
  152. ContentStyleValue const& as_content() const;
  153. ContentStyleValue& as_content() { return const_cast<ContentStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_content()); }
  154. bool is_counter() const { return type() == Type::Counter; }
  155. CounterStyleValue const& as_counter() const;
  156. CounterStyleValue& as_counter() { return const_cast<CounterStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_counter()); }
  157. bool is_counter_definitions() const { return type() == Type::CounterDefinitions; }
  158. CounterDefinitionsStyleValue const& as_counter_definitions() const;
  159. CounterDefinitionsStyleValue& as_counter_definitions() { return const_cast<CounterDefinitionsStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_counter_definitions()); }
  160. bool is_custom_ident() const { return type() == Type::CustomIdent; }
  161. CustomIdentStyleValue const& as_custom_ident() const;
  162. CustomIdentStyleValue& as_custom_ident() { return const_cast<CustomIdentStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_custom_ident()); }
  163. bool is_display() const { return type() == Type::Display; }
  164. DisplayStyleValue const& as_display() const;
  165. DisplayStyleValue& as_display() { return const_cast<DisplayStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_display()); }
  166. bool is_easing() const { return type() == Type::Easing; }
  167. EasingStyleValue const& as_easing() const;
  168. EasingStyleValue& as_easing() { return const_cast<EasingStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_easing()); }
  169. bool is_edge() const { return type() == Type::Edge; }
  170. EdgeStyleValue const& as_edge() const;
  171. EdgeStyleValue& as_edge() { return const_cast<EdgeStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_edge()); }
  172. bool is_filter_value_list() const { return type() == Type::FilterValueList; }
  173. FilterValueListStyleValue const& as_filter_value_list() const;
  174. FilterValueListStyleValue& as_filter_value_list() { return const_cast<FilterValueListStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_filter_value_list()); }
  175. bool is_flex() const { return type() == Type::Flex; }
  176. FlexStyleValue const& as_flex() const;
  177. FlexStyleValue& as_flex() { return const_cast<FlexStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_flex()); }
  178. bool is_frequency() const { return type() == Type::Frequency; }
  179. FrequencyStyleValue const& as_frequency() const;
  180. FrequencyStyleValue& as_frequency() { return const_cast<FrequencyStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_frequency()); }
  181. bool is_grid_auto_flow() const { return type() == Type::GridAutoFlow; }
  182. GridAutoFlowStyleValue const& as_grid_auto_flow() const;
  183. GridAutoFlowStyleValue& as_grid_auto_flow() { return const_cast<GridAutoFlowStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_grid_auto_flow()); }
  184. bool is_grid_template_area() const { return type() == Type::GridTemplateArea; }
  185. GridTemplateAreaStyleValue const& as_grid_template_area() const;
  186. GridTemplateAreaStyleValue& as_grid_template_area() { return const_cast<GridTemplateAreaStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_grid_template_area()); }
  187. bool is_grid_track_placement() const { return type() == Type::GridTrackPlacement; }
  188. GridTrackPlacementStyleValue const& as_grid_track_placement() const;
  189. GridTrackPlacementStyleValue& as_grid_track_placement() { return const_cast<GridTrackPlacementStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_grid_track_placement()); }
  190. bool is_grid_track_size_list() const { return type() == Type::GridTrackSizeList; }
  191. GridTrackSizeListStyleValue const& as_grid_track_size_list() const;
  192. GridTrackSizeListStyleValue& as_grid_track_size_list() { return const_cast<GridTrackSizeListStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_grid_track_size_list()); }
  193. bool is_image() const { return type() == Type::Image; }
  194. ImageStyleValue const& as_image() const;
  195. ImageStyleValue& as_image() { return const_cast<ImageStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_image()); }
  196. bool is_integer() const { return type() == Type::Integer; }
  197. IntegerStyleValue const& as_integer() const;
  198. IntegerStyleValue& as_integer() { return const_cast<IntegerStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_integer()); }
  199. bool is_keyword() const { return type() == Type::Keyword; }
  200. CSSKeywordValue const& as_keyword() const;
  201. CSSKeywordValue& as_keyword() { return const_cast<CSSKeywordValue&>(const_cast<CSSStyleValue const&>(*this).as_keyword()); }
  202. bool is_length() const { return type() == Type::Length; }
  203. LengthStyleValue const& as_length() const;
  204. LengthStyleValue& as_length() { return const_cast<LengthStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_length()); }
  205. bool is_linear_gradient() const { return type() == Type::LinearGradient; }
  206. LinearGradientStyleValue const& as_linear_gradient() const;
  207. LinearGradientStyleValue& as_linear_gradient() { return const_cast<LinearGradientStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_linear_gradient()); }
  208. bool is_math_depth() const { return type() == Type::MathDepth; }
  209. MathDepthStyleValue const& as_math_depth() const;
  210. MathDepthStyleValue& as_math_depth() { return const_cast<MathDepthStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_math_depth()); }
  211. bool is_number() const { return type() == Type::Number; }
  212. NumberStyleValue const& as_number() const;
  213. NumberStyleValue& as_number() { return const_cast<NumberStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_number()); }
  214. bool is_percentage() const { return type() == Type::Percentage; }
  215. PercentageStyleValue const& as_percentage() const;
  216. PercentageStyleValue& as_percentage() { return const_cast<PercentageStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_percentage()); }
  217. bool is_position() const { return type() == Type::Position; }
  218. PositionStyleValue const& as_position() const;
  219. PositionStyleValue& as_position() { return const_cast<PositionStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_position()); }
  220. bool is_radial_gradient() const { return type() == Type::RadialGradient; }
  221. RadialGradientStyleValue const& as_radial_gradient() const;
  222. RadialGradientStyleValue& as_radial_gradient() { return const_cast<RadialGradientStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_radial_gradient()); }
  223. bool is_ratio() const { return type() == Type::Ratio; }
  224. RatioStyleValue const& as_ratio() const;
  225. RatioStyleValue& as_ratio() { return const_cast<RatioStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_ratio()); }
  226. bool is_rect() const { return type() == Type::Rect; }
  227. RectStyleValue const& as_rect() const;
  228. RectStyleValue& as_rect() { return const_cast<RectStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_rect()); }
  229. bool is_resolution() const { return type() == Type::Resolution; }
  230. ResolutionStyleValue const& as_resolution() const;
  231. ResolutionStyleValue& as_resolution() { return const_cast<ResolutionStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_resolution()); }
  232. bool is_scrollbar_gutter() const { return type() == Type::ScrollbarGutter; }
  233. ScrollbarGutterStyleValue const& as_scrollbar_gutter() const;
  234. ScrollbarGutterStyleValue& as_scrollbar_gutter() { return const_cast<ScrollbarGutterStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_scrollbar_gutter()); }
  235. bool is_shadow() const { return type() == Type::Shadow; }
  236. ShadowStyleValue const& as_shadow() const;
  237. ShadowStyleValue& as_shadow() { return const_cast<ShadowStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_shadow()); }
  238. bool is_shorthand() const { return type() == Type::Shorthand; }
  239. ShorthandStyleValue const& as_shorthand() const;
  240. ShorthandStyleValue& as_shorthand() { return const_cast<ShorthandStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_shorthand()); }
  241. bool is_string() const { return type() == Type::String; }
  242. StringStyleValue const& as_string() const;
  243. StringStyleValue& as_string() { return const_cast<StringStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_string()); }
  244. bool is_time() const { return type() == Type::Time; }
  245. TimeStyleValue const& as_time() const;
  246. TimeStyleValue& as_time() { return const_cast<TimeStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_time()); }
  247. bool is_transformation() const { return type() == Type::Transformation; }
  248. TransformationStyleValue const& as_transformation() const;
  249. TransformationStyleValue& as_transformation() { return const_cast<TransformationStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_transformation()); }
  250. bool is_transition() const { return type() == Type::Transition; }
  251. TransitionStyleValue const& as_transition() const;
  252. TransitionStyleValue& as_transition() { return const_cast<TransitionStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_transition()); }
  253. bool is_unresolved() const { return type() == Type::Unresolved; }
  254. UnresolvedStyleValue const& as_unresolved() const;
  255. UnresolvedStyleValue& as_unresolved() { return const_cast<UnresolvedStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_unresolved()); }
  256. bool is_url() const { return type() == Type::URL; }
  257. URLStyleValue const& as_url() const;
  258. URLStyleValue& as_url() { return const_cast<URLStyleValue&>(const_cast<CSSStyleValue const&>(*this).as_url()); }
  259. bool is_value_list() const { return type() == Type::ValueList; }
  260. StyleValueList const& as_value_list() const;
  261. StyleValueList& as_value_list() { return const_cast<StyleValueList&>(const_cast<CSSStyleValue const&>(*this).as_value_list()); }
  262. // https://www.w3.org/TR/css-values-4/#common-keywords
  263. // https://drafts.csswg.org/css-cascade-4/#valdef-all-revert
  264. bool is_css_wide_keyword() const { return is_inherit() || is_initial() || is_revert() || is_unset(); }
  265. bool is_inherit() const { return to_keyword() == Keyword::Inherit; }
  266. bool is_initial() const { return to_keyword() == Keyword::Initial; }
  267. bool is_revert() const { return to_keyword() == Keyword::Revert; }
  268. bool is_unset() const { return to_keyword() == Keyword::Unset; }
  269. bool has_auto() const;
  270. virtual bool has_color() const { return false; }
  271. virtual ValueComparingNonnullRefPtr<CSSStyleValue const> absolutized(CSSPixelRect const& viewport_rect, Length::FontMetrics const& font_metrics, Length::FontMetrics const& root_font_metrics) const;
  272. virtual Color to_color(Optional<Layout::NodeWithStyle const&>) const { return {}; }
  273. Keyword to_keyword() const;
  274. virtual String to_string() const = 0;
  275. [[nodiscard]] int to_font_weight() const;
  276. [[nodiscard]] int to_font_slope() const;
  277. [[nodiscard]] int to_font_stretch_width() const;
  278. virtual bool equals(CSSStyleValue const& other) const = 0;
  279. bool operator==(CSSStyleValue const& other) const
  280. {
  281. return this->equals(other);
  282. }
  283. protected:
  284. explicit CSSStyleValue(Type);
  285. private:
  286. Type m_type;
  287. };
  288. template<typename T>
  289. struct StyleValueWithDefaultOperators : public CSSStyleValue {
  290. using CSSStyleValue::CSSStyleValue;
  291. virtual bool equals(CSSStyleValue const& other) const override
  292. {
  293. if (type() != other.type())
  294. return false;
  295. auto const& typed_other = static_cast<T const&>(other);
  296. return static_cast<T const&>(*this).properties_equal(typed_other);
  297. }
  298. };
  299. }
  300. template<>
  301. struct AK::Formatter<Web::CSS::CSSStyleValue> : Formatter<StringView> {
  302. ErrorOr<void> format(FormatBuilder& builder, Web::CSS::CSSStyleValue const& style_value)
  303. {
  304. return Formatter<StringView>::format(builder, style_value.to_string());
  305. }
  306. };