[libxdgmime-perl.git] / src / xdgmime.h

/* -*- mode: C; c-file-style: "gnu" -*- */
/* xdgmime.h: XDG Mime Spec mime resolver.  Based on version 0.11 of the spec.
 *
 * More info can be found at http://www.freedesktop.org/standards/
 * 
 * Copyright (C) 2003  Red Hat, Inc.
 * Copyright (C) 2003  Jonathan Blandford <jrb@alum.mit.edu>
 *
 * Licensed under the Academic Free License version 2.0
 * Or under the following terms:
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */


#ifndef __XDG_MIME_H__
#define __XDG_MIME_H__

#include <stdlib.h>
#include <sys/stat.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#ifdef XDG_PREFIX
#define XDG_ENTRY(func) _XDG_ENTRY2(XDG_PREFIX,func)
#define _XDG_ENTRY2(prefix,func) _XDG_ENTRY3(prefix,func)
#define _XDG_ENTRY3(prefix,func) prefix##_##func

#define XDG_RESERVED_ENTRY(func) _XDG_RESERVED_ENTRY2(XDG_PREFIX,func)
#define _XDG_RESERVED_ENTRY2(prefix,func) _XDG_RESERVED_ENTRY3(prefix,func)
#define _XDG_RESERVED_ENTRY3(prefix,func) _##prefix##_##func
#endif

typedef void (*XdgMimeCallback) (void *user_data);
typedef void (*XdgMimeDestroy)  (void *user_data);

  
#ifdef XDG_PREFIX
#define xdg_mime_get_mime_type_for_data       XDG_ENTRY(get_mime_type_for_data)
#define xdg_mime_get_mime_type_for_file       XDG_ENTRY(get_mime_type_for_file)
#define xdg_mime_get_mime_type_from_file_name XDG_ENTRY(get_mime_type_from_file_name)
#define xdg_mime_get_mime_types_from_file_name XDG_ENTRY(get_mime_types_from_file_name)
#define xdg_mime_is_valid_mime_type           XDG_ENTRY(is_valid_mime_type)
#define xdg_mime_mime_type_equal              XDG_ENTRY(mime_type_equal)
#define xdg_mime_media_type_equal             XDG_ENTRY(media_type_equal)
#define xdg_mime_mime_type_subclass           XDG_ENTRY(mime_type_subclass)
#define xdg_mime_get_mime_parents             XDG_ENTRY(get_mime_parents)
#define xdg_mime_list_mime_parents            XDG_ENTRY(list_mime_parents)
#define xdg_mime_unalias_mime_type            XDG_ENTRY(unalias_mime_type)
#define xdg_mime_get_max_buffer_extents       XDG_ENTRY(get_max_buffer_extents)
#define xdg_mime_shutdown                     XDG_ENTRY(shutdown)
#define xdg_mime_dump                         XDG_ENTRY(dump)
#define xdg_mime_register_reload_callback     XDG_ENTRY(register_reload_callback)
#define xdg_mime_remove_callback              XDG_ENTRY(remove_callback)
#define xdg_mime_type_unknown                 XDG_ENTRY(type_unknown)
#define xdg_mime_type_empty                   XDG_ENTRY(type_empty)
#define xdg_mime_type_textplain               XDG_ENTRY(type_textplain)
#define xdg_mime_get_icon                     XDG_ENTRY(get_icon)
#define xdg_mime_get_generic_icon             XDG_ENTRY(get_generic_icon)

#define _xdg_mime_mime_type_equal             XDG_RESERVED_ENTRY(mime_type_equal)
#define _xdg_mime_mime_type_subclass          XDG_RESERVED_ENTRY(mime_type_subclass)
#define _xdg_mime_unalias_mime_type           XDG_RESERVED_ENTRY(unalias_mime_type)  
#endif

extern const char xdg_mime_type_unknown[];
extern const char xdg_mime_type_empty[];
extern const char xdg_mime_type_textplain[];
#define XDG_MIME_TYPE_UNKNOWN xdg_mime_type_unknown
#define XDG_MIME_TYPE_EMPTY xdg_mime_type_empty
#define XDG_MIME_TYPE_TEXTPLAIN xdg_mime_type_textplain

const char  *xdg_mime_get_mime_type_for_data       (const void *data,
						    size_t      len,
						    int        *result_prio);
const char  *xdg_mime_get_mime_type_for_file       (const char *file_name,
                                                    struct stat *statbuf);
const char  *xdg_mime_get_mime_type_from_file_name (const char *file_name);
int          xdg_mime_get_mime_types_from_file_name(const char *file_name,
						    const char *mime_types[],
						    int         n_mime_types);
int          xdg_mime_is_valid_mime_type           (const char *mime_type);
int          xdg_mime_mime_type_equal              (const char *mime_a,
						    const char *mime_b);
int          xdg_mime_media_type_equal             (const char *mime_a,
						    const char *mime_b);
int          xdg_mime_mime_type_subclass           (const char *mime_a,
						    const char *mime_b);
  /* xdg_mime_get_mime_parents() is deprecated since it does
   * not work correctly with caches. Use xdg_mime_list_parents() 
   * instead, but notice that that function expects you to free
   * the array it returns. 
   */
const char **xdg_mime_get_mime_parents		   (const char *mime);
char **      xdg_mime_list_mime_parents		   (const char *mime);
const char  *xdg_mime_unalias_mime_type		   (const char *mime);
const char  *xdg_mime_get_icon                     (const char *mime);
const char  *xdg_mime_get_generic_icon             (const char *mime);
int          xdg_mime_get_max_buffer_extents       (void);
void         xdg_mime_shutdown                     (void);
void         xdg_mime_dump                         (void);
int          xdg_mime_register_reload_callback     (XdgMimeCallback  callback,
						    void            *data,
						    XdgMimeDestroy   destroy);
void         xdg_mime_remove_callback              (int              callback_id);

   /* Private versions of functions that don't call xdg_mime_init () */
int          _xdg_mime_mime_type_equal             (const char *mime_a,
						    const char *mime_b);
int          _xdg_mime_mime_type_subclass          (const char *mime,
						    const char *base);
const char  *_xdg_mime_unalias_mime_type           (const char *mime);


#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* __XDG_MIME_H__ */
Commit	Line	Data
cf31d981 SI	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
	36	extern "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
	49	typedef void (XdgMimeCallback) (void user_data);
	50	typedef 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
76	#define _xdg_mime_mime_type_equal XDG_RESERVED_ENTRY(mime_type_equal)
77	#define _xdg_mime_mime_type_subclass XDG_RESERVED_ENTRY(mime_type_subclass)
78	#define _xdg_mime_unalias_mime_type XDG_RESERVED_ENTRY(unalias_mime_type)
79	#endif
80
81	extern const char xdg_mime_type_unknown[];
82	extern const char xdg_mime_type_empty[];
83	extern const char xdg_mime_type_textplain[];
84	#define XDG_MIME_TYPE_UNKNOWN xdg_mime_type_unknown
85	#define XDG_MIME_TYPE_EMPTY xdg_mime_type_empty
86	#define XDG_MIME_TYPE_TEXTPLAIN xdg_mime_type_textplain
87
88	const char xdg_mime_get_mime_type_for_data (const void data,
89	size_t len,
90	int *result_prio);
91	const char xdg_mime_get_mime_type_for_file (const char file_name,
92	struct stat *statbuf);
93	const char xdg_mime_get_mime_type_from_file_name (const char file_name);
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	int xdg_mime_is_valid_mime_type (const char *mime_type);
98	int xdg_mime_mime_type_equal (const char *mime_a,
99	const char *mime_b);
100	int xdg_mime_media_type_equal (const char *mime_a,
101	const char *mime_b);
102	int xdg_mime_mime_type_subclass (const char *mime_a,
103	const char *mime_b);
104	/* xdg_mime_get_mime_parents() is deprecated since it does
105	* not work correctly with caches. Use xdg_mime_list_parents()
106	* instead, but notice that that function expects you to free
107	* the array it returns.
108	*/
109	const char *xdg_mime_get_mime_parents (const char mime);
110	char ** xdg_mime_list_mime_parents (const char *mime);
111	const char xdg_mime_unalias_mime_type (const char mime);
112	const char xdg_mime_get_icon (const char mime);
113	const char xdg_mime_get_generic_icon (const char mime);
114	int xdg_mime_get_max_buffer_extents (void);
115	void xdg_mime_shutdown (void);
116	void xdg_mime_dump (void);
117	int xdg_mime_register_reload_callback (XdgMimeCallback callback,
118	void *data,
119	XdgMimeDestroy destroy);
120	void xdg_mime_remove_callback (int callback_id);
121
122	/* Private versions of functions that don't call xdg_mime_init () */
123	int _xdg_mime_mime_type_equal (const char *mime_a,
124	const char *mime_b);
125	int _xdg_mime_mime_type_subclass (const char *mime,
126	const char *base);
127	const char _xdg_mime_unalias_mime_type (const char mime);
128
129
130	#ifdef __cplusplus
131	}
132	#endif /* __cplusplus */
133	#endif /* __XDG_MIME_H__ */