include/libtorrent/escape_string.hpp

   1 /*
   2
   3 Copyright (c) 2003, Arvid Norberg
   4 All rights reserved.
   5
   6 Redistribution and use in source and binary forms, with or without
   7 modification, are permitted provided that the following conditions
   8 are met:
   9
  10     * Redistributions of source code must retain the above copyright
  11       notice, this list of conditions and the following disclaimer.
  12     * Redistributions in binary form must reproduce the above copyright
  13       notice, this list of conditions and the following disclaimer in
  14       the documentation and/or other materials provided with the distribution.
  15     * Neither the name of the author nor the names of its
  16       contributors may be used to endorse or promote products derived
  17       from this software without specific prior written permission.
  18
  19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  23 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29 POSSIBILITY OF SUCH DAMAGE.
  30
  31 */
  32
  33 #ifndef TORRENT_ESCAPE_STRING_HPP_INCLUDED
  34 #define TORRENT_ESCAPE_STRING_HPP_INCLUDED
  35
  36 #include <string>
  37 #include <boost/optional.hpp>
  38 #include "libtorrent/config.hpp"
  39
  40 namespace libtorrent
  41 {
  42         std::string TORRENT_EXPORT unescape_string(std::string const& s);
  43         std::string TORRENT_EXPORT escape_string(const char* str, int len);
  44         std::string TORRENT_EXPORT escape_path(const char* str, int len);
  45
  46         // encodes a string using the base64 scheme
  47         TORRENT_EXPORT std::string base64encode(std::string const& s);
  48         // encodes a string using the base32 scheme
  49         TORRENT_EXPORT std::string base32encode(std::string const& s);
  50         TORRENT_EXPORT std::string base32decode(std::string const& s);
  51
  52         TORRENT_EXPORT boost::optional<std::string> url_has_argument(
  53                 std::string const& url, std::string argument);
  54
  55         TORRENT_EXPORT std::string to_hex(std::string const& s);
  56 }
  57
  58 #endif // TORRENT_ESCAPE_STRING_HPP_INCLUDED