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

词法分析

开发平台:

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: XMLErrorReporter.hpp,v $
  58.   * Revision 1.6  2003/03/07 18:08:10  tng
  59.   * Return a reference instead of void for operator=
  60.   *
  61.   * Revision 1.5  2002/12/04 02:32:43  knoaman
  62.   * #include cleanup.
  63.   *
  64.   * Revision 1.4  2002/11/04 15:00:21  tng
  65.   * C++ Namespace Support.
  66.   *
  67.   * Revision 1.3  2002/05/27 18:34:59  tng
  68.   * To get ready for 64 bit large file, use XMLSSize_t to represent line and column number.
  69.   *
  70.   * Revision 1.2  2002/02/20 18:17:01  tng
  71.   * [Bug 5977] Warnings on generating apiDocs.
  72.   *
  73.   * Revision 1.1.1.1  2002/02/01 22:21:51  peiyongz
  74.   * sane_include
  75.   *
  76.   * Revision 1.11  2001/05/11 13:25:32  tng
  77.   * Copyright update.
  78.   *
  79.   * Revision 1.10  2001/05/03 19:08:56  knoaman
  80.   * Support Warning/Error/FatalError messaging.
  81.   * Validity constraints errors are treated as errors, with the ability by user to set
  82.   * validity constraints as fatal errors.
  83.   *
  84.   * Revision 1.9  2000/12/14 18:49:57  tng
  85.   * Fix API document generation warning: "Warning: end of member group without matching begin"
  86.   *
  87.   * Revision 1.8  2000/03/02 19:54:25  roddey
  88.   * This checkin includes many changes done while waiting for the
  89.   * 1.1.0 code to be finished. I can't list them all here, but a list is
  90.   * available elsewhere.
  91.   *
  92.   * Revision 1.7  2000/02/24 20:00:23  abagchi
  93.   * Swat for removing Log from API docs
  94.   *
  95.   * Revision 1.6  2000/02/16 23:03:48  roddey
  96.   * More documentation updates
  97.   *
  98.   * Revision 1.5  2000/02/16 21:42:58  aruna1
  99.   * API Doc++ summary changes in
  100.   *
  101.   * Revision 1.4  2000/02/15 23:59:07  roddey
  102.   * More updated documentation of Framework classes.
  103.   *
  104.   * Revision 1.3  2000/02/15 01:21:31  roddey
  105.   * Some initial documentation improvements. More to come...
  106.   *
  107.   * Revision 1.2  2000/02/06 07:47:48  rahulj
  108.   * Year 2K copyright swat.
  109.   *
  110.   * Revision 1.1.1.1  1999/11/09 01:08:34  twl
  111.   * Initial checkin
  112.   *
  113.   * Revision 1.2  1999/11/08 20:44:39  rahul
  114.   * Swat for adding in Product name and CVS comment log variable.
  115.   *
  116.   */
  117. #if !defined(XMLERRORREPORTER_HPP)
  118. #define XMLERRORREPORTER_HPP
  119. #include <xercesc/util/XercesDefs.hpp>
  120. XERCES_CPP_NAMESPACE_BEGIN
  121. /**
  122.  *  This abstract class defines a callback mechanism for the scanner. By
  123.  *  creating a class that implements this interface and plugging an instance
  124.  *  of that class into the scanner, the scanner will call back on the object's
  125.  *  virtual methods to report error events. This class is also used with the
  126.  *  validator, to allow it to report errors.
  127.  *
  128.  *  This class is primarily for use by those writing their own parser classes.
  129.  *  If you use the standard parser classes, DOMParser and SAXParser, you won't
  130.  *  use this API. You will instead use a similar mechanism defined by the SAX
  131.  *  API, called ErrorHandler.
  132.  */
  133. class XMLPARSER_EXPORT XMLErrorReporter
  134. {
  135. public:
  136.     // -----------------------------------------------------------------------
  137.     //  The types of errors we can issue
  138.     // -----------------------------------------------------------------------
  139.     enum ErrTypes
  140.     {
  141.         ErrType_Warning
  142.         , ErrType_Error
  143.         , ErrType_Fatal
  144.         , ErrTypes_Unknown
  145.     };
  146.     // -----------------------------------------------------------------------
  147.     //  Constructors are hidden, only the virtual destructor is exposed
  148.     // -----------------------------------------------------------------------
  149.     /** @name Destructor */
  150.     //@{
  151.     /**
  152.       *   Default destructor
  153.       */
  154.     virtual ~XMLErrorReporter()
  155.     {
  156.     }
  157.     //@}
  158.     // -----------------------------------------------------------------------
  159.     //  The error handler interface
  160.     // -----------------------------------------------------------------------
  161.     /** @name Error Handler interface */
  162.     //@{
  163.     /** Called to report errors from the scanner or validator
  164.       *
  165.       * This method is called back on by the scanner or validator (or any other
  166.       * internal parser component which might need to report an error in the
  167.       * future.) It contains all the information that the client code might
  168.       * need to report or log the error.
  169.       *
  170.       * @param  errCode     The error code of the error being reported. What
  171.       *                     this means is dependent on the domain it is from.
  172.       *
  173.       * @param  errDomain   The domain from which the error occured. The domain
  174.       *                     is a means of providing a hierarchical layering to
  175.       *                     the error system, so that a single set of error id
  176.       *                     numbers don't have to be split up.
  177.       *
  178.       * @param  type        The error type, which is defined mostly by XML which
  179.       *                     categorizes errors into warning, errors and validity
  180.       *                     constraints.
  181.       *
  182.       * @param  errorText   The actual text of the error. This is translatable,
  183.       *                     so can possibly be in the local language if a
  184.       *                     translation has been provided.
  185.       *
  186.       * @param  systemId    The system id of the entity where the error occured,
  187.       *                     fully qualified.
  188.       *
  189.       * @param  publicId    The optional public id of the entity were the error
  190.       *                     occured. It can be an empty string if non was provided.
  191.       *
  192.       * @param  lineNum     The line number within the source XML of the error.
  193.       *
  194.       * @param  colNum      The column number within the source XML of the error.
  195.       *                     Because of the parsing style, this is usually just
  196.       *                     after the actual offending text.
  197.       */
  198.     virtual void error
  199.     (
  200.         const   unsigned int        errCode
  201.         , const XMLCh* const        errDomain
  202.         , const ErrTypes            type
  203.         , const XMLCh* const        errorText
  204.         , const XMLCh* const        systemId
  205.         , const XMLCh* const        publicId
  206.         , const XMLSSize_t          lineNum
  207.         , const XMLSSize_t          colNum
  208.     ) = 0;
  209.     /** Called before a new parse event to allow the handler to reset
  210.       *
  211.       * This method is called by the scanner before a new parse event is
  212.       * about to start. It gives the error handler a chance to reset its
  213.       * internal state.
  214.       */
  215.     virtual void resetErrors() = 0;
  216.     //@}
  217. protected :
  218.     /** @name Constructor */
  219.     //@{
  220.     /**
  221.       *   Default constructor
  222.       */
  223.     XMLErrorReporter()
  224.     {
  225.     }
  226.     //@}
  227. private:
  228.     // -----------------------------------------------------------------------
  229.     //  Unimplemented constructors and destructor
  230.     // -----------------------------------------------------------------------
  231.     XMLErrorReporter(const XMLErrorReporter&);
  232.     XMLErrorReporter& operator=(const XMLErrorReporter&);
  233. };
  234. XERCES_CPP_NAMESPACE_END
  235. #endif