blob: 50deaa420083d4289309025f037a863b523e4dff (
plain)
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
#ifndef URI_IS_CHARACTER_IN_SET_HPP
#define URI_IS_CHARACTER_IN_SET_HPP
/**
* @file IsCharacterInSet.hpp
*
* This module declares the Uri::IsCharacterInSet function
* and the CharacterSet class.
*
* © 2018 by Richard Walters
*/
#include <initializer_list>
#include <memory>
namespace Uri {
/**
* This represents a set of characters which can be queried
* to find out if a character is in the set or not.
*/
class CharacterSet {
// Lifecycle management
public:
~CharacterSet();
CharacterSet(const CharacterSet&);
CharacterSet(CharacterSet&&);
CharacterSet& operator=(const CharacterSet&);
CharacterSet& operator=(CharacterSet&&);
// Methods
public:
/**
* This is the default constructor.
*/
CharacterSet();
/**
* This constructs a character set that contains
* just the given character.
*
* @param[in] c
* This is the only character to put in the set.
*/
CharacterSet(char c);
/**
* This constructs a character set that contains all the
* characters between the given "first" and "last"
* characters, inclusive.
*
* @param[in] first
* This is the first of the range of characters
* to put in the set.
*
* @param[in] last
* This is the last of the range of characters
* to put in the set.
*/
CharacterSet(char first, char last);
/**
* This constructs a character set that contains all the
* characters in all the other given character sets.
*
* @param[in] characterSets
* These are the character sets to include.
*/
CharacterSet(
std::initializer_list< const CharacterSet > characterSets
);
/**
* This method checks to see if the given character
* is in the character set.
*
* @param[in] c
* This is the character to check.
*
* @return
* An indication of whether or not the given character
* is in the character set is returned.
*/
bool Contains(char c) const;
// Private Properties
private:
/**
* This is the type of structure that contains the private
* properties of the instance. It is defined in the implementation
* and declared here to ensure that it is scoped inside the class.
*/
struct Impl;
/**
* This contains the private properties of the instance.
*/
std::unique_ptr< struct Impl > impl_;
};
/**
* This function determines whether or not the given character
* is in the given character set.
*
* @param[in] c
* This is the character to check.
*
* @param[in] characterSet
* This is the set of characters that are allowed.
*
* @return
* An indication of whether or not the given character
* is in the given character set is returned.
*/
bool IsCharacterInSet(
char c,
const CharacterSet& characterSet
);
}
#endif /* URI_IS_CHARACTER_IN_SET_HPP */
|
