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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
/**
* @file llfloateruipreview.h
* @brief Tool for previewing and editing floaters
*
* $LicenseInfo:firstyear=2008&license=viewergpl$
*
* Copyright (c) 2008-2009, Linden Research, Inc.
*
* Second Life Viewer Source Code
* The source code in this file ("Source Code") is provided by Linden Lab
* to you under the terms of the GNU General Public License, version 2.0
* ("GPL"), unless you have obtained a separate licensing agreement
* ("Other License"), formally executed by you and Linden Lab. Terms of
* the GPL can be found in doc/GPL-license.txt in this distribution, or
* online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
*
* There are special exceptions to the terms and conditions of the GPL as
* it is applied to this Source Code. View the full text of the exception
* in the file doc/FLOSS-exception.txt in this software distribution, or
* online at
* http://secondlifegrid.net/programs/open_source/licensing/flossexception
*
* By copying, modifying or distributing this software, you acknowledge
* that you have read and understood your obligations described above,
* and agree to abide by those obligations.
*
* ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
* WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
* COMPLETENESS OR PERFORMANCE.
* $/LicenseInfo$
*/
// Tool for previewing floaters and panels for localization and UI design purposes.
// See: https://wiki.lindenlab.com/wiki/GUI_Preview_And_Localization_Tools
// See: https://jira.lindenlab.com/browse/DEV-16869
#ifndef LL_LLUIPREVIEW_H
#define LL_LLUIPREVIEW_H
#include "llfloater.h" // superclass
#include "llscrollcontainer.h" // scroll container for overlapping elements
#include "lllivefile.h" // live file poll/stat/reload
#include <list>
#include <map>
// Forward declarations to avoid header dependencies
class LLEventTimer;
class LLColor;
class LLScrollListCtrl;
class LLComboBox;
class LLButton;
class LLXmlTreeNode;
class LLFloaterUIPreview;
class LLFadeEventTimer;
// Reset object to ensure that when we change the current language setting for preview purposes,
// it automatically is reset. Constructed on the stack at the start of the method; the reset
// occurs as it falls out of scope at the end of the method. See llfloateruipreview.cpp for usage.
class LLLocalizationResetForcer
{
public:
LLLocalizationResetForcer(S32 ID);
virtual ~LLLocalizationResetForcer();
private:
std::string mSavedLocalization; // the localization before we change it
};
// Implementation of live file
// When a floater is being previewed, any saved changes to its corresponding
// file cause the previewed floater to be reloaded
class LLGUIPreviewLiveFile : public LLLiveFile
{
public:
LLGUIPreviewLiveFile(std::string path, std::string name, LLFloaterUIPreview* parent);
virtual ~LLGUIPreviewLiveFile();
LLFloaterUIPreview* mParent;
LLFadeEventTimer* mFadeTimer; // timer for fade-to-yellow-and-back effect to warn that file has been reloaded
BOOL mFirstFade; // setting this avoids showing the fade reload warning on first load
std::string mFileName;
protected:
void loadFile();
};
// Implementation of graphical fade in/out (on timer) for when XUI files are updated
class LLFadeEventTimer : public LLEventTimer
{
public:
LLFadeEventTimer(F32 refresh, LLGUIPreviewLiveFile* parent);
BOOL tick();
LLGUIPreviewLiveFile* mParent;
private:
BOOL mFadingOut; // fades in then out; this is toggled in between
LLColor4 mOriginalColor; // original color; color is reset to this after fade is coimplete
};
// Implementation of previewed floater
// Used to override draw and mouse handler
class LLPreviewedFloater : public LLFloater
{
public:
LLPreviewedFloater() : LLFloater() {}
virtual void draw();
BOOL handleRightMouseDown(S32 x, S32 y, MASK mask);
BOOL selectElement(LLView* parent, int x, int y, int depth); // select element to display its overlappers
};
// Implementation of custom overlapping element display panel
class LLOverlapPanel : public LLPanel
{
public:
struct Params : public LLInitParam::Block<Params, LLPanel::Params>
{
Params() {}
};
LLOverlapPanel(Params p = Params()) : LLPanel(p),
mSpacing(10),
// mClickedElement(NULL),
mLastClickedElement(NULL)
{
mOriginalWidth = getRect().getWidth();
mOriginalHeight = getRect().getHeight();
}
virtual void draw();
// LLView *mClickedElement;
LLView *mLastClickedElement;
int mOriginalWidth, mOriginalHeight, mSpacing;
};
class LLFloaterUIPreview : public LLFloater, public LLFloaterSingleton<LLFloaterUIPreview>
{
public:
// Setup
LLFloaterUIPreview(const LLSD& key);
virtual ~LLFloaterUIPreview();
static std::string getLocStr(S32 ID); // fetches the localization string based on what is selected in the drop-down menu
static void displayFloater(BOOL click, S32 ID, bool save = false); // needs to be public so live file can call it when it finds an update
static BOOL containerType(LLView* viewp); // check if the element is a container type and tree traverses need to look at its children
static LLFloaterUIPreview* sInstance; // static instance of this (for references in handlers)
BOOL postBuild(); // post-build setup (called by superclass' constructor)
void refreshList(); // refresh list (empty it out and fill it up from scratch)
void addFloaterEntry(const std::string& path); // add a single file's entry to the list of floaters
LLPreviewedFloater* mDisplayedFloater; // the floater which is currently being displayed
LLPreviewedFloater* mDisplayedFloater_2; // the floater which is currently being displayed
LLGUIPreviewLiveFile* mLiveFile; // live file for checking for updates to the currently-displayed XML file
LLOverlapPanel* mOverlapPanel; // custom overlapping elements panel
// BOOL mHighlightingDiffs; // bool for whether localization diffs are being highlighted or not
BOOL mHighlightingOverlaps; // bool for whether overlapping elements are being highlighted
typedef std::map<LLView*, std::list<LLView*> > OverlapMap;
OverlapMap mOverlapMap; // map, of XUI element to a list of XUI elements it overlaps
// typedef std::map<std::string,std::pair<std::list<std::string>,std::list<std::string> > > DiffMap; // this version copies the lists etc., and thus is bad memory-wise
typedef std::list<std::string> StringList;
typedef boost::shared_ptr<StringList> StringListPtr;
typedef std::map<std::string, std::pair<StringListPtr,StringListPtr> > DiffMap;
DiffMap mDiffsMap; // map, of filename to pair of list of changed element paths and list of errors
protected:
virtual void onClose(bool app_quitting);
private:
// XUI elements for this floater
LLScrollListCtrl* mFileList; // scroll list control for file list
LLLineEditor* mEditorPathTextBox; // text field for path to editor executable
LLLineEditor* mEditorArgsTextBox; // text field for arguments to editor executable
LLLineEditor* mDiffPathTextBox; // text field for path to diff file
LLButton* mDisplayFloaterBtn; // button to display primary floater
LLButton* mDisplayFloaterBtn_2; // button to display secondary floater
LLButton* mEditFloaterBtn; // button to edit floater
LLButton* mExecutableBrowseButton; // button to browse for executable
LLButton* mCloseOtherButton; // button to close primary displayed floater
LLButton* mCloseOtherButton_2; // button to close secondary displayed floater
LLButton* mDiffBrowseButton; // button to browse for diff file
LLButton* mToggleHighlightButton; // button to toggle highlight of files/elements with diffs
LLButton* mToggleOverlapButton; // button to togle overlap panel/highlighting
LLComboBox* mLanguageSelection; // combo box for primary language selection
LLComboBox* mLanguageSelection_2; // combo box for secondary language selection
LLScrollContainer* mOverlapScrollView; // overlapping elements scroll container
S32 mLastDisplayedX, mLastDisplayedY; // stored position of last floater so the new one opens up in the same place
std::string mDelim; // the OS-specific delimiter character (/ or \) (*TODO: this shouldn't be needed, right?)
static std::string mSavedEditorPath; // stored editor path so closing this floater doesn't reset it
static std::string mSavedEditorArgs; // stored editor args so closing this floater doesn't reset it
static std::string mSavedDiffPath; // stored diff file path so closing this floater doesn't reset it
// Internal functionality
static void popupAndPrintWarning(std::string& warning); // pop up a warning
std::string getLocalizedDirectory(); // build and return the path to the XUI directory for the currently-selected localization
void scanDiffFile(LLXmlTreeNode* file_node); // scan a given XML node for diff entries and highlight them in its associated file
void highlightChangedElements(); // look up the list of elements to highlight and highlight them in the current floater
void highlightChangedFiles(); // look up the list of changed files to highlight and highlight them in the scroll list
void findOverlapsInChildren(LLView* parent); // fill the map below with element overlap information
static BOOL overlapIgnorable(LLView* viewp); // check it the element can be ignored for overlap/localization purposes
// check if two elements overlap using their rectangles
// used instead of llrect functions because by adding a few pixels of leeway I can cut down drastically on the number of overlaps
BOOL elementOverlap(LLView* view1, LLView* view2);
// Button/drop-down action listeners (self explanatory)
static void onClickDisplayFloater(void*);
static void onClickSaveFloater(void*);
static void onClickEditFloater(void*);
static void onClickBrowseForEditor(void*);
static void onClickBrowseForDiffs(void*);
static void onClickToggleDiffHighlighting(void*);
static void onClickToggleOverlapping(void*);
static void onClickCloseDisplayedFloater(void*);
void onLanguageComboSelect(LLUICtrl* ctrl);
};
#endif // LL_LLUIPREVIEW_H
|
