Imported Upstream version 15.0.0

[platform/upstream/libzypp.git] / zypp / url / UrlUtils.h

diff --git a/zypp/url/UrlUtils.h b/zypp/url/UrlUtils.h
index f2a3c5b..5189a57 100644 (file)
--- a/zypp/url/UrlUtils.h
+++ b/zypp/url/UrlUtils.h
@@ -12,10 +12,14 @@
 #ifndef   ZYPP_URL_URLUTILS_H
 #define   ZYPP_URL_URLUTILS_H
 
+#include "zypp/url/UrlException.h"
+
 #include <string>
 #include <vector>
 #include <map>
 
+/** Characters that are safe for URL without percent-encoding. */
+#define URL_SAFE_CHARS ":/?#[]@!$&'()*+,;="
 
 //////////////////////////////////////////////////////////////////////
 namespace zypp
@@ -95,8 +99,8 @@ namespace zypp
      * \param allowNUL A flag, if \c "%00" (encoded \c '\\0')
      *                 is allowed or not.
      * \return A decoded strig (may contain binary data).
-     * \throws A std::invalid_argument exception if \p allowNUL
-     *         is false and a \c "%00" was found in \p str.
+     * \throws UrlDecodingException if \p allowNUL is false and
+     *         a encoded NUL byte (\c "%00") was found in \p str.
      */
     std::string
     decode(const std::string &str, bool allowNUL = false);
@@ -151,6 +155,7 @@ namespace zypp
      * \param pvec    Reference to a result parameter vector.
      * \param pstr    Reference to the PathParam- or Query-String to split.
      * \param psep    Parameter separator character to split at.
+     * \throws UrlNotSupportedException if \p psep separator is empty.
      */
     void
     split(ParamVec          &pvec,
@@ -183,8 +188,8 @@ namespace zypp
      * \param vsep    Separator character to split key and value.
      * \param eflag   Flag if the key and value strings should be URL percent
      *                decoded before they're stored in the map.
-     * \throws A std::invalid_argument exception if the eflag is set to
-     * E_DECODED and the \p pstr contains a \c "%00" (encoded \c '\\0').
+     * \throws UrlNotSupportedException if \p psep or \p vsep separator
+     *         is empty.
      */
     void
     split(ParamMap          &pmap,
@@ -232,8 +237,8 @@ namespace zypp
      * \param vsep    Separator character to use between keys and values.
      * \param safe    List of characters to accept without encoding.
      * \return A URL percent-encoded parameter string.
-     * \throws A std::invalid_argument exception, if the \p safe character
-     * list contains characters used in \p psep or \p vsep.
+     * \throws UrlNotSupportedException if \p psep or \p vsep separator
+     *         is empty.
      */
     std::string
     join(const ParamMap     &pmap,