include/linux/string_helpers.h

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