XMLAttDef.hpp Source File

| API Docs for SAX and DOM |

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

# XMLAttDef.hpp

Go to the documentation of this file.

    00001 /*
    00002  * The Apache Software License, Version 1.1
    00003  *
    00004  * Copyright (c) 1999-2003 The Apache Software Foundation.  All rights
    00005  * reserved.
    00006  *
    00007  * Redistribution and use in source and binary forms, with or without
    00008  * modification, are permitted provided that the following conditions
    00009  * are met:
    00010  *
    00011  * 1. Redistributions of source code must retain the above copyright
    00012  *    notice, this list of conditions and the following disclaimer.
    00013  *
    00014  * 2. Redistributions in binary form must reproduce the above copyright
    00015  *    notice, this list of conditions and the following disclaimer in
    00016  *    the documentation and/or other materials provided with the
    00017  *    distribution.
    00018  *
    00019  * 3. The end-user documentation included with the redistribution,
    00020  *    if any, must include the following acknowledgment:
    00021  *       "This product includes software developed by the
    00022  *        Apache Software Foundation (http://www.apache.org/)."
    00023  *    Alternately, this acknowledgment may appear in the software itself,
    00024  *    if and wherever such third-party acknowledgments normally appear.
    00025  *
    00026  * 4. The names "Xerces" and "Apache Software Foundation" must
    00027  *    not be used to endorse or promote products derived from this
    00028  *    software without prior written permission. For written
    00029  *    permission, please contact apache\@apache.org.
    00030  *
    00031  * 5. Products derived from this software may not be called "Apache",
    00032  *    nor may "Apache" appear in their name, without prior written
    00033  *    permission of the Apache Software Foundation.
    00034  *
    00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
    00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
    00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
    00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
    00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    00046  * SUCH DAMAGE.
    00047  * ====================================================================
    00048  *
    00049  * This software consists of voluntary contributions made by many
    00050  * individuals on behalf of the Apache Software Foundation, and was
    00051  * originally based on software copyright (c) 1999, International
    00052  * Business Machines, Inc., http://www.ibm.com .  For more information
    00053  * on the Apache Software Foundation, please see
    00054  * <http://www.apache.org/>.
    00055  */
    00056
    00057 /*
    00058  * $Log: XMLAttDef.hpp,v $
    00059  * Revision 1.9  2003/05/16 21:36:55  knoaman
    00060  * Memory manager implementation: Modify constructors to pass in the memory manager.
    00061  *
    00062  * Revision 1.8  2003/05/15 18:26:07  knoaman
    00063  * Partial implementation of the configurable memory manager.
    00064  *
    00065  * Revision 1.7  2003/04/21 20:46:01  knoaman
    00066  * Use XMLString::release to prepare for configurable memory manager.
    00067  *
    00068  * Revision 1.6  2003/03/07 18:08:10  tng
    00069  * Return a reference instead of void for operator=
    00070  *
    00071  * Revision 1.5  2003/01/29 19:45:35  gareth
    00072  * added api for DOMTypeInfo
    00073  *
    00074  * Revision 1.4  2002/12/10 02:15:55  knoaman
    00075  * Schema Errata: E1-21.
    00076  *
    00077  * Revision 1.3  2002/11/04 15:00:21  tng
    00078  * C++ Namespace Support.
    00079  *
    00080  * Revision 1.2  2002/02/20 18:17:01  tng
    00081  * [Bug 5977] Warnings on generating apiDocs.
    00082  *
    00083  * Revision 1.1.1.1  2002/02/01 22:21:50  peiyongz
    00084  * sane_include
    00085  *
    00086  * Revision 1.13  2001/11/15 16:36:36  knoaman
    00087  * Re-organize constant values.
    00088  *
    00089  * Revision 1.12  2001/08/09 15:23:37  knoaman
    00090  * add support for <anyAttribute> declaration.
    00091  *
    00092  * Revision 1.11  2001/06/21 14:25:26  knoaman
    00093  * Fix for bug 1946
    00094  *
    00095  * Revision 1.10  2001/05/11 13:25:31  tng
    00096  * Copyright update.
    00097  *
    00098  * Revision 1.9  2001/02/27 18:48:20  tng
    00099  * Schema: Add SchemaAttDef, SchemaElementDecl, SchemaAttDefList.
    00100  *
    00101  * Revision 1.8  2000/12/14 18:49:56  tng
    00102  * Fix API document generation warning: "Warning: end of member group without matching begin"
    00103  *
    00104  * Revision 1.7  2000/11/30 18:22:38  andyh
    00105  * reuseValidator - fix bugs (spurious errors) that occured on reuse due to
    00106  * pools already containing some items.  Fixed by Tinny Ng.
    00107  *
    00108  * Revision 1.6  2000/07/07 22:23:38  jpolast
    00109  * remove useless getKey() functions.
    00110  *
    00111  * Revision 1.5  2000/02/24 20:00:22  abagchi
    00112  * Swat for removing Log from API docs
    00113  *
    00114  * Revision 1.4  2000/02/16 23:03:48  roddey
    00115  * More documentation updates
    00116  *
    00117  * Revision 1.3  2000/02/15 01:21:30  roddey
    00118  * Some initial documentation improvements. More to come...
    00119  *
    00120  * Revision 1.2  2000/02/06 07:47:46  rahulj
    00121  * Year 2K copyright swat.
    00122  *
    00123  * Revision 1.1.1.1  1999/11/09 01:08:27  twl
    00124  * Initial checkin
    00125  *
    00126  * Revision 1.2  1999/11/08 20:44:34  rahul
    00127  * Swat for adding in Product name and CVS comment log variable.
    00128  *
    00129  */
    00130
    00131 #if !defined(ATTDEF_HPP)
    00132 #define ATTDEF_HPP
    00133
    00134 #include <xercesc/util/PlatformUtils.hpp>
    00135 #include <xercesc/util/XMLString.hpp>
    00136 #include <xercesc/util/XMemory.hpp>
    00137
    00138 XERCES_CPP_NAMESPACE_BEGIN
    00139
    00140 class XMLAttr;
    00141
    00160 class  XMLAttDef : public XMemory
    00161 {
    00162 public:
    00163     // -----------------------------------------------------------------------
    00164     //  Class specific types
    00165     //
    00166     //  AttTypes
    00167     //      The list of possible types that an attribute can have, according
    00168     //      to the XML 1.0 spec and schema.
    00169     //
    00170     //  DefAttTypes
    00171     //      The modifiers that an attribute decl can have, which indicates
    00172     //      whether instances of that attributes are required, implied, etc..
    00173     //
    00174     //  CreateReasons
    00175     //      This type is used to store how an attribute declaration got into
    00176     //      the elementdecl's attribute pool.
    00177     //
    00178     // -----------------------------------------------------------------------
    00179     enum AttTypes
    00180     {
    00181         CData               = 0
    00182         , ID                = 1
    00183         , IDRef             = 2
    00184         , IDRefs            = 3
    00185         , Entity            = 4
    00186         , Entities          = 5
    00187         , NmToken           = 6
    00188         , NmTokens          = 7
    00189         , Notation          = 8
    00190         , Enumeration       = 9
    00191         , Simple            = 10
    00192         , Any_Any           = 11
    00193         , Any_Other         = 12
    00194         , Any_List          = 13
    00195
    00196         , AttTypes_Count
    00197         , AttTypes_Min      = 0
    00198         , AttTypes_Max      = 13
    00199         , AttTypes_Unknown  = -1
    00200     };
    00201
    00202     enum DefAttTypes
    00203     {
    00204         Default                  = 0
    00205         , Fixed                  = 1
    00206         , Required               = 2
    00207         , Required_And_Fixed     = 3
    00208         , Implied                = 4
    00209         , ProcessContents_Skip   = 5
    00210         , ProcessContents_Lax    = 6
    00211         , ProcessContents_Strict = 7
    00212         , Prohibited             = 8
    00213
    00214         , DefAttTypes_Count
    00215         , DefAttTypes_Min   = 0
    00216         , DefAttTypes_Max   = 8
    00217         , DefAttTypes_Unknown = -1
    00218     };
    00219
    00220     enum CreateReasons
    00221     {
    00222         NoReason
    00223         , JustFaultIn
    00224     };
    00225
    00226     // -----------------------------------------------------------------------
    00227     //  Public static data members
    00228     // -----------------------------------------------------------------------
    00229     static const unsigned int fgInvalidAttrId;
    00230
    00231
    00232     // -----------------------------------------------------------------------
    00233     //  Public, static methods
    00234     // -----------------------------------------------------------------------
    00235
    00238
    00249     static const XMLCh* getAttTypeString(const AttTypes attrType);
    00250
    00261     static const XMLCh* getDefAttTypeString(const DefAttTypes attrType);
    00262
    00264
    00265
    00266     // -----------------------------------------------------------------------
    00267     //  Destructor
    00268     // -----------------------------------------------------------------------
    00269
    00272
    00276     virtual ~XMLAttDef();
    00278
    00279
    00280     // -----------------------------------------------------------------------
    00281     //  The virtual attribute def interface
    00282     // -----------------------------------------------------------------------
    00283
    00286
    00295     virtual const XMLCh* getFullName() const = 0;
    00296
    00301     virtual void reset() = 0;
    00302
    00304
    00305
    00306     // -----------------------------------------------------------------------
    00307     //  Getter methods
    00308     // -----------------------------------------------------------------------
    00309
    00312
    00321     DefAttTypes getDefaultType() const;
    00322
    00332     const XMLCh* getEnumeration() const;
    00333
    00342     unsigned int getId() const;
    00343
    00357     bool getProvided() const;
    00358
    00368     AttTypes getType() const;
    00369
    00379     const XMLCh* getValue() const;
    00380
    00389     CreateReasons getCreateReason() const;
    00390
    00398     bool isExternal() const;
    00399
    00407     MemoryManager* getMemoryManager() const;
    00408
    00409
    00413     virtual const XMLCh* getDOMTypeInfoUri() const = 0;
    00414
    00418     virtual const XMLCh* getDOMTypeInfoName() const = 0;
    00419
    00421
    00422
    00423     // -----------------------------------------------------------------------
    00424     //  Setter methods
    00425     // -----------------------------------------------------------------------
    00426
    00429
    00438     void setDefaultType(const XMLAttDef::DefAttTypes newValue);
    00439
    00448     void setId(const unsigned int newId);
    00449
    00458     void setProvided(const bool newValue);
    00459
    00467     void setType(const XMLAttDef::AttTypes newValue);
    00468
    00479     void setValue(const XMLCh* const newValue);
    00480
    00491     void setEnumeration(const XMLCh* const newValue);
    00492
    00500     void setCreateReason(const CreateReasons newReason);
    00501
    00507     void setExternalAttDeclaration(const bool aValue);
    00508
    00510
    00511 protected :
    00512     // -----------------------------------------------------------------------
    00513     //  Hidden constructors
    00514     // -----------------------------------------------------------------------
    00515     XMLAttDef
    00516     (
    00517         const   AttTypes       type = CData
    00518         , const DefAttTypes    defType= Implied
    00519         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
    00520     );
    00521     XMLAttDef
    00522     (
    00523         const   XMLCh* const        attValue
    00524         , const AttTypes            type
    00525         , const DefAttTypes         defType
    00526         , const XMLCh* const        enumValues = 0
    00527         , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
    00528     );
    00529
    00530
    00531 private :
    00532     // -----------------------------------------------------------------------
    00533     //  Unimplemented constructors and operators
    00534     // -----------------------------------------------------------------------
    00535     XMLAttDef(const XMLAttDef&);
    00536     XMLAttDef& operator=(const XMLAttDef&);
    00537
    00538
    00539     // -----------------------------------------------------------------------
    00540     //  Private helper methods
    00541     // -----------------------------------------------------------------------
    00542     void cleanUp();
    00543
    00544
    00545     // -----------------------------------------------------------------------
    00546     //  Private data members
    00547     //
    00548     //  fDefaultType
    00549     //      Indicates what, if any, default stuff this attribute has.
    00550     //
    00551     //  fEnumeration
    00552     //      If its an enumeration, this is the list of values as space
    00553     //      separated values.
    00554     //
    00555     //  fId
    00556     //      This is the unique id of this attribute, given to it when its put
    00557     //      into the validator's attribute decl pool. It defaults to the
    00558     //      special value XMLAttrDef::fgInvalidAttrId.
    00559     //
    00560     //  fProvided
    00561     //      This field is really for use by the scanner. It is used to track
    00562     //      which of the attributes of an element were provided. Any marked
    00563     //      as not provided (after scanning the start tag) and having a
    00564     //      default type of Required, is in error.
    00565     //
    00566     //  fType
    00567     //      The type of attribute, which is one of the AttTypes values.
    00568     //
    00569     //  fValue
    00570     //      This is the value of the attribute, which is the default value
    00571     //      given in the attribute declaration.
    00572     //
    00573     //  fCreateReason
    00574     //      This flag tells us how this attribute got created.  Sometimes even
    00575     //      the attribute was not declared for the element, we want to fault
    00576     //      fault it into the pool to avoid lots of redundant errors.
    00577     //
    00578     //  fExternalAttribute
    00579     //      This flag indicates whether or not the attribute was declared externally.
    00580     // -----------------------------------------------------------------------
    00581     DefAttTypes     fDefaultType;
    00582     AttTypes        fType;
    00583     CreateReasons   fCreateReason;
    00584     bool            fProvided;
    00585     bool            fExternalAttribute;
    00586     unsigned int    fId;
    00587     XMLCh*          fValue;
    00588     XMLCh*          fEnumeration;
    00589     MemoryManager*  fMemoryManager;
    00590 };
    00591
    00592
    00593 // ---------------------------------------------------------------------------
    00594 //  Getter methods
    00595 // ---------------------------------------------------------------------------
    00596 inline XMLAttDef::DefAttTypes XMLAttDef::getDefaultType() const
    00597 {
    00598     return fDefaultType;
    00599 }
    00600
    00601 inline const XMLCh* XMLAttDef::getEnumeration() const
    00602 {
    00603     return fEnumeration;
    00604 }
    00605
    00606 inline unsigned int XMLAttDef::getId() const
    00607 {
    00608     return fId;
    00609 }
    00610
    00611 inline bool XMLAttDef::getProvided() const
    00612 {
    00613     return fProvided;
    00614 }
    00615
    00616 inline XMLAttDef::AttTypes XMLAttDef::getType() const
    00617 {
    00618     return fType;
    00619 }
    00620
    00621 inline const XMLCh* XMLAttDef::getValue() const
    00622 {
    00623     return fValue;
    00624 }
    00625
    00626 inline XMLAttDef::CreateReasons XMLAttDef::getCreateReason() const
    00627 {
    00628     return fCreateReason;
    00629 }
    00630
    00631 inline bool XMLAttDef::isExternal() const
    00632 {
    00633     return fExternalAttribute;
    00634 }
    00635
    00636 inline MemoryManager* XMLAttDef::getMemoryManager() const
    00637 {
    00638     return fMemoryManager;
    00639 }
    00640
    00641 // ---------------------------------------------------------------------------
    00642 //  XMLAttDef: Setter methods
    00643 // ---------------------------------------------------------------------------
    00644 inline void XMLAttDef::setDefaultType(const XMLAttDef::DefAttTypes newValue)
    00645 {
    00646     fDefaultType = newValue;
    00647 }
    00648
    00649 inline void XMLAttDef::setEnumeration(const XMLCh* const newValue)
    00650 {
    00651     if (fEnumeration)
    00652         fMemoryManager->deallocate(fEnumeration);
    00653
    00654     fEnumeration = XMLString::replicate(newValue, fMemoryManager);
    00655 }
    00656
    00657 inline void XMLAttDef::setId(const unsigned int newId)
    00658 {
    00659     fId = newId;
    00660 }
    00661
    00662 inline void XMLAttDef::setProvided(const bool newValue)
    00663 {
    00664     fProvided = newValue;
    00665 }
    00666
    00667 inline void XMLAttDef::setType(const XMLAttDef::AttTypes newValue)
    00668 {
    00669     fType = newValue;
    00670 }
    00671
    00672 inline void XMLAttDef::setValue(const XMLCh* const newValue)
    00673 {
    00674     if (fValue)
    00675        fMemoryManager->deallocate(fValue);
    00676
    00677     fValue = XMLString::replicate(newValue, fMemoryManager);
    00678 }
    00679
    00680 inline void
    00681 XMLAttDef::setCreateReason(const XMLAttDef::CreateReasons newReason)
    00682 {
    00683     fCreateReason = newReason;
    00684 }
    00685
    00686 inline void XMLAttDef::setExternalAttDeclaration(const bool aValue)
    00687 {
    00688     fExternalAttribute = aValue;
    00689 }
    00690
    00691 XERCES_CPP_NAMESPACE_END
    00692
    00693 #endif

Copyright © 2000 The Apache Software Foundation. All Rights Reserved.