EXT-3125 : INFRASTRUCTURE : Cleanup LLInventoryFilter to disambiguate various filter options

EXT-3124 : Add lookup for finding all linked items to an item

LLInventoryFilter cleanup, including adding ability to lookup item by UUID.

--HG--
branch : avatar-pipeline

1 files changed, 116 insertions, 79 deletions

diff --git a/indra/newview/llinventoryfilter.h b/indra/newview/llinventoryfilter.h
index b803df110b..20a4a15028 100644
--- a/indra/newview/llinventoryfilter.h
+++ b/indra/newview/llinventoryfilter.h
@@ -33,30 +33,38 @@
 #ifndef LLINVENTORYFILTER_H
 #define LLINVENTORYFILTER_H
 
-// lots of includes here
 #include "llinventorytype.h"
-#include "llpermissionsflags.h"		// PermissionsMask
+#include "llpermissionsflags.h"
 
 class LLFolderViewItem;
 
 class LLInventoryFilter
 {
 public:
-	typedef enum e_folder_show
+	enum EFolderShow
 	{
 		SHOW_ALL_FOLDERS,
 		SHOW_NON_EMPTY_FOLDERS,
 		SHOW_NO_FOLDERS
-	} EFolderShow;
+	};
 
-	typedef enum e_filter_behavior
+	enum EFilterBehavior
 	{
 		FILTER_NONE,				// nothing to do, already filtered
 		FILTER_RESTART,				// restart filtering from scratch
 		FILTER_LESS_RESTRICTIVE,	// existing filtered items will certainly pass this filter
 		FILTER_MORE_RESTRICTIVE		// if you didn't pass the previous filter, you definitely won't pass this one
-	} EFilterBehavior;
+	};
+
+	enum EFilterType
+	{
+		FILTERTYPE_NONE,
+		FILTERTYPE_ITEM,		// normal default search-by-item-type
+		FILTERTYPE_CATEGORY,	// search by folder type
+		FILTERTYPE_UUID			// find the object with UUID and any links to it
+	};
 
+	// REFACTOR: Change this to an enum.
 	static const U32 SO_DATE = 1;
 	static const U32 SO_FOLDERS_BY_NAME = 2;
 	static const U32 SO_SYSTEM_FOLDERS_TO_TOP = 4;
@@ -64,89 +72,118 @@ public:
 	LLInventoryFilter(const std::string& name);
 	virtual ~LLInventoryFilter();
 
-	void setFilterTypes(U64 types, BOOL filter_for_categories = FALSE); // if filter_for_categories is true, operate on folder preferred asset type
-	U32 getFilterTypes() const { return mFilterOps.mFilterTypes; }
-
-	void setFilterSubString(const std::string& string);
-	const std::string getFilterSubString(BOOL trim = FALSE);
-
-	void setFilterPermissions(PermissionMask perms);
-	PermissionMask getFilterPermissions() const { return mFilterOps.mPermissions; }
-
-	void setDateRange(time_t min_date, time_t max_date);
-	void setDateRangeLastLogoff(BOOL sl);
-	time_t getMinDate() const { return mFilterOps.mMinDate; }
-	time_t getMaxDate() const { return mFilterOps.mMaxDate; }
-
-	void setHoursAgo(U32 hours);
-	U32 getHoursAgo() const { return mFilterOps.mHoursAgo; }
-
-	void setShowFolderState( EFolderShow state);
-	EFolderShow getShowFolderState() { return mFilterOps.mShowFolderState; }
-
-	void setSortOrder(U32 order);
-	U32 getSortOrder() { return mOrder; }
-
-	BOOL check(LLFolderViewItem* item);
+	// +-------------------------------------------------------------------+
+	// + Execution And Results
+	// +-------------------------------------------------------------------+
+	BOOL 				check(const LLFolderViewItem* item);
+	BOOL 				checkAgainstFilterType(const LLFolderViewItem* item);
 	std::string::size_type getStringMatchOffset() const;
-	BOOL isActive();
-	BOOL isNotDefault();
-	BOOL isModified();
-	BOOL isModifiedAndClear();
-	BOOL isSinceLogoff();
-	bool hasFilterString() { return mFilterSubString.size() > 0; }
-	void clearModified() { mModified = FALSE; mFilterBehavior = FILTER_NONE; }
-	const std::string getName() const { return mName; }
-	std::string getFilterText();
 
-	void setFilterCount(S32 count) { mFilterCount = count; }
-	S32 getFilterCount() { return mFilterCount; }
-	void decrementFilterCount() { mFilterCount--; }
+	// +-------------------------------------------------------------------+
+	// + Parameters
+	// +-------------------------------------------------------------------+
+	void 				setFilterTypes(U64 types, EFilterType filter_type = FILTERTYPE_ITEM);
+	U32 				getFilterTypes() const;
+	BOOL 				isFilterWith(LLInventoryType::EType t) const;
+
+	void 				setFilterSubString(const std::string& string);
+	const std::string& 	getFilterSubString(BOOL trim = FALSE) const;
+	BOOL 				hasFilterString() const;
+
+	void 				setFilterPermissions(PermissionMask perms);
+	PermissionMask 		getFilterPermissions() const;
+
+	void 				setDateRange(time_t min_date, time_t max_date);
+	void 				setDateRangeLastLogoff(BOOL sl);
+	time_t 				getMinDate() const;
+	time_t 				getMaxDate() const;
+
+	void 				setHoursAgo(U32 hours);
+	U32 				getHoursAgo() const;
+
+	void 				setShowFolderState( EFolderShow state);
+	EFolderShow 		getShowFolderState() const;
+
+	void 				setSortOrder(U32 order);
+	U32 				getSortOrder() const;
+
+	// +-------------------------------------------------------------------+
+	// + Status
+	// +-------------------------------------------------------------------+
+	BOOL 				isActive() const;
+	BOOL 				isModified() const;
+	BOOL 				isModifiedAndClear();
+	BOOL 				isSinceLogoff() const;
+	void 				clearModified();
+	const std::string& 	getName() const;
+	const std::string& 	getFilterText();
+	//RN: this is public to allow system to externally force a global refilter
+	void 				setModified(EFilterBehavior behavior = FILTER_RESTART);
+
+	// +-------------------------------------------------------------------+
+	// + Count
+	// +-------------------------------------------------------------------+
+	void 				setFilterCount(S32 count);
+	S32 				getFilterCount() const;
+	void 				decrementFilterCount();
+
+	// +-------------------------------------------------------------------+
+	// + Default
+	// +-------------------------------------------------------------------+
+	BOOL 				isNotDefault() const;
+	void 				markDefault();
+	void 				resetDefault();
+
+	// +-------------------------------------------------------------------+
+	// + Generation
+	// +-------------------------------------------------------------------+
+	S32 				getCurrentGeneration() const;
+	S32 				getMinRequiredGeneration() const;
+	S32 				getMustPassGeneration() const;
+
+	// +-------------------------------------------------------------------+
+	// + Conversion
+	// +-------------------------------------------------------------------+
+	void 				toLLSD(LLSD& data) const;
+	void 				fromLLSD(LLSD& data);
 
-	void markDefault();
-	void resetDefault();
+private:
+	struct FilterOps
+	{
+		FilterOps();
+		EFilterType 	mFilterType;
 
-	BOOL isFilterWith(LLInventoryType::EType t);
+		U64				mFilterObjectTypes; // For _ITEM or _CATEGORY
+		LLUUID      	mFilterUUID; // for UUID
 
-	S32 getCurrentGeneration() const { return mFilterGeneration; }
-	S32 getMinRequiredGeneration() const { return mMinRequiredGeneration; }
-	S32 getMustPassGeneration() const { return mMustPassGeneration; }
+		time_t			mMinDate;
+		time_t			mMaxDate;
+		U32				mHoursAgo;
+		EFolderShow		mShowFolderState;
+		PermissionMask	mPermissions;
+	};
 
-	//RN: this is public to allow system to externally force a global refilter
-	void setModified(EFilterBehavior behavior = FILTER_RESTART);
+	U32						mOrder;
+	U32 					mLastLogoff;
 
-	void toLLSD(LLSD& data);
-	void fromLLSD(LLSD& data);
+	FilterOps				mFilterOps;
+	FilterOps				mDefaultFilterOps;
 
-protected:
-	struct filter_ops
-	{
-		U64			mFilterTypes;
-		BOOL        mFilterForCategories;
-		time_t		mMinDate;
-		time_t		mMaxDate;
-		U32			mHoursAgo;
-		EFolderShow	mShowFolderState;
-		PermissionMask	mPermissions;
-	};
-	filter_ops		mFilterOps;
-	filter_ops		mDefaultFilterOps;
 	std::string::size_type	mSubStringMatchOffset;
-	std::string		mFilterSubString;
-	U32				mOrder;
-	const std::string	mName;
-	S32				mFilterGeneration;
-	S32				mMustPassGeneration;
-	S32				mMinRequiredGeneration;
-	S32				mFilterCount;
-	S32				mNextFilterGeneration;
-	EFilterBehavior mFilterBehavior;
+	std::string				mFilterSubString;
+	const std::string		mName;
 
-private:
-	U32 mLastLogoff;
-	BOOL mModified;
-	BOOL mNeedTextRebuild;
-	std::string mFilterText;
+	S32						mFilterGeneration;
+	S32						mMustPassGeneration;
+	S32						mMinRequiredGeneration;
+	S32						mNextFilterGeneration;
+
+	S32						mFilterCount;
+	EFilterBehavior 		mFilterBehavior;
+
+	BOOL 					mModified;
+	BOOL 					mNeedTextRebuild;
+	std::string 			mFilterText;
 };
 
 #endif