summaryrefslogtreecommitdiff
path: root/indra/llui/llviewquery.h
blob: c03a15e8f9946bb6268dea3756a3def8f870329f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/**
 * @file llviewquery.h
 * @brief Query algorithm for flattening and filtering the view hierarchy.
 *
 * $LicenseInfo:firstyear=2001&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LL_LLVIEWQUERY_H
#define LL_LLVIEWQUERY_H

#include <list>

#include "llsingleton.h"
#include "llui.h"

class LLView;

typedef std::list<LLView *>         viewList_t;
typedef std::pair<bool, bool>       filterResult_t;

// Abstract base class for all query filters.
class LLQueryFilter
{
public:
    virtual ~LLQueryFilter() {};
    virtual filterResult_t operator() (const LLView* const view, const viewList_t & children) const = 0;
};

class LLQuerySorter
{
public:
    virtual ~LLQuerySorter() {};
    virtual void sort(LLView * parent, viewList_t &children) const;
};

class LLLeavesFilter : public LLQueryFilter, public LLSingleton<LLLeavesFilter>
{
    LLSINGLETON_EMPTY_CTOR(LLLeavesFilter);
    /*virtual*/ filterResult_t operator() (const LLView* const view, const viewList_t & children) const override;
};

class LLRootsFilter : public LLQueryFilter, public LLSingleton<LLRootsFilter>
{
    LLSINGLETON_EMPTY_CTOR(LLRootsFilter);
    /*virtual*/ filterResult_t operator() (const LLView* const view, const viewList_t & children) const override;
};

class LLVisibleFilter : public LLQueryFilter, public LLSingleton<LLVisibleFilter>
{
    LLSINGLETON_EMPTY_CTOR(LLVisibleFilter);
    /*virtual*/ filterResult_t operator() (const LLView* const view, const viewList_t & children) const override;
};

class LLEnabledFilter : public LLQueryFilter, public LLSingleton<LLEnabledFilter>
{
    LLSINGLETON_EMPTY_CTOR(LLEnabledFilter);
    /*virtual*/ filterResult_t operator() (const LLView* const view, const viewList_t & children) const override;
};

class LLTabStopFilter : public LLQueryFilter, public LLSingleton<LLTabStopFilter>
{
    LLSINGLETON_EMPTY_CTOR(LLTabStopFilter);
    /*virtual*/ filterResult_t operator() (const LLView* const view, const viewList_t & children) const override;
};

class LLCtrlFilter : public LLQueryFilter, public LLSingleton<LLCtrlFilter>
{
    LLSINGLETON_EMPTY_CTOR(LLCtrlFilter);
    /*virtual*/ filterResult_t operator() (const LLView* const view, const viewList_t & children) const override;
};

template <class T>
class LLWidgetTypeFilter : public LLQueryFilter
{
    /*virtual*/ filterResult_t operator() (const LLView* const view, const viewList_t & children) const
    {
        return filterResult_t(dynamic_cast<const T*>(view) != NULL, true);
    }

};

// Algorithm for flattening
class LLViewQuery
{
public:
    typedef std::list<const LLQueryFilter*>     filterList_t;
    typedef filterList_t::iterator              filterList_iter_t;
    typedef filterList_t::const_iterator        filterList_const_iter_t;

    LLViewQuery() : mPreFilters(), mPostFilters(), mSorterp() {}
    virtual ~LLViewQuery() {}

    void addPreFilter(const LLQueryFilter* prefilter) { mPreFilters.push_back(prefilter); }
    void addPostFilter(const LLQueryFilter* postfilter) { mPostFilters.push_back(postfilter); }
    const filterList_t & getPreFilters() const { return mPreFilters; }
    const filterList_t & getPostFilters() const { return mPostFilters; }

    void setSorter(const LLQuerySorter* sorter) { mSorterp = sorter; }
    const LLQuerySorter* getSorter() const { return mSorterp; }

    viewList_t run(LLView * view) const;
    // syntactic sugar
    viewList_t operator () (LLView * view) const { return run(view); }

    // override this method to provide iteration over other types of children
    virtual void filterChildren(LLView * view, viewList_t& filtered_children) const;

private:

    filterResult_t runFilters(LLView * view, const viewList_t children, const filterList_t filters) const;

    filterList_t mPreFilters;
    filterList_t mPostFilters;
    const LLQuerySorter* mSorterp;
};


#endif // LL_LLVIEWQUERY_H