XMLRefInfo.hpp
上传用户:zhuqijet
上传日期:2013-06-25
资源大小:10074k
文件大小:9k
源码类别:

词法分析

开发平台:

Visual C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-2003 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Xerces" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation, and was
  51.  * originally based on software copyright (c) 1999, International
  52.  * Business Machines, Inc., http://www.ibm.com .  For more information
  53.  * on the Apache Software Foundation, please see
  54.  * <http://www.apache.org/>.
  55.  */
  56. /*
  57.  * $Log: XMLRefInfo.hpp,v $
  58.  * Revision 1.7  2003/05/16 21:36:55  knoaman
  59.  * Memory manager implementation: Modify constructors to pass in the memory manager.
  60.  *
  61.  * Revision 1.6  2003/05/15 18:26:07  knoaman
  62.  * Partial implementation of the configurable memory manager.
  63.  *
  64.  * Revision 1.5  2003/04/21 20:46:01  knoaman
  65.  * Use XMLString::release to prepare for configurable memory manager.
  66.  *
  67.  * Revision 1.4  2003/03/07 18:08:10  tng
  68.  * Return a reference instead of void for operator=
  69.  *
  70.  * Revision 1.3  2002/12/04 02:32:43  knoaman
  71.  * #include cleanup.
  72.  *
  73.  * Revision 1.2  2002/11/04 15:00:21  tng
  74.  * C++ Namespace Support.
  75.  *
  76.  * Revision 1.1.1.1  2002/02/01 22:21:52  peiyongz
  77.  * sane_include
  78.  *
  79.  * Revision 1.5  2000/07/07 22:23:38  jpolast
  80.  * remove useless getKey() functions.
  81.  *
  82.  * Revision 1.4  2000/02/24 20:00:23  abagchi
  83.  * Swat for removing Log from API docs
  84.  *
  85.  * Revision 1.3  2000/02/15 01:21:31  roddey
  86.  * Some initial documentation improvements. More to come...
  87.  *
  88.  * Revision 1.2  2000/02/06 07:47:49  rahulj
  89.  * Year 2K copyright swat.
  90.  *
  91.  * Revision 1.1.1.1  1999/11/09 01:08:37  twl
  92.  * Initial checkin
  93.  *
  94.  * Revision 1.2  1999/11/08 20:44:40  rahul
  95.  * Swat for adding in Product name and CVS comment log variable.
  96.  *
  97.  */
  98. #if !defined(XMLIDREFINFO_HPP)
  99. #define XMLIDREFINFO_HPP
  100. #include <xercesc/util/XMemory.hpp>
  101. #include <xercesc/util/PlatformUtils.hpp>
  102. #include <xercesc/util/XMLString.hpp>
  103. XERCES_CPP_NAMESPACE_BEGIN
  104. /**
  105.  *  This class provides a simple means to track ID Ref usage. Since id/idref
  106.  *  semamatics are part of XML 1.0, any validator will likely to be able to
  107.  *  track them. Instances of this class represent a reference and two markers,
  108.  *  one for its being declared and another for its being used. When the
  109.  *  document is done, one can look at each instance and, if used but not
  110.  *  declared, its an error.
  111.  *
  112.  *  The getKey() method allows it to support keyed collection semantics. It
  113.  *  returns the referenced name, so these objects will be stored via the hash
  114.  *  of the name. This name will either be a standard QName if namespaces are
  115.  *  not enabled/supported by the validator, or it will be in the form
  116.  *  {url}name if namespace processing is enabled.
  117.  */
  118. class XMLPARSER_EXPORT XMLRefInfo : public XMemory
  119. {
  120. public :
  121.     // -----------------------------------------------------------------------
  122.     //  Constructors and Destructor
  123.     // -----------------------------------------------------------------------
  124.     /** @name Constructor */
  125.     //@{
  126.     XMLRefInfo
  127.     (
  128.         const   XMLCh* const   refName
  129.         , const bool           fDeclared = false
  130.         , const bool           fUsed = false
  131.         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
  132.     );
  133.     //@}
  134.     /** @name Destructor */
  135.     //@{
  136.     ~XMLRefInfo();
  137.     //@}
  138.     // -----------------------------------------------------------------------
  139.     //  Getter methods
  140.     // -----------------------------------------------------------------------
  141.     bool getDeclared() const;
  142.     const XMLCh* getRefName() const;
  143.     bool getUsed() const;
  144.     // -----------------------------------------------------------------------
  145.     //  Setter methods
  146.     // -----------------------------------------------------------------------
  147.     void setDeclared(const bool newValue);
  148.     void setUsed(const bool newValue);
  149. private :
  150.     // -----------------------------------------------------------------------
  151.     //  Unimplemented constructors and operators
  152.     // -----------------------------------------------------------------------
  153.     XMLRefInfo();
  154.     XMLRefInfo(const XMLRefInfo&);
  155.     XMLRefInfo& operator=(XMLRefInfo&);
  156.     // -----------------------------------------------------------------------
  157.     //  Private data members
  158.     //
  159.     //  fDeclared
  160.     //      The name was declared somewhere as an ID attribute.
  161.     //
  162.     //  fRefName
  163.     //      The name of the ref that this object represents. This is not a
  164.     //      name of the attribute, but of the value of an ID or IDREF attr
  165.     //      in content.
  166.     //
  167.     //  fUsed
  168.     //      The name was used somewhere in an IDREF/IDREFS attribute. If this
  169.     //      is true, but fDeclared is false, then the ref does not refer to
  170.     //      a declared ID.
  171.     // -----------------------------------------------------------------------
  172.     bool        fDeclared;
  173.     bool        fUsed;
  174.     XMLCh*      fRefName;
  175.     MemoryManager* fMemoryManager;
  176. };
  177. // ---------------------------------------------------------------------------
  178. //  XMLRefInfo: Constructors and Destructor
  179. // ---------------------------------------------------------------------------
  180. inline XMLRefInfo::XMLRefInfo( const XMLCh* const   refName
  181.                              , const bool           declared
  182.                              , const bool           used
  183.                              , MemoryManager* const manager) :
  184.     fDeclared(declared)
  185.     , fUsed(used)
  186.     , fRefName(0)
  187.     , fMemoryManager(manager)
  188. {
  189.     fRefName = XMLString::replicate(refName, fMemoryManager);
  190. }
  191. inline XMLRefInfo::~XMLRefInfo()
  192. {
  193.     fMemoryManager->deallocate(fRefName);
  194. }
  195. // ---------------------------------------------------------------------------
  196. //  XMLRefInfo: Getter methods
  197. // ---------------------------------------------------------------------------
  198. inline bool XMLRefInfo::getDeclared() const
  199. {
  200.     return fDeclared;
  201. }
  202. inline const XMLCh* XMLRefInfo::getRefName() const
  203. {
  204.     return fRefName;
  205. }
  206. inline bool XMLRefInfo::getUsed() const
  207. {
  208.     return fUsed;
  209. }
  210. // ---------------------------------------------------------------------------
  211. //  XMLRefInfo: Setter methods
  212. // ---------------------------------------------------------------------------
  213. inline void XMLRefInfo::setDeclared(const bool newValue)
  214. {
  215.     fDeclared = newValue;
  216. }
  217. inline void XMLRefInfo::setUsed(const bool newValue)
  218. {
  219.     fUsed = newValue;
  220. }
  221. XERCES_CPP_NAMESPACE_END
  222. #endif