Xalan-C++ API Documentation

The Xalan-C++ XSL Transformer Version 1.0

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

FunctionSubstring.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(FUNCTIONSUBSTRING_HEADER_GUARD_1357924680)
00058 #define FUNCTIONSUBSTRING_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base header file.  Must be first.
00063 #include <XPath/XPathDefinitions.hpp>
00064 
00065 
00066 
00067 #include <cfloat>
00068 
00069 
00070 
00071 #include <PlatformSupport/DoubleSupport.hpp>
00072 #include <PlatformSupport/DOMStringHelper.hpp>
00073 
00074 
00075 
00076 // Base class header file...
00077 #include <XPath/Function.hpp>
00078 
00079 
00080 
00081 #include <XPath/FunctionRound.hpp>
00082 #include <XPath/XObject.hpp>
00083 #include <XPath/XObjectFactory.hpp>
00084 #include <XPath/XPathExecutionContext.hpp>
00085 
00086 
00087 
00091 //
00092 // These are all inline, even though
00093 // there are virtual functions, because we expect that they will only be
00094 // needed by the XPath class.
00095 class XALAN_XPATH_EXPORT FunctionSubstring : public Function
00096 {
00097 public:
00098 
00099     // These methods are inherited from Function ...
00100 
00101     virtual XObject*
00102     execute(
00103             XPathExecutionContext&          executionContext,
00104             XalanNode*                      context,
00105             int                             /* opPos */,
00106             const XObjectArgVectorType&     args)
00107     {
00108         const XObjectArgVectorType::size_type   theArgCount =
00109                 args.size();
00110 
00111         if (theArgCount < 2 || theArgCount > 3)
00112         {
00113             executionContext.error("The substring() function takes two or three arguments!",
00114                                    context);
00115         }
00116 
00117         const XalanDOMString&   theSourceString = args[0]->str();
00118         const unsigned int      theSourceStringLength = length(theSourceString);
00119 
00120 #if !defined(XALAN_NO_NAMESPACES)
00121         using std::vector;
00122 #endif
00123 
00124         // This buffer will hold the output characters.
00125         vector<XalanDOMChar>    theBuffer;
00126 
00127         if (theSourceStringLength > 0)
00128         {
00129             // The substring can only be as long as the source string,
00130             // so reserve enough space now.  Also reserve space for
00131             // the terminating 0.
00132             theBuffer.reserve(theSourceStringLength);
00133 
00134             // $$$ ToDo: Add support for NaN.
00135 
00136             // Get the value of the second argument...
00137             const double    theSecondArgValue =
00138                 FunctionRound::getRoundedValue(args[1]->num());
00139 
00140             // Now, total the second and third arguments.  If
00141             // the third argument is missing, make the total
00142             // DBL_MAX.
00143             const double    theTotal =
00144                     theArgCount == 2 ? DBL_MAX :
00145                                        FunctionRound::getRoundedValue(theSecondArgValue + args[2]->num());
00146 
00147             if (DoubleSupport::isNaN(theSecondArgValue) == false &&
00148                 DoubleSupport::isNaN(theTotal) == false &&
00149                 DoubleSupport::isNegativeInfinity(theTotal) == false)
00150             {
00151                 // Start with 1, since strings are index from 1 in the XPath spec,
00152                 for (unsigned int i = 1; i <= theSourceStringLength; i++)
00153                 {
00154                     // Is the index greater than or equal to the second argument?
00155                     if (i >= theSecondArgValue)
00156                     {
00157                         // Is it less than the sum of the second and
00158                         // third arguments?
00159                         if (i < theTotal)
00160                         {
00161                             // It is, so include the character.
00162                             theBuffer.push_back(charAt(theSourceString, i - 1));
00163                         }
00164                         else
00165                         {
00166                             // It's not, so stop.
00167                             break;
00168                         }
00169                     }
00170                 }
00171             }
00172         }
00173 
00174         return executionContext.getXObjectFactory().createString(XalanDOMString(theBuffer.begin(), theBuffer.size()));
00175     }
00176 
00177 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00178     virtual Function*
00179 #else
00180     virtual FunctionSubstring*
00181 #endif
00182     clone() const
00183     {
00184         return new FunctionSubstring(*this);
00185     }
00186 
00187 private:
00188 
00189     // Not implemented...
00190     FunctionSubstring&
00191     operator=(const FunctionSubstring&);
00192 
00193     bool
00194     operator==(const FunctionSubstring&) const;
00195 };
00196 
00197 
00198 
00199 #endif  // FUNCTIONSUBSTRING_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.0
Copyright © 2000 The Apache Software Foundation. All Rights Reserved.