/*
 * 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(FUNCTIONID_HEADER_GUARD_1357924680)
#define FUNCTIONID_HEADER_GUARD_1357924680



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



#include <xalanc/XalanDOM/XalanElement.hpp>
#include <xalanc/XalanDOM/XalanNode.hpp>
#include <xalanc/XalanDOM/XalanDocument.hpp>



// Base class header files...
#include <xalanc/XPath/Function.hpp>
#include <xalanc/XPath/XObjectTypeCallback.hpp>



#include <xalanc/PlatformSupport/DOMStringHelper.hpp>
#include <xalanc/PlatformSupport/StringTokenizer.hpp>



#include <xalanc/XPath/MutableNodeRefList.hpp>
#include <xalanc/XPath/NodeRefListBase.hpp>



XALAN_CPP_NAMESPACE_BEGIN



/**
 * XPath implementation of "id" function.
 */
class XALAN_XPATH_EXPORT FunctionID : public Function
{
public:

    typedef Function    ParentType;

    FunctionID();

    virtual
    ~FunctionID();

    // These methods are inherited from Function ...

    virtual XObjectPtr
    execute(
            XPathExecutionContext&  executionContext,
            XalanNode*              context,
            const XObjectPtr        arg1,
            const Locator*          locator) const;

    using ParentType::execute;

#if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
    virtual Function*
#else
    virtual FunctionID*
#endif
    clone(MemoryManager& theManager) const;

protected:

    virtual const XalanDOMString&
    getError(XalanDOMString& theResult) const;

private:

    class FunctionIDXObjectTypeCallback : public XObjectTypeCallback
    {
    public:

        FunctionIDXObjectTypeCallback(
                XPathExecutionContext&  theExecutionContext,
                XalanDOMString&         theString);

        void
        processCallback(const XObject&  theXObject);

        // These methods are inherited from XObjectTypeCallback ...

        virtual void
        Number(
            const XObject&  theXObject,
            double          /* theValue */);

        virtual void
        Boolean(
            const XObject&  theXObject,
            bool            /* theValue */);

        virtual void
        String(
            const XObject&          theXObject,
            const XalanDOMString&   /* theValue */);

        virtual void
        ResultTreeFragment(
            const XObject&                  theXObject,
            const XalanDocumentFragment&    /* theValue */);

        virtual void
        ResultTreeFragment(
            const XObject&          theXObject,
            XalanDocumentFragment&  /* theValue */);

        virtual void
        NodeSet(
            const XObject&          /* theXObject */,
            const NodeRefListBase&  theValue);

        virtual void
        Unknown(
            const XObject&          /* theObject */,
            const XalanDOMString&   /* theName */);

        virtual void
        Null(const XObject&     /* theObject */);

    private:

        XalanDOMString&         m_resultString;

        XPathExecutionContext&  m_executionContext;
    };

    // Not implemented...
    FunctionID&
    operator=(const FunctionID&);

    bool
    operator==(const FunctionID&) const;
};



XALAN_CPP_NAMESPACE_END



#endif  // FUNCTIONID_HEADER_GUARD_1357924680
