forked from mirrors/linux
ea4692c75e
There are a few implementations of string helpers in the tree like yesno() that just returns "yes" or "no" depending on a boolean argument. Those are helpful to output strings to the user or log. In order to consolidate them, prefix all of them str_ prefix to make it clear what they are about and avoid symbol clashes. Taking the commoon `val ? "yes" : "no"` implementation, quite a few users of open coded yesno() could later be converted to the new function: $ git grep '?\s*"yes"\s*' | wc -l 286 $ git grep '?\s*"no"\s*' | wc -l 20 The inlined function should keep the const strings local to each compilation unit, the same way it's now, thus not changing the current behavior. Signed-off-by: Lucas De Marchi <lucas.demarchi@intel.com> Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com> Acked-by: Jani Nikula <jani.nikula@intel.com> Acked-by: Daniel Vetter <daniel.vetter@ffwll.ch> Link: https://patchwork.freedesktop.org/patch/msgid/20220126093951.1470898-2-lucas.demarchi@intel.com
129 lines
3.2 KiB
C
129 lines
3.2 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
#ifndef _LINUX_STRING_HELPERS_H_
|
|
#define _LINUX_STRING_HELPERS_H_
|
|
|
|
#include <linux/bits.h>
|
|
#include <linux/ctype.h>
|
|
#include <linux/string.h>
|
|
#include <linux/types.h>
|
|
|
|
struct device;
|
|
struct file;
|
|
struct task_struct;
|
|
|
|
/* Descriptions of the types of units to
|
|
* print in */
|
|
enum string_size_units {
|
|
STRING_UNITS_10, /* use powers of 10^3 (standard SI) */
|
|
STRING_UNITS_2, /* use binary powers of 2^10 */
|
|
};
|
|
|
|
void string_get_size(u64 size, u64 blk_size, enum string_size_units units,
|
|
char *buf, int len);
|
|
|
|
#define UNESCAPE_SPACE BIT(0)
|
|
#define UNESCAPE_OCTAL BIT(1)
|
|
#define UNESCAPE_HEX BIT(2)
|
|
#define UNESCAPE_SPECIAL BIT(3)
|
|
#define UNESCAPE_ANY \
|
|
(UNESCAPE_SPACE | UNESCAPE_OCTAL | UNESCAPE_HEX | UNESCAPE_SPECIAL)
|
|
|
|
#define UNESCAPE_ALL_MASK GENMASK(3, 0)
|
|
|
|
int string_unescape(char *src, char *dst, size_t size, unsigned int flags);
|
|
|
|
static inline int string_unescape_inplace(char *buf, unsigned int flags)
|
|
{
|
|
return string_unescape(buf, buf, 0, flags);
|
|
}
|
|
|
|
static inline int string_unescape_any(char *src, char *dst, size_t size)
|
|
{
|
|
return string_unescape(src, dst, size, UNESCAPE_ANY);
|
|
}
|
|
|
|
static inline int string_unescape_any_inplace(char *buf)
|
|
{
|
|
return string_unescape_any(buf, buf, 0);
|
|
}
|
|
|
|
#define ESCAPE_SPACE BIT(0)
|
|
#define ESCAPE_SPECIAL BIT(1)
|
|
#define ESCAPE_NULL BIT(2)
|
|
#define ESCAPE_OCTAL BIT(3)
|
|
#define ESCAPE_ANY \
|
|
(ESCAPE_SPACE | ESCAPE_OCTAL | ESCAPE_SPECIAL | ESCAPE_NULL)
|
|
#define ESCAPE_NP BIT(4)
|
|
#define ESCAPE_ANY_NP (ESCAPE_ANY | ESCAPE_NP)
|
|
#define ESCAPE_HEX BIT(5)
|
|
#define ESCAPE_NA BIT(6)
|
|
#define ESCAPE_NAP BIT(7)
|
|
#define ESCAPE_APPEND BIT(8)
|
|
|
|
#define ESCAPE_ALL_MASK GENMASK(8, 0)
|
|
|
|
int string_escape_mem(const char *src, size_t isz, char *dst, size_t osz,
|
|
unsigned int flags, const char *only);
|
|
|
|
static inline int string_escape_mem_any_np(const char *src, size_t isz,
|
|
char *dst, size_t osz, const char *only)
|
|
{
|
|
return string_escape_mem(src, isz, dst, osz, ESCAPE_ANY_NP, only);
|
|
}
|
|
|
|
static inline int string_escape_str(const char *src, char *dst, size_t sz,
|
|
unsigned int flags, const char *only)
|
|
{
|
|
return string_escape_mem(src, strlen(src), dst, sz, flags, only);
|
|
}
|
|
|
|
static inline int string_escape_str_any_np(const char *src, char *dst,
|
|
size_t sz, const char *only)
|
|
{
|
|
return string_escape_str(src, dst, sz, ESCAPE_ANY_NP, only);
|
|
}
|
|
|
|
static inline void string_upper(char *dst, const char *src)
|
|
{
|
|
do {
|
|
*dst++ = toupper(*src);
|
|
} while (*src++);
|
|
}
|
|
|
|
static inline void string_lower(char *dst, const char *src)
|
|
{
|
|
do {
|
|
*dst++ = tolower(*src);
|
|
} while (*src++);
|
|
}
|
|
|
|
char *kstrdup_quotable(const char *src, gfp_t gfp);
|
|
char *kstrdup_quotable_cmdline(struct task_struct *task, gfp_t gfp);
|
|
char *kstrdup_quotable_file(struct file *file, gfp_t gfp);
|
|
|
|
char **kasprintf_strarray(gfp_t gfp, const char *prefix, size_t n);
|
|
void kfree_strarray(char **array, size_t n);
|
|
|
|
char **devm_kasprintf_strarray(struct device *dev, const char *prefix, size_t n);
|
|
|
|
static inline const char *str_yes_no(bool v)
|
|
{
|
|
return v ? "yes" : "no";
|
|
}
|
|
|
|
static inline const char *str_on_off(bool v)
|
|
{
|
|
return v ? "on" : "off";
|
|
}
|
|
|
|
static inline const char *str_enable_disable(bool v)
|
|
{
|
|
return v ? "enable" : "disable";
|
|
}
|
|
|
|
static inline const char *str_enabled_disabled(bool v)
|
|
{
|
|
return v ? "enabled" : "disabled";
|
|
}
|
|
|
|
#endif
|