Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

             

---

XPathEnvSupportDefault.hpp

Go to the documentation of this file.

/*
 * Copyright 1999-2004 The Apache Software Foundation.
 *
 * Licensed 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(XPATHENVSUPPORTDEFAULT_HEADER_GUARD_1357924680)
#define XPATHENVSUPPORTDEFAULT_HEADER_GUARD_1357924680



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


#include<xalanc/PlatformSupport/DOMStringHelper.hpp>


#include<xalanc/Include/XalanMap.hpp>


XALAN_CPP_NAMESPACE_BEGIN

typedef XalanMap<XalanDOMString, const Function*>   FunctionTableTypeDefinition;
XALAN_USES_MEMORY_MANAGER(FunctionTableTypeDefinition)


class XALAN_XPATH_EXPORT XPathEnvSupportDefault : public XPathEnvSupport
{
public:

    typedef XalanMap<XalanDOMString, XalanDocument*>    SourceDocsTableType;
    typedef FunctionTableTypeDefinition                         FunctionTableType;
    typedef XalanMap<XalanDOMString, FunctionTableType> NamespaceFunctionTablesType;

    static void
    initialize(MemoryManagerType&  theManager);

    static void
    terminate();


    XPathEnvSupportDefault(MemoryManagerType&  theManager XALAN_DEFAULT_MEMMGR);

    virtual
    ~XPathEnvSupportDefault();

    MemoryManagerType& 
    getMemoryManager()
    {
        return m_sourceDocs.getMemoryManager();
    }

    // Interfaces to install and uninstall external functions globally.
    // These calls are not thread-safe, and should happen during
    // processing.

    static void
    installExternalFunctionGlobal(
            const XalanDOMString&   theNamespace,
            const XalanDOMString&   functionName,
            const Function&         function);

    static void
    uninstallExternalFunctionGlobal(
            const XalanDOMString&   theNamespace,
            const XalanDOMString&   functionName);

    // Interfaces to install and uninstall external functions in this instance.

    virtual void
    installExternalFunctionLocal(
            const XalanDOMString&   theNamespace,
            const XalanDOMString&   functionName,
            const Function&         function);

    virtual void
    uninstallExternalFunctionLocal(
            const XalanDOMString&   theNamespace,
            const XalanDOMString&   functionName);


    // These interfaces are inherited from XPathEnvSupport...

    virtual XalanDocument*
    parseXML(
            MemoryManagerType&      theManager,
            const XalanDOMString&   urlString,
            const XalanDOMString&   base);

    virtual XalanDocument*
    getSourceDocument(const XalanDOMString& theURI) const;

    virtual void
    setSourceDocument(
            const XalanDOMString&   theURI,
            XalanDocument*          theDocument);

    virtual const XalanDOMString&
    findURIFromDoc(const XalanDocument*     owner) const;

    virtual bool
    elementAvailable(
            const XalanDOMString&   theNamespace, 
            const XalanDOMString&   elementName) const;

    virtual bool
    functionAvailable(
            const XalanDOMString&   theNamespace, 
            const XalanDOMString&   functionName) const;

    virtual XObjectPtr
    extFunction(
            XPathExecutionContext&          executionContext,
            const XalanDOMString&           theNamespace,
            const XalanDOMString&           functionName, 
            XalanNode*                      context,
            const XObjectArgVectorType&     argVec,
            const LocatorType*              locator) const;

    virtual bool
    problem(
            eSource                 where,
            eClassification         classification,
            const PrefixResolver*   resolver,
            const XalanNode*        sourceNode,
            const XalanDOMString&   msg,
            const XalanDOMChar*     uri,
            int                     lineNo,
            int                     charOffset) const;

    // These interfaces are inherited from Resettable...

    virtual void
    reset();

    // Delete functor for table cleanup...
    struct NamespaceFunctionTableDeleteFunctor
    {
        typedef FunctionTableType               FunctionTableInnerType;
        typedef NamespaceFunctionTablesType     NamespaceFunctionTablesInnerType;

        NamespaceFunctionTableDeleteFunctor(MemoryManagerType& theManager);
        void
        operator()(const NamespaceFunctionTablesInnerType::value_type&  thePair) const;
    private:
        MemoryManagerType& m_memMgr;
    };

protected:

    const Function*
    findFunction(
            const XalanDOMString&   theNamespace,
            const XalanDOMString&   functionName) const;

private:

    // These are not implemented...
    XPathEnvSupportDefault(const XPathEnvSupportDefault&);

    XPathEnvSupportDefault&
    operator=(const XPathEnvSupportDefault&);

    bool
    operator==(const XPathEnvSupportDefault&) const;

    static void
    updateFunctionTable(
            NamespaceFunctionTablesType&    theTable,
            const XalanDOMString&           theNamespace,
            const XalanDOMString&           functionName,
            const Function*                 function);

    const Function*
    findFunction(
            const NamespaceFunctionTablesType&  theTable,
            const XalanDOMString&               theNamespace,
            const XalanDOMString&               functionName) const;

    // Data members...

    SourceDocsTableType                     m_sourceDocs;

    NamespaceFunctionTablesType             m_externalFunctions;

    static NamespaceFunctionTablesType      s_externalFunctions;

    static const XalanDOMString             s_emptyString;
};

XALAN_CPP_NAMESPACE_END



#endif  // XPATHENVSUPPORTDEFAULT_HEADER_GUARD_1357924680

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.10 Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.