/indra/llui/lluictrlfactory.h
https://bitbucket.org/lindenlab/viewer-beta/ · C++ Header · 333 lines · 213 code · 57 blank · 63 comment · 13 complexity · 9c7089f7b91b93da95a6f63bce5a091f MD5 · raw file
- /**
- * @file lluictrlfactory.h
- * @brief Factory class for creating UI controls
- *
- * $LicenseInfo:firstyear=2003&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$
- */
- #ifndef LLUICTRLFACTORY_H
- #define LLUICTRLFACTORY_H
- #include "llfasttimer.h"
- #include "llinitparam.h"
- #include "llregistry.h"
- #include "llxuiparser.h"
- class LLView;
- // sort functor for typeid maps
- struct LLCompareTypeID
- {
- bool operator()(const std::type_info* lhs, const std::type_info* rhs) const
- {
- return lhs->before(*rhs);
- }
- };
- // lookup widget constructor funcs by widget name
- template <typename DERIVED_TYPE>
- class LLChildRegistry : public LLRegistrySingleton<std::string, LLWidgetCreatorFunc, DERIVED_TYPE>
- {
- public:
- typedef LLRegistrySingleton<std::string, LLWidgetCreatorFunc, DERIVED_TYPE> super_t;
- // local static instance for registering a particular widget
- template<typename T>
- class Register : public super_t::StaticRegistrar
- {
- public:
- // register with either the provided builder, or the generic templated builder
- Register(const char* tag, LLWidgetCreatorFunc func = NULL);
- };
- protected:
- LLChildRegistry() {}
- };
- class LLDefaultChildRegistry : public LLChildRegistry<LLDefaultChildRegistry>
- {
- protected:
- LLDefaultChildRegistry(){}
- friend class LLSingleton<LLDefaultChildRegistry>;
- };
- // lookup widget name by type
- class LLWidgetNameRegistry
- : public LLRegistrySingleton<const std::type_info*, std::string, LLWidgetNameRegistry , LLCompareTypeID>
- {};
- // lookup function for generating empty param block by widget type
- // this is used for schema generation
- //typedef const LLInitParam::BaseBlock& (*empty_param_block_func_t)();
- //class LLDefaultParamBlockRegistry
- //: public LLRegistrySingleton<const std::type_info*, empty_param_block_func_t, LLDefaultParamBlockRegistry, LLCompareTypeID>
- //{};
- extern LLFastTimer::DeclareTimer FTM_WIDGET_SETUP;
- extern LLFastTimer::DeclareTimer FTM_WIDGET_CONSTRUCTION;
- extern LLFastTimer::DeclareTimer FTM_INIT_FROM_PARAMS;
- // Build time optimization, generate this once in .cpp file
- #ifndef LLUICTRLFACTORY_CPP
- extern template class LLUICtrlFactory* LLSingleton<class LLUICtrlFactory>::getInstance();
- #endif
- class LLUICtrlFactory : public LLSingleton<LLUICtrlFactory>
- {
- private:
- friend class LLSingleton<LLUICtrlFactory>;
- LLUICtrlFactory();
- ~LLUICtrlFactory();
- // only partial specialization allowed in inner classes, so use extra dummy parameter
- template <typename PARAM_BLOCK, int DUMMY>
- class ParamDefaults : public LLSingleton<ParamDefaults<PARAM_BLOCK, DUMMY> >
- {
- public:
- ParamDefaults()
- {
- // look up template file for this param block...
- const std::string* param_block_tag = getWidgetTag(&typeid(PARAM_BLOCK));
- if (param_block_tag)
- { // ...and if it exists, back fill values using the most specific template first
- PARAM_BLOCK params;
- LLUICtrlFactory::loadWidgetTemplate(*param_block_tag, params);
- mPrototype.fillFrom(params);
- }
- // recursively fill from base class param block
- ((typename PARAM_BLOCK::base_block_t&)mPrototype).fillFrom(ParamDefaults<typename PARAM_BLOCK::base_block_t, DUMMY>::instance().get());
- }
- const PARAM_BLOCK& get() { return mPrototype; }
- private:
- PARAM_BLOCK mPrototype;
- };
- // base case for recursion, there are NO base classes of LLInitParam::BaseBlock
- template<int DUMMY>
- class ParamDefaults<LLInitParam::BaseBlock, DUMMY> : public LLSingleton<ParamDefaults<LLInitParam::BaseBlock, DUMMY> >
- {
- public:
- const LLInitParam::BaseBlock& get() { return mBaseBlock; }
- private:
- LLInitParam::BaseBlock mBaseBlock;
- };
- public:
- // get default parameter block for widget of a specific type
- template<typename T>
- static const typename T::Params& getDefaultParams()
- {
- //#pragma message("Generating ParamDefaults")
- return ParamDefaults<typename T::Params, 0>::instance().get();
- }
- // Does what you want for LLFloaters and LLPanels
- // Returns 0 on success
- S32 saveToXML(LLView* viewp, const std::string& filename);
- // filename tracking for debugging info
- std::string getCurFileName();
- void pushFileName(const std::string& name);
- void popFileName();
- template<typename T>
- static T* create(typename T::Params& params, LLView* parent = NULL)
- {
- params.fillFrom(ParamDefaults<typename T::Params, 0>::instance().get());
- T* widget = createWidgetImpl<T>(params, parent);
- if (widget)
- {
- widget->postBuild();
- }
- return widget;
- }
- LLView* createFromXML(LLXMLNodePtr node, LLView* parent, const std::string& filename, const widget_registry_t&, LLXMLNodePtr output_node );
- template<typename T>
- static T* createFromFile(const std::string &filename, LLView *parent, const widget_registry_t& registry, LLXMLNodePtr output_node = NULL)
- {
- T* widget = NULL;
-
- std::string skinned_filename = findSkinnedFilename(filename);
- instance().pushFileName(filename);
- {
- LLXMLNodePtr root_node;
- //if exporting, only load the language being exported,
- //instead of layering localized version on top of english
- if (output_node)
- {
- if (!LLUICtrlFactory::getLocalizedXMLNode(filename, root_node))
- {
- llwarns << "Couldn't parse XUI file: " << filename << llendl;
- goto fail;
- }
- }
- else if (!LLUICtrlFactory::getLayeredXMLNode(filename, root_node))
- {
- llwarns << "Couldn't parse XUI file: " << skinned_filename << llendl;
- goto fail;
- }
-
- LLView* view = getInstance()->createFromXML(root_node, parent, filename, registry, output_node);
- if (view)
- {
- widget = dynamic_cast<T*>(view);
- // not of right type, so delete it
- if (!widget)
- {
- llwarns << "Widget in " << filename << " was of type " << typeid(view).name() << " instead of expected type " << typeid(T).name() << llendl;
- delete view;
- view = NULL;
- }
- }
- }
- fail:
- instance().popFileName();
- return widget;
- }
- template<class T>
- static T* getDefaultWidget(const std::string& name)
- {
- typename T::Params widget_params;
- widget_params.name = name;
- return create<T>(widget_params);
- }
- static void createChildren(LLView* viewp, LLXMLNodePtr node, const widget_registry_t&, LLXMLNodePtr output_node = NULL);
- static bool getLayeredXMLNode(const std::string &filename, LLXMLNodePtr& root);
- static bool getLocalizedXMLNode(const std::string &xui_filename, LLXMLNodePtr& root);
- private:
- //NOTE: both friend declarations are necessary to keep both gcc and msvc happy
- template <typename T> friend class LLChildRegistry;
- template <typename T> template <typename U> friend class LLChildRegistry<T>::Register;
- static void copyName(LLXMLNodePtr src, LLXMLNodePtr dest);
- // helper function for adding widget type info to various registries
- static void registerWidget(const std::type_info* widget_type, const std::type_info* param_block_type, const std::string& tag);
- static void loadWidgetTemplate(const std::string& widget_tag, LLInitParam::BaseBlock& block);
- template<typename T>
- static T* createWidgetImpl(const typename T::Params& params, LLView* parent = NULL)
- {
- T* widget = NULL;
- if (!params.validateBlock())
- {
- llwarns << getInstance()->getCurFileName() << ": Invalid parameter block for " << typeid(T).name() << llendl;
- //return NULL;
- }
- { LLFastTimer _(FTM_WIDGET_CONSTRUCTION);
- widget = new T(params);
- }
- { LLFastTimer _(FTM_INIT_FROM_PARAMS);
- widget->initFromParams(params);
- }
- if (parent)
- {
- S32 tab_group = params.tab_group.isProvided() ? params.tab_group() : S32_MAX;
- setCtrlParent(widget, parent, tab_group);
- }
- return widget;
- }
- template<typename T>
- static T* defaultBuilder(LLXMLNodePtr node, LLView *parent, LLXMLNodePtr output_node)
- {
- LLFastTimer timer(FTM_WIDGET_SETUP);
- typename T::Params params(getDefaultParams<T>());
- LLXUIParser parser;
- parser.readXUI(node, params, LLUICtrlFactory::getInstance()->getCurFileName());
- if (output_node)
- {
- // We always want to output top-left coordinates
- typename T::Params output_params(params);
- T::setupParamsForExport(output_params, parent);
- // Export only the differences between this any default params
- typename T::Params default_params(getDefaultParams<T>());
- copyName(node, output_node);
- parser.writeXUI(output_node, output_params, &default_params);
- }
- // Apply layout transformations, usually munging rect
- params.from_xui = true;
- T::applyXUILayout(params, parent);
- T* widget = createWidgetImpl<T>(params, parent);
- typedef typename T::child_registry_t registry_t;
- createChildren(widget, node, registry_t::instance(), output_node);
- if (widget && !widget->postBuild())
- {
- delete widget;
- widget = NULL;
- }
- return widget;
- }
- static const std::string* getWidgetTag(const std::type_info* widget_type);
- // this exists to get around dependency on llview
- static void setCtrlParent(LLView* view, LLView* parent, S32 tab_group);
- // Avoid directly using LLUI and LLDir in the template code
- static std::string findSkinnedFilename(const std::string& filename);
- class LLPanel* mDummyPanel;
- std::vector<std::string> mFileNames;
- };
- // this is here to make gcc happy with reference to LLUICtrlFactory
- template<typename DERIVED>
- template<typename T>
- LLChildRegistry<DERIVED>::Register<T>::Register(const char* tag, LLWidgetCreatorFunc func)
- : LLChildRegistry<DERIVED>::StaticRegistrar(tag, func.empty() ? (LLWidgetCreatorFunc)&LLUICtrlFactory::defaultBuilder<T> : func)
- {
- // add this widget to various registries
- LLUICtrlFactory::instance().registerWidget(&typeid(T), &typeid(typename T::Params), tag);
-
- // since registry_t depends on T, do this in line here
- // TODO: uncomment this for schema generation
- //typedef typename T::child_registry_t registry_t;
- //LLChildRegistryRegistry::instance().defaultRegistrar().add(&typeid(T), registry_t::instance());
- }
- #endif //LLUICTRLFACTORY_H