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

词法分析

开发平台:

Visual C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-2000 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: DeclHandler.hpp,v $
  58.  * Revision 1.3  2003/03/07 18:10:30  tng
  59.  * Return a reference instead of void for operator=
  60.  *
  61.  * Revision 1.2  2002/11/04 14:55:45  tng
  62.  * C++ Namespace Support.
  63.  *
  64.  * Revision 1.1.1.1  2002/02/01 22:22:09  peiyongz
  65.  * sane_include
  66.  *
  67.  * Revision 1.1  2002/01/28 17:08:33  knoaman
  68.  * SAX2-ext's DeclHandler support.
  69.  *
  70.  */
  71. #ifndef DECLHANDLER_HPP
  72. #define DECLHANDLER_HPP
  73. #include <xercesc/util/XercesDefs.hpp>
  74. XERCES_CPP_NAMESPACE_BEGIN
  75. /**
  76.   * Receive notification of DTD declaration events.
  77.   *
  78.   * <p>This is an optional extension handler for SAX2 to provide more
  79.   * complete information about DTD declarations in an XML document.
  80.   * XML readers are not required to recognize this handler, and it is not
  81.   * part of core-only SAX2 distributions.</p>
  82.   *
  83.   * <p>Note that data-related DTD declarations (unparsed entities and
  84.   * notations) are already reported through the DTDHandler interface.</p>
  85.   *
  86.   * <p>If you are using the declaration handler together with a lexical
  87.   * handler, all of the events will occur between the startDTD and the endDTD
  88.   * events.</p>
  89.   *
  90.   * @see SAX2XMLReader#setLexicalHandler
  91.   * @see SAX2XMLReader#setDeclarationHandler
  92.   */
  93. class SAX2_EXPORT DeclHandler
  94. {
  95. public:
  96.     /** @name Constructors and Destructor */
  97.     //@{
  98.     /** Default constructor */
  99.     DeclHandler()
  100.     {
  101.     }
  102.     /** Destructor */
  103.     virtual ~DeclHandler()
  104.     {
  105.     }
  106.     //@}
  107.     /** @name The virtual declaration handler interface */
  108.     //@{
  109.    /**
  110.     * Report an element type declaration.
  111.     *
  112.     * <p>The content model will consist of the string "EMPTY", the string
  113.     * "ANY", or a parenthesised group, optionally followed by an occurrence
  114.     * indicator. The model will be normalized so that all parameter entities
  115.     * are fully resolved and all whitespace is removed,and will include the
  116.     * enclosing parentheses. Other normalization (such as removing redundant
  117.     * parentheses or simplifying occurrence indicators) is at the discretion
  118.     * of the parser.</p>
  119.     *
  120.     * @param name The element type name.
  121.     * @param model The content model as a normalized string.
  122.     * @exception SAXException Any SAX exception, possibly
  123.     *            wrapping another exception.
  124.     */
  125.     virtual void elementDecl
  126.     (
  127.         const   XMLCh* const    name
  128.         , const XMLCh* const    model
  129.     ) = 0;
  130.    /**
  131.     * Report an attribute type declaration.
  132.     *
  133.     * <p>The Parser will call this method to report each occurence of
  134.     * a comment in the XML document.</p>
  135.     *
  136.     * <p>The application must not attempt to read from the array
  137.     * outside of the specified range.</p>
  138.     *
  139.     * @param eName The name of the associated element.
  140.     * @param aName The name of the attribute.
  141.     * @param type A string representing the attribute type.
  142.     * @param mode A string representing the attribute defaulting mode ("#IMPLIED", "#REQUIRED", or "#FIXED") or null if none of these applies.
  143.     * @param value A string representing the attribute's default value, or null if there is none.
  144.     * @exception SAXException Any SAX exception, possibly
  145.     *            wrapping another exception.
  146.     */
  147.     virtual void attributeDecl
  148.     (
  149.         const   XMLCh* const    eName
  150.         , const XMLCh* const    aName
  151.         , const XMLCh* const    type
  152.         , const XMLCh* const    mode
  153.         , const XMLCh* const    value
  154.     ) = 0;
  155.    /**
  156.     * Report an internal entity declaration.
  157.     *
  158.     * <p>Only the effective (first) declaration for each entity will be
  159.     * reported. All parameter entities in the value will be expanded, but
  160.     * general entities will not.</p>
  161.     *
  162.     * @param name The name of the entity. If it is a parameter entity, the name will begin with '%'.
  163.     * @param value The replacement text of the entity.
  164.     * @exception SAXException Any SAX exception, possibly
  165.     *            wrapping another exception.
  166.     */
  167.     virtual void internalEntityDecl
  168.     (
  169.         const   XMLCh* const    name
  170.         , const XMLCh* const    value
  171.     ) = 0;
  172.    /**
  173.     * Report a parsed external entity declaration.
  174.     *
  175.     * <p>Only the effective (first) declaration for each entity will
  176.     * be reported.</p>
  177.     *
  178.     * @param name The name of the entity. If it is a parameter entity, the name will begin with '%'.
  179.     * @param publicId The The declared public identifier of the entity, or null if none was declared.
  180.     * @param systemId The declared system identifier of the entity.
  181.     * @exception SAXException Any SAX exception, possibly
  182.     *            wrapping another exception.
  183.     */
  184.     virtual void externalEntityDecl
  185.     (
  186.         const   XMLCh* const    name
  187.         , const XMLCh* const    publicId
  188.         , const XMLCh* const    systemId
  189.     ) = 0;
  190.     //@}
  191. private :
  192.     /* Unimplemented Constructors and operators */
  193.     /* Copy constructor */
  194.     DeclHandler(const DeclHandler&);
  195.     /** Assignment operator */
  196.     DeclHandler& operator=(const DeclHandler&);
  197. };
  198. XERCES_CPP_NAMESPACE_END
  199. #endif