LXR linux/include/linux/string

   1#ifndef _LINUX_STRING_HELPERS_H_
   2#define _LINUX_STRING_HELPERS_H_
   3
   4#include <linux/types.h>
   5
   6struct file;
   7
   8/* Descriptions of the types of units to
   9 * print in */
  10enum string_size_units {
  11        STRING_UNITS_10,        /* use powers of 10^3 (standard SI) */
  12        STRING_UNITS_2,         /* use binary powers of 2^10 */
  13};
  14
  15void string_get_size(u64 size, u64 blk_size, enum string_size_units units,
  16                     char *buf, int len);
  17
  18#define UNESCAPE_SPACE          0x01
  19#define UNESCAPE_OCTAL          0x02
  20#define UNESCAPE_HEX            0x04
  21#define UNESCAPE_SPECIAL        0x08
  22#define UNESCAPE_ANY            \
  23        (UNESCAPE_SPACE | UNESCAPE_OCTAL | UNESCAPE_HEX | UNESCAPE_SPECIAL)
  24
  25int string_unescape(char *src, char *dst, size_t size, unsigned int flags);
  26
  27static inline int string_unescape_inplace(char *buf, unsigned int flags)
  28{
  29        return string_unescape(buf, buf, 0, flags);
  30}
  31
  32static inline int string_unescape_any(char *src, char *dst, size_t size)
  33{
  34        return string_unescape(src, dst, size, UNESCAPE_ANY);
  35}
  36
  37static inline int string_unescape_any_inplace(char *buf)
  38{
  39        return string_unescape_any(buf, buf, 0);
  40}
  41
  42#define ESCAPE_SPACE            0x01
  43#define ESCAPE_SPECIAL          0x02
  44#define ESCAPE_NULL             0x04
  45#define ESCAPE_OCTAL            0x08
  46#define ESCAPE_ANY              \
  47        (ESCAPE_SPACE | ESCAPE_OCTAL | ESCAPE_SPECIAL | ESCAPE_NULL)
  48#define ESCAPE_NP               0x10
  49#define ESCAPE_ANY_NP           (ESCAPE_ANY | ESCAPE_NP)
  50#define ESCAPE_HEX              0x20
  51
  52int string_escape_mem(const char *src, size_t isz, char *dst, size_t osz,
  53                unsigned int flags, const char *only);
  54
  55static inline int string_escape_mem_any_np(const char *src, size_t isz,
  56                char *dst, size_t osz, const char *only)
  57{
  58        return string_escape_mem(src, isz, dst, osz, ESCAPE_ANY_NP, only);
  59}
  60
  61static inline int string_escape_str(const char *src, char *dst, size_t sz,
  62                unsigned int flags, const char *only)
  63{
  64        return string_escape_mem(src, strlen(src), dst, sz, flags, only);
  65}
  66
  67static inline int string_escape_str_any_np(const char *src, char *dst,
  68                size_t sz, const char *only)
  69{
  70        return string_escape_str(src, dst, sz, ESCAPE_ANY_NP, only);
  71}
  72
  73char *kstrdup_quotable(const char *src, gfp_t gfp);
  74char *kstrdup_quotable_cmdline(struct task_struct *task, gfp_t gfp);
  75char *kstrdup_quotable_file(struct file *file, gfp_t gfp);
  76
  77#endif
  78