File: gwymoduleloader.h

package info (click to toggle)
gwyddion 2.52-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 46,588 kB
  • sloc: ansic: 367,740; python: 7,788; sh: 5,245; makefile: 4,317; xml: 3,631; cpp: 2,550; pascal: 418; perl: 154; ruby: 130
file content (112 lines) | stat: -rw-r--r-- 3,887 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/*
 *  $Id: gwymoduleloader.h 20678 2017-12-18 18:26:55Z yeti-dn $
 *  Copyright (C) 2003,2004,2017 David Necas (Yeti), Petr Klapetek.
 *  E-mail: yeti@gwyddion.net, klapetek@gwyddion.net.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301, USA.
 */

#ifndef __GWY_MODULE_LOADER_H__
#define __GWY_MODULE_LOADER_H__

#include <gmodule.h>

G_BEGIN_DECLS

#define GWY_MODULE_ABI_VERSION 2
#define GWY_MODULE_BUNDLE_FLAG 256u

#ifdef  __cplusplus
#define __GWY_MODULE_QUERY_EXTERN_C extern "C"
#else
#define __GWY_MODULE_QUERY_EXTERN_C /* */
#endif

#define GWY_MODULE_QUERY(mod_info) \
    __GWY_MODULE_QUERY_EXTERN_C G_MODULE_EXPORT GwyModuleInfo* \
    _gwy_module_query(void) { return &mod_info; }

#ifdef GWY_MODULE_BUNDLING
#define GWY_MODULE_QUERY2(mod_info,mod_name) \
    __GWY_MODULE_QUERY_EXTERN_C G_GNUC_INTERNAL GwyModuleInfo* \
    _gwy_module_query__##mod_name(void) { return &mod_info; }
#else
#define GWY_MODULE_QUERY2(mod_info,mod_name) GWY_MODULE_QUERY(mod_info)
#endif

#define GWY_MODULE_ERROR gwy_module_error_quark()

typedef enum {
    GWY_MODULE_ERROR_NAME,
    GWY_MODULE_ERROR_DUPLICATE,
    GWY_MODULE_ERROR_OPEN,
    GWY_MODULE_ERROR_QUERY,
    GWY_MODULE_ERROR_ABI,
    GWY_MODULE_ERROR_INFO,
    GWY_MODULE_ERROR_REGISTER,
    GWY_MODULE_ERROR_NESTING
} GwyModuleError;

typedef struct _GwyModuleInfo GwyModuleInfo;
typedef struct _GwyModuleRecord GwyModuleRecord;

typedef gboolean               (*GwyModuleRegisterFunc)       (void);
typedef GwyModuleInfo*         (*GwyModuleQueryFunc)          (void);
typedef const GwyModuleRecord* (*GwyModuleBundleRegisterFunc) (void);

struct _GwyModuleRecord {
    GwyModuleQueryFunc query;
    const gchar *name;
};

struct _GwyModuleInfo {
    guint32 abi_version;
    GwyModuleRegisterFunc register_func;
    const gchar *blurb;
    const gchar *author;
    const gchar *version;
    const gchar *copyright;
    const gchar *date;
};

typedef struct {
    const gchar *filename;
    const gchar *modname;
    const gchar *err_message;
    gint err_domain;
    gint err_code;
} GwyModuleFailureInfo;

GQuark               gwy_module_error_quark         (void);
void                 gwy_module_register_modules    (const gchar **paths);
const GwyModuleInfo* gwy_module_lookup              (const gchar *name);
const gchar*         gwy_module_get_filename        (const gchar *name);
GSList*              gwy_module_get_functions       (const gchar *name);
void                 gwy_module_foreach             (GHFunc function,
                                                     gpointer data);
void                 gwy_module_failure_foreach     (GFunc function,
                                                     gpointer data);
const GwyModuleInfo* gwy_module_register_module     (const gchar *name,
                                                     GError **error);
void                 gwy_module_disable_registration(const gchar *name);
void                 gwy_module_enable_registration (const gchar *name);
gboolean             gwy_module_is_enabled          (const gchar *name);

G_END_DECLS

#endif /* __GWY_MODULE_LOADER_H__ */

/* vim: set cin et ts=4 sw=4 cino=>1s,e0,n0,f0,{0,}0,^0,\:1s,=0,g1s,h0,t0,+1s,c3,(0,u0 : */