2020-12-23 22:21:36 +01:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0-or-later */
|
2019-09-25 13:13:40 +02:00
|
|
|
/*
|
2019-10-01 09:20:35 +02:00
|
|
|
* Copyright (C) 2010 - 2017 Red Hat, Inc.
|
2017-03-28 12:16:31 +02:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef __NM_CLIENT_UTILS_H__
|
|
|
|
|
#define __NM_CLIENT_UTILS_H__
|
|
|
|
|
|
all: move shared/nm-meta-setting.[hc] to libnm-core and clients
"shared/nm-meta-setting.[hc]" contains meta data about settings.
As such it is similarly used by libnm-core (as internal API) and
by clients (as extension of public API of libnm). However, it must
be compiled twice, because while it defines in both cases a
NMMetaSettingInfo type, these types are different between internal and
public API.
Hence, the files must also be compiled twice (and differently), once
against libnm-core and once against the client helper library.
Previously, the file was under "shared/", but there it's a bit odd
it doesn't clearly belong anywhere.
There are two goals here:
- copy the file to the two places where it is used. We also have
a "check-tree" unit test that ensures those files don't diverge in
the future.
- we no longer require CFLAGS set during built. Instead, the sources
should control the build. For that we have new (simple) headers
"nm-meta-setting-base.h" that define the right behavior for the
impl files.
There is still an ugliness (among several): the files must be named the
same for libnm-core and clients/common. Preferably, all our sources have
unique names, but that is not possible with this scheme (without
introducing other ugliness). To mitigate that, include the files only at
one exact place.
2021-02-07 10:53:44 +01:00
|
|
|
#include "nm-meta-setting-desc.h"
|
2017-10-12 15:27:55 +02:00
|
|
|
#include "nm-active-connection.h"
|
|
|
|
|
#include "nm-device.h"
|
shared: build helper "libnm-libnm-core-{intern|aux}.la" library for libnm-core
"libnm-core" implements common functionality for "NetworkManager" and
"libnm".
Note that clients like "nmcli" cannot access the internal API provided
by "libnm-core". So, if nmcli wants to do something that is also done by
"libnm-core", , "libnm", or "NetworkManager", the code would have to be
duplicated.
Instead, such code can be in "libnm-libnm-core-{intern|aux}.la".
Note that:
0) "libnm-libnm-core-intern.la" is used by libnm-core itsself.
On the other hand, "libnm-libnm-core-aux.la" is not used by
libnm-core, but provides utilities on top of it.
1) they both extend "libnm-core" with utlities that are not public
API of libnm itself. Maybe part of the code should one day become
public API of libnm. On the other hand, this is code for which
we may not want to commit to a stable interface or which we
don't want to provide as part of the API.
2) "libnm-libnm-core-intern.la" is statically linked by "libnm-core"
and thus directly available to "libnm" and "NetworkManager".
On the other hand, "libnm-libnm-core-aux.la" may be used by "libnm"
and "NetworkManager".
Both libraries may be statically linked by libnm clients (like
nmcli).
3) it must only use glib, libnm-glib-aux.la, and the public API
of libnm-core.
This is important: it must not use "libnm-core/nm-core-internal.h"
nor "libnm-core/nm-utils-private.h" so the static library is usable
by nmcli which couldn't access these.
Note that "shared/nm-meta-setting.c" is an entirely different case,
because it behaves differently depending on whether linking against
"libnm-core" or the client programs. As such, this file must be compiled
twice.
(cherry picked from commit af07ed01c04867e281cc3982a7ab0d244d4f8e2e)
2019-04-15 09:26:53 +02:00
|
|
|
#include "nm-libnm-core-intern/nm-libnm-core-utils.h"
|
2019-02-28 14:22:35 +01:00
|
|
|
|
2018-04-27 17:28:09 +02:00
|
|
|
const NMObject **nmc_objects_sort_by_path(const NMObject *const *objs, gssize len);
|
|
|
|
|
|
2017-03-28 12:16:31 +02:00
|
|
|
const char *nmc_string_is_valid(const char *input, const char **allowed, GError **error);
|
|
|
|
|
|
|
|
|
|
gboolean nmc_string_to_uint(const char * str,
|
|
|
|
|
gboolean range_check,
|
|
|
|
|
unsigned long int min,
|
|
|
|
|
unsigned long int max,
|
|
|
|
|
unsigned long int *value);
|
|
|
|
|
gboolean nmc_string_to_bool(const char *str, gboolean *val_bool, GError **error);
|
2018-08-01 17:59:21 +02:00
|
|
|
gboolean nmc_string_to_ternary(const char *str, NMTernary *val, GError **error);
|
2017-03-28 12:16:31 +02:00
|
|
|
|
|
|
|
|
gboolean matches(const char *cmd, const char *pattern);
|
|
|
|
|
|
2018-04-18 14:13:28 +02:00
|
|
|
/* FIXME: don't expose this function on its own, at least not from this file. */
|
2017-04-04 13:50:30 +02:00
|
|
|
const char *nmc_bond_validate_mode(const char *mode, GError **error);
|
|
|
|
|
|
2020-06-10 15:27:59 +02:00
|
|
|
const char *nmc_device_state_to_string_with_external(NMDevice *device);
|
|
|
|
|
|
2017-10-12 15:04:58 +02:00
|
|
|
const char *nm_active_connection_state_reason_to_string(NMActiveConnectionStateReason reason);
|
|
|
|
|
const char *nmc_device_state_to_string(NMDeviceState state);
|
|
|
|
|
const char *nmc_device_reason_to_string(NMDeviceStateReason reason);
|
|
|
|
|
const char *nmc_device_metered_to_string(NMMetered value);
|
|
|
|
|
|
2017-10-12 15:27:55 +02:00
|
|
|
NMActiveConnectionState nmc_activation_get_effective_state(NMActiveConnection *active,
|
|
|
|
|
NMDevice * device,
|
|
|
|
|
const char ** reason);
|
|
|
|
|
|
2017-12-15 16:46:07 +01:00
|
|
|
const char *nmc_wifi_strength_bars(guint8 strength);
|
|
|
|
|
|
2017-12-15 16:51:59 +01:00
|
|
|
const char *nmc_password_subst_char(void);
|
|
|
|
|
|
2019-09-11 16:45:12 +02:00
|
|
|
void nmc_print_qrcode(const char *str);
|
|
|
|
|
|
2020-05-04 16:33:59 +02:00
|
|
|
GHashTable *nmc_utils_parse_passwd_file(char *contents, gssize *out_error_line, GError **error);
|
|
|
|
|
|
2020-05-04 13:33:35 +02:00
|
|
|
GHashTable *
|
|
|
|
|
nmc_utils_read_passwd_file(const char *passwd_file, gssize *out_error_line, GError **error);
|
|
|
|
|
|
2017-03-28 12:16:31 +02:00
|
|
|
#endif /* __NM_CLIENT_UTILS_H__ */
|
