text: /*
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999-2001 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution,
   *    if any, must include the following acknowledgment:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowledgment may appear in the software itself,
   *    if and wherever such third-party acknowledgments normally appear.
   *
   * 4. The names "Xerces" and "Apache Software Foundation" must
   *    not be used to endorse or promote products derived from this
   *    software without prior written permission. For written
   *    permission, please contact apache\@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache",
   *    nor may "Apache" appear in their name, without prior written
   *    permission of the Apache Software Foundation.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation, and was
   * originally based on software copyright (c) 1999, International
   * Business Machines, Inc., http://www.ibm.com .  For more information
   * on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  
  /*
   * $Log: DTDGrammar.hpp,v $
   * Revision 1.1  2003/11/12 01:57:57  AnJingBin
   * *** empty log message ***
   *
   * Revision 1.1  2003/10/23 20:57:50  AnJingBin
   * *** empty log message ***
   *
   * Revision 1.1.1.1  2002/02/01 22:22:43  peiyongz
   * sane_include
   *
   * Revision 1.5  2001/09/14 14:50:22  tng
   * Schema: Fix some wildcard bugs, and some retrieving qualified/unqualified element decl problems.
   *
   * Revision 1.4  2001/05/28 20:56:17  tng
   * Schema: Move getTargetNamespace as virtual function in base class Grammar
   *
   * Revision 1.3  2001/05/11 13:27:09  tng
   * Copyright update.
   *
   * Revision 1.2  2001/04/19 18:17:21  tng
   * Schema: SchemaValidator update, and use QName in Content Model
   *
   * Revision 1.1  2001/03/21 21:56:20  tng
   * Schema: Add Schema Grammar, Schema Validator, and split the DTDValidator into DTDValidator, DTDScanner, and DTDGrammar.
   *
   */
  
  
  
  #if !defined(DTDGRAMMAR_HPP)
  #define DTDGRAMMAR_HPP
  
  #include <xercesc/util/RefHashTableOf.hpp>
  #include <xercesc/util/NameIdPool.hpp>
  #include <xercesc/util/StringPool.hpp>
  #include <xercesc/validators/common/Grammar.hpp>
  #include <xercesc/validators/DTD/DTDElementDecl.hpp>
  
  //
  // This class stores the DTD information
  //  NOTE: DTDs are not namespace aware, so we just use regular NameIdPool
  //  data structures to store element and attribute decls. They are all set
  //  to be in the global namespace and the full QName is used as the base name
  //  of the decl. This means that all the URI parameters below are expected
  //  to be null pointers (and anything else will cause an exception.)
  //
  
  class VALIDATORS_EXPORT DTDGrammar : public Grammar
  {
  public:
      // -----------------------------------------------------------------------
      //  Constructors and Destructor
      // -----------------------------------------------------------------------
      DTDGrammar();
      virtual ~DTDGrammar();
  
  
      // -----------------------------------------------------------------------
      //  Implementation of Virtual Interface
      // -----------------------------------------------------------------------
      virtual Grammar::GrammarType getGrammarType();
      virtual const XMLCh* getTargetNamespace() const;
  
      virtual XMLElementDecl* findOrAddElemDecl
      (
          const   unsigned int    uriId
          , const XMLCh* const    baseName
          , const XMLCh* const    prefixName
          , const XMLCh* const    qName
          , unsigned int          scope
          ,       bool&           wasAdded
      ) ;
  
      virtual unsigned int getElemId
      (
          const   unsigned int    uriId
          , const XMLCh* const    baseName
          , const XMLCh* const    qName
          , unsigned int          scope
      )   const ;
  
      virtual const XMLElementDecl* getElemDecl
      (
          const   unsigned int    uriId
          , const XMLCh* const    baseName
          , const XMLCh* const    qName
          , unsigned int          scope
      )   const ;
  
      virtual XMLElementDecl* getElemDecl
      (
          const   unsigned int    uriId
          , const XMLCh* const    baseName
          , const XMLCh* const    qName
          , unsigned int          scope
      );
  
      virtual const XMLElementDecl* getElemDecl
      (
          const   unsigned int    elemId
      )   const;
  
      virtual XMLElementDecl* getElemDecl
      (
          const   unsigned int    elemId
      );
  
      virtual const XMLNotationDecl* getNotationDecl
      (
          const   XMLCh* const    notName
      )   const;
  
      virtual XMLNotationDecl* getNotationDecl
      (
          const   XMLCh* const    notName
      );
  
      virtual XMLElementDecl* putElemDecl
      (
          const   unsigned int    uriId
          , const XMLCh* const    baseName
          , const XMLCh* const    prefixName
          , const XMLCh* const    qName
          , unsigned int          scope
      );
  
      virtual unsigned int putElemDecl
      (
          XMLElementDecl* const elemDecl
      )   const;
  
      virtual unsigned int putNotationDecl
      (
          XMLNotationDecl* const notationDecl
      )   const;
  
      virtual void reset();
  
      // -----------------------------------------------------------------------
      //  Getter methods
      // -----------------------------------------------------------------------
      unsigned int getRootElemId();
      NameIdPoolEnumerator<DTDElementDecl> getElemEnumerator() const;
      NameIdPoolEnumerator<XMLNotationDecl> getNotationEnumerator() const;
  
      // -----------------------------------------------------------------------
      //  Setter methods
      // -----------------------------------------------------------------------
      void setRootElemId(unsigned int rootElemId);
  
  private:
  
      // -----------------------------------------------------------------------
      //  Private data members
      //
      //  fElemDeclPool
      //      This is the element decl pool. It contains all of the elements
      //      declared in the DTD (and their associated attributes.) When in
      //      non-validating mode, its just populated as new elements are seen
      //      and they are given default characteristics.
      //
      //  fNotationDeclPool
      //      This is a pool of NotationDecl objects, which contains all of the
      //      notations declared in the DTD subsets.
      //
      //  fRootElemId
      //      The id of the root element that we found in the DOCTYPE statement.
      //      Its initialized to ContentModel::fgInvalidElemId, so that its
      //      invalid unless we have a DOCTYPE.
      // -----------------------------------------------------------------------
      NameIdPool<DTDElementDecl>*     fElemDeclPool;
      NameIdPool<XMLNotationDecl>*    fNotationDeclPool;
      unsigned int                    fRootElemId;
  };
  
  
  // ---------------------------------------------------------------------------
  //  DTDGrammar: Getter methods
  // ---------------------------------------------------------------------------
  inline unsigned int DTDGrammar::getRootElemId()
  {
      return fRootElemId;
  }
  
  // ---------------------------------------------------------------------------
  //  DTDGrammar: Getter methods
  // ---------------------------------------------------------------------------
  inline NameIdPoolEnumerator<DTDElementDecl>
  DTDGrammar::getElemEnumerator() const
  {
      return NameIdPoolEnumerator<DTDElementDecl>(fElemDeclPool);
  }
  
  inline NameIdPoolEnumerator<XMLNotationDecl>
  DTDGrammar::getNotationEnumerator() const
  {
      return NameIdPoolEnumerator<XMLNotationDecl>(fNotationDeclPool);
  }
  
  // -----------------------------------------------------------------------
  //  Setter methods
  // -----------------------------------------------------------------------
  inline void DTDGrammar::setRootElemId(unsigned int rootElemId) {
      fRootElemId = rootElemId;
  }
  
  // ---------------------------------------------------------------------------
  //  DTDGrammar: Virtual methods
  // ---------------------------------------------------------------------------
  inline Grammar::GrammarType DTDGrammar::getGrammarType() {
      return Grammar::DTDGrammarType;
  }
  
  inline const XMLCh* DTDGrammar::getTargetNamespace() const {
      return XMLUni::fgZeroLenString;
  }
  
  // Element Decl
  inline unsigned int DTDGrammar::getElemId (const   unsigned int  uriId
                                                , const XMLCh* const    baseName
                                                , const XMLCh* const    qName
                                                , unsigned int          scope ) const
  {
      //
      //  In this case, we don't return zero to mean 'not found', so we have to
      //  map it to the official not found value if we don't find it.
      //
      const DTDElementDecl* decl = fElemDeclPool->getByKey(qName);
      if (!decl)
          return XMLElementDecl::fgInvalidElemId;
      return decl->getId();
  }
  
  inline const XMLElementDecl* DTDGrammar::getElemDecl( const   unsigned int  uriId
                                                , const XMLCh* const    baseName
                                                , const XMLCh* const    qName
                                                , unsigned int          scope )   const
  {
      return fElemDeclPool->getByKey(qName);
  }
  
  inline XMLElementDecl* DTDGrammar::getElemDecl (const   unsigned int  uriId
                                                , const XMLCh* const    baseName
                                                , const XMLCh* const    qName
                                                , unsigned int          scope )
  {
      return fElemDeclPool->getByKey(qName);
  }
  
  inline const XMLElementDecl* DTDGrammar::getElemDecl(const unsigned int elemId) const
  {
      // Look up this element decl by id
      return fElemDeclPool->getById(elemId);
  }
  
  inline XMLElementDecl* DTDGrammar::getElemDecl(const unsigned int elemId)
  {
      // Look up this element decl by id
      return fElemDeclPool->getById(elemId);
  }
  
  inline unsigned int DTDGrammar::putElemDecl (XMLElementDecl* const elemDecl)   const
  {
      return fElemDeclPool->put((DTDElementDecl*) elemDecl);
  }
  
  // Notation Decl
  inline const XMLNotationDecl* DTDGrammar::getNotationDecl(const XMLCh* const notName) const
  {
      return fNotationDeclPool->getByKey(notName);
  }
  
  inline XMLNotationDecl* DTDGrammar::getNotationDecl(const XMLCh* const notName)
  {
      return fNotationDeclPool->getByKey(notName);
  }
  
  inline unsigned int DTDGrammar::putNotationDecl(XMLNotationDecl* const notationDecl)   const
  {
      return fNotationDeclPool->put(notationDecl);
  }
  
  #endif
  