herrie/src/util.h

   1 /*
   2  * Copyright (c) 2006-2011 Ed Schouten <ed@80386.nl>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26 /**
  27  * @file util.h
  28  * @brief General utility functions
  29  */
  30
  31 #ifdef BUILD_SCROBBLER
  32 /**
  33  * @brief Convert a binary buffer to a hexadecimal string. The len
  34  *        parameter is the length of the binary buffer. The string will
  35  *        not be null terminated.
  36  */
  37 void hex_encode(unsigned char *bin, char *hex, size_t len);
  38 #endif /* BUILD_SCROBBLER */
  39
  40 /**
  41  * @brief Escape a string according to HTTP/1.1. A string can be
  42  *        prepended as well, which won't be escaped.
  43  */
  44 char *http_escape(const char *str, const char *prepend);
  45
  46 #ifdef BUILD_XSPF
  47 /**
  48  * @brief Escape an URL when needed. If it's a local filename, file://
  49  *        will be prepended.
  50  */
  51 char *url_escape(const char *str);
  52 /**
  53  * @brief Unescape an URL to a local filename where possible
  54  *        (file://foo -> foo).
  55  */
  56 char *url_unescape(char *str);
  57 #endif /* BUILD_XSPF */