ElemStack.hpp
上传用户:huihehuasu
上传日期:2007-01-10
资源大小:6948k
文件大小:13k
源码类别:

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-2001 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: ElemStack.hpp,v $
  58.  * Revision 1.10  2001/08/07 13:47:47  tng
  59.  * Schema: Fix unmatched end tag for qualified/unqualifed start tag.
  60.  *
  61.  * Revision 1.9  2001/05/28 20:55:19  tng
  62.  * Schema: Store Grammar in ElemStack as well.
  63.  *
  64.  * Revision 1.8  2001/05/11 13:26:16  tng
  65.  * Copyright update.
  66.  *
  67.  * Revision 1.7  2001/05/03 20:34:28  tng
  68.  * Schema: SchemaValidator update
  69.  *
  70.  * Revision 1.6  2001/04/19 18:16:58  tng
  71.  * Schema: SchemaValidator update, and use QName in Content Model
  72.  *
  73.  * Revision 1.5  2000/04/18 23:54:29  roddey
  74.  * Got rid of some foward references to no longer used classes.
  75.  *
  76.  * Revision 1.4  2000/03/02 19:54:28  roddey
  77.  * This checkin includes many changes done while waiting for the
  78.  * 1.1.0 code to be finished. I can't list them all here, but a list is
  79.  * available elsewhere.
  80.  *
  81.  * Revision 1.3  2000/02/24 20:18:07  abagchi
  82.  * Swat for removing Log from API docs
  83.  *
  84.  * Revision 1.2  2000/02/06 07:47:52  rahulj
  85.  * Year 2K copyright swat.
  86.  *
  87.  * Revision 1.1.1.1  1999/11/09 01:08:06  twl
  88.  * Initial checkin
  89.  *
  90.  * Revision 1.2  1999/11/08 20:44:42  rahul
  91.  * Swat for adding in Product name and CVS comment log variable.
  92.  *
  93.  */
  94. #if !defined(ELEMSTACK_HPP)
  95. #define ELEMSTACK_HPP
  96. #include <util/XercesDefs.hpp>
  97. #include <util/StringPool.hpp>
  98. #include <util/QName.hpp>
  99. class XMLElementDecl;
  100. class Grammar;
  101. //
  102. //  During the scan of content, we have to keep up with the nesting of
  103. //  elements (for validation and wellformedness purposes) and we have to
  104. //  have places to remember namespace (prefix to URI) mappings.
  105. //
  106. //  We only have to keep a stack of the current path down through the tree
  107. //  that we are currently scanning, and keep track of any children of any
  108. //  elements along that path.
  109. //
  110. //  So, this data structure is a stack, which represents the current path
  111. //  through the tree that we've worked our way down to. For each node in
  112. //  the stack, there is an array of element ids that represent the ids of
  113. //  the child elements scanned so far. Upon exit from that element, its
  114. //  array of child elements is validated.
  115. //
  116. //  Since we have the actual XMLElementDecl in the stack nodes, when its time
  117. //  to validate, we just extract the content model from that element decl
  118. //  and validate. All the required data falls easily to hand. Note that we
  119. //  actually have some derivative of XMLElementDecl, which is specific to
  120. //  the validator used, but the abstract API is sufficient for the needs of
  121. //  the scanner.
  122. //
  123. //  Since the namespace support also requires the storage of information on
  124. //  a nested element basis, this structure also holds the namespace info. For
  125. //  each level, the prefixes defined at that level (and the namespaces that
  126. //  they map to) are stored.
  127. //
  128. class XMLPARSER_EXPORT ElemStack
  129. {
  130. public :
  131.     // -----------------------------------------------------------------------
  132.     //  Class specific data types
  133.     //
  134.     //  These really should be private, but some of the compilers we have to
  135.     //  support are too dumb to deal with that.
  136.     //
  137.     //  PrefMapElem
  138.     //      fURIId is the id of the URI from the validator's URI map. The
  139.     //      fPrefId is the id of the prefix from our own prefix pool. The
  140.     //      namespace stack consists of these elements.
  141.     //
  142.     //  StackElem
  143.     //      fThisElement is the basic element decl for the current element.
  144.     //      The fRowCapacity is how large fChildIds has grown so far.
  145.     //      fChildCount is how many of them are valid right now.
  146.     //
  147.     //      The fMapCapacity is how large fMap has grown so far. fMapCount
  148.     //      is how many of them are valid right now.
  149.     //
  150.     //      Note that we store the reader number we were in when we found the
  151.     //      start tag. We'll use this at the end tag to test for unbalanced
  152.     //      markup in entities.
  153.     //
  154.     //  MapModes
  155.     //      When a prefix is mapped to a namespace id, it matters whether the
  156.     //      QName being mapped is an attribute or name. Attributes are not
  157.     //      affected by an sibling xmlns attributes, whereas elements are
  158.     //      affected by its own xmlns attributes.
  159.     // -----------------------------------------------------------------------
  160.     struct PrefMapElem
  161.     {
  162.         unsigned int        fPrefId;
  163.         unsigned int        fURIId;
  164.     };
  165.     struct StackElem
  166.     {
  167.         XMLElementDecl*     fThisElement;
  168.         unsigned int        fReaderNum;
  169.         unsigned int        fChildCapacity;
  170.         unsigned int        fChildCount;
  171.         QName**             fChildren;
  172.         PrefMapElem*        fMap;
  173.         unsigned int        fMapCapacity;
  174.         unsigned int        fMapCount;
  175.         bool                fValidationFlag;
  176.         int                 fCurrentScope;
  177.         Grammar*            fCurrentGrammar;
  178.         unsigned int        fCurrentURI;
  179.     };
  180.     enum MapModes
  181.     {
  182.         Mode_Attribute
  183.         , Mode_Element
  184.     };
  185.     // -----------------------------------------------------------------------
  186.     //  Constructors and Destructor
  187.     // -----------------------------------------------------------------------
  188.     ElemStack();
  189.     ~ElemStack();
  190.     // -----------------------------------------------------------------------
  191.     //  Stack access
  192.     // -----------------------------------------------------------------------
  193.     unsigned int addLevel();
  194.     unsigned int addLevel(XMLElementDecl* const toSet, const unsigned int readerNum);
  195.     XMLElementDecl& elemAt(const unsigned int index);
  196.     const XMLElementDecl& elemAt(const unsigned int index) const;
  197.     const StackElem* popTop();
  198.     // -----------------------------------------------------------------------
  199.     //  Stack top access
  200.     // -----------------------------------------------------------------------
  201.     unsigned int addChild(QName* const child, const bool toParent);
  202.     const StackElem* topElement() const;
  203.     void setElement(XMLElementDecl* const toSet, const unsigned int readerNum);
  204.     void setValidationFlag(bool validationFlag);
  205.     bool getValidationFlag();
  206.     void setCurrentScope(int currentScope);
  207.     int getCurrentScope();
  208.     void setCurrentGrammar(Grammar* currentGrammar);
  209.     Grammar* getCurrentGrammar();
  210.     void setCurrentURI(unsigned int uri);
  211.     unsigned int getCurrentURI();
  212.     // -----------------------------------------------------------------------
  213.     //  Prefix map methods
  214.     // -----------------------------------------------------------------------
  215.     void addPrefix
  216.     (
  217.         const   XMLCh* const    prefixToAdd
  218.         , const unsigned int    uriId
  219.     );
  220.     unsigned int mapPrefixToURI
  221.     (
  222.         const   XMLCh* const    prefixToMap
  223.         , const MapModes        mode
  224.         ,       bool&           unknown
  225.     )   const;
  226.     // -----------------------------------------------------------------------
  227.     //  Miscellaneous methods
  228.     // -----------------------------------------------------------------------
  229.     bool isEmpty() const;
  230.     void reset
  231.     (
  232.         const   unsigned int    emptyId
  233.         , const unsigned int    unknownId
  234.         , const unsigned int    xmlId
  235.         , const unsigned int    xmlNSId
  236.     );
  237. private :
  238.     // -----------------------------------------------------------------------
  239.     //  Unimplemented constructors and operators
  240.     // -----------------------------------------------------------------------
  241.     ElemStack(const ElemStack&);
  242.     void operator=(const ElemStack&);
  243.     // -----------------------------------------------------------------------
  244.     //  Private helper methods
  245.     // -----------------------------------------------------------------------
  246.     void expandMap(StackElem* const toExpand);
  247.     void expandStack();
  248.     // -----------------------------------------------------------------------
  249.     //  Data members
  250.     //
  251.     //  fEmptyNamespaceId
  252.     //      This is the special URI id for the "" namespace, which is magic
  253.     //      because of the xmlns="" operation.
  254.     //
  255.     //  fGlobalPoolId
  256.     //      This is a special URI id that is returned when the namespace
  257.     //      prefix is "" and no one has explicitly mapped that prefix to an
  258.     //      explicit URI (or when they explicitly clear any such mapping,
  259.     //      which they can also do.) And also its prefix pool id, which is
  260.     //      stored here for fast access.
  261.     //
  262.     //  fPrefixPool
  263.     //      This is the prefix pool where prefixes are hashed and given unique
  264.     //      ids. These ids are used to track prefixes in the element stack.
  265.     //
  266.     //  fStack
  267.     //  fStackCapacity
  268.     //  fStackTop
  269.     //      This the stack array. Its an array of pointers to StackElem
  270.     //      structures. The capacity is the current high water mark of the
  271.     //      stack. The top is the current top of stack (i.e. the part of it
  272.     //      being used.)
  273.     //
  274.     //  fUnknownNamespaceId
  275.     //      This is the URI id for the special URI that is assigned to any
  276.     //      prefix which has not been mapped. This lets us keep going after
  277.     //      issuing the error.
  278.     //
  279.     //  fXMLNamespaceId
  280.     //  fXMLPoolId
  281.     //  fXMLNSNamespaceId
  282.     //  fXMLNSPoolId
  283.     //      These are the URI ids for the special URIs that are assigned to
  284.     //      the 'xml' and 'xmlns' namespaces. And also its prefix pool id,
  285.     //      which is stored here for fast access.
  286.     // -----------------------------------------------------------------------
  287.     unsigned int    fEmptyNamespaceId;
  288.     unsigned int    fGlobalPoolId;
  289.     XMLStringPool   fPrefixPool;
  290.     StackElem**     fStack;
  291.     unsigned int    fStackCapacity;
  292.     unsigned int    fStackTop;
  293.     unsigned int    fUnknownNamespaceId;
  294.     unsigned int    fXMLNamespaceId;
  295.     unsigned int    fXMLPoolId;
  296.     unsigned int    fXMLNSNamespaceId;
  297.     unsigned int    fXMLNSPoolId;
  298. };
  299. // ---------------------------------------------------------------------------
  300. //  ElemStack: Miscellaneous methods
  301. // ---------------------------------------------------------------------------
  302. inline bool ElemStack::isEmpty() const
  303. {
  304.     return (fStackTop == 0);
  305. }
  306. inline bool ElemStack::getValidationFlag()
  307. {
  308.     return fStack[fStackTop-1]->fValidationFlag;
  309. }
  310. inline void ElemStack::setValidationFlag(bool validationFlag)
  311. {
  312.     fStack[fStackTop-1]->fValidationFlag = validationFlag;
  313.     return;
  314. }
  315. inline int ElemStack::getCurrentScope()
  316. {
  317.     return fStack[fStackTop-1]->fCurrentScope;
  318. }
  319. inline void ElemStack::setCurrentScope(int currentScope)
  320. {
  321.     fStack[fStackTop-1]->fCurrentScope = currentScope;
  322.     return;
  323. }
  324. inline Grammar* ElemStack::getCurrentGrammar()
  325. {
  326.     return fStack[fStackTop-1]->fCurrentGrammar;
  327. }
  328. inline void ElemStack::setCurrentGrammar(Grammar* currentGrammar)
  329. {
  330.     fStack[fStackTop-1]->fCurrentGrammar = currentGrammar;
  331.     return;
  332. }
  333. inline unsigned int ElemStack::getCurrentURI()
  334. {
  335.     return fStack[fStackTop-1]->fCurrentURI;
  336. }
  337. inline void ElemStack::setCurrentURI(unsigned int uri)
  338. {
  339.     fStack[fStackTop-1]->fCurrentURI = uri;
  340.     return;
  341. }
  342. #endif