summaryrefslogtreecommitdiff
path: root/indra/newview/llteleporthistorystorage.h
blob: 643c4a6bfcff8439611499dee1f1422b11dbe618 (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
/**
 * @file llteleporthistorystorage.h
 * @brief Saving/restoring of teleport 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_LLTELEPORTHISTORYSTORAGE_H
#define LL_LLTELEPORTHISTORYSTORAGE_H

#include <vector>

#include "llsingleton.h"
#include "lldate.h"
#include "v3dmath.h"

class LLSD;

/**
 * An item of the teleport history, stored in file
 *
 * Contains the location's global coordinates, title and date.
 */
class LLTeleportHistoryPersistentItem
{
public:
    LLTeleportHistoryPersistentItem()
    {}

    LLTeleportHistoryPersistentItem(const std::string title, const LLVector3d& global_pos)
        : mTitle(title), mGlobalPos(global_pos), mDate(LLDate::now())
    {}

    LLTeleportHistoryPersistentItem(const std::string title, const LLVector3d& global_pos, const LLDate& date)
        : mTitle(title), mGlobalPos(global_pos), mDate(date)
    {}

    LLTeleportHistoryPersistentItem(const LLSD& val);
    LLSD toLLSD() const;

    std::string mTitle;
    LLVector3d  mGlobalPos;
    LLDate      mDate;
};

/**
 * Persistent teleport history.
 *
 */
class LLTeleportHistoryStorage: public LLSingleton<LLTeleportHistoryStorage>
{
    LLSINGLETON(LLTeleportHistoryStorage);
    ~LLTeleportHistoryStorage();
    LOG_CLASS(LLTeleportHistoryStorage);

public:

    typedef std::vector<LLTeleportHistoryPersistentItem> slurl_list_t;

    // removed_index is index of removed item, which replaced by more recent
    typedef boost::function<void(S32 removed_index)>        history_callback_t;
    typedef boost::signals2::signal<void(S32 removed_index)>    history_signal_t;

    /**
     * @return history items.
     */
    const slurl_list_t& getItems() const { return mItems; }
    void            purgeItems();

    void addItem(const std::string title, const LLVector3d& global_pos);
    void addItem(const std::string title, const LLVector3d& global_pos, const LLDate& date);

    void removeItem(S32 idx);

    void save();

    /**
     * Set a callback to be called upon history changes.
     *
     * Multiple callbacks can be set.
     */
    boost::signals2::connection setHistoryChangedCallback(history_callback_t cb);

    /**
     * Go to specific item in the history.
     *
     * The item is specified by its index (starting from 0).
     */
    void                    goToItem(S32 idx);

    /**
     * Show specific item on map.
     *
     * The item is specified by its index (starting from 0).
     */
    void                    showItemOnMap(S32 idx);

private:

    void load();
    void dump() const;

    void onTeleportHistoryChange();
    bool compareByTitleAndGlobalPos(const LLTeleportHistoryPersistentItem& a, const LLTeleportHistoryPersistentItem& b);

    slurl_list_t    mItems;
    std::string mFilename;

    /**
     * Signal emitted when the history gets changed.
     *
     * Invokes callbacks set with setHistoryChangedCallback().
     */
    history_signal_t        mHistoryChangedSignal;
};

#endif //LL_LLTELEPORTHISTORYSTORAGE_H