File: suggestion_parser.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (68 lines) | stat: -rw-r--r-- 2,810 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_EXTENSIONS_API_OMNIBOX_SUGGESTION_PARSER_H_
#define CHROME_BROWSER_EXTENSIONS_API_OMNIBOX_SUGGESTION_PARSER_H_

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

#include "base/functional/callback_forward.h"
#include "chrome/common/extensions/api/omnibox.h"

namespace extensions {

// A helper struct to hold description and styles, as parsed from an XML
// string. In practice, this corresponds to omnibox::DefaultSuggestResult, but
// it will also be used to construct SuggestResults, so we disambiguate with a
// common struct.
struct DescriptionAndStyles {
  DescriptionAndStyles();
  DescriptionAndStyles(const DescriptionAndStyles&) = delete;
  DescriptionAndStyles(DescriptionAndStyles&&);
  DescriptionAndStyles& operator=(const DescriptionAndStyles&) = delete;
  DescriptionAndStyles& operator=(DescriptionAndStyles&&);
  ~DescriptionAndStyles();

  std::u16string description;
  std::vector<api::omnibox::MatchClassification> styles;
};

// The container for the result from parsing descriptions and styles.
struct DescriptionAndStylesResult {
  // Chromium's clang plugin about non-trivial structs needing out-of-line
  // constructors requires us to go a little ham here.
  DescriptionAndStylesResult();
  DescriptionAndStylesResult(const DescriptionAndStylesResult&) = delete;
  DescriptionAndStylesResult(DescriptionAndStylesResult&&);
  DescriptionAndStylesResult& operator=(const DescriptionAndStylesResult&) =
      delete;
  DescriptionAndStylesResult& operator=(DescriptionAndStylesResult&&);
  ~DescriptionAndStylesResult();

  // The parse error, if any. If a parsing error was encountered, no results
  // will be populated.
  std::string error;
  // The parsed descriptions and styles, if parsing was successful.
  std::vector<DescriptionAndStyles> descriptions_and_styles;
};

using DescriptionAndStylesCallback =
    base::OnceCallback<void(DescriptionAndStylesResult)>;

// Parses `str`, which is the suggestion string passed from the extension that
// potentially contains XML markup (e.g., the string may be
// "visit <url>https://example.com</url>"). This parses the string in an
// isolated process and asynchronously returns the parse result via `callback`.
void ParseDescriptionAndStyles(std::string_view str,
                               DescriptionAndStylesCallback callback);
// Same as above, but takes in multiple string inputs.
void ParseDescriptionsAndStyles(const std::vector<std::string_view>& strs,
                                DescriptionAndStylesCallback callback);

}  // namespace extensions

#endif  // CHROME_BROWSER_EXTENSIONS_API_OMNIBOX_SUGGESTION_PARSER_H_