summaryrefslogtreecommitdiff
path: root/content/fetchers/resource.h
blob: 35c397310ad0df5b252b5c1816277eb3c34f03d9 (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
/*
 * Copyright 2011 Vincent Sanders <vince@netsurf-browser.org>
 *
 * This file is part of NetSurf.
 *
 * NetSurf 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; version 2 of the License.
 *
 * NetSurf 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, see <http://www.gnu.org/licenses/>.
 */

/** \file
 * resource: URL method handler.
 * 
 * The resource fetcher is intended to provide a flat uniform URL
 * space for browser local resources referenced by URL. Using this
 * scheme each frontend is only required to provide a single entry
 * point to locate resources which can be accessed by the standard URL
 * type scheme.
 *
 */

#ifndef NETSURF_CONTENT_FETCHERS_FETCH_RESOURCE_H
#define NETSURF_CONTENT_FETCHERS_FETCH_RESOURCE_H

/**
 * Register the resource scheme.
 * 
 * should only be called from the fetch initialise
 */
void fetch_resource_register(void);

/**
 * Callback to translate resource to full url.
 *
 * Transforms a resource: filename into a full URL. The returned URL
 * is used as the target for a redirect. The caller takes ownership of
 * the returned string including freeing it when finished with it.
 *
 * \param filename The filename of the resource to locate.
 * \return A string containing the full URL of the target object or
 *         NULL if no suitable resource can be found.
 */
char* gui_get_resource_url(const char *filename);

#endif