WebSocket++  0.8.0-dev
C++ websocket client/server library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
utilities.hpp
1 /*
2  * Copyright (c) 2014, Peter Thorson. All rights reserved.
3  *
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.
14  *
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.
25  *
26  */
27 
28 #ifndef WEBSOCKETPP_UTILITIES_HPP
29 #define WEBSOCKETPP_UTILITIES_HPP
30 
31 #include <websocketpp/common/stdint.hpp>
32 
33 #include <algorithm>
34 #include <string>
35 #include <locale>
36 
37 namespace websocketpp {
38 /// Generic non-websocket specific utility functions and data structures
39 namespace utility {
40 
41 /// Helper functor for case insensitive find
42 /**
43  * Based on code from
44  * http://stackoverflow.com/questions/3152241/case-insensitive-stdstring-find
45  *
46  * templated version of my_equal so it could work with both char and wchar_t
47  */
48 template<typename charT>
49 struct my_equal {
50  /// Construct the functor with the given locale
51  /**
52  * @param [in] loc The locale to use for determining the case of values
53  */
54  my_equal(std::locale const & loc ) : m_loc(loc) {}
55 
56  /// Perform a case insensitive comparison
57  /**
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.
62  */
63  bool operator()(charT ch1, charT ch2) {
64  return std::toupper(ch1, m_loc) == std::toupper(ch2, m_loc);
65  }
66 private:
67  std::locale const & m_loc;
68 };
69 
70 /// Helper less than functor for case insensitive find
71 /**
72  * Based on code from
73  * http://stackoverflow.com/questions/3152241/case-insensitive-stdstring-find
74  */
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>
79  {
80  bool operator() (unsigned char const & c1, unsigned char const & c2) const {
81  return tolower (c1) < tolower (c2);
82  }
83  };
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
89  }
90 };
91 
92 /// Find substring (case insensitive)
93 /**
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
100  * haystack.end()
101  */
102 template<typename T>
103 typename T::const_iterator ci_find_substr(T const & haystack, T const & needle,
104  std::locale const & loc = std::locale())
105 {
106  return std::search( haystack.begin(), haystack.end(),
107  needle.begin(), needle.end(), my_equal<typename T::value_type>(loc) );
108 }
109 
110 /// Find substring (case insensitive)
111 /**
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
114  *
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
122  * haystack.end()
123  */
124 template<typename T>
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())
128 {
129  return std::search( haystack.begin(), haystack.end(),
130  needle, needle+size, my_equal<typename T::value_type>(loc) );
131 }
132 
133 /// Convert a string to lowercase
134 /**
135  * @param [in] in The string to convert
136  * @return The converted string
137  */
138 std::string to_lower(std::string const & in);
139 
140 /// Replace all occurrances of a substring with another
141 /**
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
146  * `replace`
147  */
148 std::string string_replace_all(std::string subject, std::string const & search,
149  std::string const & replace);
150 
151 /// Convert std::string to ascii printed string of hex digits
152 /**
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.
156  */
157 std::string to_hex(std::string const & input);
158 
159 /// Convert byte array (uint8_t) to ascii printed string of hex digits
160 /**
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.
165  */
166 std::string to_hex(uint8_t const * input, size_t length);
167 
168 /// Convert char array to ascii printed string of hex digits
169 /**
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.
174  */
175 std::string to_hex(char const * input, size_t length);
176 
177 } // namespace utility
178 } // namespace websocketpp
179 
180 #include <websocketpp/impl/utilities_impl.hpp>
181 
182 #endif // WEBSOCKETPP_UTILITIES_HPP
T::const_iterator ci_find_substr(T const &haystack, typename T::value_type const *needle, typename T::size_type size, std::locale const &loc=std::locale())
Find substring (case insensitive)
Definition: utilities.hpp:125
std::string string_replace_all(std::string subject, std::string const &search, std::string const &replace)
Replace all occurrances of a substring with another.
std::string to_hex(std::string const &input)
Convert std::string to ascii printed string of hex digits.
bool operator()(charT ch1, charT ch2)
Perform a case insensitive comparison.
Definition: utilities.hpp:63
std::string to_hex(uint8_t const *input, size_t length)
Convert byte array (uint8_t) to ascii printed string of hex digits.
void handle_accept(connection_ptr con, lib::error_code const &ec)
Handler callback for start_accept.
std::string to_hex(const char *input, size_t length)
Convert char array to ascii printed string of hex digits.
std::string to_lower(std::string const &in)
Convert a string to lowercase.
my_equal(std::locale const &loc)
Construct the functor with the given locale.
Definition: utilities.hpp:54
Helper functor for case insensitive find.
Definition: utilities.hpp:49
Generic non-websocket specific utility functions and data structures.
Helper less than functor for case insensitive find.
Definition: utilities.hpp:75
T::const_iterator ci_find_substr(T const &haystack, T const &needle, std::locale const &loc=std::locale())
Find substring (case insensitive)
Definition: utilities.hpp:103