Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.6

Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

FunctionDocument.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2003 The Apache Software Foundation.  All rights 
00006  * reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions
00010  * are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer. 
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in
00017  *    the documentation and/or other materials provided with the
00018  *    distribution.
00019  *
00020  * 3. The end-user documentation included with the redistribution,
00021  *    if any, must include the following acknowledgment:  
00022  *       "This product includes software developed by the
00023  *        Apache Software Foundation (http://www.apache.org/)."
00024  *    Alternately, this acknowledgment may appear in the software itself,
00025  *    if and wherever such third-party acknowledgments normally appear.
00026  *
00027  * 4. The names "Xalan" and "Apache Software Foundation" must
00028  *    not be used to endorse or promote products derived from this
00029  *    software without prior written permission. For written 
00030  *    permission, please contact apache@apache.org.
00031  *
00032  * 5. Products derived from this software may not be called "Apache",
00033  *    nor may "Apache" appear in their name, without prior written
00034  *    permission of the Apache Software Foundation.
00035  *
00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00039  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00040  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00041  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00042  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00043  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00044  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00045  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00046  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00047  * SUCH DAMAGE.
00048  * ====================================================================
00049  *
00050  * This software consists of voluntary contributions made by many
00051  * individuals on behalf of the Apache Software Foundation and was
00052  * originally based on software copyright (c) 1999, International
00053  * Business Machines, Inc., http://www.ibm.com.  For more
00054  * information on the Apache Software Foundation, please see
00055  * <http://www.apache.org/>.
00056  */
00057 #if !defined(FUNCTIONDOCUMENT_HEADER_GUARD_1357924680)
00058 #define FUNCTIONDOCUMENT_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base header file.  Must be first.
00063 #include <xalanc/XSLT/XSLTDefinitions.hpp>
00064 
00065 
00066 
00067 #include <xalanc/XPath/Function.hpp>
00068 
00069 
00070 
00071 XALAN_CPP_NAMESPACE_BEGIN
00072 
00073 
00074 
00075 // Implementation of the XSLT function document().
00076 //
00077 class XALAN_XSLT_EXPORT FunctionDocument : public Function
00078 {
00079 public:
00080 
00081     typedef Function    ParentType;
00082 
00083     FunctionDocument();
00084 
00085     virtual
00086     ~FunctionDocument();
00087 
00088     // These methods are inherited from Function ...
00089 
00090     virtual XObjectPtr
00091     execute(
00092             XPathExecutionContext&  executionContext,
00093             XalanNode*              context,
00094             const XObjectPtr        arg,
00095             const LocatorType*      locator) const;
00096 
00097     virtual XObjectPtr
00098     execute(
00099             XPathExecutionContext&  executionContext,
00100             XalanNode*              context,
00101             const XObjectPtr        arg1,
00102             const XObjectPtr        arg2,
00103             const LocatorType*      locator) const;
00104 
00105 #if !defined(XALAN_NO_USING_DECLARATION)
00106     using ParentType::execute;
00107 #endif
00108 
00109 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00110     virtual Function*
00111 #else
00112     virtual FunctionDocument*
00113 #endif
00114     clone() const;
00115 
00116 protected:
00117 
00118     const XalanDOMString
00119     getError() const;
00120 
00121 private:
00122 
00123     XObjectPtr
00124     doExecute(
00125             XPathExecutionContext&  executionContext,
00126             XalanNode*              context,            
00127             const XObjectPtr&       arg,
00128             XalanDOMString*         base,
00129             int                     argCount,
00130             const LocatorType*      locator,
00131             bool                    fNoRelativeURI = false) const;
00132 
00133     // Not implemented...
00134     FunctionDocument&
00135     operator=(const FunctionDocument&);
00136 
00137     bool
00138     operator==(const FunctionDocument&) const;
00139 };
00140 
00141 
00142 
00143 XALAN_CPP_NAMESPACE_END
00144 
00145 
00146 
00147 #endif  // FUNCTIONDOCUMENT_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.6
Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.