extensions/common/icons/extension_icon_variants.h

// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef EXTENSIONS_COMMON_ICONS_EXTENSION_ICON_VARIANTS_H_
#define EXTENSIONS_COMMON_ICONS_EXTENSION_ICON_VARIANTS_H_

#include <string>
#include <vector>

#include "base/values.h"
#include "extensions/buildflags/buildflags.h"
#include "extensions/common/icons/extension_icon_set.h"
#include "extensions/common/icons/extension_icon_variant.h"
#include "extensions/common/icons/extension_icon_variants_diagnostics.h"

static_assert(BUILDFLAG(ENABLE_EXTENSIONS_CORE));

namespace extensions {

class Extension;

// Representation of the `icon_variants` key defined in manifest.json. It could
// be a top level key or a subkey of `action`.
class ExtensionIconVariants {
 public:
  ExtensionIconVariants();
  ~ExtensionIconVariants();
  ExtensionIconVariants(ExtensionIconVariants&& other);
  ExtensionIconVariants(const ExtensionIconVariants& other);
  ExtensionIconVariants& operator=(ExtensionIconVariants&& other) = default;
  ExtensionIconVariants& operator=(const ExtensionIconVariants& other) = delete;

  // Parse the provided list from manifest.json and set `list_` with the result.
  void Parse(const Extension& extension, const base::Value::List* list);

  // Determine whether `list_` has at least one icon variant after parsing.
  bool IsEmpty() const;

  // Add an icon variant to the this object.
  void Add(std::unique_ptr<ExtensionIconVariant> icon_variant);

  // Diagnostics for the `icon_variants` key are consumed only once and deleted.
  std::vector<diagnostics::icon_variants::Diagnostic>& get_diagnostics() {
    return diagnostics_;
  }

  const std::vector<ExtensionIconVariant>& GetList() const { return list_; }

  void AddDiagnostic(diagnostics::icon_variants::Feature feature,
                     diagnostics::icon_variants::Id id);

 private:
  std::vector<ExtensionIconVariant> list_;

  // Warnings observed while parsing `icon_variants` from manifest.json. These
  // will be cleared at the end of manifest parsing for memory optimization.
  std::vector<diagnostics::icon_variants::Diagnostic> diagnostics_;
};

}  //  namespace extensions

#endif  // EXTENSIONS_COMMON_ICONS_EXTENSION_ICON_VARIANTS_H_