summaryrefslogtreecommitdiff
path: root/src/yelp-uri.h
blob: 2c46d4557a54f56f37647b0b53bcbef7c57f978f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 4 -*- */
/*
 * Copyright (C) 2003 Shaun McCance <shaunm@gnome.org>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * Author: Shaun McCance <shaunm@gnome.org>
 *   Based on implementation by Mikael Hallendal <micke@imendio.com>
 */

#ifndef __YELP_URI_H__
#define __YELP_URI_H__

#include <glib.h>

#define YELP_TYPE_URI         (yelp_uri_get_type ())
#define YELP_URI(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), YELP_TYPE_URI, YelpURI))
#define YELP_URI_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST ((k), YELP_TYPE_URI, YelpURIClass))
#define YELP_IS_URI(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), YELP_TYPE_URI))
#define YELP_IS_URI_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), YELP_TYPE_URI))
#define YELP_URI_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), YELP_TYPE_URI, YelpURIClass))

typedef struct _YelpURI      YelpURI;
typedef struct _YelpURIClass YelpURIClass;
typedef struct _YelpURIPriv  YelpURIPriv;

typedef enum {
    YELP_URI_TYPE_UNKNOWN,
    YELP_URI_TYPE_RELATIVE,
    YELP_URI_TYPE_DOCBOOK_XML,
    YELP_URI_TYPE_DOCBOOK_SGML,
    YELP_URI_TYPE_HTML,
    YELP_URI_TYPE_MAN,
    YELP_URI_TYPE_INFO,

    YELP_URI_TYPE_GHELP,
    YELP_URI_TYPE_GHELP_OTHER,
    YELP_URI_TYPE_TOC,
    YELP_URI_TYPE_INDEX,
    YELP_URI_TYPE_PATH,
    YELP_URI_TYPE_FILE
} YelpURIType;

struct _YelpURI {
    GObject      parent;

    YelpURIPriv *priv;
};

struct _YelpURIClass {
    GObjectClass parent_class;
};


GType           yelp_uri_get_type          (void);

YelpURI *       yelp_uri_new               (const gchar   *uri_str);
gboolean        yelp_uri_exists            (YelpURI       *uri);

YelpURIType     yelp_uri_get_resource_type (YelpURI       *uri);
gchar *         yelp_uri_get_path          (YelpURI       *uri);
gchar *         yelp_uri_get_fragment      (YelpURI       *uri);

gchar *         yelp_uri_to_string         (YelpURI       *uri);

gboolean        yelp_uri_equal             (YelpURI       *uri1,
					    YelpURI       *uri2);
gboolean        yelp_uri_equal_path        (YelpURI       *uri1,
					    YelpURI       *uri2);
gboolean        yelp_uri_equal_fragment    (YelpURI       *uri1,
					    YelpURI       *uri2);

/*
YelpURI *       yelp_uri_copy             (YelpURI       *uri);
YelpURI *       yelp_uri_get_relative     (YelpURI       *uri,
					   const gchar   *link);

YelpURI *       yelp_uri_to_index         (YelpURI       *uri);
YelpURI *       yelp_uri_from_index       (YelpURI       *uri);
gboolean        yelp_uri_no_path          (YelpURI       *uri);
*/

#endif /* __YELP_URI_H__ */