components/omnibox/browser/history_provider.h

// Copyright 2012 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_OMNIBOX_BROWSER_HISTORY_PROVIDER_H_
#define COMPONENTS_OMNIBOX_BROWSER_HISTORY_PROVIDER_H_

#include <stddef.h>

#include "base/compiler_specific.h"
#include "base/memory/raw_ptr.h"
#include "components/omnibox/browser/autocomplete_provider.h"
#include "components/omnibox/browser/autocomplete_provider_client.h"
#include "components/omnibox/browser/in_memory_url_index_types.h"

struct AutocompleteMatch;

// This class is a base class for the history autocomplete providers and
// provides functions useful to all derived classes.
class HistoryProvider : public AutocompleteProvider {
 public:
  void DeleteMatch(const AutocompleteMatch& match) override;

  // Fill and return an ACMatchClassifications structure given the |matches|
  // to highlight.
  // TODO (manukh) replace calls to SpansFromTermMatch with calls to
  // ClassifyTermMatches (autocomplete_match_classification.h)
  static ACMatchClassifications SpansFromTermMatch(const TermMatches& matches,
                                                   size_t text_length,
                                                   bool is_url);

 protected:
  HistoryProvider(AutocompleteProvider::Type type,
                  AutocompleteProviderClient* client);

  ~HistoryProvider() override;

  HistoryProvider(const HistoryProvider&) = delete;
  HistoryProvider& operator=(const HistoryProvider&) = delete;

  // Finds and removes the match from the current collection of matches and
  // backing data.
  void DeleteMatchFromMatches(const AutocompleteMatch& match);

  AutocompleteProviderClient* client() const { return client_; }

 private:
  // TODO(https://issues.chromium.org/issues/41485238#comment6) investigate why
  // this pointer is kept dangling, for longer than the duration of the task.
  raw_ptr<AutocompleteProviderClient,
          FlakyDanglingUntriaged | AcrossTasksDanglingUntriaged>
      client_;
};

#endif  // COMPONENTS_OMNIBOX_BROWSER_HISTORY_PROVIDER_H_