components/bookmarks/browser/titled_url_match.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 COMPONENTS_BOOKMARKS_BROWSER_TITLED_URL_MATCH_H_
#define COMPONENTS_BOOKMARKS_BROWSER_TITLED_URL_MATCH_H_

#include <stddef.h>

#include <utility>
#include <vector>

#include "base/memory/raw_ptr.h"

namespace bookmarks {

class TitledUrlNode;

struct TitledUrlMatch {
  // Each MatchPosition is the [begin, end) positions of a match within a
  // string.
  using MatchPosition = std::pair<size_t, size_t>;
  using MatchPositions = std::vector<MatchPosition>;

  TitledUrlMatch();
  TitledUrlMatch(const TitledUrlMatch& other);
  ~TitledUrlMatch();

  // Extracts and returns the offsets from `match_positions`.
  static std::vector<size_t> OffsetsFromMatchPositions(
      const MatchPositions& match_positions);

  // Replaces the offsets in `match_positions` with those given in `offsets`,
  // deleting any which are npos, and returns the updated list of match
  // positions.
  static MatchPositions ReplaceOffsetsInMatchPositions(
      const MatchPositions& match_positions,
      const std::vector<size_t>& offsets);

  // The matching node of a query.
  raw_ptr<const TitledUrlNode> node;

  // Location of the matching words in the title of the node.
  MatchPositions title_match_positions;

  // Location of the matching words in the URL of the node.
  MatchPositions url_match_positions;

  // Whether there was at least 1 match in the titles of ancestors of the node.
  bool has_ancestor_match;
};

}  // namespace bookmarks

#endif  // COMPONENTS_BOOKMARKS_BROWSER_TITLED_URL_MATCH_H_