src/xalanc/XPath/NodeRefList.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(NODEREFLIST_HEADER_GUARD_1357924680)
#define NODEREFLIST_HEADER_GUARD_1357924680



// Base include file.  Must be first.
#include <xalanc/XPath/XPathDefinitions.hpp>



#include <xalanc/Include/XalanVector.hpp>



#include <xalanc/XPath/NodeRefListBase.hpp>



namespace XALAN_CPP_NAMESPACE {



/**
 * Local implementation of NodeRefList.  This class is for internal use only.
 */
class XALAN_XPATH_EXPORT NodeRefList : public NodeRefListBase
{
public:

    explicit
    NodeRefList(MemoryManager&  theManager XALAN_DEFAULT_CONSTRUCTOR_MEMMGR);

    /**
     * Construct a node list from another
     *
     * @param theSource source node list
     */
    NodeRefList(
        const NodeRefList&  theSource,
        MemoryManager&      theManager XALAN_DEFAULT_CONSTRUCTOR_MEMMGR);

    MemoryManager&
    getMemoryManager()
    {
        return m_nodeList.getMemoryManager();
    }

    /**
     * Construct a node list from another
     *
     * @param theSource source node list
     */
    explicit
    NodeRefList(
            const NodeRefListBase&  theSource,
            MemoryManager&          theManager XALAN_DEFAULT_CONSTRUCTOR_MEMMGR);

    virtual
    ~NodeRefList();

    NodeRefList&
    operator=(const NodeRefListBase&    theRHS);

    NodeRefList&
    operator=(const NodeRefList&    theRHS);

    bool
    empty() const
    {
        return m_nodeList.empty();
    }


    // These methods are inherited from NodeRefListBase ...

    virtual XalanNode*
    item(size_type  index) const;

    virtual size_type
    getLength() const;

    virtual size_type
    indexOf(const XalanNode*    theNode) const;

#if !defined(NDEBUG)
    bool
    checkForDuplicates(MemoryManager& theManager) const;
#endif

    typedef XalanVector<XalanNode*>         NodeListVectorType;

    void
    swap(NodeRefList&   theOther)
    {
        m_nodeList.swap(theOther.m_nodeList);
    }

protected:

    // Default vector allocation size.  It seems high, but
    // it's really worth it...
    enum
    {
        eDefaultVectorSize = 100
    };

    /**
     * Ensure that an allocation is either the default allocation
     * amount, or the amount specified in the parameter, whichever
     * is larger.
     *
     * @param theSize The requested size.
     */
    void
    ensureAllocation(NodeListVectorType::size_type  theSize = 0)
    {
        m_nodeList.reserve(eDefaultVectorSize > theSize ? eDefaultVectorSize : theSize);
    }

    NodeListVectorType  m_nodeList;
private:
#if defined (XALAN_DEVELOPMENT)
    // not defined
    NodeRefList();
    NodeRefList(const NodeRefList&  theSource);
#endif
};



}



#endif  // NODEREFLIST_HEADER_GUARD_1357924680