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