str: change example to match function being explained.
[ccan] / ccan / str / str.h
index 70fe26c74fad3905b3acf2efd8ac0b792ba766a5..bf858f13b69cb1f671a895450004f36a6ad361cd 100644 (file)
@@ -11,7 +11,7 @@
  * This macro is arguably more readable than "!strcmp(a, b)".
  *
  * Example:
- *     if (streq(str, ""))
+ *     if (streq(somestring, ""))
  *             printf("String is empty!\n");
  */
 #define streq(a,b) (strcmp((a),(b)) == 0)
@@ -22,8 +22,8 @@
  * @prefix: prefix to look for at start of str
  *
  * Example:
- *     if (strstarts(str, "foo"))
- *             printf("String %s begins with 'foo'!\n", str);
+ *     if (strstarts(somestring, "foo"))
+ *             printf("String %s begins with 'foo'!\n", somestring);
  */
 #define strstarts(str,prefix) (strncmp((str),(prefix),strlen(prefix)) == 0)
 
@@ -33,8 +33,8 @@
  * @postfix: postfix to look for at end of str
  *
  * Example:
- *     if (strends(str, "foo"))
- *             printf("String %s end with 'foo'!\n", str);
+ *     if (strends(somestring, "foo"))
+ *             printf("String %s end with 'foo'!\n", somestring);
  */
 static inline bool strends(const char *str, const char *postfix)
 {
@@ -55,4 +55,18 @@ static inline bool strends(const char *str, const char *postfix)
 #define stringify(expr)                stringify_1(expr)
 /* Double-indirection required to stringify expansions */
 #define stringify_1(expr)      #expr
+
+/**
+ * strcount - Count number of (non-overlapping) occurrences of a substring.
+ * @haystack: a C string
+ * @needle: a substring
+ *
+ * Example:
+ *     int i;
+ *      i = strcount("aaa aaa", "a");  // i = 6;
+ *      i = strcount("aaa aaa", "ab"); // i = 0;
+ *      i = strcount("aaa aaa", "aa"); // i = 2;
+ */
+size_t strcount(const char *haystack, const char *needle);
+
 #endif /* CCAN_STR_H */