/** * @file llxuiparser.h * @brief Utility functions for handling XUI structures in XML * * $LicenseInfo:firstyear=2003&license=viewergpl$ * * Copyright (c) 2003-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$ */ #ifndef LLXUIPARSER_H #define LLXUIPARSER_H #include "llinitparam.h" #include "llfasttimer.h" #include "llregistry.h" #include "llpointer.h" #include #include #include #include class LLView; typedef LLPointer LLXMLNodePtr; // lookup widget type by name class LLWidgetTypeRegistry : public LLRegistrySingleton {}; // global static instance for registering all widget types typedef boost::function LLWidgetCreatorFunc; typedef LLRegistry widget_registry_t; class LLChildRegistryRegistry : public LLRegistrySingleton {}; class LLXSDWriter : public LLInitParam::Parser { LOG_CLASS(LLXSDWriter); public: void writeXSD(const std::string& name, LLXMLNodePtr node, const LLInitParam::BaseBlock& block, const std::string& xml_namespace); /*virtual*/ std::string getCurrentElementName() { return LLStringUtil::null; } LLXSDWriter(); protected: void writeAttribute(const std::string& type, const Parser::name_stack_t&, S32 min_count, S32 max_count, const std::vector* possible_values); void addAttributeToSchema(LLXMLNodePtr nodep, const std::string& attribute_name, const std::string& type, bool mandatory, const std::vector* possible_values); LLXMLNodePtr mAttributeNode; LLXMLNodePtr mElementNode; LLXMLNodePtr mSchemaNode; typedef std::set string_set_t; typedef std::map attributes_map_t; attributes_map_t mAttributesWritten; }; // NOTE: DOES NOT WORK YET // should support child widgets for XUI class LLXUIXSDWriter : public LLXSDWriter { public: void writeXSD(const std::string& name, const std::string& path, const LLInitParam::BaseBlock& block); }; class LLXUIParser : public LLInitParam::Parser, public LLSingleton { LOG_CLASS(LLXUIParser); protected: LLXUIParser(); friend class LLSingleton; public: typedef LLInitParam::Parser::name_stack_t name_stack_t; /*virtual*/ std::string getCurrentElementName(); /*virtual*/ void parserWarning(const std::string& message); /*virtual*/ void parserError(const std::string& message); void readXUI(LLXMLNodePtr node, LLInitParam::BaseBlock& block, const std::string& filename = LLStringUtil::null, bool silent=false); void writeXUI(LLXMLNodePtr node, const LLInitParam::BaseBlock& block, const LLInitParam::BaseBlock* diff_block = NULL); private: bool readXUIImpl(LLXMLNodePtr node, const std::string& scope, LLInitParam::BaseBlock& block); bool readAttributes(LLXMLNodePtr nodep, LLInitParam::BaseBlock& block); //reader helper functions static bool readBoolValue(Parser& parser, void* val_ptr); static bool readStringValue(Parser& parser, void* val_ptr); static bool readU8Value(Parser& parser, void* val_ptr); static bool readS8Value(Parser& parser, void* val_ptr); static bool readU16Value(Parser& parser, void* val_ptr); static bool readS16Value(Parser& parser, void* val_ptr); static bool readU32Value(Parser& parser, void* val_ptr); static bool readS32Value(Parser& parser, void* val_ptr); static bool readF32Value(Parser& parser, void* val_ptr); static bool readF64Value(Parser& parser, void* val_ptr); static bool readColor4Value(Parser& parser, void* val_ptr); static bool readUIColorValue(Parser& parser, void* val_ptr); static bool readUUIDValue(Parser& parser, void* val_ptr); static bool readSDValue(Parser& parser, void* val_ptr); //writer helper functions bool writeBoolValue(const void* val_ptr, const name_stack_t&); bool writeStringValue(const void* val_ptr, const name_stack_t&); bool writeU8Value(const void* val_ptr, const name_stack_t&); bool writeS8Value(const void* val_ptr, const name_stack_t&); bool writeU16Value(const void* val_ptr, const name_stack_t&); bool writeS16Value(const void* val_ptr, const name_stack_t&); bool writeU32Value(const void* val_ptr, const name_stack_t&); bool writeS32Value(const void* val_ptr, const name_stack_t&); bool writeF32Value(const void* val_ptr, const name_stack_t&); bool writeF64Value(const void* val_ptr, const name_stack_t&); bool writeColor4Value(const void* val_ptr, const name_stack_t&); bool writeUIColorValue(const void* val_ptr, const name_stack_t&); bool writeUUIDValue(const void* val_ptr, const name_stack_t&); bool writeSDValue(const void* val_ptr, const name_stack_t&); LLXMLNodePtr getNode(const name_stack_t& stack); private: Parser::name_stack_t mNameStack; LLXMLNodePtr mCurReadNode; // Root of the widget XML sub-tree, for example, "line_editor" LLXMLNodePtr mWriteRootNode; typedef std::map out_nodes_t; out_nodes_t mOutNodes; S32 mLastWriteGeneration; LLXMLNodePtr mLastWrittenChild; S32 mCurReadDepth; std::string mCurFileName; }; // LLSimpleXUIParser is a streamlined SAX-based XUI parser that does not support localization // or parsing of a tree of independent param blocks, such as child widgets. // Use this for reading non-localized files that only need a single param block as a result. // // NOTE: In order to support nested block parsing, we need callbacks for start element that // push new blocks contexts on the mScope stack. // NOTE: To support localization without building a DOM, we need to enforce consistent // ordering of child elements from base file to localized diff file. Then we can use a pair // of coroutines to perform matching of xml nodes during parsing. Not sure if the overhead // of coroutines would offset the gain from SAX parsing class LLSimpleXUIParser : public LLInitParam::Parser, public LLSingleton { LOG_CLASS(LLSimpleXUIParser); protected: LLSimpleXUIParser(); virtual ~LLSimpleXUIParser(); friend class LLSingleton; public: typedef LLInitParam::Parser::name_stack_t name_stack_t; /*virtual*/ std::string getCurrentElementName(); /*virtual*/ void parserWarning(const std::string& message); /*virtual*/ void parserError(const std::string& message); bool readXUI(const std::string& filename, LLInitParam::BaseBlock& block, bool silent=false); void setBlock(LLInitParam::BaseBlock* block); private: //reader helper functions static bool readBoolValue(Parser&, void* val_ptr); static bool readStringValue(Parser&, void* val_ptr); static bool readU8Value(Parser&, void* val_ptr); static bool readS8Value(Parser&, void* val_ptr); static bool readU16Value(Parser&, void* val_ptr); static bool readS16Value(Parser&, void* val_ptr); static bool readU32Value(Parser&, void* val_ptr); static bool readS32Value(Parser&, void* val_ptr); static bool readF32Value(Parser&, void* val_ptr); static bool readF64Value(Parser&, void* val_ptr); static bool readColor4Value(Parser&, void* val_ptr); static bool readUIColorValue(Parser&, void* val_ptr); static bool readUUIDValue(Parser&, void* val_ptr); static bool readSDValue(Parser&, void* val_ptr); private: static void startElementHandler(void *userData, const char *name, const char **atts); static void endElementHandler(void *userData, const char *name); static void characterDataHandler(void *userData, const char *s, int len); void startElement(const char *name, const char **atts); void endElement(const char *name); void characterData(const char *s, int len); bool readAttributes(const char **atts); LLInitParam::BaseBlock* mBlock; Parser::name_stack_t mNameStack; struct XML_ParserStruct* mParser; S32 mLastWriteGeneration; LLXMLNodePtr mLastWrittenChild; S32 mCurReadDepth; std::string mCurFileName; std::string mTextContents; const char* mCurAttributeValueBegin; std::vector mTokenSizeStack; std::vector mScope; }; #endif //LLXUIPARSER_H