
Return a boolean to indicate whether the value is the default one, so that the caller can choose to hide it.
179 lines
7.3 KiB
C
179 lines
7.3 KiB
C
/* nmcli - command-line tool to control NetworkManager
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*
|
|
* Copyright 2010 - 2017 Red Hat, Inc.
|
|
*/
|
|
|
|
#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, char ***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, char ***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);
|
|
void nmc_terminal_spawn_pager (const NmcConfig *nmc_config);
|
|
gboolean nmc_term_use_colors (NmcColorOption color_option);
|
|
const char *nmc_term_color_sequence (NMMetaTermColor color);
|
|
const char *nmc_term_format_sequence (NMMetaTermFormat format);
|
|
NMMetaTermColor nmc_term_color_parse_string (const char *str, GError **error);
|
|
char *nmc_colorize (NmcColorOption color_option, NMMetaTermColor color, NMMetaTermFormat format, const char * fmt, ...) _nm_printf (4, 5);
|
|
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[], NMMetaTermColor color);
|
|
void set_val_color_fmt_all (NmcOutputField fields_array[], NMMetaTermFormat format);
|
|
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,
|
|
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,
|
|
const GArray *indices,
|
|
const char *header_name,
|
|
int indent,
|
|
const NmcOutputData *out);
|
|
|
|
/*****************************************************************************/
|
|
|
|
extern const NMMetaEnvironment *const nmc_meta_environment;
|
|
extern NmCli *const nmc_meta_environment_arg;
|
|
|
|
typedef enum {
|
|
|
|
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,
|
|
|
|
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,
|
|
|
|
} NmcGenericInfoType;
|
|
|
|
#define NMC_HANDLE_TERMFORMAT(color) \
|
|
G_STMT_START { \
|
|
if (get_type == NM_META_ACCESSOR_GET_TYPE_TERMFORMAT) \
|
|
return nm_meta_termformat_pack ((color), NM_META_TERM_FORMAT_NORMAL); \
|
|
} G_STMT_END
|
|
|
|
struct _NmcMetaGenericInfo {
|
|
union {
|
|
NMObjBaseInst parent;
|
|
const NMMetaType *meta_type;
|
|
};
|
|
NmcGenericInfoType info_type;
|
|
const char *name;
|
|
const char *name_header;
|
|
const NmcMetaGenericInfo *const*nested;
|
|
gconstpointer (*get_fcn) (const NMMetaEnvironment *environment,
|
|
gpointer environment_user_data,
|
|
const NmcMetaGenericInfo *info,
|
|
gpointer target,
|
|
NMMetaAccessorGetType get_type,
|
|
NMMetaAccessorGetFlags get_flags,
|
|
NMMetaAccessorGetOutFlags *out_flags,
|
|
gboolean *out_is_default,
|
|
gpointer *out_to_free);
|
|
};
|
|
|
|
#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__)
|
|
|
|
/*****************************************************************************/
|
|
|
|
gboolean nmc_print (const NmcConfig *nmc_config,
|
|
gpointer const *targets,
|
|
const char *header_name_no_l10n,
|
|
const NMMetaAbstractInfo *const*fields,
|
|
const char *fields_str,
|
|
GError **error);
|
|
|
|
/*****************************************************************************/
|
|
|
|
#endif /* NMC_UTILS_H */
|