Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

             

---

XSLTProcessor.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(XALAN_XSLTPROCESSOR_HEADER_GUARD)
#define XALAN_XSLTPROCESSOR_HEADER_GUARD



// Base include file.  Must be first.
#include "XSLTDefinitions.hpp"



#include <cstddef>



XALAN_DECLARE_XERCES_CLASS(Locator)



XALAN_CPP_NAMESPACE_BEGIN



typedef XERCES_CPP_NAMESPACE_QUALIFIER Locator  LocatorType;



class ElemTemplateElement;
class FormatterListener;
class GenerateEvent;
class NodeRefListBase;
class PrefixResolver;
class PrintWriter;
class SelectionEvent;
class StylesheetConstructionContext;
class StylesheetExecutionContext;
class StylesheetRoot;
class TraceListener;
class TracerEvent;
class XalanDOMString;
class XalanDocument;
class XalanElement;
class XalanNode;
class XMLParserLiaison;
class XObject;
class XObjectPtr;
class XPath;
class XPathExecutionContext;
class XSLTInputSource;
class XSLTResultTarget;



class XALAN_XSLT_EXPORT XSLTProcessor
{
public:

    typedef size_t  size_type;

    XSLTProcessor();

    virtual
    ~XSLTProcessor();

    virtual void
    process(
        const XSLTInputSource&          inputSource,
        const XSLTInputSource&          stylesheetSource,
        XSLTResultTarget&               outputTarget,
        StylesheetConstructionContext&  constructionContext,
        StylesheetExecutionContext&     executionContext) = 0;

    virtual void
    process(
            const XSLTInputSource&          inputSource,
            XSLTResultTarget&               outputTarget,
            StylesheetExecutionContext&     executionContext) = 0;

    virtual StylesheetRoot*
    processStylesheet(
            const XSLTInputSource&          stylesheetSource,
            StylesheetConstructionContext&  constructionContext) = 0;
  
    virtual StylesheetRoot*
    processStylesheet(
            const XalanDOMString&           xsldocURLString,
            StylesheetConstructionContext&  constructionContext) = 0;
  
    virtual void
    reset() = 0;
  
    virtual XalanNode*
    getSourceTreeFromInput(const XSLTInputSource&   inputSource) = 0;

    virtual const StylesheetRoot*
    getStylesheetRoot() const = 0;

    virtual void
    setStylesheetRoot(const StylesheetRoot*     theStylesheet) = 0;

    virtual void
    setExecutionContext(StylesheetExecutionContext*     theExecutionContext) = 0;

    virtual void
    resolveTopLevelParams(StylesheetExecutionContext&   executionContext) = 0;

    virtual XMLParserLiaison&
    getXMLParserLiaison() const = 0;


    virtual void
    getUniqueNamespaceValue(XalanDOMString&     theValue) = 0;

   virtual void
   setStylesheetParam(
            const XalanDOMString&   key,
            XObjectPtr              value) = 0;
  
    virtual void
    setStylesheetParam(
            const XalanDOMString&   key,
            const XalanDOMString&   expression) = 0;

    virtual FormatterListener*
    getFormatterListener() const = 0;
  
    virtual void
    setFormatterListener(FormatterListener*     flistener) = 0;  

    virtual size_type
    getTraceListeners() const = 0;

    virtual void
    addTraceListener(TraceListener*     tl) = 0;

    virtual void
    removeTraceListener(TraceListener*  tl) = 0;

    virtual void
    fireGenerateEvent(const GenerateEvent&  ge) = 0;

    virtual void
    fireTraceEvent(const TracerEvent&   te) = 0;

    virtual void
    fireSelectEvent(const SelectionEvent&   se) = 0;

    virtual bool
    getTraceSelects() const = 0;

    virtual void
    traceSelect(
            StylesheetExecutionContext&     executionContext,
            const ElemTemplateElement&      theStylesheetElement,
            const NodeRefListBase&          nl,
            const XPath*                    xpath) const = 0;

    virtual void
    setQuietConflictWarnings(bool b) = 0;

    virtual void
    setDiagnosticsOutput(PrintWriter* pw) = 0;

    virtual void
    message(
            const XalanDOMString&       msg,
            const XalanNode*            sourceNode = 0,
            const ElemTemplateElement*  styleNode = 0) const = 0;

    virtual void
    message(
            const XalanDOMString&   msg,
            const LocatorType&      locator,
            const XalanNode*        sourceNode = 0) const = 0;

    virtual void
    warn(
            const XalanDOMString&       msg,
            const XalanNode*            sourceNode = 0,
            const ElemTemplateElement*  styleNode = 0) const = 0;

    virtual void
    warn(
            const XalanDOMString&   msg,
            const LocatorType&      locator,
            const XalanNode*        sourceNode = 0) const = 0;


    virtual void
    error(
            const XalanDOMString&       msg,
            const XalanNode*            sourceNode = 0,
            const ElemTemplateElement*  styleNode = 0) const = 0;

    virtual void
    error(
            const XalanDOMString&   msg,
            const LocatorType&      locator,
            const XalanNode*        sourceNode = 0) const = 0;
};



XALAN_CPP_NAMESPACE_END



#endif  // XALAN_XSLTPROCESSOR_HEADER_GUARD

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.