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
69
70
71
72
73
74
|
// Copyright 2020 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_SHARED_HIGHLIGHTING_CORE_COMMON_TEXT_FRAGMENT_H_
#define COMPONENTS_SHARED_HIGHLIGHTING_CORE_COMMON_TEXT_FRAGMENT_H_
#include <optional>
#include <string>
#include <string_view>
#include "base/values.h"
namespace shared_highlighting {
// Class representing a text fragment.
class TextFragment {
public:
// Constructors for TextFragment instances. Special characters in the string
// parameters must not be escaped.
explicit TextFragment(const std::string& text_start);
TextFragment(const std::string& text_start,
const std::string& text_end,
const std::string& prefix,
const std::string& suffix);
TextFragment(const TextFragment& other);
TextFragment& operator=(const TextFragment& other);
~TextFragment();
// Returns a TextFragment instance created from a |fragment_string| whose
// special characters have been escaped. The given string is expected to have
// the traditional text fragment format:
// [prefix-,]textStart[,textEnd][,-suffix]
// Returns |std::nullopt| if parsing failed.
static std::optional<TextFragment> FromEscapedString(
std::string_view escaped_string);
// Returns a TextFragment instance created from a dictionary |value|
// containing the right set of values. The values stored in |value| must be
// already unescaped.
// Returns |std::nullopt| if parsing failed.
static std::optional<TextFragment> FromValue(const base::Value* value);
const std::string& text_start() const { return text_start_; }
const std::string& text_end() const { return text_end_; }
const std::string& prefix() const { return prefix_; }
const std::string& suffix() const { return suffix_; }
// Converts the current fragment to its escaped URL parameter format. Returns
// an empty string if |text_start| does not have a value.
enum class EscapedStringFormat {
// [prefix-,]textStart[,textEnd][,=suffix]
kWithoutTextDirective,
// text=[prefix-,]textStart[,textEnd][,=suffix]
kWithTextDirective,
};
std::string ToEscapedString(
EscapedStringFormat format =
EscapedStringFormat::kWithTextDirective) const;
// Converts the current fragment to a dictionary Value.
base::Value ToValue() const;
private:
// Values of a fragment, stored unescaped.
std::string text_start_;
std::string text_end_;
std::string prefix_;
std::string suffix_;
};
} // namespace shared_highlighting
#endif // COMPONENTS_SHARED_HIGHLIGHTING_CORE_COMMON_TEXT_FRAGMENT_H_
|
