mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager
synced 2024-07-22 02:35:25 +00:00
1c42375efb
The NMVpnPluginInfo is essentially the .name file, that is, a configuration file about the plugin itself. Via NMVpnPluginInfo instance, the NMVpnEditorPlugin can be created. Usually, one would create a NMVpnPluginInfo (that is, reading the .name file) and then create a NMVpnEditorPlugin instance from there. In this case, usually the editor-plugin is owned by the plugin-info instance (although the API allows for creating the editor-plugin independently). Now, pass the NMVpnPluginInfo to the editor-plugin too. This is useful, because then the editor-plugin can look at the .name file. The .name file is not user configuration. Instead it is configuration about the plugin itself. Although the .name file is part of the plugin build artefacts, it is useful to allow the plugin to access the .name file. The reason is, that this can allow the user to easily change a configuration knob of the plugin without requiring to patch or the plugin.
138 lines
5.4 KiB
C
138 lines
5.4 KiB
C
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
|
|
/*
|
|
* 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., 51 Franklin Street, Fifth Floor,
|
|
* Boston, MA 02110-1301 USA.
|
|
*
|
|
* Copyright 2015 Red Hat, Inc.
|
|
*/
|
|
|
|
#ifndef __NM_VPN_PLUGIN_INFO_H__
|
|
#define __NM_VPN_PLUGIN_INFO_H__
|
|
|
|
#include <glib.h>
|
|
#include <glib-object.h>
|
|
|
|
#include "nm-utils.h"
|
|
#include "nm-vpn-editor-plugin.h"
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define NM_TYPE_VPN_PLUGIN_INFO (nm_vpn_plugin_info_get_type ())
|
|
#define NM_VPN_PLUGIN_INFO(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_VPN_PLUGIN_INFO, NMVpnPluginInfo))
|
|
#define NM_VPN_PLUGIN_INFO_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), NM_TYPE_VPN_PLUGIN_INFO, NMVpnPluginInfoClass))
|
|
#define NM_IS_VPN_PLUGIN_INFO(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_VPN_PLUGIN_INFO))
|
|
#define NM_IS_VPN_PLUGIN_INFO_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_VPN_PLUGIN_INFO))
|
|
#define NM_VPN_PLUGIN_INFO_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_VPN_PLUGIN_INFO, NMVpnPluginInfoClass))
|
|
|
|
#define NM_VPN_PLUGIN_INFO_NAME "name"
|
|
#define NM_VPN_PLUGIN_INFO_FILENAME "filename"
|
|
#define NM_VPN_PLUGIN_INFO_KEYFILE "keyfile"
|
|
|
|
#define NM_VPN_PLUGIN_INFO_KF_GROUP_CONNECTION "VPN Connection"
|
|
#define NM_VPN_PLUGIN_INFO_KF_GROUP_LIBNM "libnm"
|
|
#define NM_VPN_PLUGIN_INFO_KF_GROUP_GNOME "GNOME"
|
|
|
|
struct _NMVpnPluginInfo;
|
|
|
|
/**
|
|
* NMVpnPluginInfo:
|
|
*/
|
|
typedef struct _NMVpnPluginInfo {
|
|
NM_AVAILABLE_IN_1_2
|
|
GObject parent;
|
|
} NMVpnPluginInfo;
|
|
|
|
typedef struct {
|
|
NM_AVAILABLE_IN_1_2
|
|
GObjectClass parent;
|
|
|
|
/*< private >*/
|
|
NM_AVAILABLE_IN_1_2
|
|
gpointer padding[8];
|
|
} NMVpnPluginInfoClass NM_AVAILABLE_IN_1_2;
|
|
|
|
NM_AVAILABLE_IN_1_2
|
|
GType nm_vpn_plugin_info_get_type (void);
|
|
|
|
NM_AVAILABLE_IN_1_2
|
|
NMVpnPluginInfo *nm_vpn_plugin_info_new_from_file (const char *filename,
|
|
GError **error);
|
|
|
|
NM_AVAILABLE_IN_1_2
|
|
NMVpnPluginInfo *nm_vpn_plugin_info_new_with_data (const char *filename,
|
|
GKeyFile *keyfile,
|
|
GError **error);
|
|
|
|
NM_AVAILABLE_IN_1_4
|
|
NMVpnPluginInfo *nm_vpn_plugin_info_new_search_file (const char *name,
|
|
const char *service);
|
|
|
|
NM_AVAILABLE_IN_1_2
|
|
const char *nm_vpn_plugin_info_get_name (NMVpnPluginInfo *self);
|
|
NM_AVAILABLE_IN_1_2
|
|
const char *nm_vpn_plugin_info_get_filename (NMVpnPluginInfo *self);
|
|
NM_AVAILABLE_IN_1_4
|
|
const char *nm_vpn_plugin_info_get_service (NMVpnPluginInfo *self);
|
|
NM_AVAILABLE_IN_1_2
|
|
const char *nm_vpn_plugin_info_get_plugin (NMVpnPluginInfo *self);
|
|
NM_AVAILABLE_IN_1_2
|
|
const char *nm_vpn_plugin_info_get_program (NMVpnPluginInfo *self);
|
|
NM_AVAILABLE_IN_1_4
|
|
const char *nm_vpn_plugin_info_get_auth_dialog (NMVpnPluginInfo *self);
|
|
NM_AVAILABLE_IN_1_4
|
|
gboolean nm_vpn_plugin_info_supports_hints (NMVpnPluginInfo *self);
|
|
NM_AVAILABLE_IN_1_2
|
|
gboolean nm_vpn_plugin_info_supports_multiple (NMVpnPluginInfo *self);
|
|
NM_AVAILABLE_IN_1_4
|
|
const char *const*nm_vpn_plugin_info_get_aliases (NMVpnPluginInfo *self);
|
|
NM_AVAILABLE_IN_1_2
|
|
const char *nm_vpn_plugin_info_lookup_property (NMVpnPluginInfo *self, const char *group, const char *key);
|
|
|
|
NM_AVAILABLE_IN_1_2
|
|
gboolean nm_vpn_plugin_info_validate_filename (const char *filename);
|
|
|
|
NM_AVAILABLE_IN_1_2
|
|
GSList *nm_vpn_plugin_info_list_load (void);
|
|
NM_AVAILABLE_IN_1_2
|
|
gboolean nm_vpn_plugin_info_list_add (GSList **list, NMVpnPluginInfo *plugin_info, GError **error);
|
|
NM_AVAILABLE_IN_1_2
|
|
gboolean nm_vpn_plugin_info_list_remove (GSList **list, NMVpnPluginInfo *plugin_info);
|
|
NM_AVAILABLE_IN_1_2
|
|
NMVpnPluginInfo *nm_vpn_plugin_info_list_find_by_name (GSList *list, const char *name);
|
|
NM_AVAILABLE_IN_1_2
|
|
NMVpnPluginInfo *nm_vpn_plugin_info_list_find_by_filename (GSList *list, const char *filename);
|
|
NM_AVAILABLE_IN_1_2
|
|
NMVpnPluginInfo *nm_vpn_plugin_info_list_find_by_service (GSList *list, const char *service);
|
|
|
|
NM_AVAILABLE_IN_1_4
|
|
char *nm_vpn_plugin_info_list_find_service_type (GSList *list, const char *name);
|
|
NM_AVAILABLE_IN_1_4
|
|
char **nm_vpn_plugin_info_list_get_service_types (GSList *list,
|
|
gboolean only_existing,
|
|
gboolean with_abbreviations);
|
|
|
|
NM_AVAILABLE_IN_1_2
|
|
NMVpnEditorPlugin *nm_vpn_plugin_info_get_editor_plugin (NMVpnPluginInfo *self);
|
|
NM_AVAILABLE_IN_1_2
|
|
void nm_vpn_plugin_info_set_editor_plugin (NMVpnPluginInfo *self,
|
|
NMVpnEditorPlugin *plugin);
|
|
NM_AVAILABLE_IN_1_2
|
|
NMVpnEditorPlugin *nm_vpn_plugin_info_load_editor_plugin (NMVpnPluginInfo *self,
|
|
GError **error);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __NM_VPN_PLUGIN_INFO_H__ */
|