components/query_tiles/tile.h

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

#ifndef COMPONENTS_QUERY_TILES_TILE_H_
#define COMPONENTS_QUERY_TILES_TILE_H_

#include <memory>
#include <string>
#include <vector>

#include "base/time/time.h"
#include "url/gurl.h"

namespace query_tiles {

// Metadata of a tile image.
struct ImageMetadata {
  ImageMetadata();
  explicit ImageMetadata(const GURL& url);
  ~ImageMetadata();
  ImageMetadata(const ImageMetadata& other);
  bool operator==(const ImageMetadata& other) const;

  // URL of the image.
  GURL url;
};

// Stats of a tile, used for ranking.
struct TileStats {
  TileStats();
  TileStats(base::Time last_clicked_time, double score);
  ~TileStats();
  TileStats(const TileStats& other);
  bool operator==(const TileStats& other) const;

  // Last clicked timestamp.
  base::Time last_clicked_time;

  // Score of the tile, used for ranking.
  double score;
};

// Represents the in memory structure of Tile.
struct Tile {
  Tile();
  ~Tile();
  bool operator==(const Tile& other) const;
  bool operator!=(const Tile& other) const;

  Tile(const Tile& other);
  Tile(Tile&& other) noexcept;

  Tile& operator=(const Tile& other);
  Tile& operator=(Tile&& other) noexcept;

  // Unique Id for each entry.
  std::string id;

  // String of query that send to the search engine.
  std::string query_text;

  // String of the text that displays in UI.
  std::string display_text;

  // Text for accessibility purposes, in pair with |display_text|.
  std::string accessibility_text;

  // A list of images's matadatas.
  std::vector<ImageMetadata> image_metadatas;

  // A list of children of this tile.
  std::vector<std::unique_ptr<Tile>> sub_tiles;

  // Additional params for search query.
  std::vector<std::string> search_params;

  // Print pretty formatted content in Tile struct.
  std::string DebugString();
};

}  // namespace query_tiles

#endif  // COMPONENTS_QUERY_TILES_TILE_H_