Merge branch 'test-ip_mreq_source-android-only' into 'master'
[glib.git] / gio / xdgmime / xdgmime.h
blobcd20c77a913c2014cab43358f1f8501bed369c1b
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/
5 *
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.1 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, see <http://www.gnu.org/licenses/>.
27 #ifndef __XDG_MIME_H__
28 #define __XDG_MIME_H__
30 #include <stdlib.h>
31 #include <sys/stat.h>
33 #ifdef __cplusplus
34 extern "C" {
35 #endif /* __cplusplus */
37 #ifdef XDG_PREFIX
38 #define XDG_ENTRY(func) _XDG_ENTRY2(XDG_PREFIX,func)
39 #define _XDG_ENTRY2(prefix,func) _XDG_ENTRY3(prefix,func)
40 #define _XDG_ENTRY3(prefix,func) prefix##_##func
42 #define XDG_RESERVED_ENTRY(func) _XDG_RESERVED_ENTRY2(XDG_PREFIX,func)
43 #define _XDG_RESERVED_ENTRY2(prefix,func) _XDG_RESERVED_ENTRY3(prefix,func)
44 #define _XDG_RESERVED_ENTRY3(prefix,func) _##prefix##_##func
45 #endif
47 typedef void (*XdgMimeCallback) (void *user_data);
48 typedef void (*XdgMimeDestroy) (void *user_data);
51 #ifdef XDG_PREFIX
52 #define xdg_mime_get_mime_type_for_data XDG_ENTRY(get_mime_type_for_data)
53 #define xdg_mime_get_mime_type_for_file XDG_ENTRY(get_mime_type_for_file)
54 #define xdg_mime_get_mime_type_from_file_name XDG_ENTRY(get_mime_type_from_file_name)
55 #define xdg_mime_get_mime_types_from_file_name XDG_ENTRY(get_mime_types_from_file_name)
56 #define xdg_mime_is_valid_mime_type XDG_ENTRY(is_valid_mime_type)
57 #define xdg_mime_mime_type_equal XDG_ENTRY(mime_type_equal)
58 #define xdg_mime_media_type_equal XDG_ENTRY(media_type_equal)
59 #define xdg_mime_mime_type_subclass XDG_ENTRY(mime_type_subclass)
60 #define xdg_mime_get_mime_parents XDG_ENTRY(get_mime_parents)
61 #define xdg_mime_list_mime_parents XDG_ENTRY(list_mime_parents)
62 #define xdg_mime_unalias_mime_type XDG_ENTRY(unalias_mime_type)
63 #define xdg_mime_get_max_buffer_extents XDG_ENTRY(get_max_buffer_extents)
64 #define xdg_mime_shutdown XDG_ENTRY(shutdown)
65 #define xdg_mime_dump XDG_ENTRY(dump)
66 #define xdg_mime_register_reload_callback XDG_ENTRY(register_reload_callback)
67 #define xdg_mime_remove_callback XDG_ENTRY(remove_callback)
68 #define xdg_mime_type_unknown XDG_ENTRY(type_unknown)
69 #define xdg_mime_type_empty XDG_ENTRY(type_empty)
70 #define xdg_mime_type_textplain XDG_ENTRY(type_textplain)
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_subclass XDG_RESERVED_ENTRY(mime_type_subclass)
75 #define _xdg_mime_mime_type_equal XDG_RESERVED_ENTRY(mime_type_equal)
76 #define _xdg_mime_unalias_mime_type XDG_RESERVED_ENTRY(unalias_mime_type)
77 #endif
79 extern const char xdg_mime_type_unknown[];
80 extern const char xdg_mime_type_empty[];
81 extern const char xdg_mime_type_textplain[];
82 #define XDG_MIME_TYPE_UNKNOWN xdg_mime_type_unknown
83 #define XDG_MIME_TYPE_EMPTY xdg_mime_type_empty
84 #define XDG_MIME_TYPE_TEXTPLAIN xdg_mime_type_textplain
86 const char *xdg_mime_get_mime_type_for_data (const void *data,
87 size_t len,
88 int *result_prio);
89 #ifdef NOT_USED_IN_GIO
90 const char *xdg_mime_get_mime_type_for_file (const char *file_name,
91 struct stat *statbuf);
92 const char *xdg_mime_get_mime_type_from_file_name (const char *file_name);
93 #endif
94 int xdg_mime_get_mime_types_from_file_name(const char *file_name,
95 const char *mime_types[],
96 int n_mime_types);
97 #ifdef NOT_USED_IN_GIO
98 int xdg_mime_is_valid_mime_type (const char *mime_type);
99 #endif
100 int xdg_mime_mime_type_equal (const char *mime_a,
101 const char *mime_b);
102 int xdg_mime_media_type_equal (const char *mime_a,
103 const char *mime_b);
104 int xdg_mime_mime_type_subclass (const char *mime_a,
105 const char *mime_b);
106 /* xdg_mime_get_mime_parents() is deprecated since it does
107 * not work correctly with caches. Use xdg_mime_list_parents()
108 * instead, but notice that that function expects you to free
109 * the array it returns.
111 #ifdef NOT_USED_IN_GIO
112 const char **xdg_mime_get_mime_parents (const char *mime);
113 #endif
114 char ** xdg_mime_list_mime_parents (const char *mime);
115 const char *xdg_mime_unalias_mime_type (const char *mime);
116 const char *xdg_mime_get_icon (const char *mime);
117 const char *xdg_mime_get_generic_icon (const char *mime);
118 int xdg_mime_get_max_buffer_extents (void);
119 void xdg_mime_shutdown (void);
120 #ifdef NOT_USED_IN_GIO
121 void xdg_mime_dump (void);
122 #endif
123 int xdg_mime_register_reload_callback (XdgMimeCallback callback,
124 void *data,
125 XdgMimeDestroy destroy);
126 #ifdef NOT_USED_IN_GIO
127 void xdg_mime_remove_callback (int callback_id);
128 #endif
130 /* Private versions of functions that don't call xdg_mime_init () */
131 int _xdg_mime_mime_type_equal (const char *mime_a,
132 const char *mime_b);
133 int _xdg_mime_mime_type_subclass (const char *mime,
134 const char *base);
135 const char *_xdg_mime_unalias_mime_type (const char *mime);
138 #ifdef __cplusplus
140 #endif /* __cplusplus */
141 #endif /* __XDG_MIME_H__ */