/indra/llui/llfloaterreg.cpp
https://bitbucket.org/lindenlab/viewer-beta/ · C++ · 507 lines · 375 code · 54 blank · 78 comment · 73 complexity · 255d9f5c14c2d0695c1d28b4b78f8830 MD5 · raw file
- /**
- * @file llfloaterreg.cpp
- * @brief LLFloaterReg Floater Registration Class
- *
- * $LicenseInfo:firstyear=2002&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 "llfloaterreg.h"
- //#include "llagent.h"
- #include "llfloater.h"
- #include "llmultifloater.h"
- #include "llfloaterreglistener.h"
- //*******************************************************
- //static
- LLFloaterReg::instance_list_t LLFloaterReg::sNullInstanceList;
- LLFloaterReg::instance_map_t LLFloaterReg::sInstanceMap;
- LLFloaterReg::build_map_t LLFloaterReg::sBuildMap;
- std::map<std::string,std::string> LLFloaterReg::sGroupMap;
- bool LLFloaterReg::sBlockShowFloaters = false;
- std::set<std::string> LLFloaterReg::sAlwaysShowableList;
- static LLFloaterRegListener sFloaterRegListener;
- //*******************************************************
- //static
- void LLFloaterReg::add(const std::string& name, const std::string& filename, const LLFloaterBuildFunc& func, const std::string& groupname)
- {
- sBuildMap[name].mFunc = func;
- sBuildMap[name].mFile = filename;
- sGroupMap[name] = groupname.empty() ? name : groupname;
- sGroupMap[groupname] = groupname; // for referencing directly by group name
- }
- //static
- LLFloater* LLFloaterReg::getLastFloaterInGroup(const std::string& name)
- {
- const std::string& groupname = sGroupMap[name];
- if (!groupname.empty())
- {
- instance_list_t& list = sInstanceMap[groupname];
- if (!list.empty())
- {
- for (instance_list_t::reverse_iterator iter = list.rbegin(); iter != list.rend(); ++iter)
- {
- LLFloater* inst = *iter;
- if (inst->getVisible() && !inst->isMinimized())
- {
- return inst;
- }
- }
- }
- }
- return NULL;
- }
- LLFloater* LLFloaterReg::getLastFloaterCascading()
- {
- LLRect candidate_rect;
- candidate_rect.mTop = 100000;
- LLFloater* candidate_floater = NULL;
- std::map<std::string,std::string>::const_iterator it = sGroupMap.begin(), it_end = sGroupMap.end();
- for( ; it != it_end; ++it)
- {
- const std::string& group_name = it->second;
- instance_list_t& instances = sInstanceMap[group_name];
- for (instance_list_t::const_iterator iter = instances.begin(); iter != instances.end(); ++iter)
- {
- LLFloater* inst = *iter;
- if (inst->getVisible() && inst->isPositioning(LLFloaterEnums::OPEN_POSITIONING_CASCADING))
- {
- if (candidate_rect.mTop > inst->getRect().mTop)
- {
- candidate_floater = inst;
- candidate_rect = inst->getRect();
- }
- }
- }
- }
- return candidate_floater;
- }
- //static
- LLFloater* LLFloaterReg::findInstance(const std::string& name, const LLSD& key)
- {
- LLFloater* res = NULL;
- const std::string& groupname = sGroupMap[name];
- if (!groupname.empty())
- {
- instance_list_t& list = sInstanceMap[groupname];
- for (instance_list_t::iterator iter = list.begin(); iter != list.end(); ++iter)
- {
- LLFloater* inst = *iter;
- if (inst->matchesKey(key))
- {
- res = inst;
- break;
- }
- }
- }
- return res;
- }
- //static
- LLFloater* LLFloaterReg::getInstance(const std::string& name, const LLSD& key)
- {
- LLFloater* res = findInstance(name, key);
- if (!res)
- {
- const LLFloaterBuildFunc& build_func = sBuildMap[name].mFunc;
- const std::string& xui_file = sBuildMap[name].mFile;
- if (build_func)
- {
- const std::string& groupname = sGroupMap[name];
- if (!groupname.empty())
- {
- instance_list_t& list = sInstanceMap[groupname];
- res = build_func(key);
- if (!res)
- {
- llwarns << "Failed to build floater type: '" << name << "'." << llendl;
- return NULL;
- }
- bool success = res->buildFromFile(xui_file, NULL);
- if (!success)
- {
- llwarns << "Failed to build floater type: '" << name << "'." << llendl;
- return NULL;
- }
- // Note: key should eventually be a non optional LLFloater arg; for now, set mKey to be safe
- if (res->mKey.isUndefined())
- {
- res->mKey = key;
- }
- res->setInstanceName(name);
- LLFloater *last_floater = (list.empty() ? NULL : list.back());
- res->applyControlsAndPosition(last_floater);
- gFloaterView->adjustToFitScreen(res, false);
- list.push_back(res);
- }
- }
- if (!res)
- {
- llwarns << "Floater type: '" << name << "' not registered." << llendl;
- }
- }
- return res;
- }
- //static
- LLFloater* LLFloaterReg::removeInstance(const std::string& name, const LLSD& key)
- {
- LLFloater* res = NULL;
- const std::string& groupname = sGroupMap[name];
- if (!groupname.empty())
- {
- instance_list_t& list = sInstanceMap[groupname];
- for (instance_list_t::iterator iter = list.begin(); iter != list.end(); ++iter)
- {
- LLFloater* inst = *iter;
- if (inst->matchesKey(key))
- {
- res = inst;
- list.erase(iter);
- break;
- }
- }
- }
- return res;
- }
- //static
- // returns true if the instance existed
- bool LLFloaterReg::destroyInstance(const std::string& name, const LLSD& key)
- {
- LLFloater* inst = removeInstance(name, key);
- if (inst)
- {
- delete inst;
- return true;
- }
- else
- {
- return false;
- }
- }
- // Iterators
- //static
- LLFloaterReg::const_instance_list_t& LLFloaterReg::getFloaterList(const std::string& name)
- {
- instance_map_t::iterator iter = sInstanceMap.find(name);
- if (iter != sInstanceMap.end())
- {
- return iter->second;
- }
- else
- {
- return sNullInstanceList;
- }
- }
- // Visibility Management
- //static
- LLFloater* LLFloaterReg::showInstance(const std::string& name, const LLSD& key, BOOL focus)
- {
- if( sBlockShowFloaters
- // see EXT-7090
- && sAlwaysShowableList.find(name) == sAlwaysShowableList.end())
- return 0;//
- LLFloater* instance = getInstance(name, key);
- if (instance)
- {
- instance->openFloater(key);
- if (focus)
- instance->setFocus(TRUE);
- }
- return instance;
- }
- //static
- // returns true if the instance exists
- bool LLFloaterReg::hideInstance(const std::string& name, const LLSD& key)
- {
- LLFloater* instance = findInstance(name, key);
- if (instance)
- {
- // When toggling *visibility*, close the host instead of the floater when hosted
- if (instance->getHost())
- instance->getHost()->closeFloater();
- else
- instance->closeFloater();
- return true;
- }
- else
- {
- return false;
- }
- }
- //static
- // returns true if the instance is visible when completed
- bool LLFloaterReg::toggleInstance(const std::string& name, const LLSD& key)
- {
- LLFloater* instance = findInstance(name, key);
- if (LLFloater::isShown(instance))
- {
- // When toggling *visibility*, close the host instead of the floater when hosted
- if (instance->getHost())
- instance->getHost()->closeFloater();
- else
- instance->closeFloater();
- return false;
- }
- else
- {
- return showInstance(name, key, TRUE) ? true : false;
- }
- }
- //static
- // returns true if the instance exists and is visible (doesnt matter minimized or not)
- bool LLFloaterReg::instanceVisible(const std::string& name, const LLSD& key)
- {
- LLFloater* instance = findInstance(name, key);
- return LLFloater::isVisible(instance);
- }
- //static
- void LLFloaterReg::showInitialVisibleInstances()
- {
- // Iterate through alll registered instance names and show any with a save visible state
- for (build_map_t::iterator iter = sBuildMap.begin(); iter != sBuildMap.end(); ++iter)
- {
- const std::string& name = iter->first;
- std::string controlname = getVisibilityControlName(name);
- if (LLFloater::getControlGroup()->controlExists(controlname))
- {
- BOOL isvis = LLFloater::getControlGroup()->getBOOL(controlname);
- if (isvis)
- {
- showInstance(name, LLSD()); // keyed floaters shouldn't set save_vis to true
- }
- }
- }
- }
- //static
- void LLFloaterReg::hideVisibleInstances(const std::set<std::string>& exceptions)
- {
- // Iterate through alll active instances and hide them
- for (instance_map_t::iterator iter = sInstanceMap.begin(); iter != sInstanceMap.end(); ++iter)
- {
- const std::string& name = iter->first;
- if (exceptions.find(name) != exceptions.end())
- continue;
- instance_list_t& list = iter->second;
- for (instance_list_t::iterator iter = list.begin(); iter != list.end(); ++iter)
- {
- LLFloater* floater = *iter;
- floater->pushVisible(FALSE);
- }
- }
- }
- //static
- void LLFloaterReg::restoreVisibleInstances()
- {
- // Iterate through all active instances and restore visibility
- for (instance_map_t::iterator iter = sInstanceMap.begin(); iter != sInstanceMap.end(); ++iter)
- {
- instance_list_t& list = iter->second;
- for (instance_list_t::iterator iter = list.begin(); iter != list.end(); ++iter)
- {
- LLFloater* floater = *iter;
- floater->popVisible();
- }
- }
- }
- //static
- std::string LLFloaterReg::getRectControlName(const std::string& name)
- {
- std::string res = std::string("floater_rect_") + name;
- LLStringUtil::replaceChar( res, ' ', '_' );
- return res;
- }
- //static
- std::string LLFloaterReg::declareRectControl(const std::string& name)
- {
- std::string controlname = getRectControlName(name);
- LLFloater::getControlGroup()->declareRect(controlname, LLRect(),
- llformat("Window Position and Size for %s", name.c_str()),
- TRUE);
- return controlname;
- }
- //static
- std::string LLFloaterReg::getVisibilityControlName(const std::string& name)
- {
- std::string res = std::string("floater_vis_") + name;
- LLStringUtil::replaceChar( res, ' ', '_' );
- return res;
- }
- //static
- std::string LLFloaterReg::declareVisibilityControl(const std::string& name)
- {
- std::string controlname = getVisibilityControlName(name);
- LLFloater::getControlGroup()->declareBOOL(controlname, FALSE,
- llformat("Window Visibility for %s", name.c_str()),
- TRUE);
- return controlname;
- }
- //static
- std::string LLFloaterReg::declareDockStateControl(const std::string& name)
- {
- std::string controlname = getDockStateControlName(name);
- LLFloater::getControlGroup()->declareBOOL(controlname, TRUE,
- llformat("Window Docking state for %s", name.c_str()),
- TRUE);
- return controlname;
- }
- //static
- std::string LLFloaterReg::getDockStateControlName(const std::string& name)
- {
- std::string res = std::string("floater_dock_") + name;
- LLStringUtil::replaceChar( res, ' ', '_' );
- return res;
- }
- //static
- void LLFloaterReg::registerControlVariables()
- {
- // Iterate through alll registered instance names and register rect and visibility control variables
- for (build_map_t::iterator iter = sBuildMap.begin(); iter != sBuildMap.end(); ++iter)
- {
- const std::string& name = iter->first;
- if (LLFloater::getControlGroup()->controlExists(getRectControlName(name)))
- {
- declareRectControl(name);
- }
- if (LLFloater::getControlGroup()->controlExists(getVisibilityControlName(name)))
- {
- declareVisibilityControl(name);
- }
- }
- const LLSD& exclude_list = LLUI::sSettingGroups["config"]->getLLSD("always_showable_floaters");
- for (LLSD::array_const_iterator iter = exclude_list.beginArray();
- iter != exclude_list.endArray();
- iter++)
- {
- sAlwaysShowableList.insert(iter->asString());
- }
- }
- //static
- void LLFloaterReg::toggleInstanceOrBringToFront(const LLSD& sdname, const LLSD& key)
- {
- //
- // Floaters controlled by the toolbar behave a bit differently from others.
- // Namely they have 3-4 states as defined in the design wiki page here:
- // https://wiki.lindenlab.com/wiki/FUI_Button_states
- //
- // The basic idea is this:
- // * If the target floater is minimized, this button press will un-minimize it.
- // * Else if the target floater is closed open it.
- // * Else if the target floater does not have focus, give it focus.
- // * Also, if it is not on top, bring it forward when focus is given.
- // * Else the target floater is open, close it.
- //
- std::string name = sdname.asString();
- LLFloater* instance = getInstance(name, key);
- if (!instance)
- {
- lldebugs << "Unable to get instance of floater '" << name << "'" << llendl;
- }
- else if (instance->isMinimized())
- {
- instance->setMinimized(FALSE);
- instance->setVisibleAndFrontmost();
- }
- else if (!instance->isShown())
- {
- instance->openFloater(key);
- instance->setVisibleAndFrontmost();
- }
- else if (!instance->isFrontmost())
- {
- instance->setVisibleAndFrontmost();
- }
- else
- {
- instance->closeFloater();
- }
- }
- // static
- U32 LLFloaterReg::getVisibleFloaterInstanceCount()
- {
- U32 count = 0;
- std::map<std::string,std::string>::const_iterator it = sGroupMap.begin(), it_end = sGroupMap.end();
- for( ; it != it_end; ++it)
- {
- const std::string& group_name = it->second;
- instance_list_t& instances = sInstanceMap[group_name];
- for (instance_list_t::const_iterator iter = instances.begin(); iter != instances.end(); ++iter)
- {
- LLFloater* inst = *iter;
- if (inst->getVisible() && !inst->isMinimized())
- {
- count++;
- }
- }
- }
- return count;
- }