aboutsummaryrefslogtreecommitdiff
path: root/vmime-master/src/vmime/utility/stringUtils.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'vmime-master/src/vmime/utility/stringUtils.hpp')
-rw-r--r--vmime-master/src/vmime/utility/stringUtils.hpp271
1 files changed, 271 insertions, 0 deletions
diff --git a/vmime-master/src/vmime/utility/stringUtils.hpp b/vmime-master/src/vmime/utility/stringUtils.hpp
new file mode 100644
index 0000000..4678940
--- /dev/null
+++ b/vmime-master/src/vmime/utility/stringUtils.hpp
@@ -0,0 +1,271 @@
+//
+// VMime library (http://www.vmime.org)
+// Copyright (C) 2002 Vincent Richard <vincent@vmime.org>
+//
+// This program is free software; you can redistribute it and/or
+// modify it under the terms of the GNU General Public License as
+// published by the Free Software Foundation; either version 3 of
+// the License, or (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+// General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, write to the Free Software Foundation, Inc.,
+// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+//
+// Linking this library statically or dynamically with other modules is making
+// a combined work based on this library. Thus, the terms and conditions of
+// the GNU General Public License cover the whole combination.
+//
+
+#ifndef VMIME_UTILITY_STRINGUTILS_HPP_INCLUDED
+#define VMIME_UTILITY_STRINGUTILS_HPP_INCLUDED
+
+
+#include "vmime/types.hpp"
+#include "vmime/base.hpp"
+
+#include <sstream>
+
+
+namespace vmime {
+namespace utility {
+
+
+/** Miscellaneous functions related to strings.
+ */
+class VMIME_EXPORT stringUtils {
+
+public:
+
+ /** Makes a string from bytes.
+ *
+ * @param data pointer to buffer containing data
+ * @param count number of bytes to use from buffer
+ * @return a string object containing a copy of the specified data
+ */
+ static const string makeStringFromBytes(const byte_t* data, const size_t count) {
+
+ return string(reinterpret_cast <const char*>(data), count);
+ }
+
+ /** Casts a string to bytes.
+ *
+ * @param str string
+ * @return pointer to the first byte of the string
+ */
+ static const byte_t* bytesFromString(const string& str) {
+
+ return reinterpret_cast <const byte_t*>(str.data());
+ }
+
+ /** Casts a NULL-terminated string to bytes.
+ *
+ * @param str string
+ * @return pointer to the first byte of the string
+ */
+ static const byte_t* bytesFromString(const char* str) {
+
+ return reinterpret_cast <const byte_t*>(str);
+ }
+
+ /** Appends bytes to a string.
+ *
+ * @param str string to which append data
+ * @param data pointer to buffer containing data
+ * @param count number of bytes to use from buffer
+ * @return a reference to modified string
+ */
+ static string& appendBytesToString(string& str, const byte_t* data, const size_t count) {
+
+ str.append(reinterpret_cast <const char*>(data), count);
+ return str;
+ }
+
+ /** Test two strings for equality (case insensitive).
+ * \warning Use this with ASCII-only strings.
+ *
+ * @param s1 first string
+ * @param s2 second string (must be in lower-case!)
+ * @param n length of the second string
+ * @return true if the two strings compare equally, false otherwise
+ */
+ static bool isStringEqualNoCase(const string& s1, const char* s2, const size_t n);
+
+ /** Test two strings for equality (case insensitive).
+ * \warning Use this with ASCII-only strings.
+ *
+ * @param s1 first string
+ * @param s2 second string
+ * @return true if the two strings compare equally, false otherwise
+ */
+ static bool isStringEqualNoCase(const string& s1, const string& s2);
+
+ /** Test two strings for equality (case insensitive).
+ * \warning Use this with ASCII-only strings.
+ *
+ * @param begin start position of the first string
+ * @param end end position of the first string
+ * @param s second string (must be in lower-case!)
+ * @param n length of the second string
+ * @return true if the two strings compare equally, false otherwise
+ */
+ static bool isStringEqualNoCase(
+ const string::const_iterator begin,
+ const string::const_iterator end,
+ const char* s,
+ const size_t n
+ );
+
+ /** Transform all the characters in a string to lower-case.
+ * \warning Use this with ASCII-only strings.
+ *
+ * @param str the string to transform
+ * @return a new string in lower-case
+ */
+ static const string toLower(const string& str);
+
+ /** Transform all the characters in a string to upper-case.
+ * \warning Use this with ASCII-only strings.
+ *
+ * @param str the string to transform
+ * @return a new string in upper-case
+ */
+ static const string toUpper(const string& str);
+
+ /** Strip the space characters (SPC, TAB, CR, LF) at the beginning
+ * and at the end of the specified string.
+ *
+ * @param str string in which to strip spaces
+ * @return a new string with space characters removed
+ */
+ static const string trim(const string& str);
+
+ /** Return the number of 7-bit US-ASCII characters in a string.
+ *
+ * @param begin start position
+ * @param end end position
+ * @return number of ASCII characters
+ */
+ static size_t countASCIIchars(
+ const string::const_iterator begin,
+ const string::const_iterator end
+ );
+
+ /** Returns whether the specified string is composed exclusively
+ * of 7-bit ASCII characters.
+ *
+ * @param str string to test
+ * @return true if the string is ASCII-only, false otherwise
+ */
+ static bool is7bit(const string& str);
+
+ /** Returns the position of the first non 7-bit US-ASCII character in a string.
+ *
+ * @param begin start position
+ * @param end end position
+ * @return position since begin, or string::npos
+ */
+ static size_t findFirstNonASCIIchar(
+ const string::const_iterator begin,
+ const string::const_iterator end
+ );
+
+ /** Convert the specified value to a string value.
+ *
+ * @param value to convert
+ * @return value converted from type 'TYPE'
+ */
+ template <class TYPE>
+ static const string toString(const TYPE& value) {
+
+ std::ostringstream oss;
+ oss.imbue(std::locale::classic());
+
+ oss << value;
+
+ return oss.str();
+ }
+
+ /** Convert the specified string value to a value of
+ * the specified type.
+ *
+ * @param value value to convert
+ * @return value converted into type 'TYPE'
+ */
+ template <class TYPE>
+ static const TYPE fromString(const string& value) {
+
+ TYPE ret;
+
+ std::istringstream iss(value);
+ iss.imbue(std::locale::classic());
+
+ iss >> ret;
+
+ return ret;
+ }
+
+ /** Unquote the specified string and transform escaped characters.
+ *
+ * @param str string from which to remove quotes
+ * @return unquoted string
+ */
+ static const string unquote(const string& str);
+
+ /** Determines whether the specified string needs to be quoted.
+ *
+ * @param str string to test
+ * @param specialChars list of characters that will cause the
+ * string to be quoted
+ * @return true if the string needs to be quoted, false otherwise
+ */
+ static bool needQuoting(
+ const string& str,
+ const string& specialChars = " \t\"(),:;<>@[\\]"
+ );
+
+ /** Quotes the specified string.
+ *
+ * @param str string to quote
+ * @param escapeSpecialChars list of characters that will be escaped
+ * @param escapeChar character that will be used for escaping (eg. '\')
+ * @return quoted string
+ */
+ static string quote(
+ const string& str,
+ const string& escapeSpecialChars,
+ const string& escapeChar
+ );
+
+ /** Return whether the specified string is a valid host name
+ * or domain name.
+ *
+ * @param hostname string to test
+ * @return true if the string is a valid host name or domain
+ * name, or false otherwise
+ */
+ static bool isValidHostname(const vmime::string& hostname);
+
+ /** Return whether the specified string is a valid fully
+ * qualified domain name (FQDN).
+ *
+ * @param fqdn string to test
+ * @return true if the string seems to be a FQDN, false otherwise
+ */
+ static bool isValidFQDN(const vmime::string& fqdn);
+
+private:
+
+ static bool isValidFQDNImpl(const vmime::string& fqdn, short* minNumberOfDots);
+};
+
+
+} // utility
+} // vmime
+
+
+#endif // VMIME_UTILITY_STRINGUTILS_HPP_INCLUDED