## Xalan-C++ API Documentation

### The Xalan C++ XSLT Processor Version 1.6

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

# Function.hpp

Go to the documentation of this file.

    00001 /*
    00002  * The Apache Software License, Version 1.1
    00003  *
    00004  *
    00005  * Copyright (c) 2000-2002 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(FUNCTION_HEADER_GUARD_1357924680)
    00058 #define FUNCTION_HEADER_GUARD_1357924680
    00059
    00060
    00061
    00062 // Base header file.  Must be first.
    00063 #include <xalanc/XPath/XPathDefinitions.hpp>
    00064
    00065
    00066
    00067 #include <vector>
    00068
    00069
    00070
    00071 #include <xalanc/XPath/XObject.hpp>
    00072 #include <xalanc/XPath/XPathExecutionContext.hpp>
    00073
    00074
    00075
    00076 XALAN_DECLARE_XERCES_CLASS(Locator)
    00077
    00078
    00079
    00080 XALAN_CPP_NAMESPACE_BEGIN
    00081
    00082
    00083
    00084 class XalanNode;
    00085
    00086
    00087
    00088 // Base class for all XPath function classes.
    00089 //
    00090 // These are all inline, even though
    00091 // there are virtual functions, because we expect that they will only be
    00092 // needed by the XPath class.
    00093 class XALAN_XPATH_EXPORT Function
    00094 {
    00095 public:
    00096
    00097     typedef XERCES_CPP_NAMESPACE_QUALIFIER Locator  LocatorType;
    00098
    00099     explicit
    00100     Function();
    00101
    00102     virtual
    00103     ~Function();
    00104
    00105     typedef XPathExecutionContext::XObjectArgVectorType XObjectArgVectorType;
    00106
    00121     virtual XObjectPtr
    00122     execute(
    00123             XPathExecutionContext&          executionContext,
    00124             XalanNode*                      context,
    00125             const XObjectArgVectorType&     args,
    00126             const LocatorType*              locator) const;
    00127
    00137     virtual XObjectPtr
    00138     execute(
    00139             XPathExecutionContext&  executionContext,
    00140             XalanNode*              context,
    00141             const LocatorType*      locator) const;
    00142
    00153     virtual XObjectPtr
    00154     execute(
    00155             XPathExecutionContext&  executionContext,
    00156             XalanNode*              context,
    00157             const XObjectPtr        arg,
    00158             const LocatorType*      locator) const;
    00159
    00171     virtual XObjectPtr
    00172     execute(
    00173             XPathExecutionContext&  executionContext,
    00174             XalanNode*              context,
    00175             const XObjectPtr        arg1,
    00176             const XObjectPtr        arg2,
    00177             const LocatorType*      locator) const;
    00178
    00191     virtual XObjectPtr
    00192     execute(
    00193             XPathExecutionContext&  executionContext,
    00194             XalanNode*              context,
    00195             const XObjectPtr        arg1,
    00196             const XObjectPtr        arg2,
    00197             const XObjectPtr        arg3,
    00198             const LocatorType*      locator) const;
    00199
    00205     virtual Function*
    00206     clone() const = 0;
    00207
    00208 protected:
    00209
    00217     virtual const XalanDOMString
    00218     getError() const = 0;
    00219
    00220 private:
    00221
    00222     // Not implemented...
    00223     Function&
    00224     operator=(const Function&);
    00225
    00226     bool
    00227     operator==(const Function&) const;
    00228 };
    00229
    00230
    00231
    00232 XALAN_CPP_NAMESPACE_END
    00233
    00234
    00235
    00236 #endif  // FUNCTION_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.