xapian-applications/omega/urlencode.h

   1 /** @file
   2  * @brief URL encoding as described by RFC3986.
   3  */
   4 /* Copyright (C) 2011,2014 Olly Betts
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to
   8  * deal in the Software without restriction, including without limitation the
   9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  10  * sell copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  22  * IN THE SOFTWARE.
  23  */
  24
  25 #ifndef OMEGA_INCLUDED_URLENCODE_H
  26 #define OMEGA_INCLUDED_URLENCODE_H
  27
  28 #include <cstring>
  29 #include <string>
  30
  31 void url_encode_(std::string & res,
  32                  const char * p, size_t len,
  33                  const char * safe);
  34
  35 inline void
  36 url_encode(std::string & res, const std::string &str)
  37 {
  38     url_encode_(res, str.data(), str.size(), "-._~");
  39 }
  40
  41 inline void
  42 url_encode(std::string & res, const char * p)
  43 {
  44     url_encode_(res, p, std::strlen(p), "-._~");
  45 }
  46
  47 /// Append a path, url encoding the segments, but not the '/' between them.
  48 inline void
  49 url_encode_path(std::string & res, const std::string &str)
  50 {
  51     url_encode_(res, str.data(), str.size(), "/-._~");
  52 }
  53
  54 /// Append a path, url encoding the segments, but not the '/' between them.
  55 inline void
  56 url_encode_path(std::string & res, const char * p)
  57 {
  58     url_encode_(res, p, std::strlen(p), "/-._~");
  59 }
  60
  61 #endif // OMEGA_INCLUDED_URLENCODE_H