fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2025-12-21 00:30:07 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
NetworkManager/clients/common/nm-meta-setting-access.h

92 lines
4.9 KiB
C
Raw Normal View History

all: SPDX header conversion $ find * -type f |xargs perl contrib/scripts/spdx.pl $ git rm contrib/scripts/spdx.pl
2019-09-10 11:19:01 +02:00
// SPDX-License-Identifier: GPL-2.0+
all: manually drop code comments with file description
2019-09-25 13:13:40 +02:00
/*
all: unify format of our Copyright source code comments ```bash readarray -d '' FILES < <( git ls-files -z \ ':(exclude)po' \ ':(exclude)shared/c-rbtree' \ ':(exclude)shared/c-list' \ ':(exclude)shared/c-siphash' \ ':(exclude)shared/c-stdaux' \ ':(exclude)shared/n-acd' \ ':(exclude)shared/n-dhcp4' \ ':(exclude)src/systemd/src' \ ':(exclude)shared/systemd/src' \ ':(exclude)m4' \ ':(exclude)COPYING*' ) sed \ -e 's/^\(--\|#\| \*\) *\(([cC]) *\)\?Copyright \+\(\(([cC])\) \+\)\?\(\(20\|19\)[0-9][0-9]\) *[-–] *\(\(20\|19\)[0-9][0-9]\) \+\([^ ].*\)$/\1 C1pyright#\5 - \7#\9/' \ -e 's/^\(--\|#\| \*\) *\(([cC]) *\)\?Copyright \+\(\(([cC])\) \+\)\?\(\(20\|19\)[0-9][0-9]\) *[,] *\(\(20\|19\)[0-9][0-9]\) \+\([^ ].*\)$/\1 C2pyright#\5, \7#\9/' \ -e 's/^\(--\|#\| \*\) *\(([cC]) *\)\?Copyright \+\(\(([cC])\) \+\)\?\(\(20\|19\)[0-9][0-9]\) \+\([^ ].*\)$/\1 C3pyright#\5#\7/' \ -e 's/^Copyright \(\(20\|19\)[0-9][0-9]\) \+\([^ ].*\)$/C4pyright#\1#\3/' \ -i \ "${FILES[@]}" echo ">>> untouched Copyright lines" git grep Copyright "${FILES[@]}" echo ">>> Copyright lines with unusual extra" git grep '\<C[0-9]pyright#' "${FILES[@]}" | grep -i reserved sed \ -e 's/\<C[0-9]pyright#\([^#]*\)#\(.*\)$/Copyright (C) \1 \2/' \ -i \ "${FILES[@]}" ``` https://gitlab.freedesktop.org/NetworkManager/NetworkManager/merge_requests/298
2019-10-01 09:20:35 +02:00
* Copyright (C) 2010 - 2017 Red Hat, Inc.
cli: split out new file "nm-meta-setting-access.h" "nm-meta-setting-desc.h" contains static type description, vtable and (internal) accessor functions. Add accessor functions that operate on top of the type description to "nm-meta-setting-access.h".
2017-03-31 14:45:46 +02:00
*/
#ifndef _NM_META_SETTING_ACCESS_H__
#define _NM_META_SETTING_ACCESS_H__
#include "nm-meta-setting.h"
#include "nm-meta-setting-desc.h"
/*****************************************************************************/
cli: move setting creation to meta data
2017-04-12 10:13:41 +02:00
NMSetting *nm_meta_setting_info_editor_new_setting (const NMMetaSettingInfoEditor *setting_info,
NMMetaAccessorSettingInitType init_type);
cli: move information about valid connection settings to common
2017-04-11 11:31:27 +02:00
const NMMetaSettingInfoEditor *nm_meta_setting_info_editor_find_by_name (const char *setting_name, gboolean use_alias);
cli: split out new file "nm-meta-setting-access.h" "nm-meta-setting-desc.h" contains static type description, vtable and (internal) accessor functions. Add accessor functions that operate on top of the type description to "nm-meta-setting-access.h".
2017-03-31 14:45:46 +02:00
const NMMetaSettingInfoEditor *nm_meta_setting_info_editor_find_by_gtype (GType gtype);
cli: split tracking of meta data out of NmcOutputField When generating output data, nmcli iterates over a list of property-descriptors (nmc_fields_ip4_config), creates an intermediate array (output_data) and finally prints it. However, previously both the meta data (nmc_fields_ip4_config) and the intermediate format use the same type NmcOutputField. This means, certain fields are relevant to describe a property, and other fields are output/formatting fields. Split this up. Now, the meta data is tracked in form of an NMMetaAbstractInfo lists. This separates the information about properties from intermediate steps during creation of the output. Note that currently functions like print_ip4_config() still have all the knowledge about how to generate the output. That is wrong, instead, the meta data (NMMetaAbstractInfo) should describe how to create the output and then all those functions could be replaced. This means, later we want to add more knowledge to the NMMetaAbstractInfo, so it is important to keep them separate from NmcOutputField.
2017-03-31 19:18:16 +02:00
const NMMetaSettingInfoEditor *nm_meta_setting_info_editor_find_by_setting (NMSetting *setting);
cli: split out new file "nm-meta-setting-access.h" "nm-meta-setting-desc.h" contains static type description, vtable and (internal) accessor functions. Add accessor functions that operate on top of the type description to "nm-meta-setting-access.h".
2017-03-31 14:45:46 +02:00
const NMMetaPropertyInfo *nm_meta_setting_info_editor_get_property_info (const NMMetaSettingInfoEditor *setting_info,
const char *property_name);
const NMMetaPropertyInfo *nm_meta_property_info_find_by_name (const char *setting_name,
cli: make setting meta data more generic Embed a @meta_type structure in NMMetaSettingInfoEditor and NMMetaPropertyInfo. This allows to make the NMMeta*Info instances themself to become generic and they can be passed around as generic NMMetaAbstractInfo types. For one, the embedded NMMetaType pointer can be used to determine of which type a NMMetaAbstractInfo instance is. On the other hand, the NMMetaType struct can be extended to be a VTable to provide generic access to the type. In the end, both NMMetaSettingInfoEditor and NMMetaPropertyInfo are conceptionally very similar: the describe a certain type and provide accessors. In nmcli we have yet another NMMetaAbstractInfo type: NmcOutputField will be modified to become another implementation of meta data (it already is, it just cannot be used interchangable with the other types). Also, embed the NMMetaSettingInfoEditor in the NMMetaPropertyInfo instance. This allows from a given NMMetaPropertyInfo to retrieve it's parent NMMetaSettingInfoEditor.
2017-03-31 16:16:06 +02:00
const char *property_name);
cli: split out new file "nm-meta-setting-access.h" "nm-meta-setting-desc.h" contains static type description, vtable and (internal) accessor functions. Add accessor functions that operate on top of the type description to "nm-meta-setting-access.h".
2017-03-31 14:45:46 +02:00
const NMMetaPropertyInfo *nm_meta_property_info_find_by_setting (NMSetting *setting,
cli: make setting meta data more generic Embed a @meta_type structure in NMMetaSettingInfoEditor and NMMetaPropertyInfo. This allows to make the NMMeta*Info instances themself to become generic and they can be passed around as generic NMMetaAbstractInfo types. For one, the embedded NMMetaType pointer can be used to determine of which type a NMMetaAbstractInfo instance is. On the other hand, the NMMetaType struct can be extended to be a VTable to provide generic access to the type. In the end, both NMMetaSettingInfoEditor and NMMetaPropertyInfo are conceptionally very similar: the describe a certain type and provide accessors. In nmcli we have yet another NMMetaAbstractInfo type: NmcOutputField will be modified to become another implementation of meta data (it already is, it just cannot be used interchangable with the other types). Also, embed the NMMetaSettingInfoEditor in the NMMetaPropertyInfo instance. This allows from a given NMMetaPropertyInfo to retrieve it's parent NMMetaSettingInfoEditor.
2017-03-31 16:16:06 +02:00
const char *property_name);
cli: split out new file "nm-meta-setting-access.h" "nm-meta-setting-desc.h" contains static type description, vtable and (internal) accessor functions. Add accessor functions that operate on top of the type description to "nm-meta-setting-access.h".
2017-03-31 14:45:46 +02:00
clients: only ask secrets for settings that require them When nmcli needs secrets for a connection it asks them for every known setting. nmtui is a bit smarter and asks them only for settings that actually exist in the connection. Make a step further and let clients ask secrets only for setting that exist *and* have any secret property. This decreases the number of D-Bus calls when editing or showing a connection with secrets. https://bugzilla.redhat.com/show_bug.cgi?id=1506536 https://github.com/NetworkManager/NetworkManager/pull/327
2019-03-31 11:36:09 +02:00
gboolean nm_meta_setting_info_editor_has_secrets (const NMMetaSettingInfoEditor *setting_info);
cli: split out new file "nm-meta-setting-access.h" "nm-meta-setting-desc.h" contains static type description, vtable and (internal) accessor functions. Add accessor functions that operate on top of the type description to "nm-meta-setting-access.h".
2017-03-31 14:45:46 +02:00
/*****************************************************************************/
cli: split tracking of meta data out of NmcOutputField When generating output data, nmcli iterates over a list of property-descriptors (nmc_fields_ip4_config), creates an intermediate array (output_data) and finally prints it. However, previously both the meta data (nmc_fields_ip4_config) and the intermediate format use the same type NmcOutputField. This means, certain fields are relevant to describe a property, and other fields are output/formatting fields. Split this up. Now, the meta data is tracked in form of an NMMetaAbstractInfo lists. This separates the information about properties from intermediate steps during creation of the output. Note that currently functions like print_ip4_config() still have all the knowledge about how to generate the output. That is wrong, instead, the meta data (NMMetaAbstractInfo) should describe how to create the output and then all those functions could be replaced. This means, later we want to add more knowledge to the NMMetaAbstractInfo, so it is important to keep them separate from NmcOutputField.
2017-03-31 19:18:16 +02:00
const NMMetaSettingInfoEditor *const*nm_meta_setting_infos_editor_p (void);
/*****************************************************************************/
cli: use nmc_print() to output device's IP4 info The IP4 info adds a new type: to expose strv arguments for addresses, etc.
2017-04-06 15:14:23 +02:00
const char *nm_meta_abstract_info_get_name (const NMMetaAbstractInfo *abstract_info, gboolean for_header);
cli: add accessors for NMMetaAbstractInfo
2017-04-05 15:48:53 +02:00
const NMMetaAbstractInfo *const*nm_meta_abstract_info_get_nested (const NMMetaAbstractInfo *abstract_info,
guint *out_len,
gpointer *nested_to_free);
cli: implement new nmc_print() command to generically output cli data We already have - data sources (nm_cli, connections or settings) - meta data information how to access the data sources (NMMetaAbstractInfo, NmcMetaGenericInfo, NMMetaPropertyInfo) Add now a generic way to output cli data using nmc_print(). It gets a list of data-sources (@targets) and a list of available fields (meta data). It also gets cli configuration (NmcConfig) and field selector strings (@field_str). Based on that, it should output the desired data. This is intended to replaces the previous approach, where functions like show_nm_status() have full knowledge about how to access the data and create an intermediate output format (NmcOutputData, NmcOutputField) that was printed via print_data(). show_nm_status() contained both knowledge about the data itself (how to print a value) and intimate knoweledge about the output intermediate format. Also, the intermediate format is hard to understand. For example, sometimes we put the field prefix in NmcOutputField at index 0 and via the NmcOfFlags we control how to output the data. Clearly separate the responsibilities. - The meta data (NmcMetaGenericInfo) is only concerned with converting a data source to a string (or a color format). - the field selection (@field_str) only cares about parsing the list of NMMetaAbstractInfo. - _print_fill() populates a table with output values and header entries. - _print_do() prints the previously prepared table. The advantage is that if you want to change anything, you only need to touch a particular part. This is only a show-case for `nmcli general status`. Parts are still un-implemented and will follow. This changes behavior for --terse mode: the values are now no longer translated: $ LANG=de_DE.utf8 nmcli -t --mode multiline general
2017-04-04 15:23:39 +02:00
gconstpointer nm_meta_abstract_info_get (const NMMetaAbstractInfo *abstract_info,
const NMMetaEnvironment *environment,
gpointer environment_user_data,
gpointer target,
cli: add additional user-data argument to get_fcn() The function nmc_print() receives a list of "targets". These are essentially the rows that should be printed (while the "fields" list represents the columns). When filling the cells with values, it calles repeatedly get_fcn() on the column descriptors (fields), by passing each row (target). The caller must be well aware that the fields and targets are compatible. For example, in some cases the targets are NMDevice instances and the target type must correspond to what get_fcn() expects. Add another user-data pointer that is passed on along with the targets. That is useful, if we have a list of targets/rows, but pass in additional data that applies to all rows alike. It is still unused.
2018-04-30 13:01:20 +02:00
gpointer target_data,
cli: implement new nmc_print() command to generically output cli data We already have - data sources (nm_cli, connections or settings) - meta data information how to access the data sources (NMMetaAbstractInfo, NmcMetaGenericInfo, NMMetaPropertyInfo) Add now a generic way to output cli data using nmc_print(). It gets a list of data-sources (@targets) and a list of available fields (meta data). It also gets cli configuration (NmcConfig) and field selector strings (@field_str). Based on that, it should output the desired data. This is intended to replaces the previous approach, where functions like show_nm_status() have full knowledge about how to access the data and create an intermediate output format (NmcOutputData, NmcOutputField) that was printed via print_data(). show_nm_status() contained both knowledge about the data itself (how to print a value) and intimate knoweledge about the output intermediate format. Also, the intermediate format is hard to understand. For example, sometimes we put the field prefix in NmcOutputField at index 0 and via the NmcOfFlags we control how to output the data. Clearly separate the responsibilities. - The meta data (NmcMetaGenericInfo) is only concerned with converting a data source to a string (or a color format). - the field selection (@field_str) only cares about parsing the list of NMMetaAbstractInfo. - _print_fill() populates a table with output values and header entries. - _print_do() prints the previously prepared table. The advantage is that if you want to change anything, you only need to touch a particular part. This is only a show-case for `nmcli general status`. Parts are still un-implemented and will follow. This changes behavior for --terse mode: the values are now no longer translated: $ LANG=de_DE.utf8 nmcli -t --mode multiline general
2017-04-04 15:23:39 +02:00
NMMetaAccessorGetType get_type,
NMMetaAccessorGetFlags get_flags,
cli: use nmc_print() to output device's IP4 info The IP4 info adds a new type: to expose strv arguments for addresses, etc.
2017-04-06 15:14:23 +02:00
NMMetaAccessorGetOutFlags *out_flags,
clients: change nm_meta_abstract_info_get() to report defaults Return a boolean to indicate whether the value is the default one, so that the caller can choose to hide it.
2018-02-27 15:34:49 +01:00
gboolean *out_is_default,
cli: implement new nmc_print() command to generically output cli data We already have - data sources (nm_cli, connections or settings) - meta data information how to access the data sources (NMMetaAbstractInfo, NmcMetaGenericInfo, NMMetaPropertyInfo) Add now a generic way to output cli data using nmc_print(). It gets a list of data-sources (@targets) and a list of available fields (meta data). It also gets cli configuration (NmcConfig) and field selector strings (@field_str). Based on that, it should output the desired data. This is intended to replaces the previous approach, where functions like show_nm_status() have full knowledge about how to access the data and create an intermediate output format (NmcOutputData, NmcOutputField) that was printed via print_data(). show_nm_status() contained both knowledge about the data itself (how to print a value) and intimate knoweledge about the output intermediate format. Also, the intermediate format is hard to understand. For example, sometimes we put the field prefix in NmcOutputField at index 0 and via the NmcOfFlags we control how to output the data. Clearly separate the responsibilities. - The meta data (NmcMetaGenericInfo) is only concerned with converting a data source to a string (or a color format). - the field selection (@field_str) only cares about parsing the list of NMMetaAbstractInfo. - _print_fill() populates a table with output values and header entries. - _print_do() prints the previously prepared table. The advantage is that if you want to change anything, you only need to touch a particular part. This is only a show-case for `nmcli general status`. Parts are still un-implemented and will follow. This changes behavior for --terse mode: the values are now no longer translated: $ LANG=de_DE.utf8 nmcli -t --mode multiline general
2017-04-04 15:23:39 +02:00
gpointer *out_to_free);
cli: add property completion to meta-data (not used yet).
2017-04-10 16:38:35 +02:00
const char *const*nm_meta_abstract_info_complete (const NMMetaAbstractInfo *abstract_info,
cli: move completion for devices names to meta data
2017-04-11 15:48:04 +02:00
const NMMetaEnvironment *environment,
gpointer environment_user_data,
cli: move completion for master connections to meta data This change (improves) behavior. Before, we would only complete if (g_strcmp0 (con_type, nmc_tab_completion.con_type) != 0) which doesn't really make sense as it depends on the slave-type, not nmc_tab_completion.con_type.
2017-04-11 15:48:04 +02:00
const NMMetaOperationContext *operation_context,
cli: add property completion to meta-data (not used yet).
2017-04-10 16:38:35 +02:00
const char *text,
cli: allow completing filenames Allow the completion function to indicate that the word should be completed as a filename by the shell.
2019-04-23 21:35:19 +02:00
gboolean *out_complete_filename,
cli: add property completion to meta-data (not used yet).
2017-04-10 16:38:35 +02:00
char ***out_to_free);
cli: add accessors for NMMetaAbstractInfo
2017-04-05 15:48:53 +02:00
/*****************************************************************************/
cli: move parsing of meta data fields
2017-04-12 15:19:26 +02:00
char *nm_meta_abstract_info_get_nested_names_str (const NMMetaAbstractInfo *abstract_info, const char *name_prefix);
char *nm_meta_abstract_infos_get_names_str (const NMMetaAbstractInfo *const*fields_array, const char *name_prefix);
/*****************************************************************************/
typedef struct {
const NMMetaAbstractInfo *info;
const char *self_selection;
const char *sub_selection;
guint idx;
} NMMetaSelectionItem;
typedef struct {
const guint num;
const NMMetaSelectionItem items[];
} NMMetaSelectionResultList;
NMMetaSelectionResultList *nm_meta_selection_create_all (const NMMetaAbstractInfo *const* fields_array);
NMMetaSelectionResultList *nm_meta_selection_create_parse_one (const NMMetaAbstractInfo *const* fields_array,
const char *fields_prefix,
const char *fields_str,
gboolean validate_nested,
GError **error);
NMMetaSelectionResultList *nm_meta_selection_create_parse_list (const NMMetaAbstractInfo *const* fields_array,
const char *fields_str,
gboolean validate_nested,
GError **error);
cli: split out new file "nm-meta-setting-access.h" "nm-meta-setting-desc.h" contains static type description, vtable and (internal) accessor functions. Add accessor functions that operate on top of the type description to "nm-meta-setting-access.h".
2017-03-31 14:45:46 +02:00
#endif /* _NM_META_SETTING_ACCESS_H__ */
Reference in a new issue Copy permalink