ios/web/public/webui/web_ui_ios_data_source.h

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

#ifndef IOS_WEB_PUBLIC_WEBUI_WEB_UI_IOS_DATA_SOURCE_H_
#define IOS_WEB_PUBLIC_WEBUI_WEB_UI_IOS_DATA_SOURCE_H_

#include <string>
#include <string_view>

#include "base/containers/span.h"
#include "base/functional/callback.h"
#include "base/supports_user_data.h"
#include "base/values.h"

namespace webui {
struct LocalizedString;
struct ResourcePath;
}  // namespace webui

namespace web {
class BrowserState;

// A data source that can help with implementing the common operations needed by
// WebUIIOS pages.
class WebUIIOSDataSource : public base::SupportsUserData {
 public:
  ~WebUIIOSDataSource() override {}

  static WebUIIOSDataSource* Create(std::string_view source_name);

  // Adds a WebUIIOS data source to `browser_state`.
  static void Add(BrowserState* browser_state, WebUIIOSDataSource* source);

  // Adds a string keyed to its name to our dictionary.
  virtual void AddString(const std::string& name,
                         const std::u16string& value) = 0;

  // Adds a string keyed to its name to our dictionary.
  virtual void AddString(const std::string& name, const std::string& value) = 0;

  // Adds a localized string with resource `ids` keyed to its name to our
  // dictionary.
  virtual void AddLocalizedString(const std::string& name, int ids) = 0;

  virtual void AddLocalizedStrings(
      const base::Value::Dict& localized_strings) = 0;

  virtual void AddLocalizedStrings(
      base::span<const webui::LocalizedString> strings) = 0;

  // Adds a boolean keyed to its name to our dictionary.
  virtual void AddBoolean(const std::string& name, bool value) = 0;

  // Call this to enable a virtual "strings.js" (or "strings.m.js" for modules)
  // URL that provides translations and dynamic data when requested.
  virtual void UseStringsJs() = 0;

  // Call this to enable i18n replacements in JS files (needed by Web UIs that
  // use Web Components).
  virtual void EnableReplaceI18nInJS() = 0;

  // Adds a mapping between a path name and a resource to return.
  virtual void AddResourcePath(const std::string& path, int resource_id) = 0;

  // Calls AddResourcePath() in a for-loop for `paths`. Reduces code size vs.
  // reimplementing the same for-loop.
  virtual void AddResourcePaths(
      base::span<const webui::ResourcePath> paths) = 0;

  // Sets the resource to returned when no other paths match.
  virtual void SetDefaultResource(int resource_id) = 0;

  // The following map to methods on URLDataSource. See the documentation there.
  virtual void DisableDenyXFrameOptions() = 0;
};

}  // namespace web

#endif  // IOS_WEB_PUBLIC_WEBUI_WEB_UI_IOS_DATA_SOURCE_H_