bstr.h

   1 /*
   2  * This file is part of MPlayer.
   3  *
   4  * MPlayer is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * MPlayer is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with MPlayer; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  */
  18
  19 #ifndef MPLAYER_BSTR_H
  20 #define MPLAYER_BSTR_H
  21
  22 #include <stdint.h>
  23 #include <stddef.h>
  24 #include <string.h>
  25 #include <stdbool.h>
  26
  27 #include "talloc.h"
  28
  29 /* NOTE: 'len' is size_t, but most string-handling functions below assume
  30  * that input size has been sanity checked and len fits in an int.
  31  */
  32 struct bstr {
  33     unsigned char *start;
  34     size_t len;
  35 };
  36
  37 // If str.start is NULL, return NULL.
  38 static inline char *bstrdup0(void *talloc_ctx, struct bstr str)
  39 {
  40     return talloc_strndup(talloc_ctx, (char *)str.start, str.len);
  41 }
  42
  43 // Return start = NULL iff that is true for the original.
  44 static inline struct bstr bstrdup(void *talloc_ctx, struct bstr str)
  45 {
  46     struct bstr r = { NULL, str.len };
  47     if (str.start)
  48         r.start = talloc_memdup(talloc_ctx, str.start, str.len);
  49     return r;
  50 }
  51
  52 static inline struct bstr bstr(const unsigned char *s)
  53 {
  54     return (struct bstr){(unsigned char *)s, s ? strlen(s) : 0};
  55 }
  56
  57 int bstrcmp(struct bstr str1, struct bstr str2);
  58 int bstrcasecmp(struct bstr str1, struct bstr str2);
  59 int bstrchr(struct bstr str, int c);
  60 int bstrrchr(struct bstr str, int c);
  61 int bstrcspn(struct bstr str, const char *reject);
  62
  63 int bstr_find(struct bstr haystack, struct bstr needle);
  64 struct bstr *bstr_splitlines(void *talloc_ctx, struct bstr str);
  65 struct bstr bstr_getline(struct bstr str, struct bstr *rest);
  66 struct bstr bstr_lstrip(struct bstr str);
  67 struct bstr bstr_strip(struct bstr str);
  68 struct bstr bstr_split(struct bstr str, const char *sep, struct bstr *rest);
  69 struct bstr bstr_splice(struct bstr str, int start, int end);
  70 long long bstrtoll(struct bstr str, struct bstr *rest, int base);
  71 double bstrtod(struct bstr str, struct bstr *rest);
  72 void bstr_lower(struct bstr str);
  73 int bstr_sscanf(struct bstr str, const char *format, ...);
  74
  75 // Decode the UTF-8 code point at the start of the string,, and return the
  76 // character.
  77 // After calling this function, *out_next will point to the next character.
  78 // out_next can be NULL.
  79 // On error, -1 is returned, and *out_next is not modified.
  80 int bstr_decode_utf8(struct bstr str, struct bstr *out_next);
  81
  82 // Return the length of the UTF-8 sequence that starts with the given byte.
  83 // Given a string char *s, the next UTF-8 code point is to be expected at
  84 //      s + bstr_parse_utf8_code_length(s[0])
  85 // On error, -1 is returned. On success, it returns a value in the range [1, 4].
  86 int bstr_parse_utf8_code_length(unsigned char b);
  87
  88 // If s starts with prefix, return true and return the rest of the string in s.
  89 bool bstr_eatstart(struct bstr *s, struct bstr prefix);
  90
  91 static inline struct bstr bstr_cut(struct bstr str, int n)
  92 {
  93     if (n > str.len)
  94         n = str.len;
  95     return (struct bstr){str.start + n, str.len - n};
  96 }
  97
  98 static inline bool bstr_startswith(struct bstr str, struct bstr prefix)
  99 {
 100     if (str.len < prefix.len)
 101         return false;
 102     return !memcmp(str.start, prefix.start, prefix.len);
 103 }
 104
 105 static inline bool bstr_startswith0(struct bstr str, const char *prefix)
 106 {
 107     return bstr_startswith(str, bstr(prefix));
 108 }
 109
 110 static inline bool bstr_endswith(struct bstr str, struct bstr suffix)
 111 {
 112     if (str.len < suffix.len)
 113         return false;
 114     return !memcmp(str.start + str.len - suffix.len, suffix.start, suffix.len);
 115 }
 116
 117 static inline bool bstr_endswith0(struct bstr str, const char *suffix)
 118 {
 119     return bstr_endswith(str, bstr(suffix));
 120 }
 121
 122 static inline int bstrcmp0(struct bstr str1, const char *str2)
 123 {
 124     return bstrcmp(str1, bstr(str2));
 125 }
 126
 127 static inline int bstrcasecmp0(struct bstr str1, const char *str2)
 128 {
 129     return bstrcasecmp(str1, bstr(str2));
 130 }
 131
 132 static inline int bstr_find0(struct bstr haystack, const char *needle)
 133 {
 134     return bstr_find(haystack, bstr(needle));
 135 }
 136
 137 static inline int bstr_eatstart0(struct bstr *s, char *prefix)
 138 {
 139     return bstr_eatstart(s, bstr(prefix));
 140 }
 141
 142
 143 // create a pair (not single value!) for "%.*s" printf syntax
 144 #define BSTR_P(bstr) (int)((bstr).len), (bstr).start
 145
 146 #define WHITESPACE " \f\n\r\t\v"
 147
 148 #endif /* MPLAYER_BSTR_H */