From 3653727e7f84f10caefb6ea7dc33859455ebfa0b Mon Sep 17 00:00:00 2001
From: Nat Goodspeed <nat@lindenlab.com>
Date: Wed, 10 Oct 2012 14:57:43 -0400
Subject: Introduce new LLDir::findSkinnedFilenames() method. Use as needed. In
a number of different places, for different reasons, the viewer wants to load
a UI-related file that might be overridden by a non-default skin; and within
that skin, might further be overridden by a non-default language. Apparently,
for each of those use cases, every individual developer approached it as an
entirely new problem, solving it idiosyncratically for that one case. Not
only is this a maintenance problem, but it rubs one's nose in the fact that
most such solutions consider only a subset of the relevant skin directories.
Richard and I evolved an API intended to address all such cases: a central
LLDir method returning a list of relevant pathnames, from most general to
most localized, filtered to present only existing files; plus a couple of
convenience methods to specifically obtain the most general and most
localized available file. There were several load-skinned-file methods
(LLFloater::buildFromFile(), LLPanel::buildFromFile() and
LLUICtrlFactory::createFromFile() -- apparently cloned-and-modified from each
other) that contained funky bolted-on logic to output the loaded data to an
optional passed LLXMLNodePtr param. The trouble is that passing that param
forced each of these methods to subvert its normal search: specifically for
that case, it needed to find the baseline XML file instead of the localized
one. Richard agreed that for the intended usage (reformatting XML files) we
should use XML schema instead, and that the hacky functionality should be
removed. Remove it. Also remove LLUICtrlFactory::getLocalizedXMLNode(), only
used for those three special cases. Some callers explicitly passed the
optional LLXMLNodePtr param as NULL. Remove that. Remove
LLFloaterUIPreview::displayFloater(save) param, which relied on the optional
output LLXMLNodePtr param. Make onClickSaveFloater() and onClickSaveAll()
emit popupAndPrintWarning() about discontinued functionality. Recast
LLFloater::buildFromFile(), LLPanel::buildFromFile(),
LLUICtrlFactory::createFromFile(), LLNotifications::loadTemplates(),
LLUI::locateSkin(), LLFontRegistry::parseFontInfo(),
LLUIColorTable::loadFromSettings(), LLUICtrlFactory::loadWidgetTemplate(),
LLUICtrlFactory::getLayeredXMLNode(), LLUIImageList::initFromFile(),
LLAppViewer::launchUpdater() and LLMediaCtrl::navigateToLocalPage() to use
findSkinnedFilenames(). (Is LLAppViewer::launchUpdater() ever called any
more? Apparently so -- though the linux-updater.bin logic to process the
relevant command-line switch has been disabled. Shrug.) (Is
LLMediaCtrl::navigateToLocalPage() ever used?? If so, why?) Remove
LLUI::setupPaths(), getXUIPaths(), getSkinPath() and getLocalizedSkinPath().
Remove the skins/paths.xml file read by setupPaths(). The only configuration
it contained was the pair of partial paths "xui/en" and "xui/[LANGUAGE]" --
hardly likely to change. getSkinPath() specifically returned the first of
these, while getLocalizedSkinPath() specifically returned the second. This
knowledge is now embedded in findSkinnedFilenames(). Also remove paths.xml
from viewer_manifest.py. Remove injected xui_paths from LLFontGL::initClass()
and LLFontRegistry::LLFontRegistry(). These are no longer needed since
LLFontRegistry can now directly consult LLDir for its path search. Stop
passing LLUI::getXUIPaths() to LLFontGL::initClass() in LLViewerWindow's
constructor and initFonts() method. Add LLDir::append() and add() methods for
the simple task of combining two path components separated by
getDirDelimiter() -- but only if they're both non-empty. Amazing how often
that logic is replicated. Replace some existing concatenations with add() or
append(). New LLDir::findSkinnedFilenames() method must know current
language. Allow injecting current language by adding an
LLDir::setSkinFolder(language) param, and pass it where LLAppViewer::init()
and initConfiguration() currently call setSkinFolder(). Also add
LLDir::getSkinFolder() and getLanguage() methods. Change LLFLoaterUIPreview's
LLLocalizationResetForcer helper to "forcibly reset language" using
LLDir::setSkinFolder() instead of LLUI::setupPaths(). Update LLDir stubs in
lldir_stub.cpp and llupdaterservice_test.cpp. Add
LLDir::getUserDefaultSkinDir() to obtain often-overlooked possible skin
directory -- like getUserSkinDir() but with "default" in place of the current
skin name as the last path component. (However, we hope
findSkinnedFilenames() obviates most explicit use of such individual skin
directory pathnames.) Add LLDir unit tests for new findSkinnedFilenames() and
add() methods -- the latter exercises append() as well. Tweak
indra/integration_tests/llui_libtest/llui_libtest.cpp for all the above.
Notably, comment out its export_test_floaters() function, since the essential
LLFloater::buildFromFile(optional LLXMLNodePtr) functionality has been
removed. This may mean that llui_libtest.cpp has little remaining value, not
sure.
---
indra/llui/llui.cpp | 87 ++++++++++++-----------------------------------------
1 file changed, 19 insertions(+), 68 deletions(-)
(limited to 'indra/llui/llui.cpp')
diff --git a/indra/llui/llui.cpp b/indra/llui/llui.cpp
index 87bf518aa1..507ced9172 100644
--- a/indra/llui/llui.cpp
+++ b/indra/llui/llui.cpp
@@ -1836,88 +1836,39 @@ struct Paths : public LLInitParam::Block<Paths>
{}
};
-//static
-void LLUI::setupPaths()
-{
- std::string filename = gDirUtilp->getExpandedFilename(LL_PATH_SKINS, "paths.xml");
-
- LLXMLNodePtr root;
- BOOL success = LLXMLNode::parseFile(filename, root, NULL);
- Paths paths;
-
- if(success)
- {
- LLXUIParser parser;
- parser.readXUI(root, paths, filename);
- }
- sXUIPaths.clear();
-
- if (success && paths.validateBlock())
- {
- LLStringUtil::format_map_t path_args;
- path_args["[LANGUAGE]"] = LLUI::getLanguage();
-
- for (LLInitParam::ParamIterator<Directory>::const_iterator it = paths.directories.begin(),
- end_it = paths.directories.end();
- it != end_it;
- ++it)
- {
- std::string path_val_ui;
- for (LLInitParam::ParamIterator<SubDir>::const_iterator subdir_it = it->subdirs.begin(),
- subdir_end_it = it->subdirs.end();
- subdir_it != subdir_end_it;)
- {
- path_val_ui += subdir_it->value();
- if (++subdir_it != subdir_end_it)
- path_val_ui += gDirUtilp->getDirDelimiter();
- }
- LLStringUtil::format(path_val_ui, path_args);
- if (std::find(sXUIPaths.begin(), sXUIPaths.end(), path_val_ui) == sXUIPaths.end())
- {
- sXUIPaths.push_back(path_val_ui);
- }
-
- }
- }
- else // parsing failed
- {
- std::string slash = gDirUtilp->getDirDelimiter();
- std::string dir = "xui" + slash + "en";
- llwarns << "XUI::config file unable to open: " << filename << llendl;
- sXUIPaths.push_back(dir);
- }
-}
-
//static
std::string LLUI::locateSkin(const std::string& filename)
{
- std::string slash = gDirUtilp->getDirDelimiter();
std::string found_file = filename;
- if (!gDirUtilp->fileExists(found_file))
+ if (gDirUtilp->fileExists(found_file))
{
- found_file = gDirUtilp->getExpandedFilename(LL_PATH_USER_SETTINGS, filename); // Should be CUSTOM_SKINS?
+ return found_file;
}
- if (sSettingGroups["config"] && sSettingGroups["config"]->controlExists("Language"))
+
+ found_file = gDirUtilp->getExpandedFilename(LL_PATH_USER_SETTINGS, filename); // Should be CUSTOM_SKINS?
+ if (gDirUtilp->fileExists(found_file))
{
- if (!gDirUtilp->fileExists(found_file))
- {
- std::string localization = getLanguage();
- std::string local_skin = "xui" + slash + localization + slash + filename;
- found_file = gDirUtilp->findSkinnedFilename(local_skin);
- }
+ return found_file;
}
- if (!gDirUtilp->fileExists(found_file))
+
+ found_file = gDirUtilp->findSkinnedFilename(LLDir::XUI, filename);
+ if (! found_file.empty())
{
- std::string local_skin = "xui" + slash + "en" + slash + filename;
- found_file = gDirUtilp->findSkinnedFilename(local_skin);
+ return found_file;
}
- if (!gDirUtilp->fileExists(found_file))
+
+ found_file = gDirUtilp->getExpandedFilename(LL_PATH_APP_SETTINGS, filename);
+/*==========================================================================*|
+ // Hmm, if we got this far, previous implementation of this method would
+ // return this last found_file value whether or not it actually exists.
+ if (gDirUtilp->fileExists(found_file))
{
- found_file = gDirUtilp->getExpandedFilename(LL_PATH_APP_SETTINGS, filename);
+ return found_file;
}
+|*==========================================================================*/
return found_file;
-}
+}
//static
LLVector2 LLUI::getWindowSize()
--
cgit v1.2.3
From 543b7ee9f7eb104497e971961fc0c39ed32ef54d Mon Sep 17 00:00:00 2001
From: Nat Goodspeed <nat@lindenlab.com>
Date: Fri, 12 Oct 2012 11:09:25 -0400
Subject: Fix LLUI::locateSkin() failure case; clarify lldir.cpp static init.
Per code review: Previous refactoring of LLUI::locateSkin() preserved odd
failure behavior: it would return last-considered pathname, whether or not it
exists. Changed to emit LL_WARNS log message and return empty string. Use
Boost.Assign to simplify initialization of a couple static containers in
lldir.cpp.
---
indra/llui/llui.cpp | 8 +++-----
1 file changed, 3 insertions(+), 5 deletions(-)
(limited to 'indra/llui/llui.cpp')
diff --git a/indra/llui/llui.cpp b/indra/llui/llui.cpp
index 507ced9172..6d2bc1837c 100644
--- a/indra/llui/llui.cpp
+++ b/indra/llui/llui.cpp
@@ -1859,15 +1859,13 @@ std::string LLUI::locateSkin(const std::string& filename)
}
found_file = gDirUtilp->getExpandedFilename(LL_PATH_APP_SETTINGS, filename);
-/*==========================================================================*|
- // Hmm, if we got this far, previous implementation of this method would
- // return this last found_file value whether or not it actually exists.
if (gDirUtilp->fileExists(found_file))
{
return found_file;
}
-|*==========================================================================*/
- return found_file;
+ LL_WARNS("LLUI") << "Can't find '" << filename
+ << "' in user settings, any skin directory or app_settings" << LL_ENDL;
+ return "";
}
//static
--
cgit v1.2.3