2019-09-10 09:19:01 +00:00
|
|
|
// SPDX-License-Identifier: LGPL-2.1+
|
2017-01-31 13:13:35 +00:00
|
|
|
/*
|
2019-10-01 07:20:35 +00:00
|
|
|
* Copyright (C) 2017 Red Hat, Inc.
|
2017-01-31 13:13:35 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#include "nm-default.h"
|
|
|
|
|
|
|
|
#include "nm-setting-dummy.h"
|
2017-02-23 09:58:32 +00:00
|
|
|
|
|
|
|
#include "nm-connection-private.h"
|
2017-01-31 13:13:35 +00:00
|
|
|
#include "nm-setting-connection.h"
|
|
|
|
#include "nm-setting-private.h"
|
|
|
|
|
|
|
|
/**
|
|
|
|
* SECTION:nm-setting-dummy
|
|
|
|
* @short_description: Describes connection properties for dummy interfaces
|
|
|
|
*
|
|
|
|
* The #NMSettingDummy object is a #NMSetting subclass that describes properties
|
|
|
|
* necessary for connection to dummy devices
|
|
|
|
**/
|
|
|
|
|
2019-01-11 07:32:54 +00:00
|
|
|
/*****************************************************************************/
|
|
|
|
|
libnm: use NMMetaSettingInfo for tracking setting priority
Previously, each (non abstract) NMSetting class had to register
its name and priority via _nm_register_setting().
Note, that libnm-core.la already links against "nm-meta-setting.c",
which also redundantly keeps track of the settings name and gtype
as well.
Re-use NMMetaSettingInfo also in libnm-core.la, to track this meta
data.
The goal is to get rid of private data structures that track
meta data about NMSetting classes. In this case, "registered_settings"
hash. Instead, we should have one place where all this meta data
is tracked. This was, it is also accessible as internal API,
which can be useful (for keyfile).
Note that NMSettingClass has some overlap with NMMetaSettingInfo.
One difference is, that NMMetaSettingInfo is const, while NMSettingClass
is only initialized during the class_init() method. Appart from that,
it's mostly a matter of taste, whether we attach meta data to
NMSettingClass, to NMMetaSettingInfo, or to a static-array indexed
by NMMetaSettingType.
Note, that previously, _nm_register_setting() was private API. That
means, no user could subclass a functioning NMSetting instance. The same
is still true: NMMetaSettingInfo is internal API and users cannot access
it to create their own NMSetting subclasses. But that is almost desired.
libnm is not designed, to be extensible via subclassing, nor is it
clear why that would be a useful thing to do. One day, we should remove
the NMSetting and NMSettingClass definitions from public headers. Their
only use is subclassing the types, which however does not work.
While libnm-core was linking already against nm-meta-setting.c,
nm_meta_setting_infos was unreferenced. So, this change increases
the binary size of libnm and NetworkManager (1032 bytes). Note however
that roughly the same information was previously allocated at runtime.
2018-07-27 12:08:14 +00:00
|
|
|
G_DEFINE_TYPE (NMSettingDummy, nm_setting_dummy, NM_TYPE_SETTING)
|
2017-01-31 13:13:35 +00:00
|
|
|
|
2019-01-11 07:32:54 +00:00
|
|
|
/*****************************************************************************/
|
2017-01-31 13:13:35 +00:00
|
|
|
|
2017-02-23 09:58:32 +00:00
|
|
|
static gboolean
|
|
|
|
verify (NMSetting *setting, NMConnection *connection, GError **error)
|
|
|
|
{
|
|
|
|
if (!_nm_connection_verify_required_interface_name (connection, error))
|
|
|
|
return FALSE;
|
|
|
|
|
|
|
|
return TRUE;
|
|
|
|
}
|
|
|
|
|
2019-01-11 07:32:54 +00:00
|
|
|
/*****************************************************************************/
|
|
|
|
|
2017-01-31 13:13:35 +00:00
|
|
|
static void
|
|
|
|
nm_setting_dummy_init (NMSettingDummy *setting)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2019-01-11 07:32:54 +00:00
|
|
|
/**
|
|
|
|
* nm_setting_dummy_new:
|
|
|
|
*
|
|
|
|
* Creates a new #NMSettingDummy object with default values.
|
|
|
|
*
|
|
|
|
* Returns: (transfer full): the new empty #NMSettingDummy object
|
|
|
|
*
|
|
|
|
* Since: 1.8
|
|
|
|
**/
|
|
|
|
NMSetting *
|
|
|
|
nm_setting_dummy_new (void)
|
|
|
|
{
|
|
|
|
return (NMSetting *) g_object_new (NM_TYPE_SETTING_DUMMY, NULL);
|
|
|
|
}
|
|
|
|
|
2017-01-31 13:13:35 +00:00
|
|
|
static void
|
libnm/trivial: cleanup variable names in settings' class-init functions
- Don't use @parent_class name. This local variable (and @object_class) is
the class instance up-cast to the pointer types of the parents. The point
here is not that it is the direct parent. The point is, that it's the
NMSettingClass type.
Also, it can only be used inconsistently, in face of NMSettingIP4Config,
who's parent type is NMSettingIPConfig. Clearly, inside
nm-setting-ip4-config.c we wouldn't want to use the "parent_class"
name. Consistently rename @parent_class to @setting_class.
- Also rename the pointer to the own class to @klass. "setting_class" is also the
wrong name for that, because the right name would be something like
"setting_6lowpan_class".
However, "klass" is preferred over the latter, because we commonly create new
GObject implementations by copying an existing one. Generic names like "klass"
and "self" inside a type implementation make that simpler.
- drop useless comments like
/* virtual functions */
/* Properties */
It's better to logically and visually structure the code, and avoid trival
remarks about that. They only end up being used inconsistently. If you
even need a stronger visual separator, then an 80 char /****/ line
should be preferred.
2018-07-28 08:43:21 +00:00
|
|
|
nm_setting_dummy_class_init (NMSettingDummyClass *klass)
|
2017-01-31 13:13:35 +00:00
|
|
|
{
|
libnm/trivial: cleanup variable names in settings' class-init functions
- Don't use @parent_class name. This local variable (and @object_class) is
the class instance up-cast to the pointer types of the parents. The point
here is not that it is the direct parent. The point is, that it's the
NMSettingClass type.
Also, it can only be used inconsistently, in face of NMSettingIP4Config,
who's parent type is NMSettingIPConfig. Clearly, inside
nm-setting-ip4-config.c we wouldn't want to use the "parent_class"
name. Consistently rename @parent_class to @setting_class.
- Also rename the pointer to the own class to @klass. "setting_class" is also the
wrong name for that, because the right name would be something like
"setting_6lowpan_class".
However, "klass" is preferred over the latter, because we commonly create new
GObject implementations by copying an existing one. Generic names like "klass"
and "self" inside a type implementation make that simpler.
- drop useless comments like
/* virtual functions */
/* Properties */
It's better to logically and visually structure the code, and avoid trival
remarks about that. They only end up being used inconsistently. If you
even need a stronger visual separator, then an 80 char /****/ line
should be preferred.
2018-07-28 08:43:21 +00:00
|
|
|
NMSettingClass *setting_class = NM_SETTING_CLASS (klass);
|
2017-02-23 09:58:32 +00:00
|
|
|
|
libnm: rework setting metadata for property handling
NMSetting internally already tracked a list of all proper GObject properties
and D-Bus-only properties.
Rework the tracking of the list, so that:
- instead of attaching the data to the GType of the setting via
g_type_set_qdata(), it is tracked in a static array indexed by
NMMetaSettingType. This allows to find the setting-data by simple
pointer arithmetic, instead of taking a look and iterating (like
g_type_set_qdata() does).
Note, that this is still thread safe, because the static table entry is
initialized in the class-init function with _nm_setting_class_commit().
And it only accessed by following a NMSettingClass instance, thus
the class constructor already ran (maybe not for all setting classes,
but for the particular one that we look up).
I think this makes initialization of the metadata simpler to
understand.
Previously, in a first phase each class would attach the metadata
to the GType as setting_property_overrides_quark(). Then during
nm_setting_class_ensure_properties() it would merge them and
set as setting_properties_quark(). Now, during the first phase,
we only incrementally build a properties_override GArray, which
we finally hand over during nm_setting_class_commit().
- sort the property infos by name and do binary search.
Also expose this meta data types as internal API in nm-setting-private.h.
While not accessed yet, it can prove beneficial, to have direct (internal)
access to these structures.
Also, rename NMSettingProperty to NMSettInfoProperty to use a distinct
naming scheme. We already have 40+ subclasses of NMSetting that are called
NMSetting*. Likewise, NMMetaSetting* is heavily used already. So, choose a
new, distinct name.
2018-07-28 13:26:03 +00:00
|
|
|
setting_class->verify = verify;
|
|
|
|
|
|
|
|
_nm_setting_class_commit (setting_class, NM_META_SETTING_TYPE_DUMMY);
|
2017-01-31 13:13:35 +00:00
|
|
|
}
|