/*

* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description: 

*

*/

/*

 * Licensed to the Apache Software Foundation (ASF) under one or more

 * contributor license agreements.  See the NOTICE file distributed with

 * this work for additional information regarding copyright ownership.

 * The ASF licenses this file to You under the Apache License, Version 2.0

 * (the "License"); you may not use this file except in compliance with

 * the License.  You may obtain a copy of the License at

 * 

 *      http://www.apache.org/licenses/LICENSE-2.0

 * 

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

 /*

 * $Id: XMLErrorReporter.hpp 568078 2007-08-21 11:43:25Z amassari $

 */

#if !defined(XMLERRORREPORTER_HPP)

#define XMLERRORREPORTER_HPP

#include <xercesc/util/XercesDefs.hpp>

XERCES_CPP_NAMESPACE_BEGIN

/**

 *  This abstract class defines a callback mechanism for the scanner. By

 *  creating a class that implements this interface and plugging an instance

 *  of that class into the scanner, the scanner will call back on the object's

 *  virtual methods to report error events. This class is also used with the

 *  validator, to allow it to report errors.

 *

 *  This class is primarily for use by those writing their own parser classes.

 *  If you use the standard parser classes, DOMParser and SAXParser, you won't

 *  use this API. You will instead use a similar mechanism defined by the SAX

 *  API, called ErrorHandler.

 */

class XMLPARSER_EXPORT XMLErrorReporter

{

public:

    // -----------------------------------------------------------------------

    //  The types of errors we can issue

    // -----------------------------------------------------------------------

    enum ErrTypes

    {

        ErrType_Warning

        , ErrType_Error

        , ErrType_Fatal

        , ErrTypes_Unknown

    };

    // -----------------------------------------------------------------------

    //  Constructors are hidden, only the virtual destructor is exposed

    // -----------------------------------------------------------------------

    /** @name Destructor */

    //@{

    /**

      *   Default destructor

      */

    virtual ~XMLErrorReporter()

    {

    }

    //@}

    // -----------------------------------------------------------------------

    //  The error handler interface

    // -----------------------------------------------------------------------

    /** @name Error Handler interface */

    //@{

    /** Called to report errors from the scanner or validator

      *

      * This method is called back on by the scanner or validator (or any other

      * internal parser component which might need to report an error in the

      * future.) It contains all the information that the client code might

      * need to report or log the error.

      *

      * @param  errCode     The error code of the error being reported. What

      *                     this means is dependent on the domain it is from.

      *

      * @param  errDomain   The domain from which the error occured. The domain

      *                     is a means of providing a hierarchical layering to

      *                     the error system, so that a single set of error id

      *                     numbers don't have to be split up.

      *

      * @param  type        The error type, which is defined mostly by XML which

      *                     categorizes errors into warning, errors and validity

      *                     constraints.

      *

      * @param  errorText   The actual text of the error. This is translatable,

      *                     so can possibly be in the local language if a

      *                     translation has been provided.

      *

      * @param  systemId    The system id of the entity where the error occured,

      *                     fully qualified.

      *

      * @param  publicId    The optional public id of the entity were the error

      *                     occured. It can be an empty string if non was provided.

      *

      * @param  lineNum     The line number within the source XML of the error.

      *

      * @param  colNum      The column number within the source XML of the error.

      *                     Because of the parsing style, this is usually just

      *                     after the actual offending text.

      */

    virtual void error

    (

        const   unsigned int        errCode

        , const XMLCh* const        errDomain

        , const ErrTypes            type

        , const XMLCh* const        errorText

        , const XMLCh* const        systemId

        , const XMLCh* const        publicId

        , const XMLSSize_t          lineNum

        , const XMLSSize_t          colNum

    ) = 0;

    /** Called before a new parse event to allow the handler to reset

      *

      * This method is called by the scanner before a new parse event is

      * about to start. It gives the error handler a chance to reset its

      * internal state.

      */

    virtual void resetErrors() = 0;

    //@}

protected :

    /** @name Constructor */

    //@{

    /**

      *   Default constructor

      */

    XMLErrorReporter()

    {

    }

    //@}

private:

    // -----------------------------------------------------------------------

    //  Unimplemented constructors and destructor

    // -----------------------------------------------------------------------

    XMLErrorReporter(const XMLErrorReporter&);

    XMLErrorReporter& operator=(const XMLErrorReporter&);

};

XERCES_CPP_NAMESPACE_END

#endif