summaryrefslogtreecommitdiff
path: root/src/yelp-uri.h
blob: 824365f6891d55582e3729cccc9a5711e168b660 (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
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * Copyright (C) 2002 Mikael Hallendal <micke@imendio.com>
 *
 * 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: Mikael Hallendal <micke@imendio.com>
 */

#ifndef __YELP_URI_H__
#define __YELP_URI_H__

#include <glib.h>

#define YELP_URI(x) ((YelpURI *) x)

typedef enum {
        YELP_URI_TYPE_UNKNOWN,
        YELP_URI_TYPE_DOCBOOK_XML,
	YELP_URI_TYPE_DOCBOOK_SGML,
	YELP_URI_TYPE_GHELP_OTHER,
        YELP_URI_TYPE_HTML,
        YELP_URI_TYPE_MAN,
        YELP_URI_TYPE_INFO,
	YELP_URI_TYPE_TOC,
	YELP_URI_TYPE_INDEX,
	YELP_URI_TYPE_PATH,
	YELP_URI_TYPE_FILE
} YelpURIType;

typedef struct _YelpURI YelpURI;

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

YelpURIType     yelp_uri_get_type         (YelpURI       *uri);
const gchar *   yelp_uri_get_path         (YelpURI       *uri);
const gchar *   yelp_uri_get_section      (YelpURI       *uri);

YelpURI *       yelp_uri_ref              (YelpURI       *uri);
void            yelp_uri_unref            (YelpURI       *uri);

YelpURI *       yelp_uri_copy             (YelpURI       *uri);
YelpURI *       yelp_uri_get_relative     (YelpURI       *uri,
					   const gchar   *link);
gboolean        yelp_uri_equal            (YelpURI       *uri1,
					   YelpURI       *uri2);
gboolean        yelp_uri_equal_path       (YelpURI       *uri1,
					   YelpURI       *uri2);
gboolean        yelp_uri_equal_section    (YelpURI       *uri1,
					   YelpURI       *uri2);
gchar *         yelp_uri_to_string        (YelpURI       *uri);

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__ */