Coverage Report

Created: 2024-09-23 06:29

/src/abseil-cpp/absl/strings/match.h
Line
Count
Source (jump to first uncovered line)
1
//
2
// Copyright 2017 The Abseil Authors.
3
//
4
// Licensed under the Apache License, Version 2.0 (the "License");
5
// you may not use this file except in compliance with the License.
6
// You may obtain a copy of the License at
7
//
8
//      https://www.apache.org/licenses/LICENSE-2.0
9
//
10
// Unless required by applicable law or agreed to in writing, software
11
// distributed under the License is distributed on an "AS IS" BASIS,
12
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
// See the License for the specific language governing permissions and
14
// limitations under the License.
15
//
16
// -----------------------------------------------------------------------------
17
// File: match.h
18
// -----------------------------------------------------------------------------
19
//
20
// This file contains simple utilities for performing string matching checks.
21
// All of these function parameters are specified as `absl::string_view`,
22
// meaning that these functions can accept `std::string`, `absl::string_view` or
23
// NUL-terminated C-style strings.
24
//
25
// Examples:
26
//   std::string s = "foo";
27
//   absl::string_view sv = "f";
28
//   assert(absl::StrContains(s, sv));
29
//
30
// Note: The order of parameters in these functions is designed to mimic the
31
// order an equivalent member function would exhibit;
32
// e.g. `s.Contains(x)` ==> `absl::StrContains(s, x).
33
#ifndef ABSL_STRINGS_MATCH_H_
34
#define ABSL_STRINGS_MATCH_H_
35
36
#include <cstring>
37
38
#include "absl/strings/string_view.h"
39
40
namespace absl {
41
ABSL_NAMESPACE_BEGIN
42
43
// StrContains()
44
//
45
// Returns whether a given string `haystack` contains the substring `needle`.
46
inline bool StrContains(absl::string_view haystack,
47
0
                        absl::string_view needle) noexcept {
48
0
  return haystack.find(needle, 0) != haystack.npos;
49
0
}
50
51
0
inline bool StrContains(absl::string_view haystack, char needle) noexcept {
52
0
  return haystack.find(needle) != haystack.npos;
53
0
}
54
55
// StartsWith()
56
//
57
// Returns whether a given string `text` begins with `prefix`.
58
inline bool StartsWith(absl::string_view text,
59
0
                       absl::string_view prefix) noexcept {
60
0
  return prefix.empty() ||
61
0
         (text.size() >= prefix.size() &&
62
0
          memcmp(text.data(), prefix.data(), prefix.size()) == 0);
63
0
}
64
65
// EndsWith()
66
//
67
// Returns whether a given string `text` ends with `suffix`.
68
inline bool EndsWith(absl::string_view text,
69
0
                     absl::string_view suffix) noexcept {
70
0
  return suffix.empty() ||
71
0
         (text.size() >= suffix.size() &&
72
0
          memcmp(text.data() + (text.size() - suffix.size()), suffix.data(),
73
0
                 suffix.size()) == 0);
74
0
}
75
// StrContainsIgnoreCase()
76
//
77
// Returns whether a given ASCII string `haystack` contains the ASCII substring
78
// `needle`, ignoring case in the comparison.
79
bool StrContainsIgnoreCase(absl::string_view haystack,
80
                           absl::string_view needle) noexcept;
81
82
bool StrContainsIgnoreCase(absl::string_view haystack,
83
                           char needle) noexcept;
84
85
// EqualsIgnoreCase()
86
//
87
// Returns whether given ASCII strings `piece1` and `piece2` are equal, ignoring
88
// case in the comparison.
89
bool EqualsIgnoreCase(absl::string_view piece1,
90
                      absl::string_view piece2) noexcept;
91
92
// StartsWithIgnoreCase()
93
//
94
// Returns whether a given ASCII string `text` starts with `prefix`,
95
// ignoring case in the comparison.
96
bool StartsWithIgnoreCase(absl::string_view text,
97
                          absl::string_view prefix) noexcept;
98
99
// EndsWithIgnoreCase()
100
//
101
// Returns whether a given ASCII string `text` ends with `suffix`, ignoring
102
// case in the comparison.
103
bool EndsWithIgnoreCase(absl::string_view text,
104
                        absl::string_view suffix) noexcept;
105
106
// Yields the longest prefix in common between both input strings.
107
// Pointer-wise, the returned result is a subset of input "a".
108
absl::string_view FindLongestCommonPrefix(absl::string_view a,
109
                                          absl::string_view b);
110
111
// Yields the longest suffix in common between both input strings.
112
// Pointer-wise, the returned result is a subset of input "a".
113
absl::string_view FindLongestCommonSuffix(absl::string_view a,
114
                                          absl::string_view b);
115
116
ABSL_NAMESPACE_END
117
}  // namespace absl
118
119
#endif  // ABSL_STRINGS_MATCH_H_