Branch and submit for IVI panda
[profile/ivi/gobject-introspection.git] / girepository / gicallableinfo.h
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
2  * GObject introspection: Callable
3  *
4  * Copyright (C) 2005 Matthias Clasen
5  * Copyright (C) 2008,2009 Red Hat, Inc.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22
23 #ifndef __GICALLABLEINFO_H__
24 #define __GICALLABLEINFO_H__
25
26 #if !defined (__GIREPOSITORY_H_INSIDE__) && !defined (GI_COMPILATION)
27 #error "Only <girepository.h> can be included directly."
28 #endif
29
30 #include <gitypes.h>
31
32 G_BEGIN_DECLS
33
34 #define GI_IS_CALLABLE_INFO(info)                                       \
35     ((g_base_info_get_type((GIBaseInfo*)info) == GI_INFO_TYPE_FUNCTION) || \
36      (g_base_info_get_type((GIBaseInfo*)info) == GI_INFO_TYPE_CALLBACK) || \
37      (g_base_info_get_type((GIBaseInfo*)info) == GI_INFO_TYPE_SIGNAL) || \
38      (g_base_info_get_type((GIBaseInfo*)info) == GI_INFO_TYPE_VFUNC))
39
40 GITypeInfo *           g_callable_info_get_return_type (GICallableInfo *info);
41 void                   g_callable_info_load_return_type (GICallableInfo *info,
42                                                          GITypeInfo     *type);
43 const gchar *          g_callable_info_get_return_attribute (GICallableInfo *info,
44                                                              const gchar    *name);
45 gboolean               g_callable_info_iterate_return_attributes (GICallableInfo  *info,
46                                                                   GIAttributeIter *iterator,
47                                                                   char           **name,
48                                                                   char          **value);
49 GITransfer             g_callable_info_get_caller_owns (GICallableInfo *info);
50 gboolean               g_callable_info_may_return_null (GICallableInfo *info);
51 gboolean               g_callable_info_skip_return     (GICallableInfo *info);
52 gint                   g_callable_info_get_n_args      (GICallableInfo *info);
53 GIArgInfo *            g_callable_info_get_arg         (GICallableInfo *info,
54                                                         gint            n);
55 void                   g_callable_info_load_arg        (GICallableInfo *info,
56                                                         gint            n,
57                                                         GIArgInfo      *arg);
58 gboolean               g_callable_info_invoke          (GICallableInfo   *info,
59                                                         gpointer          function,
60                                                         const GIArgument *in_args,
61                                                         int               n_in_args,
62                                                         const GIArgument *out_args,
63                                                         int               n_out_args,
64                                                         GIArgument       *return_value,
65                                                         gboolean          is_method,
66                                                         gboolean          throws,
67                                                         GError          **error);
68 G_END_DECLS
69
70
71 #endif  /* __GICALLABLEINFO_H__ */
72