Add a BStringList class

headers/build/os/support/StringList.h

@@ -0,0 +1 @@
+#include <../os/support/StringList.h>

headers/os/support/StringList.h

@@ -0,0 +1,85 @@
+/*
+ * Copyright 2011, Haiku, Inc. All Rights Reserved.
+ * Distributed under the terms of the MIT License.
+ */
+#ifndef _SUPPORT_BSTRING_LIST_H_
+#define _SUPPORT_BSTRING_LIST_H_
+
+
+#include <BeBuild.h>
+#include <List.h>
+#include <String.h>
+
+
+class BStringList {
+public:
+								BStringList(int32 count = 20);
+								BStringList(const BStringList& other);
+	virtual						~BStringList();
+
+	// Adding and removing items.
+			bool				Add(const BString& string, int32 index);
+			bool				Add(const BString& string);
+			bool				Add(const BStringList& list, int32 index);
+			bool				Add(const BStringList& list);
+
+			bool				Remove(const BString& string,
+									bool ignoreCase = false);
+			BString				Remove(int32 index);
+			bool				Remove(int32 index, int32 count);
+			bool				Replace(int32 index, const BString& string);
+
+			void				MakeEmpty();
+
+	// Reorder items
+			void				Sort(bool ignoreCase = false);
+									// TODO: Sort() with custom sort function.
+			bool				Swap(int32 indexA, int32 indexB);
+			bool				Move(int32 fromIndex, int32 toIndex);
+
+	// Retrieve items
+			BString				StringAt(int32 index) const;
+			BString				First() const;
+			BString				Last() const;
+
+	// Query
+			bool				HasString(const BString& string,
+									bool ignoreCase = false) const;
+			int32				IndexOf(const BString& string,
+									bool ignoreCase = false) const;
+			int32				CountStrings() const;
+			bool				IsEmpty() const;
+
+	// Iteration
+			void				DoForEach(bool (*func)(const BString& string));
+			void				DoForEach(bool (*func)(const BString& string,
+									void* arg2), void* arg2);
+
+			BStringList&		operator=(const BStringList& other);
+			bool				operator==(const BStringList& other) const;
+			bool				operator!=(const BStringList& other) const;
+
+private:
+			void				_IncrementRefCounts() const;
+			void				_DecrementRefCounts() const;
+
+private:
+			BList				fStrings;
+};
+
+
+inline bool
+BStringList::HasString(const BString& string, bool ignoreCase) const
+{
+	return IndexOf(string, ignoreCase) >= 0;
+}
+
+
+inline bool
+BStringList::operator!=(const BStringList& other) const
+{
+	return !(*this == other);
+}
+
+
+#endif	// _SUPPORT_BSTRING_LIST_H_

src/build/libbe/support/Jamfile

@@ -16,4 +16,5 @@ BuildPlatformMergeObjectPIC <libbe_build>support_kit.o :
 	Locker.cpp
 	PointerList.cpp
 	String.cpp
+	StringList.cpp
 ;

src/kits/support/Jamfile

@@ -20,5 +20,6 @@ MergeObject <libbe>support_kit.o :
 	Referenceable.cpp
 	StopWatch.cpp
 	String.cpp
+	StringList.cpp
 	Url.cpp
 ;

src/kits/support/StringList.cpp

@@ -0,0 +1,330 @@
+/*
+ * Copyright 2011, Ingo Weinhold, ingo_weinhold@gmx.de.
+ * Distributed under the terms of the MIT License.
+ */
+
+
+#include <StringList.h>
+
+#include <algorithm>
+
+#include <StringPrivate.h>
+
+
+static int
+compare_private_data(const void* a, const void* b)
+{
+	return BString::Private::StringFromData((char*)a).Compare(
+		BString::Private::StringFromData((char*)b));
+}
+
+
+static int
+compare_private_data_ignore_case(const void* a, const void* b)
+{
+	return BString::Private::StringFromData((char*)a).ICompare(
+		BString::Private::StringFromData((char*)b));
+}
+
+
+// #pragma mark - BStringList
+
+
+BStringList::BStringList(int32 count)
+	:
+	fStrings(count)
+{
+}
+
+
+BStringList::BStringList(const BStringList& other)
+	:
+	fStrings(other.fStrings)
+{
+	_IncrementRefCounts();
+}
+
+
+BStringList::~BStringList()
+{
+	_DecrementRefCounts();
+}
+
+
+bool
+BStringList::Add(const BString& string, int32 index)
+{
+	char* privateData = BString::Private(string).Data();
+	if (!fStrings.AddItem(privateData, index))
+		return false;
+
+	BString::Private::IncrementDataRefCount(privateData);
+	return true;
+}
+
+
+bool
+BStringList::Add(const BString& string)
+{
+	char* privateData = BString::Private(string).Data();
+	if (!fStrings.AddItem(privateData))
+		return false;
+
+	BString::Private::IncrementDataRefCount(privateData);
+	return true;
+}
+
+
+bool
+BStringList::Add(const BStringList& list, int32 index)
+{
+	if (!fStrings.AddList(&list.fStrings, index))
+		return false;
+
+	list._IncrementRefCounts();
+	return true;
+}
+
+
+bool
+BStringList::Add(const BStringList& list)
+{
+	if (!fStrings.AddList(&list.fStrings))
+		return false;
+
+	list._IncrementRefCounts();
+	return true;
+}
+
+
+bool
+BStringList::Remove(const BString& string, bool ignoreCase)
+{
+	bool result = false;
+	int32 count = fStrings.CountItems();
+
+	if (ignoreCase) {
+		int32 length = string.Length();
+
+		for (int32 i = count - 1; i >= 0; i--) {
+			BString element(StringAt(i));
+			if (length == element.Length() && string.ICompare(element) == 0) {
+				Remove(i);
+				result = true;
+			}
+		}
+	} else {
+		for (int32 i = count - 1; i >= 0; i--) {
+			if (string == StringAt(i)) {
+				Remove(i);
+				result = true;
+			}
+		}
+	}
+
+	return result;
+}
+
+
+BString
+BStringList::Remove(int32 index)
+{
+	if (index < 0 || index >= fStrings.CountItems())
+		return BString();
+
+	char* privateData = (char*)fStrings.RemoveItem(index);
+	BString string(BString::Private::StringFromData(privateData));
+	BString::Private::DecrementDataRefCount(privateData);
+	return string;
+}
+
+
+bool
+BStringList::Remove(int32 index, int32 count)
+{
+	int32 stringCount = fStrings.CountItems();
+	if (index < 0 || index > stringCount)
+		return false;
+
+	int32 end = index + std::min(stringCount - index, count);
+	for (int32 i = index; i < end; i++)
+		BString::Private::DecrementDataRefCount((char*)fStrings.ItemAt(i));
+
+	fStrings.RemoveItems(index, end - index);
+	return true;
+}
+
+
+bool
+BStringList::Replace(int32 index, const BString& string)
+{
+	if (index < 0 || index >= fStrings.CountItems())
+		return false;
+
+	BString::Private::DecrementDataRefCount((char*)fStrings.ItemAt(index));
+
+	char* privateData = BString::Private(string).Data();
+	BString::Private::IncrementDataRefCount(privateData);
+	fStrings.ReplaceItem(index, privateData);
+
+	return true;
+}
+
+
+void
+BStringList::MakeEmpty()
+{
+	_DecrementRefCounts();
+	fStrings.MakeEmpty();
+}
+
+
+void
+BStringList::Sort(bool ignoreCase)
+{
+	fStrings.SortItems(ignoreCase
+		? compare_private_data_ignore_case : compare_private_data);
+}
+
+
+bool
+BStringList::Swap(int32 indexA, int32 indexB)
+{
+	return fStrings.SwapItems(indexA, indexB);
+}
+
+
+bool
+BStringList::Move(int32 fromIndex, int32 toIndex)
+{
+	return fStrings.MoveItem(fromIndex, toIndex);
+}
+
+
+BString
+BStringList::StringAt(int32 index) const
+{
+	return BString::Private::StringFromData((char*)fStrings.ItemAt(index));
+}
+
+
+BString
+BStringList::First() const
+{
+	return BString::Private::StringFromData((char*)fStrings.FirstItem());
+}
+
+
+BString
+BStringList::Last() const
+{
+	return BString::Private::StringFromData((char*)fStrings.LastItem());
+}
+
+
+int32
+BStringList::IndexOf(const BString& string, bool ignoreCase) const
+{
+	int32 count = fStrings.CountItems();
+
+	if (ignoreCase) {
+		int32 length = string.Length();
+
+		for (int32 i = 0; i < count; i++) {
+			BString element(StringAt(i));
+			if (length == element.Length() && string.ICompare(element) == 0)
+				return true;
+		}
+	} else {
+		for (int32 i = 0; i < count; i++) {
+			if (string == StringAt(i))
+				return true;
+		}
+	}
+
+	return false;
+}
+
+
+int32
+BStringList::CountStrings() const
+{
+	return fStrings.CountItems();
+}
+
+
+bool
+BStringList::IsEmpty() const
+{
+	return fStrings.IsEmpty();
+}
+
+
+void
+BStringList::DoForEach(bool (*func)(const BString& string))
+{
+	int32 count = fStrings.CountItems();
+	for (int32 i = 0; i < count; i++)
+		func(StringAt(i));
+}
+
+
+void
+BStringList::DoForEach(bool (*func)(const BString& string, void* arg2),
+	void* arg2)
+{
+	int32 count = fStrings.CountItems();
+	for (int32 i = 0; i < count; i++)
+		func(StringAt(i), arg2);
+}
+
+
+BStringList&
+BStringList::operator=(const BStringList& other)
+{
+	if (this != &other) {
+		_DecrementRefCounts();
+		fStrings = other.fStrings;
+		_IncrementRefCounts();
+	}
+
+	return *this;
+}
+
+
+bool
+BStringList::operator==(const BStringList& other) const
+{
+	if (this == &other)
+		return true;
+
+	int32 count = fStrings.CountItems();
+	if (count != other.fStrings.CountItems())
+		return false;
+
+	for (int32 i = 0; i < count; i++) {
+		if (StringAt(i) != other.StringAt(i))
+			return false;
+	}
+
+	return true;
+}
+
+
+void
+BStringList::_IncrementRefCounts() const
+{
+	int32 count = fStrings.CountItems();
+	for (int32 i = 0; i < count; i++) {
+		BString::Private::IncrementDataRefCount((char*)fStrings.ItemAt(i));
+	}
+}
+
+
+void
+BStringList::_DecrementRefCounts() const
+{
+	int32 count = fStrings.CountItems();
+	for (int32 i = 0; i < count; i++)
+		BString::Private::DecrementDataRefCount((char*)fStrings.ItemAt(i));
+}