2 * Copyright (c) 2014, Peter Thorson. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 * * Redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer.
8 * * Redistributions in binary form must reproduce the above copyright
9 * notice, this list of conditions and the following disclaimer in the
10 * documentation and/or other materials provided with the distribution.
11 * * Neither the name of the WebSocket++ Project nor the
12 * names of its contributors may be used to endorse or promote products
13 * derived from this software without specific prior written permission.
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL PETER THORSON BE LIABLE FOR ANY
19 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #ifndef WEBSOCKETPP_UTILITIES_HPP
29 #define WEBSOCKETPP_UTILITIES_HPP
31 #include <websocketpp/common/stdint.hpp>
37 namespace websocketpp {
38 /// Generic non-websocket specific utility functions and data structures
41 /// Helper functor for case insensitive find
44 * http://stackoverflow.com/questions/3152241/case-insensitive-stdstring-find
46 * templated version of my_equal so it could work with both char and wchar_t
48 template<typename charT>
50 /// Construct the functor with the given locale
52 * @param [in] loc The locale to use for determining the case of values
54 my_equal(std::locale const & loc ) : m_loc(loc) {}
56 /// Perform a case insensitive comparison
58 * @param ch1 The first value to compare
59 * @param ch2 The second value to compare
60 * @return Whether or not the two values are equal when both are converted
61 * to uppercase using the given locale.
63 bool operator()(charT ch1, charT ch2) {
64 return std::toupper(ch1, m_loc) == std::toupper(ch2, m_loc);
67 std::locale const & m_loc;
70 /// Helper less than functor for case insensitive find
73 * http://stackoverflow.com/questions/3152241/case-insensitive-stdstring-find
75 struct ci_less : std::binary_function<std::string, std::string, bool> {
76 // case-independent (ci) compare_less binary function
78 : public std::binary_function<unsigned char,unsigned char,bool>
80 bool operator() (unsigned char const & c1, unsigned char const & c2) const {
81 return tolower (c1) < tolower (c2);
84 bool operator() (std::string const & s1, std::string const & s2) const {
85 return std::lexicographical_compare
86 (s1.begin (), s1.end (), // source range
87 s2.begin (), s2.end (), // dest range
88 nocase_compare ()); // comparison
92 /// Find substring (case insensitive)
94 * @param [in] haystack The string to search in
95 * @param [in] needle The string to search for
96 * @param [in] loc The locale to use for determining the case of values.
97 * Defaults to the current locale.
98 * @return An iterator to the first element of the first occurrance of needle in
99 * haystack. If the sequence is not found, the function returns
103 typename T::const_iterator ci_find_substr(T const & haystack, T const & needle,
104 std::locale const & loc = std::locale())
106 return std::search( haystack.begin(), haystack.end(),
107 needle.begin(), needle.end(), my_equal<typename T::value_type>(loc) );
110 /// Find substring (case insensitive)
112 * @todo Is this still used? This method may not make sense.. should use
113 * iterators or be less generic. As is it is too tightly coupled to std::string
115 * @param [in] haystack The string to search in
116 * @param [in] needle The string to search for as a char array of values
117 * @param [in] size Length of needle
118 * @param [in] loc The locale to use for determining the case of values.
119 * Defaults to the current locale.
120 * @return An iterator to the first element of the first occurrance of needle in
121 * haystack. If the sequence is not found, the function returns
125 typename T::const_iterator ci_find_substr(T const & haystack,
126 typename T::value_type const * needle, typename T::size_type size,
127 std::locale const & loc = std::locale())
129 return std::search( haystack.begin(), haystack.end(),
130 needle, needle+size, my_equal<typename T::value_type>(loc) );
133 /// Convert a string to lowercase
135 * @param [in] in The string to convert
136 * @return The converted string
138 std::string to_lower(std::string const & in);
140 /// Replace all occurrances of a substring with another
142 * @param [in] subject The string to search in
143 * @param [in] search The string to search for
144 * @param [in] replace The string to replace with
145 * @return A copy of `subject` with all occurances of `search` replaced with
148 std::string string_replace_all(std::string subject, std::string const & search,
149 std::string const & replace);
151 /// Convert std::string to ascii printed string of hex digits
153 * @param [in] input The string to print
154 * @return A copy of `input` converted to the printable representation of the
155 * hex values of its data.
157 std::string to_hex(std::string const & input);
159 /// Convert byte array (uint8_t) to ascii printed string of hex digits
161 * @param [in] input The byte array to print
162 * @param [in] length The length of input
163 * @return A copy of `input` converted to the printable representation of the
164 * hex values of its data.
166 std::string to_hex(uint8_t const * input, size_t length);
168 /// Convert char array to ascii printed string of hex digits
170 * @param [in] input The char array to print
171 * @param [in] length The length of input
172 * @return A copy of `input` converted to the printable representation of the
173 * hex values of its data.
175 std::string to_hex(char const * input, size_t length);
177 } // namespace utility
178 } // namespace websocketpp
180 #include <websocketpp/impl/utilities_impl.hpp>
182 #endif // WEBSOCKETPP_UTILITIES_HPP