glib/gurifuncs.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #ifndef __G_URI_FUNCS_H__
  24 #define __G_URI_FUNCS_H__
  25
  26 #include <glib.h>
  27
  28 G_BEGIN_DECLS
  29
  30 /**
  31  * G_URI_RESERVED_CHARS_GENERIC_DELIMITERS:
  32  *
  33  * Generic delimiters characters as defined in RFC 3986. Includes ":/?#[]@".
  34  **/
  35 #define G_URI_RESERVED_CHARS_GENERIC_DELIMITERS ":/?#[]@"
  36
  37 /**
  38  * G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS
  39  *
  40  * Subcomponent delimiter characters as defined in RFC 3986. Includes "!$&'()*+,;=".
  41  **/
  42 #define G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS "!$&'()*+,;="
  43
  44 /**
  45  * G_URI_RESERVED_CHARS_ALLOWED_IN_PATH_ELEMENT:
  46  *
  47  * Allowed characters in path elements. Includes "!$&'()*+,;=:@".
  48  **/
  49 #define G_URI_RESERVED_CHARS_ALLOWED_IN_PATH_ELEMENT G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS ":@"
  50
  51 /**
  52  * G_URI_RESERVED_CHARS_ALLOWED_IN_PATH:
  53  *
  54  * Allowed characters in a path. Includes "!$&'()*+,;=:@/".
  55  **/
  56 #define G_URI_RESERVED_CHARS_ALLOWED_IN_PATH G_URI_RESERVED_CHARS_ALLOWED_IN_PATH_ELEMENT "/"
  57
  58 /**
  59  * G_URI_RESERVED_CHARS_ALLOWED_IN_USERINFO:
  60  *
  61  * Allowed characters in userinfo as defined in RFC 3986. Includes "!$&'()*+,;=:".
  62  **/
  63 #define G_URI_RESERVED_CHARS_ALLOWED_IN_USERINFO G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS ":"
  64
  65 char *   g_uri_unescape_string       (const char *escaped_string,
  66                                       const char *illegal_characters);
  67 char *   g_uri_unescape_segment      (const char *escaped_string,
  68                                       const char *escaped_string_end,
  69                                       const char *illegal_characters);
  70 char *   g_uri_parse_scheme          (const char *uri);
  71 char *   g_uri_escape_string         (const char *unescaped,
  72                                       const char *reserved_chars_allowed,
  73                                       gboolean    allow_utf8);
  74
  75 G_END_DECLS
  76
  77 #endif /* __G_URI_FUNCS_H__ */