summaryrefslogtreecommitdiff
path: root/indra/llui/llundo.cpp
blob: 0928cb4417564486e48e240036e5bbcf8bd8855f (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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
/**
 * @file llundo.cpp
 *
 * $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$
 */

#include "linden_common.h"
#include "llundo.h"


// TODO:
// implement doubly linked circular list for ring buffer
// this will allow us to easily change the size of an undo buffer on the fly

//-----------------------------------------------------------------------------
// LLUndoBuffer()
//-----------------------------------------------------------------------------
LLUndoBuffer::LLUndoBuffer( LLUndoAction (*create_func()), S32 initial_count )
{
    mNextAction = 0;
    mLastAction = 0;
    mFirstAction = 0;
    mOperationID = 0;

    mNumActions = initial_count;

    mActions = new LLUndoAction *[initial_count];

    //initialize buffer with actions
    for (S32 i = 0; i < initial_count; i++)
    {
        mActions[i] = create_func();
        if (!mActions[i])
        {
            LL_ERRS() << "Unable to create action for undo buffer" << LL_ENDL;
        }
    }
}

//-----------------------------------------------------------------------------
// ~LLUndoBuffer()
//-----------------------------------------------------------------------------
LLUndoBuffer::~LLUndoBuffer()
{
    for (S32 i = 0; i < mNumActions; i++)
    {
        delete mActions[i];
    }

    delete [] mActions;
}

//-----------------------------------------------------------------------------
// getNextAction()
//-----------------------------------------------------------------------------
LLUndoBuffer::LLUndoAction* LLUndoBuffer::getNextAction(bool setClusterBegin)
{
    LLUndoAction *nextAction = mActions[mNextAction];

    if (setClusterBegin)
    {
        mOperationID++;
    }
    mActions[mNextAction]->mClusterID = mOperationID;

    mNextAction = (mNextAction + 1) % mNumActions;
    mLastAction = mNextAction;

    if (mNextAction == mFirstAction)
    {
        mActions[mFirstAction]->cleanup();
        mFirstAction = (mFirstAction + 1) % mNumActions;
    }

    return nextAction;
}

//-----------------------------------------------------------------------------
// undoAction()
//-----------------------------------------------------------------------------
bool LLUndoBuffer::undoAction()
{
    if (!canUndo())
    {
        return false;
    }

    S32 prevAction = (mNextAction + mNumActions - 1) % mNumActions;

    while(mActions[prevAction]->mClusterID == mOperationID)
    {
        // go ahead and decrement action index
        mNextAction = prevAction;

        // undo this action
        mActions[mNextAction]->undo();

        // we're at the first action, so we don't know if we've actually undid everything
        if (mNextAction == mFirstAction)
        {
            mOperationID--;
            return false;
        }

        // do wrap-around of index, but avoid negative numbers for modulo operator
        prevAction = (mNextAction + mNumActions - 1) % mNumActions;
    }

    mOperationID--;

    return true;
}

//-----------------------------------------------------------------------------
// redoAction()
//-----------------------------------------------------------------------------
bool LLUndoBuffer::redoAction()
{
    if (!canRedo())
    {
        return false;
    }

    mOperationID++;

    while(mActions[mNextAction]->mClusterID == mOperationID)
    {
        if (mNextAction == mLastAction)
        {
            return false;
        }

        mActions[mNextAction]->redo();

        // do wrap-around of index
        mNextAction = (mNextAction + 1) % mNumActions;
    }

    return true;
}

//-----------------------------------------------------------------------------
// flushActions()
//-----------------------------------------------------------------------------
void LLUndoBuffer::flushActions()
{
    for (S32 i = 0; i < mNumActions; i++)
    {
        mActions[i]->cleanup();
    }
    mNextAction = 0;
    mLastAction = 0;
    mFirstAction = 0;
    mOperationID = 0;
}