Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.4

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

XalanQName.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2001 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(XALANQNAME_HEADER_GUARD_1357924680)
00058 #define XALANQNAME_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base header file.  Must be first.
00063 #include <XPath/XPathDefinitions.hpp>
00064 
00065 
00066 
00067 #include <deque>
00068 
00069 
00070 
00071 #include <XalanDOM/XalanDOMString.hpp>
00072 
00073 
00074 
00075 #include <PlatformSupport/DOMStringHelper.hpp>
00076 
00077 
00078 
00079 #include <XPath/NameSpace.hpp>
00080 
00081 
00082 
00083 class XalanElement;
00084 class PrefixResolver;
00085 class XPathEnvSupport;
00086 
00087 
00088 
00101 class XALAN_XPATH_EXPORT XalanQName
00102 {
00103 public:
00104 
00105 #if defined(XALAN_NO_NAMESPACES)
00106     typedef deque<NameSpace>                    NamespaceVectorType;
00107     typedef deque<NamespaceVectorType>          NamespacesStackType;
00108 #else
00109     typedef std::deque<NameSpace>               NamespaceVectorType;
00110     typedef std::deque<NamespaceVectorType>     NamespacesStackType;
00111 #endif
00112 
00117     explicit
00118     XalanQName()
00119     {
00120     }
00121 
00122     virtual
00123     ~XalanQName()
00124     {
00125     }
00126 
00132     virtual const XalanDOMString&
00133     getLocalPart() const = 0;
00134 
00140     virtual const XalanDOMString&
00141     getNamespace() const = 0;
00142 
00148     bool
00149     isValid() const
00150     {
00151         return isValidNCName(getLocalPart());
00152     }
00153 
00159     bool
00160     isEmpty() const
00161     {
00162         return ::isEmpty(getNamespace()) && ::isEmpty(getLocalPart());
00163     }
00164 
00172     bool
00173     equals(const XalanQName&    theRHS) const
00174     {
00175         // Note that we do not use our member variables here.  See
00176         // class QNameReference for details...
00177         return ::equals(getLocalPart(), theRHS.getLocalPart()) &&

00178 			   ::equals(getNamespace(), theRHS.getNamespace());
00179     }
00180 
00189     static const XalanDOMString*
00190     getNamespaceForPrefix(
00191             const NamespaceVectorType&  namespaces,
00192             const XalanDOMString&       prefix,
00193             bool                        reverse = true);
00194 
00204     static const XalanDOMString*
00205     getNamespaceForPrefix(
00206             const NamespacesStackType&  nsStack,
00207             const XalanDOMString&       prefix,
00208             bool                        reverse = true);
00209 
00218     static const XalanDOMString*
00219     getPrefixForNamespace(
00220             const NamespaceVectorType&  namespaces,
00221             const XalanDOMString&       uri,
00222             bool                        reverse = true);
00223 
00233     static const XalanDOMString*
00234     getPrefixForNamespace(
00235             const NamespacesStackType&  nsStack,
00236             const XalanDOMString&       uri,
00237             bool                        reverse = true);
00238 
00246     static bool
00247     isValidNCName(const XalanDOMString&     theNCName);
00248 
00257     static bool
00258     isValidNCName(
00259             const XalanDOMChar*         theNCName,
00260             XalanDOMString::size_type   theLength = XalanDOMString::npos);
00261 
00270     static bool
00271     isValidQName(const XalanDOMString&  theQName);
00272 
00282     static bool
00283     isValidQName(
00284             const XalanDOMChar*         theQName,
00285             XalanDOMString::size_type   theLength = XalanDOMString::npos);
00286 
00287 protected:
00288 
00289     static const XalanDOMString     s_emptyString;
00290 };
00291 
00292 
00293 
00294 inline bool
00295 operator==(
00296             const XalanQName&   theLHS,
00297             const XalanQName&   theRHS)
00298 {
00299     return theLHS.equals(theRHS);
00300 }
00301 
00302 
00303 
00304 inline bool
00305 operator!=(
00306             const XalanQName&   theLHS,
00307             const XalanQName&   theRHS)
00308 {
00309     return !(theLHS == theRHS);
00310 }
00311 
00312 
00313 
00314 inline bool
00315 operator<(
00316             const XalanQName&   theLHS,
00317             const XalanQName&   theRHS)
00318 {
00319     if (theLHS.getNamespace() < theRHS.getNamespace())
00320     {
00321         return true;
00322     }
00323     else if (equals(theLHS.getNamespace(), theRHS.getNamespace()))
00324     {
00325         return theLHS.getLocalPart() < theRHS.getLocalPart();
00326     }
00327     else
00328     {
00329         return false;
00330     }
00331 }
00332 
00333 
00334 
00335 #endif  // XALANQNAME_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.4
Copyright © 2000, 2001, 2002 The Apache Software Foundation. All Rights Reserved.