File: color_variant.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (82 lines) | stat: -rw-r--r-- 2,656 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef UI_COLOR_COLOR_VARIANT_H_
#define UI_COLOR_COLOR_VARIANT_H_

#include <optional>
#include <string>
#include <variant>

#include "third_party/skia/include/core/SkColor.h"
#include "ui/color/color_id.h"
#include "ui/gfx/color_palette.h"

namespace ui {
class ColorProvider;

// ColorVariant represents a color that can be stored either as an SkColor
// or a ColorId.  This allows for flexibility in how colors are handled,
// enabling the use of theme-aware ColorIds where appropriate, while still
// supporting direct SkColor values e.g. runtime-specified overrides, such
// as webpage-provided colors.
class COMPONENT_EXPORT(COLOR) ColorVariant {
 public:
  ColorVariant();

  // NOLINTBEGIN(google-explicit-constructor)
  ColorVariant(SkColor color);
  ColorVariant(ColorId color_id);
  // NOLINTEND(google-explicit-constructor)

  ColorVariant(const ColorVariant& other) = default;
  ColorVariant& operator=(const ColorVariant& other) = default;

  ColorVariant(ColorVariant&& other) = default;
  ColorVariant& operator=(ColorVariant&& other) = default;

  ~ColorVariant();

  ColorVariant& operator=(const SkColor& other) {
    color_variant_ = other;
    return *this;
  }
  ColorVariant& operator=(const ColorId& other) {
    color_variant_ = other;
    return *this;
  }

  bool operator==(const ColorVariant& other) const = default;
  bool operator==(const SkColor& other) const { return GetSkColor() == other; }
  bool operator==(const ColorId& other) const { return GetColorId() == other; }

  // Returns true if this ColorVariant currently holds a semantic color
  // reference (i.e., a ui::ColorId) rather than a physical color value
  // (SkColor). Semantic colors represent theme-based colors that require
  // resolution using a ui::ColorProvider via ResolveToSkColor().
  bool IsSemantic() const;

  // Returns true if this ColorVariant currently holds a physical color
  // reference (i.e., a SkColor)
  bool IsPhysical() const;

  // TODO(b:394420459): Make this method private.
  std::optional<SkColor> GetSkColor() const;

  // Resolves the ColorVariant to an SkColor.  If the ColorVariant holds a
  // ColorId, it will be resolved to an SkColor using the provided
  // ColorProvider.
  SkColor ResolveToSkColor(const ui::ColorProvider* color_provider) const;

  std::string ToString() const;

 private:
  std::optional<ColorId> GetColorId() const;

  std::variant<ColorId, SkColor> color_variant_ = gfx::kPlaceholderColor;
};

}  // namespace ui

#endif  // UI_COLOR_COLOR_VARIANT_H_