DFAContentModel.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: DFAContentModel.hpp,v $
  58.  * Revision 1.13  2001/11/21 14:30:13  knoaman
  59.  * Fix for UPA checking.
  60.  *
  61.  * Revision 1.12  2001/08/24 12:48:48  tng
  62.  * Schema: AllContentModel
  63.  *
  64.  * Revision 1.11  2001/08/21 16:06:11  tng
  65.  * Schema: Unique Particle Attribution Constraint Checking.
  66.  *
  67.  * Revision 1.10  2001/08/13 15:06:39  knoaman
  68.  * update <any> validation.
  69.  *
  70.  * Revision 1.9  2001/06/13 20:50:55  peiyongz
  71.  * fIsMixed: to handle mixed Content Model
  72.  *
  73.  * Revision 1.8  2001/05/11 13:27:18  tng
  74.  * Copyright update.
  75.  *
  76.  * Revision 1.7  2001/05/03 21:02:30  tng
  77.  * Schema: Add SubstitutionGroupComparator and update exception messages.  By Pei Yong Zhang.
  78.  *
  79.  * Revision 1.6  2001/04/19 18:17:30  tng
  80.  * Schema: SchemaValidator update, and use QName in Content Model
  81.  *
  82.  * Revision 1.5  2001/03/21 21:56:27  tng
  83.  * Schema: Add Schema Grammar, Schema Validator, and split the DTDValidator into DTDValidator, DTDScanner, and DTDGrammar.
  84.  *
  85.  * Revision 1.4  2001/03/21 19:29:55  tng
  86.  * Schema: Content Model Updates, by Pei Yong Zhang.
  87.  *
  88.  * Revision 1.3  2001/02/27 18:32:32  tng
  89.  * Schema: Use XMLElementDecl instead of DTDElementDecl in Content Model.
  90.  *
  91.  * Revision 1.2  2001/02/27 14:48:52  tng
  92.  * Schema: Add CMAny and ContentLeafNameTypeVector, by Pei Yong Zhang
  93.  *
  94.  * Revision 1.1  2001/02/16 14:17:29  tng
  95.  * Schema: Move the common Content Model files that are shared by DTD
  96.  * and schema from 'DTD' folder to 'common' folder.  By Pei Yong Zhang.
  97.  *
  98.  * Revision 1.4  2000/03/02 19:55:38  roddey
  99.  * This checkin includes many changes done while waiting for the
  100.  * 1.1.0 code to be finished. I can't list them all here, but a list is
  101.  * available elsewhere.
  102.  *
  103.  * Revision 1.3  2000/02/24 20:16:48  abagchi
  104.  * Swat for removing Log from API docs
  105.  *
  106.  * Revision 1.2  2000/02/09 21:42:37  abagchi
  107.  * Copyright swat
  108.  *
  109.  * Revision 1.1.1.1  1999/11/09 01:03:19  twl
  110.  * Initial checkin
  111.  *
  112.  * Revision 1.2  1999/11/08 20:45:38  rahul
  113.  * Swat for adding in Product name and CVS comment log variable.
  114.  *
  115.  */
  116. #if !defined(DFACONTENTMODEL_HPP)
  117. #define DFACONTENTMODEL_HPP
  118. #include <util/XercesDefs.hpp>
  119. #include <util/ArrayIndexOutOfBoundsException.hpp>
  120. #include <framework/XMLContentModel.hpp>
  121. #include <validators/common/ContentLeafNameTypeVector.hpp>
  122. class ContentSpecNode;
  123. class CMLeaf;
  124. class CMNode;
  125. class CMStateSet;
  126. //
  127. //  DFAContentModel is the heavy weight derivative of ContentModel that does
  128. //  all of the non-trivial element content validation. This guy does the full
  129. //  bore regular expression to DFA conversion to create a DFA that it then
  130. //  uses in its validation algorithm.
  131. //
  132. //  NOTE:   Upstream work insures that this guy will never see a content model
  133. //          with PCDATA in it. Any model with PCDATA is 'mixed' and is handled
  134. //          via the MixedContentModel class, since mixed models are very
  135. //          constrained in form and easily handled via a special case. This
  136. //          also makes our life much easier here.
  137. //
  138. class DFAContentModel : public XMLContentModel
  139. {
  140. public:
  141.     // -----------------------------------------------------------------------
  142.     //  Constructors and Destructor
  143.     // -----------------------------------------------------------------------
  144.     DFAContentModel(const bool              dtd
  145.                   , ContentSpecNode* const  elemContentSpec);
  146.     DFAContentModel(const bool              dtd
  147.                   , ContentSpecNode* const  elemContentSpec
  148.                   , const bool              isMixed);
  149.     virtual ~DFAContentModel();
  150.     // -----------------------------------------------------------------------
  151.     //  Implementation of the virtual content model interface
  152.     // -----------------------------------------------------------------------
  153.     virtual int validateContent
  154.     (
  155.         QName** const         children
  156.       , const unsigned int    childCount
  157.       , const unsigned int    emptyNamespaceId
  158.     ) const;
  159.     virtual int validateContentSpecial
  160.     (
  161.         QName** const           children
  162.       , const unsigned int      childCount
  163.       , const unsigned int      emptyNamespaceId
  164.       , GrammarResolver*  const pGrammarResolver
  165.       , XMLStringPool*    const pStringPool
  166.     ) const;
  167.     virtual void checkUniqueParticleAttribution
  168.     (
  169.         SchemaGrammar*    const pGrammar
  170.       , GrammarResolver*  const pGrammarResolver
  171.       , XMLStringPool*    const pStringPool
  172.       , XMLValidator*     const pValidator
  173.       , unsigned int*     const pContentSpecOrgURI
  174.     ) ;
  175.     virtual ContentLeafNameTypeVector* getContentLeafNameTypeVector() const ;
  176.     virtual unsigned int getNextState(const unsigned int currentState,
  177.                                       const unsigned int elementIndex) const;
  178. private :
  179.     // -----------------------------------------------------------------------
  180.     //  Unimplemented constructors and operators
  181.     // -----------------------------------------------------------------------
  182.     DFAContentModel();
  183.     DFAContentModel(const DFAContentModel&);
  184.     void operator=(const DFAContentModel&);
  185.     // -----------------------------------------------------------------------
  186.     //  Private helper methods
  187.     // -----------------------------------------------------------------------
  188.     void buildDFA(ContentSpecNode* const curNode);
  189.     CMNode* buildSyntaxTree(ContentSpecNode* const curNode);
  190.     void calcFollowList(CMNode* const curNode);
  191.     unsigned int* makeDefStateList() const;
  192.     int postTreeBuildInit
  193.     (
  194.                 CMNode* const   nodeCur
  195.         , const unsigned int    curIndex
  196.     );
  197.     // -----------------------------------------------------------------------
  198.     //  Private data members
  199.     //
  200.     //  fElemMap
  201.     //  fElemMapSize
  202.     //      This is the map of unique input symbol elements to indices into
  203.     //      each state's per-input symbol transition table entry. This is part
  204.     //      of the built DFA information that must be kept around to do the
  205.     //      actual validation.
  206.     //
  207.     //  fElemMapType
  208.     //      This is a map of whether the element map contains information
  209.     //      related to ANY models.
  210.     //
  211.     //  fEmptyOk
  212.     //      This is an optimization. While building the transition table we
  213.     //      can see whether this content model would approve of an empty
  214.     //      content (which could happen if everything was optional.) So we
  215.     //      set this flag and short circuit that check, which would otherwise
  216.     //      be ugly and time consuming if we tried to determine it at each
  217.     //      validation call.
  218.     //
  219.     //  fEOCPos
  220.     //      The NFA position of the special EOC (end of content) node. This
  221.     //      is saved away since its used during the DFA build.
  222.     //
  223.     //  fFinalStateFlags
  224.     //      This is an array of booleans, one per state (there are
  225.     //      fTransTableSize states in the DFA) that indicates whether that
  226.     //      state is a final state.
  227.     //
  228.     //  fFollowList
  229.     //      The list of follow positions for each NFA position (i.e. for each
  230.     //      non-epsilon leaf node.) This is only used during the building of
  231.     //      the DFA, and is let go afterwards.
  232.     //
  233.     //  fHeadNode
  234.     //      This is the head node of our intermediate representation. It is
  235.     //      only non-null during the building of the DFA (just so that it
  236.     //      does not have to be passed all around.) Once the DFA is built,
  237.     //      this is no longer required so its deleted.
  238.     //
  239.     //  fLeafCount
  240.     //      The count of leaf nodes. This is an important number that set some
  241.     //      limits on the sizes of data structures in the DFA process.
  242.     //
  243.     //  fLeafList
  244.     //      An array of non-epsilon leaf nodes, which is used during the DFA
  245.     //      build operation, then dropped. These are just references to nodes
  246.     //      pointed to by fHeadNode, so we don't have to clean them up, just
  247.     //      the actually leaf list array itself needs cleanup.
  248.     //
  249.     //  fLeafListType
  250.     //      Array mapping ANY types to the leaf list.
  251.     //
  252.     //  fTransTable
  253.     //  fTransTableSize
  254.     //      This is the transition table that is the main by product of all
  255.     //      of the effort here. It is an array of arrays of ints. The first
  256.     //      dimension is the number of states we end up with in the DFA. The
  257.     //      second dimensions is the number of unique elements in the content
  258.     //      model (fElemMapSize). Each entry in the second dimension indicates
  259.     //      the new state given that input for the first dimension's start
  260.     //      state.
  261.     //
  262.     //      The fElemMap array handles mapping from element indexes to
  263.     //      positions in the second dimension of the transition table.
  264.     //
  265.     //      fTransTableSize is the number of valid entries in the transition
  266.     //      table, and in the other related tables such as fFinalStateFlags.
  267.     //
  268.     //  fDTD
  269.     //      Boolean to allow DTDs to validate even with namespace support.
  270.     //
  271.     //  fIsMixed
  272.     //      DFA ContentModel with mixed PCDATA.
  273.     // -----------------------------------------------------------------------
  274.     QName**                 fElemMap;
  275.     ContentSpecNode::NodeTypes  *fElemMapType;
  276.     unsigned int            fElemMapSize;
  277.     bool                    fEmptyOk;
  278.     unsigned int            fEOCPos;
  279.     bool*                   fFinalStateFlags;
  280.     CMStateSet**            fFollowList;
  281.     CMNode*                 fHeadNode;
  282.     unsigned int            fLeafCount;
  283.     CMLeaf**                fLeafList;
  284.     ContentSpecNode::NodeTypes  *fLeafListType;
  285.     unsigned int**          fTransTable;
  286.     unsigned int            fTransTableSize;
  287.     bool                    fDTD;
  288.     bool                    fIsMixed;
  289.     ContentLeafNameTypeVector *fLeafNameTypeVector;
  290. };
  291. inline unsigned int
  292. DFAContentModel::getNextState(const unsigned int currentState,
  293.                               const unsigned int elementIndex) const {
  294.     if (currentState == XMLContentModel::gInvalidTrans) {
  295.         return XMLContentModel::gInvalidTrans;
  296.     }
  297.     if (currentState >= fTransTableSize || elementIndex >= fElemMapSize) {
  298.         ThrowXML(ArrayIndexOutOfBoundsException, XMLExcepts::Array_BadIndex);
  299.     }
  300.     return fTransTable[currentState][elementIndex];
  301. }
  302. #endif