1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* xdgmime.h: XDG Mime Spec mime resolver. Based on version 0.11 of the spec.
4 * More info can be found at http://www.freedesktop.org/standards/
6 * Copyright (C) 2003 Red Hat, Inc.
7 * Copyright (C) 2003 Jonathan Blandford <jrb@alum.mit.edu>
9 * Licensed under the Academic Free License version 2.0
10 * Or under the following terms:
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.
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.
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.
29 #ifndef __XDG_MIME_H__
30 #define __XDG_MIME_H__
37 #endif /* __cplusplus */
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
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
49 typedef void (*XdgMimeCallback) (void *user_data);
50 typedef void (*XdgMimeDestroy) (void *user_data);
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_get_icon XDG_ENTRY(get_icon)
72 #define xdg_mime_get_generic_icon XDG_ENTRY(get_generic_icon)
74 #define _xdg_mime_mime_type_equal XDG_RESERVED_ENTRY(mime_type_equal)
75 #define _xdg_mime_mime_type_subclass XDG_RESERVED_ENTRY(mime_type_subclass)
76 #define _xdg_mime_unalias_mime_type XDG_RESERVED_ENTRY(unalias_mime_type)
79 extern const char xdg_mime_type_unknown[];
80 #define XDG_MIME_TYPE_UNKNOWN xdg_mime_type_unknown
82 const char *xdg_mime_get_mime_type_for_data (const void *data,
85 const char *xdg_mime_get_mime_type_for_file (const char *file_name,
86 struct stat *statbuf);
87 const char *xdg_mime_get_mime_type_from_file_name (const char *file_name);
88 int xdg_mime_get_mime_types_from_file_name(const char *file_name,
89 const char *mime_types[],
91 int xdg_mime_is_valid_mime_type (const char *mime_type);
92 int xdg_mime_mime_type_equal (const char *mime_a,
94 int xdg_mime_media_type_equal (const char *mime_a,
96 int xdg_mime_mime_type_subclass (const char *mime_a,
98 /* xdg_mime_get_mime_parents() is deprecated since it does
99 * not work correctly with caches. Use xdg_mime_list_parents()
100 * instead, but notice that that function expects you to free
101 * the array it returns.
103 const char **xdg_mime_get_mime_parents (const char *mime);
104 char ** xdg_mime_list_mime_parents (const char *mime);
105 const char *xdg_mime_unalias_mime_type (const char *mime);
106 const char *xdg_mime_get_icon (const char *mime);
107 const char *xdg_mime_get_generic_icon (const char *mime);
108 int xdg_mime_get_max_buffer_extents (void);
109 void xdg_mime_shutdown (void);
110 void xdg_mime_dump (void);
111 int xdg_mime_register_reload_callback (XdgMimeCallback callback,
113 XdgMimeDestroy destroy);
114 void xdg_mime_remove_callback (int callback_id);
116 /* Private versions of functions that don't call xdg_mime_init () */
117 int _xdg_mime_mime_type_equal (const char *mime_a,
119 int _xdg_mime_mime_type_subclass (const char *mime,
121 const char *_xdg_mime_unalias_mime_type (const char *mime);
126 #endif /* __cplusplus */
127 #endif /* __XDG_MIME_H__ */