libedataserver/e-url.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2
   3 /*
   4  * e-url.h
   5  *
   6  * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
   7  *
   8  * Developed by Jon Trowbridge <trow@ximian.com>
   9  *              Rodrigo Moya   <rodrigo@ximian.com>
  10  */
  11
  12 /*
  13  * This program is free software; you can redistribute it and/or
  14  * modify it under the terms of version 2 of the GNU Lesser General Public
  15  * License as published by the Free Software Foundation.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
  25  * USA.
  26  */
  27
  28 #if !defined (__LIBEDATASERVER_H_INSIDE__) && !defined (LIBEDATASERVER_COMPILATION)
  29 #error "Only <libedataserver/libedataserver.h> should be included directly."
  30 #endif
  31
  32 #ifndef EDS_DISABLE_DEPRECATED
  33
  34 /* Do not generate bindings. */
  35 #ifndef __GI_SCANNER__
  36
  37 #ifndef E_URL_H
  38 #define E_URL_H
  39
  40 #include <glib.h>
  41
  42 G_BEGIN_DECLS
  43
  44 typedef struct _EUri EUri;
  45
  46 /**
  47  * EUri:
  48  * @protocol: The protocol to use.
  49  * @user: A user name.
  50  * @authmech: The authentication mechanism.
  51  * @passwd: The connection password.
  52  * @host: The host name.
  53  * @port: The port number.
  54  * @path: The file path on the host.
  55  * @params: Additional parameters.
  56  * @query: The URI query.
  57  * @fragment: The URI fragment.
  58  *
  59  * A structure representing a URI.
  60  **/
  61 struct _EUri {
  62         gchar *protocol;
  63         gchar *user;
  64         gchar *authmech;
  65         gchar *passwd;
  66         gchar *host;
  67         gint port;
  68         gchar *path;
  69         GData *params;
  70         gchar *query;
  71         gchar *fragment;
  72 };
  73
  74 EUri *          e_uri_new                       (const gchar *uri_string);
  75 void            e_uri_free                      (EUri *uri);
  76 const gchar *   e_uri_get_param                 (EUri *uri,
  77                                                  const gchar *name);
  78 EUri *          e_uri_copy                      (EUri *uri);
  79 gchar *         e_uri_to_string                 (EUri *uri,
  80                                                  gboolean show_password);
  81 gchar *         e_url_shroud                    (const gchar *url);
  82 gboolean        e_url_equal                     (const gchar *url1,
  83                                                  const gchar *url2);
  84
  85 G_END_DECLS
  86
  87 #endif /* E_URL_H */
  88
  89 #endif /* __GI_SCANNER__ */
  90
  91 #endif /* EDS_DISABLE_DEPRECATED */
  92