All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
EndsWithTest.h
Go to the documentation of this file.
1 // Copyright 2015, 2016 Thomas Trapp
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #ifndef HEXT_ENDS_WITH_TEST_H_INCLUDED
16 #define HEXT_ENDS_WITH_TEST_H_INCLUDED
17 
18 /// @file
19 /// Declares hext::EndsWithTest
20 
21 #include "hext/Cloneable.h"
22 #include "hext/ValueTest.h"
23 #include "hext/Visibility.h"
24 
25 #include <string>
26 
27 
28 namespace hext {
29 
30 
31 /// Tests whether a string ends with a given literal.
32 ///
33 /// @par Example:
34 /// ~~~~~~~~~~~~~
35 /// EndsWithTest ends("baz");
36 ///
37 /// assert( ends.test("foobaz"));
38 /// assert( ends.test("baz"));
39 /// assert(!ends.test("foo"));
40 /// ~~~~~~~~~~~~~
41 class HEXT_PUBLIC EndsWithTest final : public Cloneable<EndsWithTest, ValueTest>
42 {
43 public:
44  /// Constructs an EndsWithTest that succeeds for subjects that end with the
45  /// given literal.
46  ///
47  /// @param literal: A string that a subject must end with.
48  explicit EndsWithTest(std::string literal) noexcept;
49 
50  /// Returns true if subject ends with the given literal.
51  ///
52  /// @param subject: The string that is to be tested.
53  bool test(const char * subject) const override;
54 
55 private:
56  /// The literal that must be matched.
57  std::string lit_;
58 };
59 
60 
61 } // namespace hext
62 
63 
64 #endif // HEXT_ENDS_WITH_TEST_H_INCLUDED
65 
Defines HEXT_PUBLIC and HEXT_PRIVATE.
#define HEXT_PUBLIC
Definition: Visibility.h:26
Curiously recurring template pattern that extends a base class to provide a virtual method Cloneable:...
Definition: Cloneable.h:36
Declares hext::ValueTest.
Defines template hext::Cloneable.
Tests whether a string ends with a given literal.
Definition: EndsWithTest.h:41