Added functions to escape binary arrays and renamed string escaping functions.

[evaf] / src / libs / Common / util.h

diff --git a/src/libs/Common/util.h b/src/libs/Common/util.h
index 4b5e4c9fd81ce62aa7778f8a233b11c5e157d116..8237e7c76c0cc526abb5ecb488802f098dc570c2 100644 (file)
--- a/src/libs/Common/util.h
+++ b/src/libs/Common/util.h
@@ -76,6 +76,49 @@ inline bool isFalse(QString const & str)
 
 COMMON_EXPORT QVariant toVariant(QString const & value, QVariant const & defaultValue);
 
+/**
+ * Converts unicode strings to escaped 7-bit character arrays.
+ * @param str Unicode string
+ * @return Escaped 7-bit character array
+ *
+ * This function converts a unicode (or any) string to the escaped 7-bit character array. Characters that cannot
+ * be output directly as a printable 7-bit character are output as numeric character references. The result can be
+ * directly inserted into XML or HTML documents and later converted back with the eVaf::Common::strFromEscapedCharArray()
+ * function.
+ */
+COMMON_EXPORT QByteArray strToEscapedCharArray(QString const & str);
+
+/**
+ * Converts escaped 7-bit character arrays to unicode string.
+ * @param str Escaped 7-bit character array
+ * @return Unicode string
+ *
+ * This function converts an escaped 7-bit character array to the unicode string. Numeric character references and
+ * character entity references are expanded to actual unicode characters.
+ */
+COMMON_EXPORT QString strFromEscapedCharArray(QByteArray const & str);
+
+/**
+ * Converts binary arrays to escaped 7-bit character arrays
+ * @param src Binary array
+ * @return Escaped 7-bit character array
+ *
+ * This function converts a binary array to the escaped 7-bit character array. Bytes that cannot be output
+ * directly as printable 7-bit characters are output as numeric character references. The result can be directly
+ * inserted into XML or HTML documents and later converted back with the eVaf::Common::binFromEscapedCharArray()
+ * function.
+ */
+COMMON_EXPORT QByteArray binToEscapedCharArray(QByteArray const & src);
+
+/**
+ * Converts escaped 7-bit character arrays to binary arrays
+ * @param str Escaped 7-bit character array
+ * @return Binary array
+ *
+ * This function converts an escaped 7-bit character array to the binary array. Numeric character references and
+ * character entoty references are expanded to characters and binary bytes.
+ */
+COMMON_EXPORT QByteArray binFromEscapedCharArray(QByteArray const & str);
 
 } // namespace eVaf::Common
 } // namespace eVaf