1/* -*- mode: C; c-file-style: "gnu" -*- */
2/* xdgmime.h: XDG Mime Spec mime resolver. Based on version 0.11 of the spec.
3 *
4 * More info can be found at http://www.freedesktop.org/standards/
5 *
6 * Copyright (C) 2003 Red Hat, Inc.
7 * Copyright (C) 2003 Jonathan Blandford <jrb@alum.mit.edu>
8 *
9 * Licensed under the Academic Free License version 2.0
10 * Or under the following terms:
11 *
12 * This library is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU Lesser General Public
14 * License as published by the Free Software Foundation; either
15 * version 2 of the License, or (at your option) any later version.
16 *
17 * This library 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 GNU
20 * Lesser General Public License for more details.
21 *
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with this library; if not, write to the
24 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 * Boston, MA 02111-1307, USA.
26 */
27
28
29#ifndef __XDG_MIME_H__
30#define __XDG_MIME_H__
31
32#include <stdlib.h>
33#include <sys/stat.h>
34
35#ifdef __cplusplus
36extern "C" {
37#endif /* __cplusplus */
38
39#ifdef XDG_PREFIX
40#define XDG_ENTRY(func) _XDG_ENTRY2(XDG_PREFIX,func)
41#define _XDG_ENTRY2(prefix,func) _XDG_ENTRY3(prefix,func)
42#define _XDG_ENTRY3(prefix,func) prefix##_##func
43
44#define XDG_RESERVED_ENTRY(func) _XDG_RESERVED_ENTRY2(XDG_PREFIX,func)
45#define _XDG_RESERVED_ENTRY2(prefix,func) _XDG_RESERVED_ENTRY3(prefix,func)
46#define _XDG_RESERVED_ENTRY3(prefix,func) _##prefix##_##func
47#endif
48
49typedef void (*XdgMimeCallback) (void *user_data);
50typedef void (*XdgMimeDestroy) (void *user_data);
51
52
53#ifdef XDG_PREFIX
54#define xdg_mime_get_mime_type_for_data XDG_ENTRY(get_mime_type_for_data)
55#define xdg_mime_get_mime_type_for_file XDG_ENTRY(get_mime_type_for_file)
56#define xdg_mime_get_mime_type_from_file_name XDG_ENTRY(get_mime_type_from_file_name)
57#define xdg_mime_get_mime_types_from_file_name XDG_ENTRY(get_mime_types_from_file_name)
58#define xdg_mime_is_valid_mime_type XDG_ENTRY(is_valid_mime_type)
59#define xdg_mime_mime_type_equal XDG_ENTRY(mime_type_equal)
60#define xdg_mime_media_type_equal XDG_ENTRY(media_type_equal)
61#define xdg_mime_mime_type_subclass XDG_ENTRY(mime_type_subclass)
62#define xdg_mime_get_mime_parents XDG_ENTRY(get_mime_parents)
63#define xdg_mime_list_mime_parents XDG_ENTRY(list_mime_parents)
64#define xdg_mime_unalias_mime_type XDG_ENTRY(unalias_mime_type)
65#define xdg_mime_get_max_buffer_extents XDG_ENTRY(get_max_buffer_extents)
66#define xdg_mime_shutdown XDG_ENTRY(shutdown)
67#define xdg_mime_dump XDG_ENTRY(dump)
68#define xdg_mime_register_reload_callback XDG_ENTRY(register_reload_callback)
69#define xdg_mime_remove_callback XDG_ENTRY(remove_callback)
70#define xdg_mime_type_unknown XDG_ENTRY(type_unknown)
71#define xdg_mime_type_empty XDG_ENTRY(type_empty)
72#define xdg_mime_type_textplain XDG_ENTRY(type_textplain)
73#define xdg_mime_get_icon XDG_ENTRY(get_icon)
74#define xdg_mime_get_generic_icon XDG_ENTRY(get_generic_icon)
75#define xdg_mime_get_simple_globs XDG_ENTRY(get_simple_globs)
76
77#define _xdg_mime_mime_type_equal XDG_RESERVED_ENTRY(mime_type_equal)
78#define _xdg_mime_mime_type_subclass XDG_RESERVED_ENTRY(mime_type_subclass)
79#define _xdg_mime_unalias_mime_type XDG_RESERVED_ENTRY(unalias_mime_type)
80#endif
81
82extern const char xdg_mime_type_unknown[];
83extern const char xdg_mime_type_empty[];
84extern const char xdg_mime_type_textplain[];
85#define XDG_MIME_TYPE_UNKNOWN xdg_mime_type_unknown
86#define XDG_MIME_TYPE_EMPTY xdg_mime_type_empty
87#define XDG_MIME_TYPE_TEXTPLAIN xdg_mime_type_textplain
88
89const char *xdg_mime_get_mime_type_for_data (const void *data,
90 size_t len,
91 int *result_prio);
92const char *xdg_mime_get_mime_type_for_file (const char *file_name,
93 struct stat *statbuf);
94const char *xdg_mime_get_mime_type_from_file_name (const char *file_name);
95int xdg_mime_get_mime_types_from_file_name(const char *file_name,
96 const char *mime_types[],
97 int n_mime_types);
98int xdg_mime_is_valid_mime_type (const char *mime_type);
99int xdg_mime_mime_type_equal (const char *mime_a,
100 const char *mime_b);
101int xdg_mime_media_type_equal (const char *mime_a,
102 const char *mime_b);
103int xdg_mime_mime_type_subclass (const char *mime_a,
104 const char *mime_b);
105 /* xdg_mime_get_mime_parents() is deprecated since it does
106 * not work correctly with caches. Use xdg_mime_list_parents()
107 * instead, but notice that that function expects you to free
108 * the array it returns.
109 */
110const char **xdg_mime_get_mime_parents (const char *mime);
111char ** xdg_mime_list_mime_parents (const char *mime);
112const char *xdg_mime_unalias_mime_type (const char *mime);
113const char *xdg_mime_get_icon (const char *mime);
114const char *xdg_mime_get_generic_icon (const char *mime);
115int xdg_mime_get_simple_globs (const char *mime,
116 char *globs[],
117 int n_globs);
118int xdg_mime_get_max_buffer_extents (void);
119void xdg_mime_shutdown (void);
120void xdg_mime_dump (void);
121int xdg_mime_register_reload_callback (XdgMimeCallback callback,
122 void *data,
123 XdgMimeDestroy destroy);
124void xdg_mime_remove_callback (int callback_id);
125
126 /* Private versions of functions that don't call xdg_mime_init () */
127int _xdg_mime_mime_type_equal (const char *mime_a,
128 const char *mime_b);
129int _xdg_mime_mime_type_subclass (const char *mime,
130 const char *base);
131const char *_xdg_mime_unalias_mime_type (const char *mime);
132
133
134#ifdef __cplusplus
135}
136#endif /* __cplusplus */
137#endif /* __XDG_MIME_H__ */
138