project restructuring

Author: appkins

.doxygen

@@ -320,11 +320,11 @@ TOC_INCLUDE_HEADINGS   = 0
 
 AUTOLINK_SUPPORT       = YES
 
-# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# If you use STL classes (i.e. string_t, std::vector, etc.) but do not want
 # to include (a tag file for) the STL sources as input, then you should set this
 # tag to YES in order to let doxygen match functions declarations and
-# definitions whose arguments contain STL classes (e.g. func(std::string);
-# versus func(std::string) {}). This also make the inheritance and collaboration
+# definitions whose arguments contain STL classes (e.g. func(string_t);
+# versus func(string_t) {}). This also make the inheritance and collaboration
 # diagrams that involve STL classes more complete and accurate.
 # The default value is: NO.
 

CHANGELOG.md

@@ -246,7 +246,7 @@ None
 ### Tag
 `3.1.2`.
 ### Changes
-* rename the `setbit()` function into `setbit_()` in order to avoid conflict with the standard library macro `setbit` causing compilation error.
+* rename the `setbit()` function into `setbit()` in order to avoid conflict with the standard library macro `setbit` causing compilation error.
 ### Additions
 * add `send()` method to the `sync_client` and `future_client`.
 ### Removals

CMakeLists.txt

@@ -149,7 +149,7 @@ configure_file("cpp_redis.pc.in"
 #
 # executable
 #
-add_library(${PROJECT} STATIC ${SOURCES})
+add_library(${PROJECT} STATIC ${SOURCES} include/cpp_redis/helpers/string_util.hpp include/cpp_redis/misc/crc16.hpp)
 set_property(TARGET ${PROJECT} PROPERTY POSITION_INDEPENDENT_CODE ON)
 
 target_include_directories(${PROJECT} PRIVATE include)

README.md

@@ -42,10 +42,10 @@ cpp_redis::subscriber sub;
 
 sub.connect();
 
-sub.subscribe("some_chan", [](const std::string& chan, const std::string& msg) {
+sub.subscribe("some_chan", [](const string_t& chan, const string_t& msg) {
   std::cout << "MESSAGE " << chan << ": " << msg << std::endl;
 });
-sub.psubscribe("*", [](const std::string& chan, const std::string& msg) {
+sub.psubscribe("*", [](const string_t& chan, const string_t& msg) {
   std::cout << "PMESSAGE " << chan << ": " << msg << std::endl;
 });
 

clang_format.sh

@@ -1,3 +1,3 @@
 #!/bin/sh
 
-find sources includes tests examples -maxdepth 4 \( -name '*.cpp' -o -name '*.hpp' -o -name '*.ipp' -o -name '*.c' -o -name '*.h' \) -exec clang-format -style=file -i {} ';'
+find src include tests examples -maxdepth 4 \( -name '*.cpp' -o -name '*.hpp' -o -name '*.ipp' -o -name '*.c' -o -name '*.h' \) -exec clang-format -style=file -i {} ';'

docs/html/classcpp__redis_1_1client-members.html

@@ -75,17 +75,17 @@
 
 <p>This is the complete list of members for <a class="el" href="classcpp__redis_1_1logger.html">cpp_redis::logger</a>, including all inherited members.</p>
 <table class="directory">
-  <tr class="even"><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html#a36e0908e7b05850b663a4b8b9cdbc299">debug</a>(const std::string &amp;msg, const std::string &amp;file, std::size_t line)</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html">cpp_redis::logger</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
-  <tr><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html#aaf7f2837511f4414a4d7b7b923ebc15e">error</a>(const std::string &amp;msg, const std::string &amp;file, std::size_t line)</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html">cpp_redis::logger</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html#a04c741b5110946e76bb23728da6fb2ac">info</a>(const std::string &amp;msg, const std::string &amp;file, std::size_t line)</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html">cpp_redis::logger</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html#a36e0908e7b05850b663a4b8b9cdbc299">debug</a>(const string_t &amp;msg, const string_t &amp;file, std::size_t line)</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html">cpp_redis::logger</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html#aaf7f2837511f4414a4d7b7b923ebc15e">error</a>(const string_t &amp;msg, const string_t &amp;file, std::size_t line)</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html">cpp_redis::logger</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html#a04c741b5110946e76bb23728da6fb2ac">info</a>(const string_t &amp;msg, const string_t &amp;file, std::size_t line)</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html">cpp_redis::logger</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
   <tr><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html#a9493594d547e7abe71b8690be1946c7a">log_level</a> enum m_name</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html">cpp_redis::logger</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html#a36b15a75690a087fca7d304852785512">logger</a>(log_level level=log_level::info)</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html">cpp_redis::logger</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html#aec0854d47a13f91e09db25e745a3d722">logger</a>(const logger &amp;)=default</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html">cpp_redis::logger</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html#a902e41bf0777b960b6575e7ac986147b">logger_iface</a>(void)=default</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html">cpp_redis::logger_iface</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html#a7f1cb271b18e40f2dde7e45028e69a84">logger_iface</a>(const logger_iface &amp;)=default</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html">cpp_redis::logger_iface</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html#a09d012d32f35421a16ec73143adc4415">operator=</a>(const logger &amp;)=default</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html">cpp_redis::logger</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html#a04324701cb81ba6a23f73025b0b3eee0">cpp_redis::logger_iface::operator=</a>(const logger_iface &amp;)=default</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html">cpp_redis::logger_iface</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html#ae9359429428786c7b5605a1109508ae5">warn</a>(const std::string &amp;msg, const std::string &amp;file, std::size_t line)</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html">cpp_redis::logger</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html#ae9359429428786c7b5605a1109508ae5">warn</a>(const string_t &amp;msg, const string_t &amp;file, std::size_t line)</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html">cpp_redis::logger</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
   <tr><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html#ab5eb02b26c96a6e5cba9a7d30669f625">~logger</a>(void)=default</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger.html">cpp_redis::logger</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html#ac7ed1b828afd2e6589fcdda167d34aa5">~logger_iface</a>(void)=default</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html">cpp_redis::logger_iface</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
 </table></div><!-- contents -->

docs/html/classcpp__redis_1_1client.html

@@ -115,13 +115,13 @@
 <a class="el" href="classcpp__redis_1_1logger.html">logger</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__redis_1_1logger.html#a09d012d32f35421a16ec73143adc4415">operator=</a> (const <a class="el" href="classcpp__redis_1_1logger.html">logger</a> &amp;)=default</td></tr>
 <tr class="memdesc:a09d012d32f35421a16ec73143adc4415"><td class="mdescLeft">&#160;</td><td class="mdescRight">assignment operator <br /></td></tr>
 <tr class="separator:a09d012d32f35421a16ec73143adc4415"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a36e0908e7b05850b663a4b8b9cdbc299"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__redis_1_1logger.html#a36e0908e7b05850b663a4b8b9cdbc299">debug</a> (const std::string &amp;msg, const std::string &amp;file, std::size_t line)</td></tr>
+<tr class="memitem:a36e0908e7b05850b663a4b8b9cdbc299"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__redis_1_1logger.html#a36e0908e7b05850b663a4b8b9cdbc299">debug</a> (const string_t &amp;msg, const string_t &amp;file, std::size_t line)</td></tr>
 <tr class="separator:a36e0908e7b05850b663a4b8b9cdbc299"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a04c741b5110946e76bb23728da6fb2ac"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__redis_1_1logger.html#a04c741b5110946e76bb23728da6fb2ac">info</a> (const std::string &amp;msg, const std::string &amp;file, std::size_t line)</td></tr>
+<tr class="memitem:a04c741b5110946e76bb23728da6fb2ac"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__redis_1_1logger.html#a04c741b5110946e76bb23728da6fb2ac">info</a> (const string_t &amp;msg, const string_t &amp;file, std::size_t line)</td></tr>
 <tr class="separator:a04c741b5110946e76bb23728da6fb2ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ae9359429428786c7b5605a1109508ae5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__redis_1_1logger.html#ae9359429428786c7b5605a1109508ae5">warn</a> (const std::string &amp;msg, const std::string &amp;file, std::size_t line)</td></tr>
+<tr class="memitem:ae9359429428786c7b5605a1109508ae5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__redis_1_1logger.html#ae9359429428786c7b5605a1109508ae5">warn</a> (const string_t &amp;msg, const string_t &amp;file, std::size_t line)</td></tr>
 <tr class="separator:ae9359429428786c7b5605a1109508ae5"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:aaf7f2837511f4414a4d7b7b923ebc15e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__redis_1_1logger.html#aaf7f2837511f4414a4d7b7b923ebc15e">error</a> (const std::string &amp;msg, const std::string &amp;file, std::size_t line)</td></tr>
+<tr class="memitem:aaf7f2837511f4414a4d7b7b923ebc15e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcpp__redis_1_1logger.html#aaf7f2837511f4414a4d7b7b923ebc15e">error</a> (const string_t &amp;msg, const string_t &amp;file, std::size_t line)</td></tr>
 <tr class="separator:aaf7f2837511f4414a4d7b7b923ebc15e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="inherit_header pub_methods_classcpp__redis_1_1logger__iface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcpp__redis_1_1logger__iface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classcpp__redis_1_1logger__iface.html">cpp_redis::logger_iface</a></td></tr>
 <tr class="memitem:a902e41bf0777b960b6575e7ac986147b inherit pub_methods_classcpp__redis_1_1logger__iface"><td class="memItemLeft" align="right" valign="top"><a id="a902e41bf0777b960b6575e7ac986147b"></a>
@@ -180,13 +180,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#a36e0908e7b05850b663a4b8b
         <tr>
           <td class="memname">void cpp_redis::logger::debug </td>
           <td>(</td>
-          <td class="paramtype">const std::string &amp;&#160;</td>
+          <td class="paramtype">const string_t &amp;&#160;</td>
           <td class="paramname"><em>msg</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">const std::string &amp;&#160;</td>
+          <td class="paramtype">const string_t &amp;&#160;</td>
           <td class="paramname"><em>file</em>, </td>
         </tr>
         <tr>
@@ -233,13 +233,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#aaf7f2837511f4414a4d7b7b9
         <tr>
           <td class="memname">void cpp_redis::logger::error </td>
           <td>(</td>
-          <td class="paramtype">const std::string &amp;&#160;</td>
+          <td class="paramtype">const string_t &amp;&#160;</td>
           <td class="paramname"><em>msg</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">const std::string &amp;&#160;</td>
+          <td class="paramtype">const string_t &amp;&#160;</td>
           <td class="paramname"><em>file</em>, </td>
         </tr>
         <tr>
@@ -286,13 +286,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#a04c741b5110946e76bb23728
         <tr>
           <td class="memname">void cpp_redis::logger::info </td>
           <td>(</td>
-          <td class="paramtype">const std::string &amp;&#160;</td>
+          <td class="paramtype">const string_t &amp;&#160;</td>
           <td class="paramname"><em>msg</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">const std::string &amp;&#160;</td>
+          <td class="paramtype">const string_t &amp;&#160;</td>
           <td class="paramname"><em>file</em>, </td>
         </tr>
         <tr>
@@ -339,13 +339,13 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae9359429428786c7b5605a11
         <tr>
           <td class="memname">void cpp_redis::logger::warn </td>
           <td>(</td>
-          <td class="paramtype">const std::string &amp;&#160;</td>
+          <td class="paramtype">const string_t &amp;&#160;</td>
           <td class="paramname"><em>msg</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">const std::string &amp;&#160;</td>
+          <td class="paramtype">const string_t &amp;&#160;</td>
           <td class="paramname"><em>file</em>, </td>
         </tr>
         <tr>

docs/html/classcpp__redis_1_1logger-members.html

@@ -75,13 +75,13 @@
 
 <p>This is the complete list of members for <a class="el" href="classcpp__redis_1_1logger__iface.html">cpp_redis::logger_iface</a>, including all inherited members.</p>
 <table class="directory">
-  <tr class="even"><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html#aaace9e12cbb32d7bdd76c17180a30de7">debug</a>(const std::string &amp;msg, const std::string &amp;file, std::size_t line)=0</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html">cpp_redis::logger_iface</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
-  <tr><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html#ac8353031252c80e69e35f5f131870ddf">error</a>(const std::string &amp;msg, const std::string &amp;file, std::size_t line)=0</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html">cpp_redis::logger_iface</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html#a02e62f55d7da56efa3b47f2b05931b3b">info</a>(const std::string &amp;msg, const std::string &amp;file, std::size_t line)=0</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html">cpp_redis::logger_iface</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html#aaace9e12cbb32d7bdd76c17180a30de7">debug</a>(const string_t &amp;msg, const string_t &amp;file, std::size_t line)=0</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html">cpp_redis::logger_iface</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html#ac8353031252c80e69e35f5f131870ddf">error</a>(const string_t &amp;msg, const string_t &amp;file, std::size_t line)=0</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html">cpp_redis::logger_iface</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html#a02e62f55d7da56efa3b47f2b05931b3b">info</a>(const string_t &amp;msg, const string_t &amp;file, std::size_t line)=0</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html">cpp_redis::logger_iface</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
   <tr><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html#a902e41bf0777b960b6575e7ac986147b">logger_iface</a>(void)=default</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html">cpp_redis::logger_iface</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html#a7f1cb271b18e40f2dde7e45028e69a84">logger_iface</a>(const logger_iface &amp;)=default</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html">cpp_redis::logger_iface</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html#a04324701cb81ba6a23f73025b0b3eee0">operator=</a>(const logger_iface &amp;)=default</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html">cpp_redis::logger_iface</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html#a0ea8e43a4f2118e77af56cd1cdb21cba">warn</a>(const std::string &amp;msg, const std::string &amp;file, std::size_t line)=0</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html">cpp_redis::logger_iface</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html#a0ea8e43a4f2118e77af56cd1cdb21cba">warn</a>(const string_t &amp;msg, const string_t &amp;file, std::size_t line)=0</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html">cpp_redis::logger_iface</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
   <tr><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html#ac7ed1b828afd2e6589fcdda167d34aa5">~logger_iface</a>(void)=default</td><td class="entry"><a class="el" href="classcpp__redis_1_1logger__iface.html">cpp_redis::logger_iface</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
 </table></div><!-- contents -->
 <!-- start footer part -->