NetworkManager/src/nmcli/common.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Copyright (C) 2012 - 2014 Red Hat, Inc.
 */

#ifndef NMC_COMMON_H
#define NMC_COMMON_H

#include "nmcli.h"
#include "libnmc-base/nm-secret-agent-simple.h"

gboolean print_ip_config(NMIPConfig      *cfg,
                         int              addr_family,
                         const NmcConfig *nmc_config,
                         const char      *one_field);

gboolean print_dhcp_config(NMDhcpConfig    *dhcp,
                           int              addr_family,
                           const NmcConfig *nmc_config,
                           const char      *one_field);

NMConnection *nmc_find_connection(const GPtrArray *connections,
                                  const char      *filter_type,
                                  const char      *filter_val,
                                  GPtrArray      **out_result,
                                  gboolean         complete);

NMActiveConnection *nmc_find_active_connection(const GPtrArray *active_cons,
                                               const char      *filter_type,
                                               const char      *filter_val,
                                               GPtrArray      **out_result,
                                               gboolean         complete);

void nmc_secrets_requested(NMSecretAgentSimple *agent,
                           const char          *request_id,
                           const char          *title,
                           const char          *msg,
                           GPtrArray           *secrets,
                           gpointer             user_data);

char *nmc_unique_connection_name(const GPtrArray *connections, const char *try_name);

void  nmc_cleanup_readline(void);
char *nmc_readline(const NmcConfig *nmc_config, const char *prompt_fmt, ...) G_GNUC_PRINTF(2, 3);
char *nmc_readline_echo(const NmcConfig *nmc_config, gboolean echo_on, const char *prompt_fmt, ...)
    G_GNUC_PRINTF(3, 4);
NmcCompEntryFunc nmc_rl_compentry_func_wrap(const char *const *values);
char            *nmc_rl_gen_func_basic(const char *text, int state, const char *const *words);
char            *nmc_rl_gen_func_ifnames(const char *text, int state);
gboolean         nmc_get_in_readline(void);
void             nmc_set_in_readline(gboolean in_readline);

#if HAVE_EDITLINE_READLINE
/* libedit has different signature for rl_startup_hook function */
#define _NMC_RL_STARTUPHOOK_ARGS const char *c, int i
#else
/* By default the libreadline shall be used */
#define _NMC_RL_STARTUPHOOK_ARGS void
#endif

/* for pre-filling a string to readline prompt */
extern char *nmc_rl_pre_input_deftext;
int          nmc_rl_set_deftext(_NMC_RL_STARTUPHOOK_ARGS);

char *nmc_parse_lldp_capabilities(guint value);

void
nmc_do_cmd(NmCli *nmc, const NMCCommand cmds[], const char *cmd, int argc, const char *const *argv);

void nmc_complete_strv(const char *prefix, gssize nargs, const char *const *args);

#define nmc_complete_strings(prefix, ...) \
    nmc_complete_strv((prefix), NM_NARG(__VA_ARGS__), (const char *const[]){__VA_ARGS__})

void nmc_complete_bool(const char *prefix);

const char *nmc_error_get_simple_message(GError *error);

extern const NmcMetaGenericInfo *const metagen_ip4_config[];
extern const NmcMetaGenericInfo *const metagen_ip6_config[];
extern const NmcMetaGenericInfo *const metagen_dhcp_config[];

const char *nm_connectivity_to_string(NMConnectivityState connectivity);
#endif /* NMC_COMMON_H */