girepository/gifunctioninfo.h

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
   2  * GObject introspection: Function
   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 __GIFUNCTIONINFO_H__
  24 #define __GIFUNCTIONINFO_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_FUNCTION_INFO(info) \
  35     (g_base_info_get_type((GIBaseInfo*)info) ==  GI_INFO_TYPE_FUNCTION)
  36
  37 const gchar *           g_function_info_get_symbol     (GIFunctionInfo *info);
  38 GIFunctionInfoFlags     g_function_info_get_flags      (GIFunctionInfo *info);
  39 GIPropertyInfo *        g_function_info_get_property   (GIFunctionInfo *info);
  40 GIVFuncInfo *           g_function_info_get_vfunc      (GIFunctionInfo *info);
  41
  42 #define G_INVOKE_ERROR (g_invoke_error_quark ())
  43 GQuark g_invoke_error_quark (void);
  44
  45 /**
  46  * GInvokeError:
  47  * @G_INVOKE_ERROR_FAILED: invokation failed, unknown error.
  48  * @G_INVOKE_ERROR_SYMBOL_NOT_FOUND: symbol couldn't be found in any of the
  49  * libraries associated with the typelib of the function.
  50  * @G_INVOKE_ERROR_ARGUMENT_MISMATCH: the arguments provided didn't match
  51  * the expected arguments for the functions type signature.
  52  *
  53  * An error occuring while invoking a function via
  54  * g_function_info_invoke().
  55  */
  56
  57 typedef enum
  58 {
  59   G_INVOKE_ERROR_FAILED,
  60   G_INVOKE_ERROR_SYMBOL_NOT_FOUND,
  61   G_INVOKE_ERROR_ARGUMENT_MISMATCH
  62 } GInvokeError;
  63
  64 gboolean              g_function_info_invoke         (GIFunctionInfo *info,
  65                                                       const GIArgument  *in_args,
  66                                                       int               n_in_args,
  67                                                       const GIArgument  *out_args,
  68                                                       int               n_out_args,
  69                                                       GIArgument        *return_value,
  70                                                       GError          **error);
  71
  72
  73 G_END_DECLS
  74
  75
  76 #endif  /* __GIFUNCTIONINFO_H__ */
  77