Source Format Enforcement (#763)

[thirdparty/squid.git] / src / StrList.h

diff --git a/src/StrList.h b/src/StrList.h
index fa1af23afc1f9e4b656142149314677dae0bb386..18c4e23d2e5e6b9d5c30967aa5af7410a1eee1ee 100644 (file)
--- a/src/StrList.h
+++ b/src/StrList.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1996-2017 The Squid Software Foundation and contributors
+ * Copyright (C) 1996-2021 The Squid Software Foundation and contributors
  *
  * Squid software is distributed under GPLv2+ license and includes
  * contributions from numerous individuals and organizations.
@@ -11,12 +11,31 @@
 #ifndef SQUID_STRLIST_H_
 #define SQUID_STRLIST_H_
 
+#include "sbuf/forward.h"
+
+#include <iterator>
+
 class String;
 
+/// Appends the given item to a delimiter-separated list in str.
 void strListAdd(String * str, const char *item, char del);
-int strListIsMember(const String * str, const char *item, char del);
+
+/// Appends the given item of a given size to a delimiter-separated list in str.
+void strListAdd(String &str, const char *item, const size_t itemSize, const char del = ',');
+
+/// Appends the given item to a delimiter-separated list in str.
+/// Use strListAdd(c-string) for c-string items with unknown length.
+void strListAdd(String &str, const SBuf &item, char delimiter = ',');
+
+int strListIsMember(const String * str, const SBuf &item, char del);
 int strListIsSubstr(const String * list, const char *s, char del);
+/// Iterates through delimiter-separated and optionally "quoted" list members.
+/// Follows HTTP #rule, including skipping OWS and empty members.
 int strListGetItem(const String * str, char del, const char **item, int *ilen, const char **pos);
+/// Searches for the first matching key=value pair
+/// within a delimiter-separated list of items.
+/// \returns the value of the found pair or an empty string.
+SBuf getListMember(const String &list, const char *key, const char delimiter);
 
 #endif /* SQUID_STRLIST_H_ */