mem: add memends_str() helper for symmetry

[ccan] / ccan / mem / mem.h

diff --git a/ccan/mem/mem.h b/ccan/mem/mem.h
index 89b16d42a155990587bda108c5b970903f5c22b2..1afe508b3a097beefdbf93660165c7146fdb3f25 100644 (file)
--- a/ccan/mem/mem.h
+++ b/ccan/mem/mem.h
@@ -3,16 +3,19 @@
 #define CCAN_MEM_H
 
 #include "config.h"
+#include <ccan/compiler/compiler.h>
 
 #include <string.h>
 #include <stdbool.h>
 
 #if !HAVE_MEMMEM
+PURE_FUNCTION
 void *memmem(const void *haystack, size_t haystacklen,
             const void *needle, size_t needlelen);
 #endif
 
 #if !HAVE_MEMRCHR
+PURE_FUNCTION
 void *memrchr(const void *s, int c, size_t n);
 #endif
 
@@ -37,6 +40,7 @@ void *memrchr(const void *s, int c, size_t n);
  *     }
  *
  */
+PURE_FUNCTION
 void *mempbrkm(const void *data, size_t len, const void *accept, size_t accept_len);
 
 /**
@@ -57,6 +61,7 @@ void *mempbrkm(const void *data, size_t len, const void *accept, size_t accept_l
  *             printf("Nada\n");
  *     }
  */
+PURE_FUNCTION
 static inline char *mempbrk(const void *data, size_t len, const char *accept)
 {
        return mempbrkm(data, len, accept, strlen(accept));
@@ -81,6 +86,7 @@ static inline char *mempbrk(const void *data, size_t len, const char *accept)
  *             printf("Found %c after trimming spaces\n", *r);
  *     }
  */
+PURE_FUNCTION
 void *memcchr(void const *data, int c, size_t data_len);
 
 /**
@@ -95,6 +101,7 @@ void *memcchr(void const *data, int c, size_t data_len);
  *             printf("memory blocks are the same!\n");
  *     }
  */
+PURE_FUNCTION
 static inline bool memeq(const void *a, size_t al, const void *b, size_t bl)
 {
        return al == bl && !memcmp(a, b, bl);
@@ -114,6 +121,7 @@ static inline bool memeq(const void *a, size_t al, const void *b, size_t bl)
  *             printf("somebytes starts with otherbytes!\n");
  *     }
  */
+PURE_FUNCTION
 static inline bool memstarts(void const *data, size_t data_len,
                void const *prefix, size_t prefix_len)
 {
@@ -135,6 +143,7 @@ static inline bool memstarts(void const *data, size_t data_len,
  *             printf("somebytes == 'foo'!\n");
  *     }
  */
+PURE_FUNCTION
 static inline bool memeqstr(const void *data, size_t length, const char *string)
 {
        return memeq(data, length, string, strlen(string));
@@ -151,6 +160,7 @@ static inline bool memeqstr(const void *data, size_t length, const char *string)
  *             printf("somebytes starts with 'It'\n");
  *     }
  */
+PURE_FUNCTION
 static inline bool memstarts_str(const void *a, size_t al, const char *s)
 {
        return memstarts(a, al, s, strlen(s));
@@ -166,10 +176,28 @@ static inline bool memstarts_str(const void *a, size_t al, const char *s)
  * Returns true if @suffix appears as a substring at the end of @s,
  * false otherwise.
  */
+PURE_FUNCTION
 static inline bool memends(const void *s, size_t s_len, const void *suffix, size_t suffix_len)
 {
        return (s_len >= suffix_len) && (memcmp((const char *)s + s_len - suffix_len,
                                                suffix, suffix_len) == 0);
 }
 
+/**
+ * memends_str - Does this byte array end with a string suffix?
+ * @a: byte array
+ * @al: length in bytes
+ * @s: string suffix
+ *
+ * Example:
+ *     if (memends_str(somebytes, bytes_len, "It")) {
+ *             printf("somebytes ends with with 'It'\n");
+ *     }
+ */
+PURE_FUNCTION
+static inline bool memends_str(const void *a, size_t al, const char *s)
+{
+       return memends(a, al, s, strlen(s));
+}
+
 #endif /* CCAN_MEM_H */