falagard/XMLHandler.h

/***********************************************************************
    created:    Fri Jun 17 2005
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2012 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIFalagard_xmlHandler_h_
#define _CEGUIFalagard_xmlHandler_h_

#include "../ChainedXMLHandler.h"
#include "./Dimensions.h"
#include "../Window.h"
#include <vector>

// Start of CEGUI namespace section
namespace CEGUI
{
    // forward refs
    class WidgetLookManager;
    class WidgetLookFeel;
    class WidgetComponent;
    class ImagerySection;
    class StateImagery;
    class LayerSpecification;
    class SectionSpecification;
    class ImageryComponent;
    class ComponentArea;
    class Dimension;
    class TextComponent;
    class NamedArea;
    class FrameComponent;
    class PropertyDefinitionBase;
    class EventLinkDefinition;

    class Falagard_xmlHandler : public ChainedXMLHandler
    {
    public:
        Falagard_xmlHandler(WidgetLookManager* mgr);

        ~Falagard_xmlHandler();
        
        static const String NativeVersion;

        static const String PropertyDefinitionHelpDefaultValue;

        static const String PropertyLinkDefinitionHelpDefaultValue;

        static const String GenericDataType;


        static const String ParentIdentifier;

        /*************************************************************************
            XML element and attribute name constants
        *************************************************************************/
        // element names
        static const String FalagardElement;            
        static const String WidgetLookElement;          
        static const String ChildElement;               
        static const String ImagerySectionElement;      
        static const String StateImageryElement;        
        static const String LayerElement;               
        static const String SectionElement;             
        static const String ImageryComponentElement;    
        static const String TextComponentElement;       
        static const String FrameComponentElement;      
        static const String AreaElement;                
        static const String ImageElement;               
        static const String ColoursElement;             
        static const String VertFormatElement;          
        static const String HorzFormatElement;          
        static const String VertAlignmentElement;       
        static const String HorzAlignmentElement;       
        static const String PropertyElement;            
                static const String DimElement;                 
                static const String UnifiedDimElement;          
        static const String AbsoluteDimElement;         
        static const String ImageDimElement;            
        static const String ImagePropertyDimElement;    
        static const String WidgetDimElement;           
        static const String FontDimElement;             
        static const String PropertyDimElement;         
        static const String TextElement;                
        static const String ColourPropertyElement;      
        static const String ColourRectPropertyElement;  
        static const String NamedAreaElement;           
        static const String PropertyDefinitionElement;  
        static const String PropertyLinkDefinitionElement;  
        static const String PropertyLinkTargetElement;  
        static const String OperatorDimElement;         
        static const String VertFormatPropertyElement;  
        static const String HorzFormatPropertyElement;  
        static const String AreaPropertyElement;        
        static const String ImagePropertyElement;       
        static const String TextPropertyElement;        
        static const String FontPropertyElement;        
        static const String ColourElement;              
        static const String EventLinkDefinitionElement; 
        static const String EventLinkTargetElement;     
        static const String NamedAreaSourceElement;
        static const String EventActionElement;
        // attribute names
        static const String VersionAttribute;           
        static const String TopLeftAttribute;           
        static const String TopRightAttribute;          
        static const String BottomLeftAttribute;        
        static const String BottomRightAttribute;       
        static const String TypeAttribute;              
        static const String NameAttribute;              
        static const String PriorityAttribute;          
        static const String SectionNameAttribute;       
        static const String NameSuffixAttribute;        
        static const String RendererAttribute;          
        static const String LookAttribute;              
        static const String ScaleAttribute;             
        static const String OffsetAttribute;            
        static const String ValueAttribute;             
        static const String DimensionAttribute;         
        static const String WidgetAttribute;            
        static const String StringAttribute;            
        static const String FontAttribute;              
        static const String InitialValueAttribute;      
        static const String ClippedAttribute;           
        static const String OperatorAttribute;          
        static const String PaddingAttribute;           
        static const String LayoutOnWriteAttribute;     
        static const String RedrawOnWriteAttribute;     
        static const String TargetPropertyAttribute;    
        static const String ControlPropertyAttribute;   
        static const String ColourAttribute;            
        static const String PropertyAttribute;          
        static const String ControlValueAttribute;      
        static const String ControlWidgetAttribute;     
        static const String HelpStringAttribute;
        static const String EventAttribute;
        static const String InheritsAttribute;
        static const String AutoWindowAttribute;
        static const String FireEventAttribute;
        static const String ActionAttribute;
        static const String ComponentAttribute;

    protected:
        /*************************************************************************
            ChainedXMLHandler base class overrides
        *************************************************************************/
        void elementStartLocal(const String& element,
                               const XMLAttributes& attributes);
        void elementEndLocal(const String& element);

    private:
        /*************************************************************************
            Typedefs
        *************************************************************************/
        typedef void (Falagard_xmlHandler::*ElementStartHandler)(const XMLAttributes& attributes);
        typedef void (Falagard_xmlHandler::*ElementEndHandler)();
        typedef std::map<String, ElementStartHandler, StringFastLessCompare> ElementStartHandlerMap;
        typedef std::map<String, ElementEndHandler, StringFastLessCompare> ElementEndHandlerMap;

        /*************************************************************************
            helper methods
        **************************************************************************/
        static argb_t hexStringToARGB(const String& str);

        /*************************************************************************
            implementation methods
        **************************************************************************/
        void assignAreaDimension(Dimension& dim);
        void assignColours(const ColourRect& colours);

        void doBaseDimStart(const BaseDim* dim);

        void elementFalagardStart(const XMLAttributes& attributes);

        void elementWidgetLookStart(const XMLAttributes& attributes);

        void elementChildStart(const XMLAttributes& attributes);

        void elementImagerySectionStart(const XMLAttributes& attributes);

        void elementStateImageryStart(const XMLAttributes& attributes);

        void elementLayerStart(const XMLAttributes& attributes);

        void elementSectionStart(const XMLAttributes& attributes);

        void elementImageryComponentStart(const XMLAttributes& attributes);

        void elementTextComponentStart(const XMLAttributes& attributes);

        void elementFrameComponentStart(const XMLAttributes& attributes);

        void elementAreaStart(const XMLAttributes& attributes);

        void elementImageStart(const XMLAttributes& attributes);

        void elementColoursStart(const XMLAttributes& attributes);

        void elementVertFormatStart(const XMLAttributes& attributes);

        void elementHorzFormatStart(const XMLAttributes& attributes);

        void elementVertAlignmentStart(const XMLAttributes& attributes);

        void elementHorzAlignmentStart(const XMLAttributes& attributes);

        void elementPropertyStart(const XMLAttributes& attributes);

        void elementDimStart(const XMLAttributes& attributes);

        void elementUnifiedDimStart(const XMLAttributes& attributes);

        void elementAbsoluteDimStart(const XMLAttributes& attributes);

        void elementImageDimStart(const XMLAttributes& attributes);

        void elementImagePropertyDimStart(const XMLAttributes& attributes);

        void elementWidgetDimStart(const XMLAttributes& attributes);

        void elementFontDimStart(const XMLAttributes& attributes);

        void elementPropertyDimStart(const XMLAttributes& attributes);

        void elementTextStart(const XMLAttributes& attributes);

        void elementColourRectPropertyStart(const XMLAttributes& attributes);

        void elementNamedAreaStart(const XMLAttributes& attributes);

        void elementPropertyDefinitionStart(const XMLAttributes& attributes);

        void elementPropertyLinkDefinitionStart(const XMLAttributes& attributes);

        void elementOperatorDimStart(const XMLAttributes& attributes);

        void elementVertFormatPropertyStart(const XMLAttributes& attributes);

        void elementHorzFormatPropertyStart(const XMLAttributes& attributes);

        void elementAreaPropertyStart(const XMLAttributes& attributes);

        void elementImagePropertyStart(const XMLAttributes& attributes);

        void elementTextPropertyStart(const XMLAttributes& attributes);

        void elementFontPropertyStart(const XMLAttributes& attributes);

        void elementColourStart(const XMLAttributes& attributes);

        void elementPropertyLinkTargetStart(const XMLAttributes& attributes);
        
        void elementAnimationDefinitionStart(const XMLAttributes& attributes);

        void elementEventLinkDefinitionStart(const XMLAttributes& attributes);

        void elementEventLinkTargetStart(const XMLAttributes& attributes);

        void elementNamedAreaSourceStart(const XMLAttributes& attributes);
        void elementEventActionStart(const XMLAttributes& attributes);

        void elementFalagardEnd();

        void elementWidgetLookEnd();

        void elementChildEnd();

        void elementImagerySectionEnd();

        void elementStateImageryEnd();

        void elementLayerEnd();

        void elementSectionEnd();

        void elementImageryComponentEnd();

        void elementTextComponentEnd();

        void elementFrameComponentEnd();

        void elementAreaEnd();

        void elementNamedAreaEnd();

        void elementAnyDimEnd();

        void elementPropertyLinkDefinitionEnd();

        void elementEventLinkDefinitionEnd();

        void registerElementStartHandler(const String& element, ElementStartHandler handler);

        void registerElementEndHandler(const String& element, ElementEndHandler handler);
    
        void processEventLinkTarget(const String& widget, const String& event);

        /*************************************************************************
            Implementation Data
        *************************************************************************/
        WidgetLookManager* d_manager;

        // these are used to implement the handler without using a huge
        // if / else if /else construct, we just register the element name, and
        // handler member function, and everything else is done using those
        // mappings.
        ElementStartHandlerMap  d_startHandlersMap;
        ElementEndHandlerMap    d_endHandlersMap;

        // these hold pointers to various objects under construction.
        WidgetLookFeel*     d_widgetlook;
        WidgetComponent*    d_childcomponent;
        ImagerySection*     d_imagerysection;
        StateImagery*       d_stateimagery;
        LayerSpecification* d_layer;
        SectionSpecification* d_section;
        ImageryComponent*   d_imagerycomponent;
        ComponentArea*   d_area;
        Dimension       d_dimension;
        TextComponent*  d_textcomponent;
        NamedArea*      d_namedArea;
        FrameComponent*  d_framecomponent;

        std::vector<BaseDim*
            CEGUI_VECTOR_ALLOC(BaseDim*)> d_dimStack;

        PropertyDefinitionBase* d_propertyLink;
        EventLinkDefinition* d_eventLink;
    };

} // End of  CEGUI namespace section


#endif  // end of guard _CEGUIFalagard_xmlHandler_h_