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, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: Alexander Larsson <alexl@redhat.com>
  19  */
  20
  21 #ifndef __G_URI_FUNCS_H__
  22 #define __G_URI_FUNCS_H__
  23
  24 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  25 #error "Only <glib.h> can be included directly."
  26 #endif
  27
  28 #include <glib/gtypes.h>
  29
  30 G_BEGIN_DECLS
  31
  32 /**
  33  * G_URI_RESERVED_CHARS_GENERIC_DELIMITERS:
  34  *
  35  * Generic delimiters characters as defined in RFC 3986. Includes ":/?#[]@".
  36  **/
  37 #define G_URI_RESERVED_CHARS_GENERIC_DELIMITERS ":/?#[]@"
  38
  39 /**
  40  * G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS:
  41  *
  42  * Subcomponent delimiter characters as defined in RFC 3986. Includes "!$&'()*+,;=".
  43  **/
  44 #define G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS "!$&'()*+,;="
  45
  46 /**
  47  * G_URI_RESERVED_CHARS_ALLOWED_IN_PATH_ELEMENT:
  48  *
  49  * Allowed characters in path elements. Includes "!$&'()*+,;=:@".
  50  **/
  51 #define G_URI_RESERVED_CHARS_ALLOWED_IN_PATH_ELEMENT G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS ":@"
  52
  53 /**
  54  * G_URI_RESERVED_CHARS_ALLOWED_IN_PATH:
  55  *
  56  * Allowed characters in a path. Includes "!$&'()*+,;=:@/".
  57  **/
  58 #define G_URI_RESERVED_CHARS_ALLOWED_IN_PATH G_URI_RESERVED_CHARS_ALLOWED_IN_PATH_ELEMENT "/"
  59
  60 /**
  61  * G_URI_RESERVED_CHARS_ALLOWED_IN_USERINFO:
  62  *
  63  * Allowed characters in userinfo as defined in RFC 3986. Includes "!$&'()*+,;=:".
  64  **/
  65 #define G_URI_RESERVED_CHARS_ALLOWED_IN_USERINFO G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS ":"
  66
  67 GLIB_AVAILABLE_IN_ALL
  68 char *   g_uri_unescape_string       (const char *escaped_string,
  69                                       const char *illegal_characters);
  70 GLIB_AVAILABLE_IN_ALL
  71 char *   g_uri_unescape_segment      (const char *escaped_string,
  72                                       const char *escaped_string_end,
  73                                       const char *illegal_characters);
  74 GLIB_AVAILABLE_IN_ALL
  75 char *   g_uri_parse_scheme          (const char *uri);
  76 GLIB_AVAILABLE_IN_ALL
  77 char *   g_uri_escape_string         (const char *unescaped,
  78                                       const char *reserved_chars_allowed,
  79                                       gboolean    allow_utf8);
  80
  81 G_END_DECLS
  82
  83 #endif /* __G_URI_FUNCS_H__ */