SAXParseException.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: SAXParseException.hpp,v $
  58.  * Revision 1.4  2003/05/15 18:27:05  knoaman
  59.  * Partial implementation of the configurable memory manager.
  60.  *
  61.  * Revision 1.3  2002/11/04 14:56:26  tng
  62.  * C++ Namespace Support.
  63.  *
  64.  * Revision 1.2  2002/05/27 18:33:07  tng
  65.  * To get ready for 64 bit large file, use XMLSSize_t to represent line and column number.
  66.  *
  67.  * Revision 1.1.1.1  2002/02/01 22:22:08  peiyongz
  68.  * sane_include
  69.  *
  70.  * Revision 1.5  2000/02/24 20:12:55  abagchi
  71.  * Swat for removing Log from API docs
  72.  *
  73.  * Revision 1.4  2000/02/12 01:27:19  aruna1
  74.  * Documentation updated
  75.  *
  76.  * Revision 1.3  2000/02/09 19:24:49  abagchi
  77.  * Inserted documentation for constructors and destructors
  78.  *
  79.  * Revision 1.2  2000/02/06 07:47:58  rahulj
  80.  * Year 2K copyright swat.
  81.  *
  82.  * Revision 1.1.1.1  1999/11/09 01:07:47  twl
  83.  * Initial checkin
  84.  *
  85.  * Revision 1.2  1999/11/08 20:45:02  rahul
  86.  * Swat for adding in Product name and CVS comment log variable.
  87.  *
  88.  */
  89. #ifndef SAXPARSEEXCEPTION_HPP
  90. #define SAXPARSEEXCEPTION_HPP
  91. #include <xercesc/sax/SAXException.hpp>
  92. XERCES_CPP_NAMESPACE_BEGIN
  93. class Locator;
  94. /**
  95.   * Encapsulate an XML parse error or warning.
  96.   *
  97.   * <p>This exception will include information for locating the error
  98.   * in the original XML document.  Note that although the application
  99.   * will receive a SAXParseException as the argument to the handlers
  100.   * in the ErrorHandler interface, the application is not actually
  101.   * required to throw the exception; instead, it can simply read the
  102.   * information in it and take a different action.</p>
  103.   *
  104.   * <p>Since this exception is a subclass of SAXException, it
  105.   * inherits the ability to wrap another exception.</p>
  106.   *
  107.   * @see SAXException#SAXException
  108.   * @see Locator#Locator
  109.   * @see ErrorHandler#ErrorHandler
  110.   */
  111. class SAX_EXPORT SAXParseException : public SAXException
  112. {
  113. public:
  114.     /** @name Constructors and Destructor */
  115.     //@{
  116.   /**
  117.     * Create a new SAXParseException from a message and a Locator.
  118.     *
  119.     * <p>This constructor is especially useful when an application is
  120.     * creating its own exception from within a DocumentHandler
  121.     * callback.</p>
  122.     *
  123.     * @param message The error or warning message.
  124.     * @param locator The locator object for the error or warning.
  125.     * @see Locator#Locator
  126.     * @see Parser#setLocale
  127.     */
  128.     SAXParseException(const XMLCh* const message, const Locator& locator);
  129.   /**
  130.     * Create a new SAXParseException.
  131.     *
  132.     * <p>This constructor is most useful for parser writers.</p>
  133.     *
  134.     * <p>If the system identifier is a URL, the parser must resolve it
  135.     * fully before creating the exception.</p>
  136.     *
  137.     * @param message The error or warning message.
  138.     * @param publicId The public identifer of the entity that generated
  139.     *                 the error or warning.
  140.     * @param systemId The system identifer of the entity that generated
  141.     *                 the error or warning.
  142.     * @param lineNumber The line number of the end of the text that
  143.     *                   caused the error or warning.
  144.     * @param columnNumber The column number of the end of the text that
  145.     *                     caused the error or warning.
  146.     * @see Parser#setLocale
  147.     */
  148.     SAXParseException
  149.     (
  150.         const   XMLCh* const    message
  151.         , const XMLCh* const    publicId
  152.         , const XMLCh* const    systemId
  153.         , const XMLSSize_t      lineNumber
  154.         , const XMLSSize_t      columnNumber
  155.     );
  156.   /**
  157.     * Copy constructor
  158.     *
  159.     * @param toCopy The object to be copied
  160.     */
  161.     SAXParseException(const SAXParseException& toCopy);
  162.     /**
  163.       * Destructor
  164.       */
  165.     ~SAXParseException();
  166.     //@}
  167.     /** @name Assignment operator */
  168.     //@{
  169.    /**
  170.     * Assignment operator
  171.     *
  172.     * @param toAssign The object to be copied through assignment
  173.     *
  174.     */
  175.     SAXParseException& operator=(const SAXParseException& toAssign);
  176.     //@}
  177.     /** @name Getter methods */
  178.     //@{
  179.    /**
  180.     * The column number of the end of the text where the exception occurred.
  181.     *
  182.     * <p>The first column in a line is position 1.</p>
  183.     *
  184.     * @return An integer representing the column number, or -1
  185.     *         if none is available.
  186.     * @see Locator#getColumnNumber
  187.     */
  188.     XMLSSize_t getColumnNumber() const;
  189.   /**
  190.     * The line number of the end of the text where the exception occurred.
  191.     *
  192.     * @return An integer representing the line number, or -1
  193.     *         if none is available.
  194.     * @see Locator#getLineNumber
  195.     */
  196.     XMLSSize_t getLineNumber() const;
  197.   /**
  198.     * Get the public identifier of the entity where the exception occurred.
  199.     *
  200.     * @return A string containing the public identifier, or null
  201.     *         if none is available.
  202.     * @see Locator#getPublicId
  203.     */
  204.     const XMLCh* getPublicId() const;
  205.   /**
  206.     * Get the system identifier of the entity where the exception occurred.
  207.     *
  208.     * <p>If the system identifier is a URL, it will be resolved
  209.     * fully.</p>
  210.     *
  211.     * @return A string containing the system identifier, or null
  212.     *         if none is available.
  213.     * @see Locator#getSystemId
  214.     */
  215.     const XMLCh* getSystemId() const;
  216.     //@}
  217. private:
  218.     /* Data Members */
  219.     /* The column in the source text where the error occured. */
  220.     XMLSSize_t      fColumnNumber;
  221.     /* The line in the source text where the error occured. */
  222.     XMLSSize_t      fLineNumber;
  223.     /* The public id of the file where the error occured. */
  224.     XMLCh*          fPublicId;
  225.     /* The system id of the file where the error occured. */
  226.     XMLCh*          fSystemId;
  227. };
  228. XERCES_CPP_NAMESPACE_END
  229. #endif