libnm: move NMVpnEditorPlugin to libnm-core/

Split the content of libnm/nm-vpn-editor-plugin.h and
move NMVpnEditorPlugin to libnm-core/nm-vpn-editor-plugin.h.

VPN plugins allow us to extend functionality about VPNs.
This can be also useful for NetworkManager core, hence
move that part to libnm-core.

The name NMVpnEditorPlugin is slightly misleading but not completely
wrong. The "editor" part stands no longer for bringing nm-applet
functionality (alone), but enable general VPN functionality in
the client.

Especially because we already have NMVpnPluginOld with a different
meaning (i.e. a base class of the plugin server implementation).
This commit is contained in:
Thomas Haller 2015-05-25 13:55:37 +02:00
parent d6226bd987
commit bce040daa2
7 changed files with 166 additions and 98 deletions

View file

@ -43,6 +43,7 @@ libnm_core_headers = \
$(core)/nm-simple-connection.h \
$(core)/nm-utils.h \
$(core)/nm-vpn-dbus-interface.h \
$(core)/nm-vpn-editor-plugin.h \
$(core)/nm-vpn-plugin-info.h
libnm_core_private_headers = \
@ -95,5 +96,6 @@ libnm_core_sources = \
$(core)/nm-setting.c \
$(core)/nm-simple-connection.c \
$(core)/nm-utils.c \
$(core)/nm-vpn-editor-plugin.c \
$(core)/nm-vpn-plugin-info.c

View file

@ -15,8 +15,9 @@
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA.
*
* Copyright 2008 - 2010 Red Hat, Inc.
* Copyright 2008 Novell, Inc.
* Copyright 2008 - 2010 Red Hat, Inc.
* Copyright 2015 Red Hat, Inc.
*/
#include "config.h"
@ -134,48 +135,3 @@ nm_vpn_editor_plugin_get_suggested_filename (NMVpnEditorPlugin *plugin,
return NULL;
}
static void nm_vpn_editor_default_init (NMVpnEditorInterface *iface);
G_DEFINE_INTERFACE (NMVpnEditor, nm_vpn_editor, G_TYPE_OBJECT)
static void
nm_vpn_editor_default_init (NMVpnEditorInterface *iface)
{
GType iface_type = G_TYPE_FROM_INTERFACE (iface);
/* Signals */
g_signal_new ("changed",
iface_type,
G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET (NMVpnEditorInterface, changed),
NULL, NULL,
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
}
/**
* nm_vpn_editor_get_widget:
*
* Returns: (transfer none):
*/
GObject *
nm_vpn_editor_get_widget (NMVpnEditor *editor)
{
g_return_val_if_fail (NM_IS_VPN_EDITOR (editor), NULL);
return NM_VPN_EDITOR_GET_INTERFACE (editor)->get_widget (editor);
}
gboolean
nm_vpn_editor_update_connection (NMVpnEditor *editor,
NMConnection *connection,
GError **error)
{
g_return_val_if_fail (NM_IS_VPN_EDITOR (editor), FALSE);
if (error)
g_return_val_if_fail (*error == NULL, FALSE);
return NM_VPN_EDITOR_GET_INTERFACE (editor)->update_connection (editor, connection, error);
}

View file

@ -15,8 +15,8 @@
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA.
*
* Copyright 2008 - 2014 Red Hat, Inc.
* Copyright 2008 Novell, Inc.
* Copyright 2008 - 2015 Red Hat, Inc.
*/
#ifndef __NM_VPN_EDITOR_PLUGIN_H__
@ -28,7 +28,8 @@
#include <glib.h>
#include <glib-object.h>
#include <nm-types.h>
#include "nm-connection.h"
G_BEGIN_DECLS
@ -137,53 +138,6 @@ gboolean nm_vpn_editor_plugin_export (NMVpnEditorPlugin *pl
char *nm_vpn_editor_plugin_get_suggested_filename (NMVpnEditorPlugin *plugin,
NMConnection *connection);
/**************************************************/
/* Editor interface */
/**************************************************/
#define NM_TYPE_VPN_EDITOR (nm_vpn_editor_get_type ())
#define NM_VPN_EDITOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_VPN_EDITOR, NMVpnEditor))
#define NM_IS_VPN_EDITOR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_VPN_EDITOR))
#define NM_VPN_EDITOR_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), NM_TYPE_VPN_EDITOR, NMVpnEditorInterface))
/**
* NMVpnEditorInterface:
* @g_iface: the parent interface
* @get_widget: return the #GtkWidget for the VPN editor's UI
* @placeholder: not currently used
* @update_connection: called to save the user-entered options to the connection
* object. Should return %FALSE and set @error if the current options are
* invalid. @error should contain enough information for the plugin to
* determine which UI widget is invalid at a later point in time. For
* example, creating unique error codes for what error occurred and populating
* the message field of @error with the name of the invalid property.
* @changed: emitted when the value of a UI widget changes. May trigger a
* validity check via @update_connection to write values to the connection.
*
* Interface for editing a specific #NMConnection
*/
typedef struct {
GTypeInterface g_iface;
GObject * (*get_widget) (NMVpnEditor *editor);
void (*placeholder) (void);
gboolean (*update_connection) (NMVpnEditor *editor,
NMConnection *connection,
GError **error);
void (*changed) (NMVpnEditor *editor);
} NMVpnEditorInterface;
GType nm_vpn_editor_get_type (void);
GObject * nm_vpn_editor_get_widget (NMVpnEditor *editor);
gboolean nm_vpn_editor_update_connection (NMVpnEditor *editor,
NMConnection *connection,
GError **error);
G_END_DECLS
#endif /* NM_VPN_EDITOR_PLUGIN_H */
#endif /* __NM_VPN_EDITOR_PLUGIN_H__ */

View file

@ -50,7 +50,7 @@ libnminclude_hfiles = \
nm-remote-connection.h \
nm-types.h \
nm-vpn-connection.h \
nm-vpn-editor-plugin.h \
nm-vpn-editor.h \
nm-wimax-nsp.h
libnminclude_nointrospect_hfiles = \
@ -108,7 +108,7 @@ libnm_la_csources = \
nm-secret-agent-old.c \
nm-vpn-connection.c \
nm-vpn-plugin-old.c \
nm-vpn-editor-plugin.c \
nm-vpn-editor.c \
nm-wimax-nsp.c
libnm_la_SOURCES = \

View file

@ -81,6 +81,7 @@
#include <nm-version.h>
#include <nm-vpn-connection.h>
#include <nm-vpn-dbus-interface.h>
#include <nm-vpn-editor.h>
#include <nm-vpn-editor-plugin.h>
#include <nm-vpn-plugin-info.h>
#include <nm-wimax-nsp.h>

69
libnm/nm-vpn-editor.c Normal file
View file

@ -0,0 +1,69 @@
/* -*- 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 2008 - 2010 Red Hat, Inc.
* Copyright 2008 Novell, Inc.
*/
#include "config.h"
#include "nm-vpn-editor.h"
static void nm_vpn_editor_default_init (NMVpnEditorInterface *iface);
G_DEFINE_INTERFACE (NMVpnEditor, nm_vpn_editor, G_TYPE_OBJECT)
static void
nm_vpn_editor_default_init (NMVpnEditorInterface *iface)
{
GType iface_type = G_TYPE_FROM_INTERFACE (iface);
/* Signals */
g_signal_new ("changed",
iface_type,
G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET (NMVpnEditorInterface, changed),
NULL, NULL,
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
}
/**
* nm_vpn_editor_get_widget:
*
* Returns: (transfer none):
*/
GObject *
nm_vpn_editor_get_widget (NMVpnEditor *editor)
{
g_return_val_if_fail (NM_IS_VPN_EDITOR (editor), NULL);
return NM_VPN_EDITOR_GET_INTERFACE (editor)->get_widget (editor);
}
gboolean
nm_vpn_editor_update_connection (NMVpnEditor *editor,
NMConnection *connection,
GError **error)
{
g_return_val_if_fail (NM_IS_VPN_EDITOR (editor), FALSE);
if (error)
g_return_val_if_fail (*error == NULL, FALSE);
return NM_VPN_EDITOR_GET_INTERFACE (editor)->update_connection (editor, connection, error);
}

86
libnm/nm-vpn-editor.h Normal file
View file

@ -0,0 +1,86 @@
/* -*- 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 2008 Novell, Inc.
* Copyright 2008 - 2015 Red Hat, Inc.
*/
#ifndef __NM_VPN_EDITOR_H__
#define __NM_VPN_EDITOR_H__
#if !defined (__NETWORKMANAGER_H_INSIDE__) && !defined (NETWORKMANAGER_COMPILATION)
#error "Only <NetworkManager.h> can be included directly."
#endif
#include <glib.h>
#include <glib-object.h>
#include <nm-types.h>
#include "nm-vpn-editor-plugin.h"
G_BEGIN_DECLS
/**************************************************/
/* Editor interface */
/**************************************************/
#define NM_TYPE_VPN_EDITOR (nm_vpn_editor_get_type ())
#define NM_VPN_EDITOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_VPN_EDITOR, NMVpnEditor))
#define NM_IS_VPN_EDITOR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_VPN_EDITOR))
#define NM_VPN_EDITOR_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), NM_TYPE_VPN_EDITOR, NMVpnEditorInterface))
/**
* NMVpnEditorInterface:
* @g_iface: the parent interface
* @get_widget: return the #GtkWidget for the VPN editor's UI
* @placeholder: not currently used
* @update_connection: called to save the user-entered options to the connection
* object. Should return %FALSE and set @error if the current options are
* invalid. @error should contain enough information for the plugin to
* determine which UI widget is invalid at a later point in time. For
* example, creating unique error codes for what error occurred and populating
* the message field of @error with the name of the invalid property.
* @changed: emitted when the value of a UI widget changes. May trigger a
* validity check via @update_connection to write values to the connection.
*
* Interface for editing a specific #NMConnection
*/
typedef struct {
GTypeInterface g_iface;
GObject * (*get_widget) (NMVpnEditor *editor);
void (*placeholder) (void);
gboolean (*update_connection) (NMVpnEditor *editor,
NMConnection *connection,
GError **error);
void (*changed) (NMVpnEditor *editor);
} NMVpnEditorInterface;
GType nm_vpn_editor_get_type (void);
GObject * nm_vpn_editor_get_widget (NMVpnEditor *editor);
gboolean nm_vpn_editor_update_connection (NMVpnEditor *editor,
NMConnection *connection,
GError **error);
G_END_DECLS
#endif /* __NM_VPN_EDITOR_H__ */