EXT-1351 DEV-38496 Add "show rectangles" check to UI Preview Tool, which draws outlines of widgets and makes tooltips show their names and sizes. Used for localization to catch string truncations and fix them. Reviewed with Leyla.

4 files changed, 249 insertions, 132 deletions

diff --git a/indra/newview/llfloateruipreview.cpp b/indra/newview/llfloateruipreview.cpp
index 98ca33c9cc..de0b995f8f 100644
--- a/indra/newview/llfloateruipreview.cpp
+++ b/indra/newview/llfloateruipreview.cpp
@@ -56,8 +56,13 @@
 #include "llfilepicker.h"
 #include "lldraghandle.h"
 #include "lllayoutstack.h"
+#include "lltooltip.h"
 #include "llviewermenu.h"
 #include "llrngwriter.h"
+#include "llfloater.h"			// superclass
+#include "llfloaterreg.h"
+#include "llscrollcontainer.h"	// scroll container for overlapping elements
+#include "lllivefile.h"					// live file poll/stat/reload
 
 // Boost (for linux/unix command-line execv)
 #include <boost/tokenizer.hpp>
@@ -65,6 +70,8 @@
 
 // External utility
 #include <string>
+#include <list>
+#include <map>
 
 #if LL_DARWIN
 #include <CoreFoundation/CFURL.h>
@@ -74,6 +81,7 @@
 static const S32 PRIMARY_FLOATER = 1;
 static const S32 SECONDARY_FLOATER = 2;
 
+class LLOverlapPanel;
 static LLDefaultChildRegistry::Register<LLOverlapPanel> register_overlap_panel("overlap_panel");
 
 static std::string get_xui_dir()
@@ -82,6 +90,134 @@ static std::string get_xui_dir()
 	return gDirUtilp->getSkinBaseDir() + delim + "default" + delim + "xui" + delim;
 }
 
+// Forward declarations to avoid header dependencies
+class LLEventTimer;
+class LLColor;
+class LLScrollListCtrl;
+class LLComboBox;
+class LLButton;
+class LLLineEditor;
+class LLXmlTreeNode;
+class LLFloaterUIPreview;
+class LLFadeEventTimer;
+
+class LLLocalizationResetForcer;
+class LLGUIPreviewLiveFile;
+class LLFadeEventTimer;
+class LLPreviewedFloater;
+
+// 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();
+	
+	typedef std::map<LLView*, std::list<LLView*> >	OverlapMap;
+	OverlapMap mOverlapMap;						// map, of XUI element to a list of XUI elements it overlaps
+	
+	// LLView *mClickedElement;
+	LLView *mLastClickedElement;
+	int mOriginalWidth, mOriginalHeight, mSpacing;
+};
+
+
+class LLFloaterUIPreview : public LLFloater
+{
+public:
+	// Setup
+	LLFloaterUIPreview(const LLSD& key);
+	virtual ~LLFloaterUIPreview();
+
+	std::string getLocStr(S32 ID);							// fetches the localization string based on what is selected in the drop-down menu
+	void displayFloater(BOOL click, S32 ID, bool save = false);			// needs to be public so live file can call it when it finds an update
+
+	/*virtual*/ BOOL postBuild();
+	/*virtual*/ void onClose(bool app_quitting);
+
+	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
+	
+	static BOOL containerType(LLView* viewp);				// check if the element is a container type and tree traverses need to look at its children
+	
+public:	
+	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<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
+
+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?)
+
+	std::string					mSavedEditorPath;					// stored editor path so closing this floater doesn't reset it
+	std::string					mSavedEditorArgs;					// stored editor args so closing this floater doesn't reset it
+	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)
+	void onClickDisplayFloater(S32 id);
+	void onClickSaveFloater(S32 id);
+	void onClickSaveAll(S32 id);
+	void onClickEditFloater();
+	void onClickBrowseForEditor();
+	void onClickBrowseForDiffs();
+	void onClickToggleDiffHighlighting();
+	void onClickToggleOverlapping();
+	void onClickCloseDisplayedFloater(S32 id);
+	void onLanguageComboSelect(LLUICtrl* ctrl);
+	void onClickExportSchema();
+	void onClickShowRectangles(const LLSD& data);
+};
+
 //----------------------------------------------------------------------------
 // Local class declarations
 // Reset object to ensure that when we change the current language setting for preview purposes,
@@ -137,11 +273,17 @@ public:
 	}
 	virtual void draw();
 	BOOL handleRightMouseDown(S32 x, S32 y, MASK mask);
+	BOOL handleToolTip(S32 x, S32 y, MASK mask);
 	BOOL selectElement(LLView* parent, int x, int y, int depth);	// select element to display its overlappers
 
 	LLFloaterUIPreview* mFloaterUIPreview;
+
+	// draw widget outlines
+	static bool	sShowRectangles;
 };
 
+bool LLPreviewedFloater::sShowRectangles = false;
+
 //----------------------------------------------------------------------------
 
 // Localization reset forcer -- ensures that when localization is temporarily changed for previewed floater, it is reset
@@ -257,7 +399,6 @@ LLFloaterUIPreview::LLFloaterUIPreview(const LLSD& key)
 	mHighlightingOverlaps(FALSE),
 	mLastDisplayedX(0),
 	mLastDisplayedY(0)
-
 {
 	// called from floater reg: LLUICtrlFactory::getInstance()->buildFloater(this, "floater_ui_preview.xml");
 }
@@ -317,6 +458,8 @@ BOOL LLFloaterUIPreview::postBuild()
 	main_panel_tmp->getChild<LLButton>("save_all_floaters")->setClickedCallback(boost::bind(&LLFloaterUIPreview::onClickSaveAll, this, PRIMARY_FLOATER));
 
 	getChild<LLButton>("export_schema")->setClickedCallback(boost::bind(&LLFloaterUIPreview::onClickExportSchema, this));
+	getChild<LLUICtrl>("show_rectangles")->setCommitCallback(
+		boost::bind(&LLFloaterUIPreview::onClickShowRectangles, this, _2));
 
 	// get pointers to text fields
 	mEditorPathTextBox = editor_panel_tmp->getChild<LLLineEditor>("executable_path_field");
@@ -438,6 +581,10 @@ void LLFloaterUIPreview::onClickExportSchema()
 	gViewerWindow->setCursor(UI_CURSOR_ARROW);
 }
 
+void LLFloaterUIPreview::onClickShowRectangles(const LLSD& data)
+{
+	LLPreviewedFloater::sShowRectangles = data.asBoolean();
+}
 
 // Close click handler -- delete my displayed floater if it exists
 void LLFloaterUIPreview::onClose(bool app_quitting)
@@ -1357,6 +1504,73 @@ void LLFloaterUIPreview::onClickCloseDisplayedFloater(S32 caller_id)
 
 }
 
+void append_view_tooltip(LLView* tooltip_view, std::string *tooltip_msg)
+{
+	LLRect rect = tooltip_view->getRect();
+	LLRect parent_rect = tooltip_view->getParent()->getRect();
+	S32 left = rect.mLeft;
+	// invert coordinate system for XUI top-left layout
+	S32 top = parent_rect.getHeight() - rect.mTop;
+	if (!tooltip_msg->empty())
+	{
+		tooltip_msg->append("\n");
+	}
+	std::string msg = llformat("%s %d, %d (%d x %d)",
+		tooltip_view->getName().c_str(),
+		left,
+		top,
+		rect.getWidth(),
+		rect.getHeight() );
+	tooltip_msg->append( msg );
+}
+
+BOOL LLPreviewedFloater::handleToolTip(S32 x, S32 y, MASK mask)
+{
+	if (!sShowRectangles)
+	{
+		return LLFloater::handleToolTip(x, y, mask);
+	}
+
+	S32 screen_x, screen_y;
+	localPointToScreen(x, y, &screen_x, &screen_y);
+	std::string tooltip_msg;
+	LLView* tooltip_view = this;
+	LLView::tree_iterator_t end_it = endTreeDFS();
+	for (LLView::tree_iterator_t it = beginTreeDFS(); it != end_it; ++it)
+	{
+		LLView* viewp = *it;
+		LLRect screen_rect;
+		viewp->localRectToScreen(viewp->getLocalRect(), &screen_rect);
+		if (!(viewp->getVisible()
+			 && screen_rect.pointInRect(screen_x, screen_y)))
+		{
+			it.skipDescendants();
+		}
+		// only report xui names for LLUICtrls, not the various container LLViews
+
+		else if (dynamic_cast<LLUICtrl*>(viewp))
+		{
+			// if we are in a new part of the tree (not a descendent of current tooltip_view)
+			// then push the results for tooltip_view and start with a new potential view
+			// NOTE: this emulates visiting only the leaf nodes that meet our criteria
+
+			if (tooltip_view != this
+				&& !viewp->hasAncestor(tooltip_view))
+			{
+				append_view_tooltip(tooltip_view, &tooltip_msg);
+			}
+			tooltip_view = viewp;
+		}
+	}
+
+	append_view_tooltip(tooltip_view, &tooltip_msg);
+	
+	LLToolTipMgr::instance().show(LLToolTip::Params()
+		.message(tooltip_msg)
+		.max_width(400));
+	return TRUE;
+}
+
 BOOL LLPreviewedFloater::handleRightMouseDown(S32 x, S32 y, MASK mask)
 {
 	selectElement(this,x,y,0);
@@ -1415,7 +1629,22 @@ void LLPreviewedFloater::draw()
 		{
 			LLView::sDrawPreviewHighlights = TRUE;
 		}
+
+		// If we're looking for truncations, draw debug rects for the displayed
+		// floater only.
+		bool old_debug_rects = LLView::sDebugRects;
+		bool old_show_names = LLView::sDebugRectsShowNames;
+		if (sShowRectangles)
+		{
+			LLView::sDebugRects = true;
+			LLView::sDebugRectsShowNames = false;
+		}
+
 		LLFloater::draw();
+
+		LLView::sDebugRects = old_debug_rects;
+		LLView::sDebugRectsShowNames = old_show_names;
+
 		if(mFloaterUIPreview->mHighlightingOverlaps)
 		{
 			LLView::sDrawPreviewHighlights = FALSE;
@@ -1635,3 +1864,9 @@ void LLOverlapPanel::draw()
 		mLastClickedElement = LLView::sPreviewClickedElement;
 	}
 }
+
+void LLFloaterUIPreviewUtil::registerFloater()
+{
+	LLFloaterReg::add("ui_preview", "floater_ui_preview.xml",
+		&LLFloaterReg::build<LLFloaterUIPreview>);
+}
diff --git a/indra/newview/llfloateruipreview.h b/indra/newview/llfloateruipreview.h
index 2a98c90727..2a31b2df59 100644
--- a/indra/newview/llfloateruipreview.h
+++ b/indra/newview/llfloateruipreview.h
@@ -37,137 +37,10 @@
 #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 LLLineEditor;
-class LLXmlTreeNode;
-class LLFloaterUIPreview;
-class LLFadeEventTimer;
-
-class LLLocalizationResetForcer;
-class LLGUIPreviewLiveFile;
-class LLFadeEventTimer;
-class LLPreviewedFloater;
-
-// Implementation of custom overlapping element display panel
-class LLOverlapPanel : public LLPanel
+namespace LLFloaterUIPreviewUtil
 {
-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();
-	
-	typedef std::map<LLView*, std::list<LLView*> >	OverlapMap;
-	OverlapMap mOverlapMap;						// map, of XUI element to a list of XUI elements it overlaps
-	
-	// LLView *mClickedElement;
-	LLView *mLastClickedElement;
-	int mOriginalWidth, mOriginalHeight, mSpacing;
-};
-
-
-class LLFloaterUIPreview : public LLFloater
-{
-public:
-	// Setup
-	LLFloaterUIPreview(const LLSD& key);
-	virtual ~LLFloaterUIPreview();
-
-	std::string getLocStr(S32 ID);							// fetches the localization string based on what is selected in the drop-down menu
-	void displayFloater(BOOL click, S32 ID, bool save = false);			// needs to be public so live file can call it when it finds an update
-
-	/*virtual*/ BOOL postBuild();
-	/*virtual*/ void onClose(bool app_quitting);
-
-	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
-	
-	static BOOL containerType(LLView* viewp);				// check if the element is a container type and tree traverses need to look at its children
-	
-public:	
-	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<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
-
-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?)
-
-	std::string					mSavedEditorPath;					// stored editor path so closing this floater doesn't reset it
-	std::string					mSavedEditorArgs;					// stored editor args so closing this floater doesn't reset it
-	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);
+	void registerFloater();
+}
 
-	// Button/drop-down action listeners (self explanatory)
-	void onClickDisplayFloater(S32 id);
-	void onClickSaveFloater(S32 id);
-	void onClickSaveAll(S32 id);
-	void onClickEditFloater();
-	void onClickBrowseForEditor();
-	void onClickBrowseForDiffs();
-	void onClickToggleDiffHighlighting();
-	void onClickToggleOverlapping();
-	void onClickCloseDisplayedFloater(S32 id);
-	void onLanguageComboSelect(LLUICtrl* ctrl);
-	void onClickExportSchema();
-};
 #endif // LL_LLUIPREVIEW_H
 
diff --git a/indra/newview/llviewerfloaterreg.cpp b/indra/newview/llviewerfloaterreg.cpp
index e88217fae6..22081f9efa 100644
--- a/indra/newview/llviewerfloaterreg.cpp
+++ b/indra/newview/llviewerfloaterreg.cpp
@@ -232,7 +232,7 @@ void LLViewerFloaterReg::registerFloaters()
 	LLFloaterReg::add("snapshot", "floater_snapshot.xml", (LLFloaterBuildFunc)&LLFloaterReg::build<LLFloaterSnapshot>);
 	LLFloaterReg::add("search", "floater_directory.xml", (LLFloaterBuildFunc)&LLFloaterReg::build<LLFloaterDirectory>);
 	
-	LLFloaterReg::add("ui_preview", "floater_ui_preview.xml", &LLFloaterReg::build<LLFloaterUIPreview>);
+	LLFloaterUIPreviewUtil::registerFloater();
 	LLFloaterReg::add("upload_anim", "floater_animation_preview.xml", (LLFloaterBuildFunc)&LLFloaterReg::build<LLFloaterAnimPreview>, "upload");
 	LLFloaterReg::add("upload_image", "floater_image_preview.xml", (LLFloaterBuildFunc)&LLFloaterReg::build<LLFloaterImagePreview>, "upload");
 	LLFloaterReg::add("upload_sound", "floater_sound_preview.xml", (LLFloaterBuildFunc)&LLFloaterReg::build<LLFloaterSoundPreview>, "upload");
diff --git a/indra/newview/skins/default/xui/en/floater_ui_preview.xml b/indra/newview/skins/default/xui/en/floater_ui_preview.xml
index 4ed6787f53..c5e0c5ea13 100644
--- a/indra/newview/skins/default/xui/en/floater_ui_preview.xml
+++ b/indra/newview/skins/default/xui/en/floater_ui_preview.xml
@@ -171,6 +171,15 @@
          name="export_schema"
          top_delta="0"
          width="120" />
+        <check_box
+          follows="left|top"
+          label="Show Rectangles"
+          name="show_rectangles"
+          left_pad="10"
+          top_delta="0"
+          height="25"
+          width="120" />
+      
         <scroll_list
          bottom="525"
          column_padding="0"