Xalan-C++ API Documentation

The Xalan C++ XSL Transformer Version 1.1

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

FunctionFunctionAvailable.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999 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(FUNCTIONFUNCTIONAVAILABLE_HEADER_GUARD_1357924680)
00058 #define FUNCTIONFUNCTIONAVAILABLE_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base header file.  Must be first.
00063 #include <XSLT/XSLTDefinitions.hpp>
00064 
00065 
00066 
00067 #include <set>
00068 #include <vector>
00069 
00070 
00071 
00072 #include <XPath/Function.hpp>
00073 
00074 
00075 
00076 class XObject;
00077 class XPathExecutionContext;
00078 
00079 
00080 
00081 // Implementation of the XSLT function function-available(). 
00082 //
00083 class XALAN_XSLT_EXPORT FunctionFunctionAvailable : public Function
00084 {
00085 public:
00086 
00087     FunctionFunctionAvailable();
00088 
00089     virtual
00090     ~FunctionFunctionAvailable();
00091 
00092     // These methods are inherited from Function ...
00093 
00094     XObjectPtr
00095     execute(
00096             XPathExecutionContext&      executionContext,
00097             XalanNode*                  context);
00098 
00099     virtual XObjectPtr
00100     execute(
00101             XPathExecutionContext&      executionContext,
00102             XalanNode*                  context,            
00103             const XObjectPtr            arg1);
00104 
00105     XObjectPtr
00106     execute(
00107             XPathExecutionContext&      executionContext,
00108             XalanNode*                  context,            
00109             const XObjectPtr            /* arg1 */,
00110             const XObjectPtr            /* arg2 */);
00111 
00112     XObjectPtr
00113     execute(
00114             XPathExecutionContext&      executionContext,
00115             XalanNode*                  context,            
00116             const XObjectPtr            /* arg1 */,
00117             const XObjectPtr            /* arg2 */,
00118             const XObjectPtr            /* arg3 */);
00119 
00120     XObjectPtr
00121     execute(
00122             XPathExecutionContext&      executionContext,
00123             XalanNode*                  context,
00124             int                         /* opPos */,
00125             const XObjectArgVectorType& /* args */);
00126 
00127 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00128     virtual Function*
00129 #else
00130     virtual FunctionFunctionAvailable*
00131 #endif
00132     clone() const;
00133 
00134 private:
00135 
00136     virtual const XalanDOMString
00137     getError() const;
00138 
00139     // Not implemented...
00140     FunctionFunctionAvailable&
00141     operator=(const FunctionFunctionAvailable&);
00142 
00143     bool
00144     operator==(const FunctionFunctionAvailable&) const;
00145 };
00146 
00147 
00148 
00149 #endif  // FUNCTIONFUNCTIONAVAILABLE_HEADER_GUARD_1357924680

Interpreting class diagrams

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

Xalan-C++ XSL Transformer Version 1.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.