X-Git-Url: https://git.ozlabs.org/?a=blobdiff_plain;f=ccan%2Fbytestring%2Fbytestring.h;h=bc99e7951c739e94221148e12491ea994642fbae;hb=0fe2d094b262f6e8bed798930e8c4716d33d5dc7;hp=abc7dd7bb0424bb684bdd5000006cfce97cc8578;hpb=4008ec0eb0f9a42827db7dd36d6e00d3c50409e7;p=ccan diff --git a/ccan/bytestring/bytestring.h b/ccan/bytestring/bytestring.h index abc7dd7b..bc99e795 100644 --- a/ccan/bytestring/bytestring.h +++ b/ccan/bytestring/bytestring.h @@ -2,12 +2,16 @@ #ifndef CCAN_BYTESTRING_H_ #define CCAN_BYTESTRING_H_ +#include "config.h" + #include #include #include #include #include +#include +#include struct bytestring { const char *ptr; @@ -26,7 +30,8 @@ struct bytestring { * struct bytestring bs = bytestring(x, 5); * assert(bs.len == 5); */ -static inline struct bytestring bytestring(const char *p, size_t l) +static inline CONST_FUNCTION struct bytestring +bytestring(const char *p, size_t l) { struct bytestring bs = { .ptr = p, @@ -50,6 +55,18 @@ static inline struct bytestring bytestring(const char *p, size_t l) */ #define BYTESTRING(s) (bytestring((s), ARRAY_SIZE(s) - 1)) +/** + * BYTESTRING_INIT - bytestring initializer + * @s: string literal + * + * Produces an initializer for a bytestring from a literal string. + * The resulting bytestring will not include the terminating \0, but + * will include any internal \0s. + * + * Example: + * static const struct bytestring CONSTANT = BYTESTRING_INIT("CONSTANT"); + */ +#define BYTESTRING_INIT(s) { .ptr = (s), .len = ARRAY_SIZE(s) - 1} /** * bytestring_from_string - construct a bytestring from a NUL terminated string @@ -77,8 +94,7 @@ static inline struct bytestring bytestring_from_string(const char *s) */ static inline bool bytestring_eq(struct bytestring a, struct bytestring b) { - return (a.len == b.len) - && (memcmp(a.ptr, b.ptr, a.len) == 0); + return memeq(a.ptr, a.len, b.ptr, b.len); } /** @@ -122,4 +138,181 @@ static inline struct bytestring bytestring_slice(struct bytestring s, return bytestring(s.ptr + start, end - start); } +/** + * bytestring_starts - test if the start of one bytestring matches another + * @s, @prefix: bytestrings + * + * Returns true if @prefix appears as a substring at the beginning of + * @s, false otherwise. + */ +static inline bool bytestring_starts(struct bytestring s, + struct bytestring prefix) +{ + return memstarts(s.ptr, s.len, prefix.ptr, prefix.len); +} + +/** + * bytestring_ends - test if the end of one bytestring matches another + * @s, @suffix: bytestrings + * + * Returns true if @suffix appears as a substring at the end of @s, + * false otherwise. + */ +static inline bool bytestring_ends(struct bytestring s, + struct bytestring suffix) +{ + return memends(s.ptr, s.len, suffix.ptr, suffix.len); +} + +/** + * bytestring_index - locate character in bytestring + * @haystack: a bytestring + * @needle: a character or byte value + * + * Returns a pointer to the first occurrence of @needle within + * @haystack, or NULL if @needle does not appear in @haystack. + */ +static inline const char *bytestring_index(struct bytestring haystack, + char needle) +{ + return memchr(haystack.ptr, needle, haystack.len); +} + +/** + * bytestring_rindex - locate character in bytestring + * @haystack: a bytestring + * @needle: a character or byte value + * + * Returns a pointer to the last occurrence of @needle within + * @haystack, or NULL if @needle does not appear in @haystack. + */ +static inline const char *bytestring_rindex(struct bytestring haystack, + char needle) +{ + return memrchr(haystack.ptr, needle, haystack.len); +} + +/* + * bytestring_bytestring - search for a bytestring in another bytestring + * @haystack, @needle: bytestrings + * + * Returns a bytestring corresponding to the first occurrence of + * @needle in @haystack, or bytestring_NULL if @needle is not found + * within @haystack. + */ +static inline struct bytestring bytestring_bytestring(struct bytestring haystack, + struct bytestring needle) +{ + const char *p = memmem(haystack.ptr, haystack.len, + needle.ptr, needle.len); + if (p) + return bytestring(p, needle.len); + else + return bytestring_NULL; +} + +/** + * bytestring_spn - search a bytestring for a set of bytes + * @s: a bytestring + * @accept: a bytestring containing a set of bytes to accept + * + * Returns the length, in bytes, of the initial segment of @s which + * consists entirely of characters in @accept. + */ +size_t bytestring_spn(struct bytestring s, struct bytestring accept); + +/** + * bytestring_cspn - search a bytestring for a set of bytes (complemented) + * @s: a bytestring + * @reject: a bytestring containing a set of bytes to reject + * + * Returns the length, in bytes, of the initial segment of @s which + * consists entirely of characters not in @reject. + */ +size_t bytestring_cspn(struct bytestring s, struct bytestring reject); + +/** + * bytestring_splitchr_first - split a bytestring on a single character delimiter + * @whole: a bytestring + * @delim: delimiter character + * + * Returns the first @delim delimited substring of @whole. + */ +struct bytestring bytestring_splitchr_first(struct bytestring whole, + char delim); + +/** + * bytestring_splitchr_next - split a bytestring on a single character delimiter + * @whole: a bytestring + * @delim: delimiter character + * @prev: last substring + * + * Returns the next @delim delimited substring of @whole after @prev. + */ +struct bytestring bytestring_splitchr_next(struct bytestring whole, + char delim, struct bytestring prev); + +#define bytestring_foreach_splitchr(_s, _w, _delim) \ + for ((_s) = bytestring_splitchr_first((_w), (_delim)); \ + (_s).ptr; \ + (_s) = bytestring_splitchr_next((_w), (_delim), (_s))) + +/** + * bytestring_splitchrs_first - split a bytestring on a set of delimiter + * characters + * @whole: a bytestring + * @delim: delimiter characters + * + * Returns the first substring of @whole delimited by any character in + * @delim. + */ +struct bytestring bytestring_splitchrs_first(struct bytestring whole, + struct bytestring delim); + +/** + * bytestring_splitchr_next - split a bytestring on a set of delimiter + * characters + * @whole: a bytestring + * @delim: delimiter character + * @prev: last substring + * + * Returns the next @delim delimited substring of @whole after @prev. + */ +struct bytestring bytestring_splitchrs_next(struct bytestring whole, + struct bytestring delim, + struct bytestring prev); + +#define bytestring_foreach_splitchrs(_s, _w, _delim) \ + for ((_s) = bytestring_splitchrs_first((_w), (_delim)); \ + (_s).ptr; \ + (_s) = bytestring_splitchrs_next((_w), (_delim), (_s))) + +/** + * bytestring_splitstr_first - split a bytestring on a delimiter string + * @whole: a bytestring + * @delim: delimiter substring + * + * Returns the first substring of @whole delimited by the substring in + * @delim. + */ +struct bytestring bytestring_splitstr_first(struct bytestring whole, + struct bytestring delim); + +/** + * bytestring_splitstr_next - split a bytestring on a delimiter string + * @whole: a bytestring + * @delim: delimiter string + * @prev: last substring + * + * Returns the next @delim delimited substring of @whole after @prev. + */ +struct bytestring bytestring_splitstr_next(struct bytestring whole, + struct bytestring delim, + struct bytestring prev); + +#define bytestring_foreach_splitstr(_s, _w, _delim) \ + for ((_s) = bytestring_splitstr_first((_w), (_delim)); \ + (_s).ptr; \ + (_s) = bytestring_splitstr_next((_w), (_delim), (_s))) + #endif /* CCAN_BYTESTRING_H_ */