linux/include/linux/string_helpers.h

/* 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_choices.h>
#include <linux/string.h>
#include <linux/types.h>

struct device;
struct file;
struct task_struct;

static inline bool string_is_terminated(const char *s, int len)
{ … }

/* Descriptions of the types of units to print in */
enum string_size_units { … };

int string_get_size(u64 size, u64 blk_size, const enum string_size_units units,
		    char *buf, int len);

int parse_int_array_user(const char __user *from, size_t count, int **array);

#define UNESCAPE_SPACE …
#define UNESCAPE_OCTAL …
#define UNESCAPE_HEX …
#define UNESCAPE_SPECIAL …
#define UNESCAPE_ANY …

#define UNESCAPE_ALL_MASK …

int string_unescape(char *src, char *dst, size_t size, unsigned int flags);

static inline int string_unescape_inplace(char *buf, unsigned int flags)
{ … }

static inline int string_unescape_any(char *src, char *dst, size_t size)
{ … }

static inline int string_unescape_any_inplace(char *buf)
{ … }

#define ESCAPE_SPACE …
#define ESCAPE_SPECIAL …
#define ESCAPE_NULL …
#define ESCAPE_OCTAL …
#define ESCAPE_ANY …
#define ESCAPE_NP …
#define ESCAPE_ANY_NP …
#define ESCAPE_HEX …
#define ESCAPE_NA …
#define ESCAPE_NAP …
#define ESCAPE_APPEND …

#define ESCAPE_ALL_MASK …

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)
{ … }

static inline int string_escape_str(const char *src, char *dst, size_t sz,
		unsigned int flags, const char *only)
{ … }

static inline int string_escape_str_any_np(const char *src, char *dst,
		size_t sz, const char *only)
{ … }

static inline void string_upper(char *dst, const char *src)
{ … }

static inline void string_lower(char *dst, const char *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 *kstrdup_and_replace(const char *src, char old, char new, 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);

#endif