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

词法分析

开发平台:

Visual 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.6  2003/05/16 21:36:57  knoaman
  59.  * Memory manager implementation: Modify constructors to pass in the memory manager.
  60.  *
  61.  * Revision 1.5  2003/05/15 18:26:29  knoaman
  62.  * Partial implementation of the configurable memory manager.
  63.  *
  64.  * Revision 1.4  2003/03/07 18:08:58  tng
  65.  * Return a reference instead of void for operator=
  66.  *
  67.  * Revision 1.3  2002/12/04 02:23:50  knoaman
  68.  * Scanner re-organization.
  69.  *
  70.  * Revision 1.2  2002/11/04 14:58:18  tng
  71.  * C++ Namespace Support.
  72.  *
  73.  * Revision 1.1.1.1  2002/02/01 22:21:58  peiyongz
  74.  * sane_include
  75.  *
  76.  * Revision 1.11  2001/12/12 14:29:50  tng
  77.  * Remove obsolete code in ElemStack which can help performance.
  78.  *
  79.  * Revision 1.10  2001/08/07 13:47:47  tng
  80.  * Schema: Fix unmatched end tag for qualified/unqualifed start tag.
  81.  *
  82.  * Revision 1.9  2001/05/28 20:55:19  tng
  83.  * Schema: Store Grammar in ElemStack as well.
  84.  *
  85.  * Revision 1.8  2001/05/11 13:26:16  tng
  86.  * Copyright update.
  87.  *
  88.  * Revision 1.7  2001/05/03 20:34:28  tng
  89.  * Schema: SchemaValidator update
  90.  *
  91.  * Revision 1.6  2001/04/19 18:16:58  tng
  92.  * Schema: SchemaValidator update, and use QName in Content Model
  93.  *
  94.  * Revision 1.5  2000/04/18 23:54:29  roddey
  95.  * Got rid of some foward references to no longer used classes.
  96.  *
  97.  * Revision 1.4  2000/03/02 19:54:28  roddey
  98.  * This checkin includes many changes done while waiting for the
  99.  * 1.1.0 code to be finished. I can't list them all here, but a list is
  100.  * available elsewhere.
  101.  *
  102.  * Revision 1.3  2000/02/24 20:18:07  abagchi
  103.  * Swat for removing Log from API docs
  104.  *
  105.  * Revision 1.2  2000/02/06 07:47:52  rahulj
  106.  * Year 2K copyright swat.
  107.  *
  108.  * Revision 1.1.1.1  1999/11/09 01:08:06  twl
  109.  * Initial checkin
  110.  *
  111.  * Revision 1.2  1999/11/08 20:44:42  rahul
  112.  * Swat for adding in Product name and CVS comment log variable.
  113.  *
  114.  */
  115. #if !defined(ELEMSTACK_HPP)
  116. #define ELEMSTACK_HPP
  117. #include <xercesc/util/StringPool.hpp>
  118. #include <xercesc/util/QName.hpp>
  119. XERCES_CPP_NAMESPACE_BEGIN
  120. class XMLElementDecl;
  121. class Grammar;
  122. //
  123. //  During the scan of content, we have to keep up with the nesting of
  124. //  elements (for validation and wellformedness purposes) and we have to
  125. //  have places to remember namespace (prefix to URI) mappings.
  126. //
  127. //  We only have to keep a stack of the current path down through the tree
  128. //  that we are currently scanning, and keep track of any children of any
  129. //  elements along that path.
  130. //
  131. //  So, this data structure is a stack, which represents the current path
  132. //  through the tree that we've worked our way down to. For each node in
  133. //  the stack, there is an array of element ids that represent the ids of
  134. //  the child elements scanned so far. Upon exit from that element, its
  135. //  array of child elements is validated.
  136. //
  137. //  Since we have the actual XMLElementDecl in the stack nodes, when its time
  138. //  to validate, we just extract the content model from that element decl
  139. //  and validate. All the required data falls easily to hand. Note that we
  140. //  actually have some derivative of XMLElementDecl, which is specific to
  141. //  the validator used, but the abstract API is sufficient for the needs of
  142. //  the scanner.
  143. //
  144. //  Since the namespace support also requires the storage of information on
  145. //  a nested element basis, this structure also holds the namespace info. For
  146. //  each level, the prefixes defined at that level (and the namespaces that
  147. //  they map to) are stored.
  148. //
  149. class XMLPARSER_EXPORT ElemStack : public XMemory
  150. {
  151. public :
  152.     // -----------------------------------------------------------------------
  153.     //  Class specific data types
  154.     //
  155.     //  These really should be private, but some of the compilers we have to
  156.     //  support are too dumb to deal with that.
  157.     //
  158.     //  PrefMapElem
  159.     //      fURIId is the id of the URI from the validator's URI map. The
  160.     //      fPrefId is the id of the prefix from our own prefix pool. The
  161.     //      namespace stack consists of these elements.
  162.     //
  163.     //  StackElem
  164.     //      fThisElement is the basic element decl for the current element.
  165.     //      The fRowCapacity is how large fChildIds has grown so far.
  166.     //      fChildCount is how many of them are valid right now.
  167.     //
  168.     //      The fMapCapacity is how large fMap has grown so far. fMapCount
  169.     //      is how many of them are valid right now.
  170.     //
  171.     //      Note that we store the reader number we were in when we found the
  172.     //      start tag. We'll use this at the end tag to test for unbalanced
  173.     //      markup in entities.
  174.     //
  175.     //  MapModes
  176.     //      When a prefix is mapped to a namespace id, it matters whether the
  177.     //      QName being mapped is an attribute or name. Attributes are not
  178.     //      affected by an sibling xmlns attributes, whereas elements are
  179.     //      affected by its own xmlns attributes.
  180.     // -----------------------------------------------------------------------
  181.     struct PrefMapElem : public XMemory
  182.     {
  183.         unsigned int        fPrefId;
  184.         unsigned int        fURIId;
  185.     };
  186.     struct StackElem : public XMemory
  187.     {
  188.         XMLElementDecl*     fThisElement;
  189.         unsigned int        fReaderNum;
  190.         unsigned int        fChildCapacity;
  191.         unsigned int        fChildCount;
  192.         QName**             fChildren;
  193.         PrefMapElem*        fMap;
  194.         unsigned int        fMapCapacity;
  195.         unsigned int        fMapCount;
  196.         bool                fValidationFlag;
  197.         int                 fCurrentScope;
  198.         Grammar*            fCurrentGrammar;
  199.         unsigned int        fCurrentURI;
  200.     };
  201.     enum MapModes
  202.     {
  203.         Mode_Attribute
  204.         , Mode_Element
  205.     };
  206.     // -----------------------------------------------------------------------
  207.     //  Constructors and Destructor
  208.     // -----------------------------------------------------------------------
  209.     ElemStack(MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
  210.     ~ElemStack();
  211.     // -----------------------------------------------------------------------
  212.     //  Stack access
  213.     // -----------------------------------------------------------------------
  214.     unsigned int addLevel();
  215.     unsigned int addLevel(XMLElementDecl* const toSet, const unsigned int readerNum);
  216.     const StackElem* popTop();
  217.     // -----------------------------------------------------------------------
  218.     //  Stack top access
  219.     // -----------------------------------------------------------------------
  220.     unsigned int addChild(QName* const child, const bool toParent);
  221.     const StackElem* topElement() const;
  222.     void setElement(XMLElementDecl* const toSet, const unsigned int readerNum);
  223.     void setValidationFlag(bool validationFlag);
  224.     bool getValidationFlag();
  225.     void setCurrentScope(int currentScope);
  226.     int getCurrentScope();
  227.     void setCurrentGrammar(Grammar* currentGrammar);
  228.     Grammar* getCurrentGrammar();
  229.     void setCurrentURI(unsigned int uri);
  230.     unsigned int getCurrentURI();
  231.     // -----------------------------------------------------------------------
  232.     //  Prefix map methods
  233.     // -----------------------------------------------------------------------
  234.     void addPrefix
  235.     (
  236.         const   XMLCh* const    prefixToAdd
  237.         , const unsigned int    uriId
  238.     );
  239.     unsigned int mapPrefixToURI
  240.     (
  241.         const   XMLCh* const    prefixToMap
  242.         , const MapModes        mode
  243.         ,       bool&           unknown
  244.     )   const;
  245.     // -----------------------------------------------------------------------
  246.     //  Miscellaneous methods
  247.     // -----------------------------------------------------------------------
  248.     bool isEmpty() const;
  249.     void reset
  250.     (
  251.         const   unsigned int    emptyId
  252.         , const unsigned int    unknownId
  253.         , const unsigned int    xmlId
  254.         , const unsigned int    xmlNSId
  255.     );
  256. private :
  257.     // -----------------------------------------------------------------------
  258.     //  Unimplemented constructors and operators
  259.     // -----------------------------------------------------------------------
  260.     ElemStack(const ElemStack&);
  261.     ElemStack& operator=(const ElemStack&);
  262.     // -----------------------------------------------------------------------
  263.     //  Private helper methods
  264.     // -----------------------------------------------------------------------
  265.     void expandMap(StackElem* const toExpand);
  266.     void expandStack();
  267.     // -----------------------------------------------------------------------
  268.     //  Data members
  269.     //
  270.     //  fEmptyNamespaceId
  271.     //      This is the special URI id for the "" namespace, which is magic
  272.     //      because of the xmlns="" operation.
  273.     //
  274.     //  fGlobalPoolId
  275.     //      This is a special URI id that is returned when the namespace
  276.     //      prefix is "" and no one has explicitly mapped that prefix to an
  277.     //      explicit URI (or when they explicitly clear any such mapping,
  278.     //      which they can also do.) And also its prefix pool id, which is
  279.     //      stored here for fast access.
  280.     //
  281.     //  fPrefixPool
  282.     //      This is the prefix pool where prefixes are hashed and given unique
  283.     //      ids. These ids are used to track prefixes in the element stack.
  284.     //
  285.     //  fStack
  286.     //  fStackCapacity
  287.     //  fStackTop
  288.     //      This the stack array. Its an array of pointers to StackElem
  289.     //      structures. The capacity is the current high water mark of the
  290.     //      stack. The top is the current top of stack (i.e. the part of it
  291.     //      being used.)
  292.     //
  293.     //  fUnknownNamespaceId
  294.     //      This is the URI id for the special URI that is assigned to any
  295.     //      prefix which has not been mapped. This lets us keep going after
  296.     //      issuing the error.
  297.     //
  298.     //  fXMLNamespaceId
  299.     //  fXMLPoolId
  300.     //  fXMLNSNamespaceId
  301.     //  fXMLNSPoolId
  302.     //      These are the URI ids for the special URIs that are assigned to
  303.     //      the 'xml' and 'xmlns' namespaces. And also its prefix pool id,
  304.     //      which is stored here for fast access.
  305.     // -----------------------------------------------------------------------
  306.     unsigned int    fEmptyNamespaceId;
  307.     unsigned int    fGlobalPoolId;
  308.     XMLStringPool   fPrefixPool;
  309.     StackElem**     fStack;
  310.     unsigned int    fStackCapacity;
  311.     unsigned int    fStackTop;
  312.     unsigned int    fUnknownNamespaceId;
  313.     unsigned int    fXMLNamespaceId;
  314.     unsigned int    fXMLPoolId;
  315.     unsigned int    fXMLNSNamespaceId;
  316.     unsigned int    fXMLNSPoolId;
  317.     MemoryManager*  fMemoryManager;
  318. };
  319. class XMLPARSER_EXPORT WFElemStack : public XMemory
  320. {
  321. public :
  322.     // -----------------------------------------------------------------------
  323.     //  Class specific data types
  324.     //
  325.     //  These really should be private, but some of the compilers we have to
  326.     //  support are too dumb to deal with that.
  327.     //
  328.     //  PrefMapElem
  329.     //      fURIId is the id of the URI from the validator's URI map. The
  330.     //      fPrefId is the id of the prefix from our own prefix pool. The
  331.     //      namespace stack consists of these elements.
  332.     //
  333.     //  StackElem
  334.     //      fThisElement is the basic element decl for the current element.
  335.     //      The fRowCapacity is how large fChildIds has grown so far.
  336.     //      fChildCount is how many of them are valid right now.
  337.     //
  338.     //      The fMapCapacity is how large fMap has grown so far. fMapCount
  339.     //      is how many of them are valid right now.
  340.     //
  341.     //      Note that we store the reader number we were in when we found the
  342.     //      start tag. We'll use this at the end tag to test for unbalanced
  343.     //      markup in entities.
  344.     //
  345.     //  MapModes
  346.     //      When a prefix is mapped to a namespace id, it matters whether the
  347.     //      QName being mapped is an attribute or name. Attributes are not
  348.     //      affected by an sibling xmlns attributes, whereas elements are
  349.     //      affected by its own xmlns attributes.
  350.     // -----------------------------------------------------------------------
  351.     struct PrefMapElem : public XMemory
  352.     {
  353.         unsigned int        fPrefId;
  354.         unsigned int        fURIId;
  355.     };
  356.     struct StackElem : public XMemory
  357.     {
  358.         int                 fTopPrefix;        
  359.         unsigned int        fCurrentURI;
  360.         unsigned int        fReaderNum;
  361.         unsigned int        fElemMaxLength;
  362.         XMLCh*              fThisElement;
  363.     };
  364.     enum MapModes
  365.     {
  366.         Mode_Attribute
  367.         , Mode_Element
  368.     };
  369.     // -----------------------------------------------------------------------
  370.     //  Constructors and Destructor
  371.     // -----------------------------------------------------------------------
  372.     WFElemStack(MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager);
  373.     ~WFElemStack();
  374.     // -----------------------------------------------------------------------
  375.     //  Stack access
  376.     // -----------------------------------------------------------------------
  377.     unsigned int addLevel();
  378.     unsigned int addLevel(const XMLCh* const toSet, const unsigned int toSetLen,
  379.                           const unsigned int readerNum);
  380.     const StackElem* popTop();
  381.     // -----------------------------------------------------------------------
  382.     //  Stack top access
  383.     // -----------------------------------------------------------------------
  384.     const StackElem* topElement() const;
  385.     void setElement(const XMLCh* const toSet, const unsigned int toSetLen,
  386.                     const unsigned int readerNum);
  387.     void setCurrentURI(unsigned int uri);
  388.     unsigned int getCurrentURI();
  389.     // -----------------------------------------------------------------------
  390.     //  Prefix map methods
  391.     // -----------------------------------------------------------------------
  392.     void addPrefix
  393.     (
  394.         const   XMLCh* const    prefixToAdd
  395.         , const unsigned int    uriId
  396.     );
  397.     unsigned int mapPrefixToURI
  398.     (
  399.         const   XMLCh* const    prefixToMap
  400.         , const MapModes        mode
  401.         ,       bool&           unknown
  402.     )   const;
  403.     // -----------------------------------------------------------------------
  404.     //  Miscellaneous methods
  405.     // -----------------------------------------------------------------------
  406.     bool isEmpty() const;
  407.     void reset
  408.     (
  409.         const   unsigned int    emptyId
  410.         , const unsigned int    unknownId
  411.         , const unsigned int    xmlId
  412.         , const unsigned int    xmlNSId
  413.     );
  414. private :
  415.     // -----------------------------------------------------------------------
  416.     //  Unimplemented constructors and operators
  417.     // -----------------------------------------------------------------------
  418.     WFElemStack(const WFElemStack&);
  419.     WFElemStack& operator=(const WFElemStack&);
  420.     // -----------------------------------------------------------------------
  421.     //  Private helper methods
  422.     // -----------------------------------------------------------------------
  423.     void expandMap();
  424.     void expandStack();
  425.     // -----------------------------------------------------------------------
  426.     //  Data members
  427.     //
  428.     //  fEmptyNamespaceId
  429.     //      This is the special URI id for the "" namespace, which is magic
  430.     //      because of the xmlns="" operation.
  431.     //
  432.     //  fGlobalPoolId
  433.     //      This is a special URI id that is returned when the namespace
  434.     //      prefix is "" and no one has explicitly mapped that prefix to an
  435.     //      explicit URI (or when they explicitly clear any such mapping,
  436.     //      which they can also do.) And also its prefix pool id, which is
  437.     //      stored here for fast access.
  438.     //
  439.     //  fPrefixPool
  440.     //      This is the prefix pool where prefixes are hashed and given unique
  441.     //      ids. These ids are used to track prefixes in the element stack.
  442.     //
  443.     //  fStack
  444.     //  fStackCapacity
  445.     //  fStackTop
  446.     //      This the stack array. Its an array of pointers to StackElem
  447.     //      structures. The capacity is the current high water mark of the
  448.     //      stack. The top is the current top of stack (i.e. the part of it
  449.     //      being used.)
  450.     //
  451.     //  fUnknownNamespaceId
  452.     //      This is the URI id for the special URI that is assigned to any
  453.     //      prefix which has not been mapped. This lets us keep going after
  454.     //      issuing the error.
  455.     //
  456.     //  fXMLNamespaceId
  457.     //  fXMLPoolId
  458.     //  fXMLNSNamespaceId
  459.     //  fXMLNSPoolId
  460.     //      These are the URI ids for the special URIs that are assigned to
  461.     //      the 'xml' and 'xmlns' namespaces. And also its prefix pool id,
  462.     //      which is stored here for fast access.
  463.     // -----------------------------------------------------------------------
  464.     unsigned int    fEmptyNamespaceId;
  465.     unsigned int    fGlobalPoolId;
  466.     unsigned int    fStackCapacity;
  467.     unsigned int    fStackTop;
  468.     unsigned int    fUnknownNamespaceId;
  469.     unsigned int    fXMLNamespaceId;
  470.     unsigned int    fXMLPoolId;
  471.     unsigned int    fXMLNSNamespaceId;
  472.     unsigned int    fXMLNSPoolId;
  473.     unsigned int    fMapCapacity;
  474.     PrefMapElem*    fMap;
  475.     StackElem**     fStack;
  476.     XMLStringPool   fPrefixPool;
  477.     MemoryManager*  fMemoryManager;
  478. };
  479. // ---------------------------------------------------------------------------
  480. //  ElemStack: Miscellaneous methods
  481. // ---------------------------------------------------------------------------
  482. inline bool ElemStack::isEmpty() const
  483. {
  484.     return (fStackTop == 0);
  485. }
  486. inline bool ElemStack::getValidationFlag()
  487. {
  488.     return fStack[fStackTop-1]->fValidationFlag;
  489. }
  490. inline void ElemStack::setValidationFlag(bool validationFlag)
  491. {
  492.     fStack[fStackTop-1]->fValidationFlag = validationFlag;
  493.     return;
  494. }
  495. inline int ElemStack::getCurrentScope()
  496. {
  497.     return fStack[fStackTop-1]->fCurrentScope;
  498. }
  499. inline void ElemStack::setCurrentScope(int currentScope)
  500. {
  501.     fStack[fStackTop-1]->fCurrentScope = currentScope;
  502.     return;
  503. }
  504. inline Grammar* ElemStack::getCurrentGrammar()
  505. {
  506.     return fStack[fStackTop-1]->fCurrentGrammar;
  507. }
  508. inline void ElemStack::setCurrentGrammar(Grammar* currentGrammar)
  509. {
  510.     fStack[fStackTop-1]->fCurrentGrammar = currentGrammar;
  511.     return;
  512. }
  513. inline unsigned int ElemStack::getCurrentURI()
  514. {
  515.     return fStack[fStackTop-1]->fCurrentURI;
  516. }
  517. inline void ElemStack::setCurrentURI(unsigned int uri)
  518. {
  519.     fStack[fStackTop-1]->fCurrentURI = uri;
  520.     return;
  521. }
  522. // ---------------------------------------------------------------------------
  523. //  WFElemStack: Miscellaneous methods
  524. // ---------------------------------------------------------------------------
  525. inline bool WFElemStack::isEmpty() const
  526. {
  527.     return (fStackTop == 0);
  528. }
  529. inline unsigned int WFElemStack::getCurrentURI()
  530. {
  531.     return fStack[fStackTop-1]->fCurrentURI;
  532. }
  533. inline void WFElemStack::setCurrentURI(unsigned int uri)
  534. {
  535.     fStack[fStackTop-1]->fCurrentURI = uri;
  536.     return;
  537. }
  538. XERCES_CPP_NAMESPACE_END
  539. #endif