NetworkManager/clients/cli/utils.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

371 lines
17 KiB
C
Raw Normal View History

/* SPDX-License-Identifier: GPL-2.0+ */
/*
* Copyright (C) 2010 - 2018 Red Hat, Inc.
2010-02-25 09:52:30 -08:00
*/
#ifndef NMC_UTILS_H
#define NMC_UTILS_H
#include "nmcli.h"
/* === Types === */
typedef struct {
const char * name;
gboolean has_value;
const char **value;
gboolean mandatory;
gboolean found;
} nmc_arg_t;
/* === Functions === */
int next_arg(NmCli *nmc, int *argc, const char *const **argv, ...);
gboolean nmc_arg_is_help(const char *arg);
gboolean nmc_arg_is_option(const char *arg, const char *opt_name);
gboolean nmc_parse_args(nmc_arg_t * arg_arr,
gboolean last,
int * argc,
const char *const **argv,
GError ** error);
char * ssid_to_hex(const char *str, gsize len);
void nmc_terminal_erase_line(void);
void nmc_terminal_show_progress(const char *str);
pid_t nmc_terminal_spawn_pager(const NmcConfig *nmc_config);
char * nmc_colorize(const NmcConfig *nmc_config, NMMetaColor color, const char *fmt, ...)
_nm_printf(3, 4);
void nmc_filter_out_colors_inplace(char *str);
char * nmc_filter_out_colors(const char *str);
char * nmc_get_user_input(const char *ask_str);
int nmc_string_to_arg_array(const char *line,
const char *delim,
gboolean unquote,
char *** argv,
int * argc);
const char *nmc_string_is_valid(const char *input, const char **allowed, GError **error);
char * nmc_util_strv_for_display(const char *const *strv, gboolean brackets);
int nmc_string_screen_width(const char *start, const char *end);
void set_val_str(NmcOutputField fields_array[], guint32 index, char *value);
void set_val_strc(NmcOutputField fields_array[], guint32 index, const char *value);
void set_val_arr(NmcOutputField fields_array[], guint32 index, char **value);
void set_val_arrc(NmcOutputField fields_array[], guint32 index, const char **value);
void set_val_color_all(NmcOutputField fields_array[], NMMetaColor color);
void nmc_free_output_field_values(NmcOutputField fields_array[]);
GArray * parse_output_fields(const char * fields_str,
const NMMetaAbstractInfo *const *fields_array,
gboolean parse_groups,
GPtrArray ** group_fields,
GError ** error);
NmcOutputField *nmc_dup_fields_array(const NMMetaAbstractInfo *const *fields, NmcOfFlags flags);
void nmc_empty_output_fields(NmcOutputData *output_data);
void print_required_fields(const NmcConfig * nmc_config,
NmcPagerData * pager_data,
NmcOfFlags of_flags,
const GArray * indices,
const char * header_name,
int indent,
const NmcOutputField *field_values);
void print_data_prepare_width(GPtrArray *output_data);
void print_data(const NmcConfig * nmc_config,
NmcPagerData * pager_data,
const GArray * indices,
const char * header_name,
int indent,
const NmcOutputData *out);
2010-02-25 09:52:30 -08:00
/*****************************************************************************/
extern const NMMetaEnvironment *const nmc_meta_environment;
extern const NmCli *const nmc_meta_environment_arg;
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
typedef enum {
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
NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_RUNNING = 0,
NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_VERSION,
NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_STATE,
NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_STARTUP,
NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_CONNECTIVITY,
NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_NETWORKING,
NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_WIFI_HW,
NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_WIFI,
NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_WWAN_HW,
NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_WWAN,
NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_WIMAX_HW,
NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_WIMAX,
_NMC_GENERIC_INFO_TYPE_GENERAL_STATUS_NUM,
NMC_GENERIC_INFO_TYPE_GENERAL_PERMISSIONS_PERMISSION = 0,
NMC_GENERIC_INFO_TYPE_GENERAL_PERMISSIONS_VALUE,
_NMC_GENERIC_INFO_TYPE_GENERAL_PERMISSIONS_NUM,
NMC_GENERIC_INFO_TYPE_GENERAL_LOGGING_LEVEL = 0,
NMC_GENERIC_INFO_TYPE_GENERAL_LOGGING_DOMAINS,
_NMC_GENERIC_INFO_TYPE_GENERAL_LOGGING_NUM,
NMC_GENERIC_INFO_TYPE_IP4_CONFIG_ADDRESS = 0,
NMC_GENERIC_INFO_TYPE_IP4_CONFIG_GATEWAY,
NMC_GENERIC_INFO_TYPE_IP4_CONFIG_ROUTE,
NMC_GENERIC_INFO_TYPE_IP4_CONFIG_DNS,
NMC_GENERIC_INFO_TYPE_IP4_CONFIG_DOMAIN,
NMC_GENERIC_INFO_TYPE_IP4_CONFIG_WINS,
_NMC_GENERIC_INFO_TYPE_IP4_CONFIG_NUM,
2017-09-18 12:29:06 +02:00
NMC_GENERIC_INFO_TYPE_IP6_CONFIG_ADDRESS = 0,
NMC_GENERIC_INFO_TYPE_IP6_CONFIG_GATEWAY,
NMC_GENERIC_INFO_TYPE_IP6_CONFIG_ROUTE,
NMC_GENERIC_INFO_TYPE_IP6_CONFIG_DNS,
NMC_GENERIC_INFO_TYPE_IP6_CONFIG_DOMAIN,
_NMC_GENERIC_INFO_TYPE_IP6_CONFIG_NUM,
2018-04-26 17:43:13 +02:00
NMC_GENERIC_INFO_TYPE_DHCP_CONFIG_OPTION = 0,
_NMC_GENERIC_INFO_TYPE_DHCP_CONFIG_NUM,
cli: rework printing of `nmcli connection` for multiple active connections The output of `nmcli connection show` contains also information about whether the profile is currently active, for example the device and the current (activation) state. Even when a profile can be activated only once (without supporting mutiple activations at the same time), there are moments when a connection is activating and still deactivating on another device. NetworkManager ensures in the case with single activations that a profile cannot be in state "activated" multiple times. But that doesn't mean, that one profile cannot have multiple active connection which reference it. That was already handled wrongly before, because `nmcli connection show` would only search the first matching active-connection. That is, it would arbitrarily pick an active connection in case there were multiple and only show activation state about one. Furthermore, we will soon also add the possibility, that a profile can be active multiple times (at the same time). Especially then, we need to extend the output format to show all the devices on which the profile is currently active. Rework printing the connection list to use nmc_print(), and fix various issues. - as discussed, a profile may have multiple active connections at each time. There are only two possibilities: if a profile is active multiple times, show a line for each activation, or otherwise, show the information about multiple activations combined in one line, e.g. by printing "DEVICE eth0,eth1". This patch, does the former. We will now print a line for each active connection, to show all the devices and activation states in multiple lines. Yes, this may result in the same profile being printed multiple times. That is a change in behavior, and inconvenient if you do something like for UUID in $(nmcli connection show | awk '{print$2}'); do ... However, above is anyway wrong because it assumes that there are no spaces in the connection name. The proper way to do this is like for UUID in $(nmcli -g UUID connection show); do ... In the latter case, whenever a user selects a subset of fields (--fields, --get) which don't print information about active connections, these multiple lines are combined. So, above still works as expected, never returning duplicate UUIDs. - if a user has no permissions to see a connection, we previously would print "<invisible> $NAME". No longer do this but just print the ID was it is reported by the active-connection. If the goal of this was to prevent users from accidentally access the non-existing connection by $NAME, then this was a bad solution, because a script would instead try to access "<invisible> $NAME". This is now solved better by hiding the active connection if the user selects "-g NAME". - the --order option now sorts according to how the fields are shown. For example, with --terse mode, it will evaluate type "802-11-wireless" but with pretty mode it will consider "wifi". This may change the ordering in which connections are shown. Also, for sorting the name, we use g_utf8_collate() because it's unicode.
2018-04-25 10:00:40 +02:00
NMC_GENERIC_INFO_TYPE_CON_SHOW_NAME = 0,
NMC_GENERIC_INFO_TYPE_CON_SHOW_UUID,
NMC_GENERIC_INFO_TYPE_CON_SHOW_TYPE,
NMC_GENERIC_INFO_TYPE_CON_SHOW_TIMESTAMP,
NMC_GENERIC_INFO_TYPE_CON_SHOW_TIMESTAMP_REAL,
NMC_GENERIC_INFO_TYPE_CON_SHOW_AUTOCONNECT,
NMC_GENERIC_INFO_TYPE_CON_SHOW_AUTOCONNECT_PRIORITY,
NMC_GENERIC_INFO_TYPE_CON_SHOW_READONLY,
NMC_GENERIC_INFO_TYPE_CON_SHOW_DBUS_PATH,
NMC_GENERIC_INFO_TYPE_CON_SHOW_ACTIVE,
NMC_GENERIC_INFO_TYPE_CON_SHOW_DEVICE,
NMC_GENERIC_INFO_TYPE_CON_SHOW_STATE,
NMC_GENERIC_INFO_TYPE_CON_SHOW_ACTIVE_PATH,
NMC_GENERIC_INFO_TYPE_CON_SHOW_SLAVE,
NMC_GENERIC_INFO_TYPE_CON_SHOW_FILENAME,
cli: rework printing of `nmcli connection` for multiple active connections The output of `nmcli connection show` contains also information about whether the profile is currently active, for example the device and the current (activation) state. Even when a profile can be activated only once (without supporting mutiple activations at the same time), there are moments when a connection is activating and still deactivating on another device. NetworkManager ensures in the case with single activations that a profile cannot be in state "activated" multiple times. But that doesn't mean, that one profile cannot have multiple active connection which reference it. That was already handled wrongly before, because `nmcli connection show` would only search the first matching active-connection. That is, it would arbitrarily pick an active connection in case there were multiple and only show activation state about one. Furthermore, we will soon also add the possibility, that a profile can be active multiple times (at the same time). Especially then, we need to extend the output format to show all the devices on which the profile is currently active. Rework printing the connection list to use nmc_print(), and fix various issues. - as discussed, a profile may have multiple active connections at each time. There are only two possibilities: if a profile is active multiple times, show a line for each activation, or otherwise, show the information about multiple activations combined in one line, e.g. by printing "DEVICE eth0,eth1". This patch, does the former. We will now print a line for each active connection, to show all the devices and activation states in multiple lines. Yes, this may result in the same profile being printed multiple times. That is a change in behavior, and inconvenient if you do something like for UUID in $(nmcli connection show | awk '{print$2}'); do ... However, above is anyway wrong because it assumes that there are no spaces in the connection name. The proper way to do this is like for UUID in $(nmcli -g UUID connection show); do ... In the latter case, whenever a user selects a subset of fields (--fields, --get) which don't print information about active connections, these multiple lines are combined. So, above still works as expected, never returning duplicate UUIDs. - if a user has no permissions to see a connection, we previously would print "<invisible> $NAME". No longer do this but just print the ID was it is reported by the active-connection. If the goal of this was to prevent users from accidentally access the non-existing connection by $NAME, then this was a bad solution, because a script would instead try to access "<invisible> $NAME". This is now solved better by hiding the active connection if the user selects "-g NAME". - the --order option now sorts according to how the fields are shown. For example, with --terse mode, it will evaluate type "802-11-wireless" but with pretty mode it will consider "wifi". This may change the ordering in which connections are shown. Also, for sorting the name, we use g_utf8_collate() because it's unicode.
2018-04-25 10:00:40 +02:00
_NMC_GENERIC_INFO_TYPE_CON_SHOW_NUM,
NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_NAME = 0,
NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_UUID,
NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_DEVICES,
NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_IP_IFACE,
NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_STATE,
NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_DEFAULT,
NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_DEFAULT6,
NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_SPEC_OBJECT,
NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_VPN,
NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_DBUS_PATH,
NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_CON_PATH,
NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_ZONE,
NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_MASTER_PATH,
_NMC_GENERIC_INFO_TYPE_CON_ACTIVE_GENERAL_NUM,
NMC_GENERIC_INFO_TYPE_CON_VPN_TYPE = 0,
NMC_GENERIC_INFO_TYPE_CON_VPN_USERNAME,
NMC_GENERIC_INFO_TYPE_CON_VPN_GATEWAY,
NMC_GENERIC_INFO_TYPE_CON_VPN_BANNER,
NMC_GENERIC_INFO_TYPE_CON_VPN_VPN_STATE,
NMC_GENERIC_INFO_TYPE_CON_VPN_CFG,
_NMC_GENERIC_INFO_TYPE_CON_ACTIVE_VPN_NUM,
2018-04-26 20:28:02 +02:00
NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_DEVICE = 0,
NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_TYPE,
NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_STATE,
NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_IP4_CONNECTIVITY,
NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_IP6_CONNECTIVITY,
2018-04-26 20:28:02 +02:00
NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_DBUS_PATH,
NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_CONNECTION,
NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_CON_UUID,
NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_CON_PATH,
_NMC_GENERIC_INFO_TYPE_DEVICE_STATUS_NUM,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_DEVICE = 0,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_TYPE,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_NM_TYPE,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_DBUS_PATH,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_VENDOR,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_PRODUCT,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_DRIVER,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_DRIVER_VERSION,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_FIRMWARE_VERSION,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_HWADDR,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_MTU,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_STATE,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_REASON,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_IP4_CONNECTIVITY,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_IP6_CONNECTIVITY,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_UDI,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_PATH,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_IP_IFACE,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_IS_SOFTWARE,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_NM_MANAGED,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_AUTOCONNECT,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_FIRMWARE_MISSING,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_NM_PLUGIN_MISSING,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_PHYS_PORT_ID,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_CONNECTION,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_CON_UUID,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_CON_PATH,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_METERED,
_NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_GENERAL_NUM,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_CONNECTIONS_AVAILABLE_CONNECTION_PATHS = 0,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_CONNECTIONS_AVAILABLE_CONNECTIONS,
_NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_CONNECTIONS_NUM,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_CAPABILITIES_CARRIER_DETECT = 0,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_CAPABILITIES_SPEED,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_CAPABILITIES_IS_SOFTWARE,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_CAPABILITIES_SRIOV,
_NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_CAPABILITIES_NUM,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIRED_PROPERTIES_CARRIER = 0,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIRED_PROPERTIES_S390_SUBCHANNELS,
_NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIRED_PROPERTIES_NUM,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_WEP = 0,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_WPA,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_WPA2,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_TKIP,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_CCMP,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_AP,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_ADHOC,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_2GHZ,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_5GHZ,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_MESH,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_IBSS_RSN,
_NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_WIFI_PROPERTIES_NUM,
2019-10-10 10:45:36 +02:00
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_INTERFACE_FLAGS_UP = 0,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_INTERFACE_FLAGS_LOWER_UP,
NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_INTERFACE_FLAGS_CARRIER,
2019-10-10 10:45:36 +02:00
_NMC_GENERIC_INFO_TYPE_DEVICE_DETAIL_INTERFACE_FLAGS_NUM,
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
} NmcGenericInfoType;
#define NMC_HANDLE_COLOR(color) \
G_STMT_START \
{ \
if (get_type == NM_META_ACCESSOR_GET_TYPE_COLOR) \
return GINT_TO_POINTER(color); \
} \
G_STMT_END
struct _NmcMetaGenericInfo {
union {
NMObjBaseInst parent;
const NMMetaType *meta_type;
};
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
NmcGenericInfoType info_type;
const char * name;
const char * name_header;
const NmcMetaGenericInfo *const *nested;
#define NMC_META_GENERIC_INFO_GET_FCN_ARGS \
const NMMetaEnvironment *environment, gpointer environment_user_data, \
const NmcMetaGenericInfo *info, gpointer target, gpointer target_data, \
NMMetaAccessorGetType get_type, NMMetaAccessorGetFlags get_flags, \
NMMetaAccessorGetOutFlags *out_flags, gboolean *out_is_default, gpointer *out_to_free
gconstpointer (*get_fcn)(NMC_META_GENERIC_INFO_GET_FCN_ARGS);
};
#define NMC_META_GENERIC(n, ...) \
(&((NmcMetaGenericInfo){.meta_type = &nmc_meta_type_generic_info, .name = n, __VA_ARGS__}))
#define NMC_META_GENERIC_WITH_NESTED(n, nest, ...) \
NMC_META_GENERIC(n, .nested = (nest), __VA_ARGS__)
#define NMC_META_GENERIC_GROUP(_group_name, _nested, _name_header) \
((const NMMetaAbstractInfo *const *) ((const NmcMetaGenericInfo *const[]){ \
NMC_META_GENERIC_WITH_NESTED(_group_name, _nested, .name_header = _name_header), \
NULL, \
}))
static inline const char *
nmc_meta_generic_get_str_i18n(const char *s, NMMetaAccessorGetType get_type)
{
if (!NM_IN_SET(get_type, NM_META_ACCESSOR_GET_TYPE_PRETTY, NM_META_ACCESSOR_GET_TYPE_PARSABLE))
g_return_val_if_reached(NULL);
if (!s)
return NULL;
if (get_type == NM_META_ACCESSOR_GET_TYPE_PRETTY)
return gettext(s);
return s;
}
static inline const char *
nmc_meta_generic_get_str_i18n_null(const char *s, NMMetaAccessorGetType get_type)
{
if (get_type == NM_META_ACCESSOR_GET_TYPE_PARSABLE) {
/* in parsable mode, return NULL. That is useful if @s is a pretty string
* to describe a missing value (like "(unknown)"). We don't want to print
* that for parsable mode. */
return NULL;
}
return nmc_meta_generic_get_str_i18n(s, get_type);
}
static inline const char *
nmc_meta_generic_get_unknown(NMMetaAccessorGetType get_type)
{
return nmc_meta_generic_get_str_i18n_null(N_("(unknown)"), get_type);
}
static inline const char *
nmc_meta_generic_get_bool(gboolean val, NMMetaAccessorGetType get_type)
{
return nmc_meta_generic_get_str_i18n(val ? N_("yes") : N_("no"), get_type);
}
static inline const char *
nmc_meta_generic_get_bool_onoff(gboolean val, NMMetaAccessorGetType get_type)
{
return nmc_meta_generic_get_str_i18n(val ? N_("on") : N_("off"), get_type);
}
typedef enum {
NMC_META_GENERIC_GET_ENUM_TYPE_PARENTHESES,
NMC_META_GENERIC_GET_ENUM_TYPE_DASH,
} NmcMetaGenericGetEnumType;
static inline char *
nmc_meta_generic_get_enum_with_detail(NmcMetaGenericGetEnumType get_enum_type,
gint64 enum_val,
const char * str_val,
NMMetaAccessorGetType get_type)
{
if (!NM_IN_SET(get_type, NM_META_ACCESSOR_GET_TYPE_PRETTY, NM_META_ACCESSOR_GET_TYPE_PARSABLE))
g_return_val_if_reached(NULL);
if (!str_val) {
/* Pass %NULL for only printing the numeric value. */
return g_strdup_printf("%lld", (long long) enum_val);
}
switch (get_enum_type) {
case NMC_META_GENERIC_GET_ENUM_TYPE_PARENTHESES:
/* note that this function will always print "$NUM ($NICK)", also in PARSABLE
* mode. That might not be desired, but it's done for certain properties to preserve
* previous behavior. */
if (get_type == NM_META_ACCESSOR_GET_TYPE_PRETTY)
return g_strdup_printf(_("%lld (%s)"), (long long) enum_val, gettext(str_val));
return g_strdup_printf("%lld (%s)", (long long) enum_val, str_val);
case NMC_META_GENERIC_GET_ENUM_TYPE_DASH:
/* note that this function will always print "$NUM ($NICK)", also in PARSABLE
* mode. That might not be desired, but it's done for certain properties to preserve
* previous behavior. */
if (get_type == NM_META_ACCESSOR_GET_TYPE_PRETTY)
return g_strdup_printf(_("%lld - %s"), (long long) enum_val, gettext(str_val));
return g_strdup_printf("%lld - %s", (long long) enum_val, str_val);
}
g_return_val_if_reached(NULL);
}
/*****************************************************************************/
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
gboolean nmc_print(const NmcConfig * nmc_config,
gpointer const * targets,
gpointer targets_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
const char * header_name_no_l10n,
const NMMetaAbstractInfo *const *fields,
const char * fields_str,
GError ** error);
/*****************************************************************************/
2010-02-25 09:52:30 -08:00
#endif /* NMC_UTILS_H */