summaryrefslogtreecommitdiff
path: root/indra/llcommon/lldictionary.h
blob: 9c399057ae176adac91369cc4e20fabb7268798b (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
/**
 * @file lldictionary.h
 * @brief Lldictionary class header file
 *
 * $LicenseInfo:firstyear=2002&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_LLDICTIONARY_H
#define LL_LLDICTIONARY_H

#include <map>
#include <string>

#include "llerror.h"

struct LL_COMMON_API LLDictionaryEntry
{
    LLDictionaryEntry(const std::string &name);
    virtual ~LLDictionaryEntry() {}
    const std::string mName;
    std::string mNameCapitalized;
};

template <class Index, class Entry>
class LLDictionary : public std::map<Index, Entry *>
{
public:
    typedef std::map<Index, Entry *> map_t;
    typedef typename map_t::iterator iterator_t;
    typedef typename map_t::const_iterator const_iterator_t;

    LLDictionary() {}
    virtual ~LLDictionary()
    {
        for (iterator_t iter = map_t::begin(); iter != map_t::end(); ++iter)
            delete (iter->second);
    }

    const Entry *lookup(Index index) const
    {
        const_iterator_t dictionary_iter = map_t::find(index);
        if (dictionary_iter == map_t::end()) return NULL;
        return dictionary_iter->second;
    }
    const Index lookup(const std::string &name) const
    {
        for (const_iterator_t dictionary_iter = map_t::begin();
             dictionary_iter != map_t::end();
             dictionary_iter++)
        {
            const Entry *entry = dictionary_iter->second;
            if (entry->mName == name)
            {
                return dictionary_iter->first;
            }
        }
        return notFound();
    }

protected:
    virtual Index notFound() const
    {
        // default is to assert
        // don't assert -- makes it impossible to work on mesh-development and viewer-development simultaneously
        //          -- davep 2010.10.29
        //llassert(false);
        return Index(-1);
    }
    void addEntry(Index index, Entry *entry)
    {
        if (!this->emplace(index, entry).second)
        {
            LL_ERRS() << "Dictionary entry already added (attempted to add duplicate entry)" << LL_ENDL;
        }
    }
};

#endif // LL_LLDICTIONARY_H