XMLParser.h

00001 /*
00002  * This source file is part of libRocket, the HTML/CSS Interface Middleware
00003  *
00004  * For the latest information, see http://www.librocket.com
00005  *
00006  * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
00007  *
00008  * Permission is hereby granted, free of charge, to any person obtaining a copy
00009  * of this software and associated documentation files (the "Software"), to deal
00010  * in the Software without restriction, including without limitation the rights
00011  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00012  * copies of the Software, and to permit persons to whom the Software is
00013  * furnished to do so, subject to the following conditions:
00014  *
00015  * The above copyright notice and this permission notice shall be included in
00016  * all copies or substantial portions of the Software.
00017  * 
00018  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00019  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00020  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00021  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00022  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00023  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00024  * THE SOFTWARE.
00025  *
00026  */
00027 
00028 #ifndef ROCKETCOREXMLPARSER_H
00029 #define ROCKETCOREXMLPARSER_H
00030 
00031 #include <stack>
00032 #include <Rocket/Core/Header.h>
00033 #include <Rocket/Core/BaseXMLParser.h>
00034 
00035 namespace Rocket {
00036 namespace Core {
00037 
00038 class DocumentHeader;
00039 class Element;
00040 class XMLNodeHandler;
00041 
00048 class ROCKETCORE_API XMLParser : public BaseXMLParser
00049 {
00050 public:
00051         XMLParser(Element* root);
00052         ~XMLParser();
00053 
00058         static XMLNodeHandler* RegisterNodeHandler(const String& tag, XMLNodeHandler* handler);
00060         static void ReleaseHandlers();
00061 
00064         DocumentHeader* GetDocumentHeader();
00067         const URL& GetSourceURL() const;
00068 
00069         // The parse stack.
00070         struct ParseFrame
00071         {
00072                 // Tag being parsed.
00073                 String tag;
00074 
00075                 // Element representing this frame.
00076                 Element* element;
00077 
00078                 // Handler used for this frame.
00079                 XMLNodeHandler* node_handler;
00080 
00081                 // The default handler used for this frame's children.
00082                 XMLNodeHandler* child_handler;
00083         };
00084 
00088         bool PushHandler(const String& tag);
00090         void PushDefaultHandler();
00091 
00094         const ParseFrame* GetParseFrame() const;
00095 
00096 protected:
00098         virtual void HandleElementStart(const String& name, const XMLAttributes& attributes);
00100         virtual void HandleElementEnd(const String& name);
00102         virtual void HandleData(const String& data);
00103 
00104 private:
00105         // The header of the document being parsed.
00106         DocumentHeader* header;
00107         // The root of the entire parse.
00108         Element* parse_root;
00109 
00110         // The active node handler.
00111         XMLNodeHandler* active_handler;
00112 
00113         // The parser stack.
00114         typedef std::stack< ParseFrame > ParserStack;
00115         ParserStack stack;
00116 };
00117 
00118 }
00119 }
00120 
00121 #endif