summaryrefslogtreecommitdiff
path: root/libpeas/peas-engine.h
blob: 58946c335e304513ad30e33fe4f969604d163b07 (plain)
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
113
114
115
116
/*
 * peas-engine.h
 * This file is part of libpeas
 *
 * Copyright (C) 2002-2005 - Paolo Maggi
 *
 * libpeas 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.1 of the License, or (at your option) any later version.
 *
 * libpeas 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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA.
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 */

#pragma once

#if !defined (LIBPEAS_INSIDE) && !defined (LIBPEAS_COMPILATION)
# error "Only <libpeas.h> can be included directly."
#endif

#include <glib-object.h>

#include "peas-plugin-info.h"
#include "peas-extension.h"
#include "peas-version-macros.h"

G_BEGIN_DECLS

#define PEAS_TYPE_ENGINE (peas_engine_get_type ())

PEAS_AVAILABLE_IN_ALL
G_DECLARE_FINAL_TYPE (PeasEngine, peas_engine, PEAS, ENGINE, GObject)

PEAS_AVAILABLE_IN_ALL
PeasEngine       *peas_engine_new                 (void);
PEAS_AVAILABLE_IN_ALL
PeasEngine       *peas_engine_new_with_nonglobal_loaders
                                                  (void);
PEAS_AVAILABLE_IN_ALL
PeasEngine       *peas_engine_get_default         (void);

PEAS_AVAILABLE_IN_ALL
void              peas_engine_add_search_path     (PeasEngine      *engine,
                                                   const gchar     *module_dir,
                                                   const gchar     *data_dir);
PEAS_AVAILABLE_IN_ALL
void              peas_engine_prepend_search_path (PeasEngine      *engine,
                                                   const gchar     *module_dir,
                                                   const gchar     *data_dir);

/* plugin management */
PEAS_AVAILABLE_IN_ALL
void              peas_engine_enable_loader       (PeasEngine      *engine,
                                                   const gchar     *loader_name);
PEAS_AVAILABLE_IN_ALL
void              peas_engine_rescan_plugins      (PeasEngine      *engine);
PEAS_AVAILABLE_IN_ALL
const GList      *peas_engine_get_plugin_list     (PeasEngine      *engine);
PEAS_AVAILABLE_IN_ALL
gchar           **peas_engine_get_loaded_plugins  (PeasEngine      *engine);
PEAS_AVAILABLE_IN_ALL
void              peas_engine_set_loaded_plugins  (PeasEngine      *engine,
                                                   const gchar    **plugin_names);
PEAS_AVAILABLE_IN_ALL
PeasPluginInfo   *peas_engine_get_plugin_info     (PeasEngine      *engine,
                                                   const gchar     *plugin_name);

/* plugin loading and unloading */
PEAS_AVAILABLE_IN_ALL
gboolean          peas_engine_load_plugin         (PeasEngine      *engine,
                                                   PeasPluginInfo  *info);
PEAS_AVAILABLE_IN_ALL
gboolean          peas_engine_unload_plugin       (PeasEngine      *engine,
                                                   PeasPluginInfo  *info);
PEAS_AVAILABLE_IN_ALL
void              peas_engine_garbage_collect     (PeasEngine      *engine);

PEAS_AVAILABLE_IN_ALL
gboolean          peas_engine_provides_extension  (PeasEngine      *engine,
                                                   PeasPluginInfo  *info,
                                                   GType            extension_type);

PEAS_AVAILABLE_IN_ALL
PeasExtension    *peas_engine_create_extension_with_properties
                                                  (PeasEngine     *engine,
                                                   PeasPluginInfo *info,
                                                   GType           extension_type,
                                                   guint           n_properties,
                                                   const gchar   **prop_names,
                                                   const GValue   *prop_values);

PEAS_AVAILABLE_IN_ALL
PeasExtension    *peas_engine_create_extension_valist
                                                  (PeasEngine      *engine,
                                                   PeasPluginInfo  *info,
                                                   GType            extension_type,
                                                   const gchar     *first_property,
                                                   va_list          var_args);
PEAS_AVAILABLE_IN_ALL
PeasExtension    *peas_engine_create_extension    (PeasEngine      *engine,
                                                   PeasPluginInfo  *info,
                                                   GType            extension_type,
                                                   const gchar     *first_property,
                                                   ...);


G_END_DECLS