]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/stdalgo.h
Update copyright headers.
[user/henk/code/inspircd.git] / include / stdalgo.h
index bb5e122623277a9daa60a6ecd13a82852db74ed1..dd97e8efa2e1447900000fdcbb1d7322c3a7e5a3 100644 (file)
@@ -1,7 +1,8 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
- *   Copyright (C) 2014 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2018, 2020-2021 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2014, 2016, 2018 Attila Molnar <attilamolnar@hush.com>
  *
  * This file is part of InspIRCd.  InspIRCd is free software: you can
  * redistribute it and/or modify it under the terms of the GNU General Public
@@ -27,10 +28,10 @@ namespace stdalgo
                 * Erase a single element from a vector by overwriting it with a copy of the last element,
                 * which is then removed. This, in contrast to vector::erase(), does not result in all
                 * elements after the erased element being moved.
+                * Returns nothing, but all iterators, references and pointers to the erased element and the
+                * last element are invalidated
                 * @param vect Vector to remove the element from
                 * @param it Iterator to the element to remove
-                * @return Nothing, but all iterators, references and pointers to the erased element and the
-                * last element are invalidated
                 */
                template <typename T>
                inline void swaperase(typename std::vector<T>& vect, const typename std::vector<T>::iterator& it)
@@ -181,6 +182,17 @@ namespace stdalgo
                std::for_each(cont.begin(), cont.end(), defaultdeleter<T>());
        }
 
+       /** Deletes a object and zeroes the memory location that pointed to it.
+        * @param pr A reference to the pointer that contains the object to delete.
+        */
+       template<typename T>
+       void delete_zero(T*& pr)
+       {
+               T* p = pr;
+               pr = NULL;
+               delete p;
+       }
+
        /**
         * Remove an element from a container
         * @param cont Container to remove the element from
@@ -210,4 +222,86 @@ namespace stdalgo
        {
                return (std::find(cont.begin(), cont.end(), val) != cont.end());
        }
+
+       namespace string
+       {
+               /**
+                * Escape a string
+                * @param str String to escape
+                * @param out Output, must not be the same string as str
+                */
+               template <char from, char to, char esc>
+               inline void escape(const std::string& str, std::string& out)
+               {
+                       for (std::string::const_iterator i = str.begin(); i != str.end(); ++i)
+                       {
+                               char c = *i;
+                               if (c == esc)
+                                       out.append(2, esc);
+                               else
+                               {
+                                       if (c == from)
+                                       {
+                                               out.push_back(esc);
+                                               c = to;
+                                       }
+                                       out.push_back(c);
+                               }
+                       }
+               }
+
+               /**
+                * Escape a string using the backslash character as the escape character
+                * @param str String to escape
+                * @param out Output, must not be the same string as str
+                */
+               template <char from, char to>
+               inline void escape(const std::string& str, std::string& out)
+               {
+                       escape<from, to, '\\'>(str, out);
+               }
+
+               /**
+                * Unescape a string
+                * @param str String to unescape
+                * @param out Output, must not be the same string as str
+                * @return True if the string was unescaped, false if an invalid escape sequence is present in the input in which case out will contain a partially unescaped string
+                */
+               template<char from, char to, char esc>
+               inline bool unescape(const std::string& str, std::string& out)
+               {
+                       for (std::string::const_iterator i = str.begin(); i != str.end(); ++i)
+                       {
+                               char c = *i;
+                               if (c == '\\')
+                               {
+                                       ++i;
+                                       if (i == str.end())
+                                               return false;
+
+                                       char nextc = *i;
+                                       if (nextc == esc)
+                                               c = esc;
+                                       else if (nextc != to)
+                                               return false; // Invalid escape sequence
+                                       else
+                                               c = from;
+                               }
+                               out.push_back(c);
+                       }
+                       return true;
+               }
+
+               /**
+                * Unescape a string using the backslash character as the escape character
+                * @param str String to unescape
+                * @param out Output, must not be the same string as str
+                * @return True if the string was unescaped, false if an invalid escape sequence is present in the input in which case out will contain a partially unescaped string
+                */
+               template <char from, char to>
+               inline bool unescape(const std::string& str, std::string& out)
+               {
+                       return unescape<from, to, '\\'>(str, out);
+               }
+       }
 }