src/xalanc/XMLSupport/XalanHTMLElementsProperties.hpp

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the  "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#if !defined(XALANHTMLELEMENTSPROPERTIES_HEADER_GUARD_1357924680)
#define XALANHTMLELEMENTSPROPERTIES_HEADER_GUARD_1357924680



// Base include file.  Must be first.
#include <xalanc/XMLSupport/XMLSupportDefinitions.hpp>



#include <xalanc/XalanDOM/XalanDOMString.hpp>



namespace XALAN_CPP_NAMESPACE {



class XALAN_XMLSUPPORT_EXPORT XalanHTMLElementsProperties
{
public:

    enum { eMaxAttributes = 6, eMaxAttributeName = 8, eMaxElementName = 10 };

    enum eFlags
    {
        EMPTY = (1 << 1),
        FLOW = (1 << 2),
        BLOCK = (1 << 3),
        BLOCKFORM = (1 << 4),
        BLOCKFORMFIELDSET = (1 << 5),
        CDATA = (1 << 6),
        PCDATA = (1 << 7),
        RAW = (1 << 8),
        INLINE = (1 << 9),
        INLINEA = (1 << 10),
        INLINELABEL = (1 << 11),
        FONTSTYLE = (1 << 12),
        PHRASE = (1 << 13),
        FORMCTRL = (1 << 14),
        SPECIAL = (1 << 15),
        ASPECIAL = (1 << 16),
        HEADMISC = (1 << 17),
        HEAD = (1 << 18),
        LIST = (1 << 19),
        PREFORMATTED = (1 << 20),
        WHITESPACESENSITIVE = (1 << 21),
        HEADELEM = (1 << 22),
        STYLEELEM = (1 << 23),
        SCRIPTELEM = (1 << 24),

        ATTRURL = (1 << 1),
        ATTREMPTY = (1 << 2)
    };

    struct XALAN_XMLSUPPORT_EXPORT InternalAttributeProperties
    {
        typedef unsigned char   FlagsType;

        XalanDOMChar    m_name[eMaxAttributeName + 1];
    
        FlagsType       m_flags;

        /**
         * Check if particular properties are set for this
         * instance.  See the eFlag enum for the valid
         * properties.
         *
         * @param theFlags The properties to check.
         * @return true if the property is set, false if not
         */
        bool
        is(FlagsType    theFlags) const
        {
            return m_flags & theFlags ? true : false;
        }
    };

    struct XALAN_XMLSUPPORT_EXPORT InternalElementProperties
    {
        typedef InternalAttributeProperties::FlagsType  AttributeFlagsType;
        typedef unsigned int                            FlagsType;

        /**
         * Check if particular attribute properties are set
         * for this  instance. See the eFlag enum for the valid
         * properties.
         *
         * @param theAttributeName The attribute name.
         * @param theFlags The properties to check.
         * @return true if the property is set, false if not
         */
        bool
        isAttribute(
                const XalanDOMChar*     theAttributeName,
                AttributeFlagsType      theFlags) const;

        /**
         * Check if particular properties are set for this
         * instance.  See the eFlag enum for the valid
         * properties.
         *
         * @param theFlags The properties to check.
         * @return true if the property is set, false if not
         */
        bool
        is(FlagsType    theFlags) const
        {
            return m_flags & theFlags ? true : false;
        }

        // Data members...
        XalanDOMChar                    m_name[eMaxElementName + 1];

        FlagsType                       m_flags;

        InternalAttributeProperties     m_attributes[eMaxAttributes + 1];

        /**
         * Find an instance with the given attribute name.
         *
         * @param theAttributeName The attribute name.
         * @return A reference to an instance.
         */
        const InternalAttributeProperties&
        findProperties(const XalanDOMChar*  theAttributeName) const;

        static const InternalAttributeProperties    s_dummyProperties;
    };

    /**
     * This class acts as a proxy for an InternalElementProperties
     * instance.
     */
    class XALAN_XMLSUPPORT_EXPORT ElementProperties
    {
    public:

        typedef InternalElementProperties::AttributeFlagsType   AttributeFlagsType;
        typedef InternalElementProperties::FlagsType            FlagsType;

        /**
         * Constructor
         * @param theProperties The instance for which this one is a proxy.
         */
        ElementProperties(const InternalElementProperties*  theProperties = 0) :
            m_properties(theProperties)
        {
        }

        /**
         * Copy constructor
         * @param theSource The source instance for the copy.
         */
        ElementProperties(const ElementProperties&  theSource) :
            m_properties(theSource.m_properties)
        {
        }

        /**
         * Determine if this is a non-null instance.  You 
         * must call this before calling any member functions,
         * if you think the instance may be null.
         *
         * @return true if the instance is null, false if not
         */
        bool
        null() const
        {
            return m_properties == 0 ? true : false;
        }

        /**
         * Check if particular properties are set for this
         * instance.  See the eFlag enum for the valid
         * properties.
         *
         * @param theFlags The properties to check.
         * @return true if the property is set, false if not
         */
        bool
        is(FlagsType    theFlags) const
        {
            return m_properties->is(theFlags);
        }

        /**
         * Check if particular attribute properties are set
         * for this  instance. See the eFlag enum for the valid
         * properties.
         *
         * @param theAttributeName The attribute name.
         * @param theFlags The properties to check.
         * @return true if the property is set, false if not
         */
        bool
        isAttribute(
                const XalanDOMChar*     theAttributeName,
                AttributeFlagsType      theFlags) const
        {
            return m_properties->isAttribute(theAttributeName, theFlags);
        }

        /**
         * Get the name of the element.
         *
         * @return The name of the element.
         */
        const XalanDOMChar*
        getName() const
        {
            return m_properties->m_name;
        }

    private:

        const InternalElementProperties*    m_properties;
    };

    /**
     * Find an instance with the given name.
     *
     * @param theElementName The element name.
     * @return A reference to an instance.
     */
    static ElementProperties
    find(const XalanDOMChar*    theElementName);

private:

    /**
     * Find an instance with the given name.
     *
     * @param theElementName The element name.
     * @return A reference to an instance.
     */
    static const InternalElementProperties&
    findProperties(const XalanDOMChar*  theElementName);

    // The order of these is significant!!!

    // The array of properties...
    static const InternalElementProperties          s_elementProperties[];

    // This point to the last of the real propeties in the array.
    static const InternalElementProperties* const   s_lastProperties;

    // This point to the last of the properties in the array, which is
    // a dummy instance we return when an instance that matches the
    // element name cannot be found.
    static const InternalElementProperties* const   s_dummyProperties;


    // These are undefined...
    XalanHTMLElementsProperties();

    ~XalanHTMLElementsProperties();

    XalanHTMLElementsProperties&
    operator=(const XalanHTMLElementsProperties&);

};



}



#endif  // XALANHTMLELEMENTSPROPERTIES_HEADER_GUARD_1357924680