summaryrefslogtreecommitdiff
path: root/indra/newview/lllocationhistory.h
blob: ca9b81457c7eea93322e78c6263f4c358123c7f5 (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
138
139
140
141
/**
 * @file llocationhistory.h
 * @brief Typed locations history
 *
 * $LicenseInfo:firstyear=2009&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_LLLOCATIONHISTORY_H
#define LL_LLLOCATIONHISTORY_H

#include "llsingleton.h" // for LLSingleton

#include <vector>
#include <string>
#include <map>
#include <boost/function.hpp>
#include <boost/signals2.hpp>

class LLSD;
/**
 * This enum is responsible for identifying of history item.
 */
enum ELocationType {
     TYPED_REGION_SLURL//item added after the user had typed a region name or slurl
    ,LANDMARK  // item has been loaded from landmark folder
    ,TELEPORT_HISTORY // item from session teleport history
    };
class LLLocationHistoryItem {

public:
    LLLocationHistoryItem(){}
    LLLocationHistoryItem(std::string typed_location,
            LLVector3d global_position, std::string tooltip,ELocationType type ):
        mLocation(typed_location),
        mGlobalPos(global_position),
        mToolTip(tooltip),
        mType(type)
    {}
    LLLocationHistoryItem(const LLLocationHistoryItem& item):
        mGlobalPos(item.mGlobalPos),
        mToolTip(item.mToolTip),
        mLocation(item.mLocation),
        mType(item.mType)
    {}
    LLLocationHistoryItem(const LLSD& data):
    mLocation(data["location"]),
    mGlobalPos(data["global_pos"]),
    mToolTip(data["tooltip"]),
    mType(ELocationType(data["item_type"].asInteger()))
    {}

    bool operator==(const LLLocationHistoryItem& item)
    {
        // do not compare  mGlobalPos,
        // because of a rounding off , the history  can contain duplicates
        return mLocation == item.mLocation && (mType == item.mType);
    }
    bool operator!=(const LLLocationHistoryItem& item)
    {
        return ! (*this == item);
    }
    LLSD toLLSD() const
    {
        LLSD val;
        val["location"]= mLocation;
        val["global_pos"]   = mGlobalPos.getValue();
        val["tooltip"]  = mToolTip;
        val["item_type"] = mType;
        return val;
    }
    const std::string& getLocation() const { return mLocation;  };
    const std::string& getToolTip() const { return mToolTip;    };
    //static bool equalByRegionParcel(const LLLocationHistoryItem& item1, const LLLocationHistoryItem& item2);
    static bool equalByLocation(const LLLocationHistoryItem& item1, const std::string& item_location)
    {
        return  item1.getLocation() == item_location;
    }

    LLVector3d  mGlobalPos; // global position
    std::string mToolTip;// SURL
    std::string mLocation;// typed_location
    ELocationType mType;
};

class LLLocationHistory: public LLSingleton<LLLocationHistory>
{
    LLSINGLETON(LLLocationHistory);
    LOG_CLASS(LLLocationHistory);

public:
    enum EChangeType
    {
         ADD
        ,CLEAR
        ,LOAD
    };

    typedef std::vector<LLLocationHistoryItem>  location_list_t;
    typedef boost::function<void(EChangeType event)>            history_changed_callback_t;
    typedef boost::signals2::signal<void(EChangeType event)>    history_changed_signal_t;


    void                    addItem(const LLLocationHistoryItem& item);
    bool                    touchItem(const LLLocationHistoryItem& item);
    void                    removeItems();
    size_t                  getItemCount() const    { return mItems.size(); }
    const location_list_t&  getItems() const        { return mItems; }
    bool                    getMatchingItems(const std::string& substring, location_list_t& result) const;
    boost::signals2::connection setChangedCallback(history_changed_callback_t cb) { return mChangedSignal.connect(cb); }

    void                    save() const;
    void                    load();
    void                    dump() const;

private:

    location_list_t         mItems;
    std::string                         mFilename; /// File to store the history to.
    history_changed_signal_t            mChangedSignal;
};

#endif