/****************************************************************************

**

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

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtXmlPatterns module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

//

//  W A R N I N G

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

//

// This file is not part of the Qt API.  It exists purely as an

// implementation detail.  This header file may change from version to

// version without notice, or even be removed.

//

// We mean it.

#ifndef Patternist_ReportContext_H

#define Patternist_ReportContext_H

#include <QSharedData>

#include <QAbstractUriResolver>

#include <QSourceLocation>

#include "qnamepool_p.h"

#include "qxmlname.h"

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

class QAbstractMessageHandler;

class QSourceLocation;

class QString;

namespace QPatternist

{

    class SourceLocationReflection;

    /**

     * @short A callback for reporting errors.

     *

     * ReportContext receives messages of various severity and type via its

     * functions warning() and error(). In turn, ReportContext create Message instances

     * and submit them to the QAbstractMessageHandler instance returned by messageHandler().

     *

     * The Message attributes are set as follows:

     *

     * - Message::description() - A translated, human-readable description

     * - Message::type() - Message::Error if a static, dynamic or type error was encountered

     * that halted compilation or evaluation, or Message::Warning in case of a warning

     * - Message::identifier() - This is a URI consisting of the error namespace with the

     * error code as fragment. For example, a Message representing a syntax error

     * would return the type "http://www.w3.org/2005/xqt-errors#XPST0003". The convenience

     * function codeFromURI() can be used to extract the error code. The error namespace

     * is typically the namespace for XPath and XQuery errors(as in the previous example), but

     * can also be user defined.

     *

     * @see <a href="http://www.w3.org/TR/xpath20/#id-identifying-errors">XML Path Language

     * (XPath) 2.0, 2.3.2 Identifying and Reporting Errors</a>

     * @see <a href="http://www.w3.org/TR/xpath-functions/#func-error">XQuery 1.0 and

     * XPath 2.0 Functions and Operators, 3 The Error Function</a>

     * @author Frans Englich <frans.englich@nokia.com>

     * @warning This file is auto-generated from extractErrorCodes.xsl. Any

     * modifications done to this file are lost.

     */

    class Q_AUTOTEST_EXPORT ReportContext : public QSharedData

    {

    public:

        typedef QHash<const SourceLocationReflection *, QSourceLocation> LocationHash;

        /**

         * A smart pointer wrapping ReportContext instances.

         */

        typedef QExplicitlySharedDataPointer<ReportContext> Ptr;

        /**

         * @short Default constructors.

         *

         * For some reason GCC fails to synthesize it, so we provide an empty

         * one here.

         */

        inline ReportContext() {}

        virtual ~ReportContext();

        /**

         * Error codes that corresponds to the error codes defined in the

         * relevant specifications. They are used throughout the API for

         * identifying error conditions.

         *

         * While strings could have been used for identifying errors, enums

         * reduces bugs by providing type safety.

         *

         * @see <a href="http://www.w3.org/TR/xpath20/#errors">XML

         * Path Language (XPath) 2.0, 2.3 Error Handling</a>

         * @see <a href="http://www.w3.org/TR/xpath-functions/#d1e10985">XQuery 1.0

         * and XPath 2.0 Functions and Operators, C Error Summary</a>

         * @see <a href="http://www.w3.org/TR/xslt20/#error-summary">XSL Transformations

         * (XSLT) Version 2.0, E Summary of Error Conditions (Non-Normative)</a>

         * @note The enumerator values' Doxygen documentation is copied from the

         * W3C documents

         * <a href="http://www.w3.org/TR/xpath-functions">XQuery 1.0 and XPath

         * 2.0 Functions and Operators</a>,

         * <a href="http://www.w3.org/TR/xpath20">XML Path Language (XPath) 2.0</a>, and

         * <a href="http://www.w3.org/TR/xslt20/">XSL Transformations (XSLT)

         * Version 2.0</a>, respectively. The doxygen documentation is therefore covered

         * by the following legal notice:

         * "Copyright @ 2005 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C

         * <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>,

         * <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a> and

         * <a href="http://www.w3.org/Consortium/Legal/copyright-documents">document

         * use</a> rules apply."

         * @warning This enumerator is auto-generated from the relevant specifications

         * by the XSL-T stylesheet extractErrorCodes.xsl. Hence, any modifications

         * done to this file, in contrary to the stylesheet, are therefore lost.

         */

        enum ErrorCode

        {

            /**

             * XML Schema error code.

             */

            XSDError,

            /**

             * It is a static error if analysis of an expression relies on some

             * component of the static context that has not been assigned a

             * value.

             */

            XPST0001,

            /**

             * It is a dynamic error if evaluation of an expression relies on

             * some part of the dynamic context that has not been assigned a

             * value.

             */

            XPDY0002,

            /**

             * It is a static error if an expression is not a valid instance

             * of the grammar defined in A.1 EBNF.

             */

            XPST0003,

            /**

             * It is a type error if, during the static analysis phase, an expression

             * is found to have a static type that is not appropriate for the

             * context in which the expression occurs, or during the dynamic

             * evaluation phase, the dynamic type of a value does not match

             * a required type as specified by the matching rules in 2.5.4 SequenceType

             * Matching.

             */

            XPTY0004,

            /**

             * During the analysis phase, it is a static error if the static

             * type assigned to an expression other than the expression () or

             * data(()) is empty-sequence().

             */

            XPST0005,

            /**

             * (Not currently used.)

             */

            XPTY0006,

            /**

             * (Not currently used.)

             */

            XPTY0007,

            /**

             * It is a static error if an expression refers to an element name,

             * attribute name, schema type name, namespace prefix, or variable

             * name that is not defined in the static context, except for an

             * ElementName in an ElementTest or an AttributeName in an AttributeTest.

             */

            XPST0008,

            /**

             * An implementation that does not support the Schema Import Feature

             * must raise a static error if a Prolog contains a schema import.

             */

            XQST0009,

            /**

             * An implementation must raise a static error if it encounters

             * a reference to an axis that it does not support.

             */

            XPST0010,

            /**

             * It is a static error if the set of definitions contained in all

             * schemas imported by a Prolog do not satisfy the conditions for

             * schema validity specified in Sections 3 and 5 of [XML Schema]

             * Part 1--i.e., each definition must be valid, complete, and unique.

             */

            XQST0012,

            /**

             * It is a static error if an implementation recognizes a pragma

             * but determines that its content is invalid.

             */

            XQST0013,

            /**

             * (Not currently used.)

             */

            XQST0014,

            /**

             * (Not currently used.)

             */

            XQST0015,

            /**

             * An implementation that does not support the Module Feature raises

             * a static error if it encounters a module declaration or a module

             * import.

             */

            XQST0016,

            /**

             * It is a static error if the expanded QName and number of arguments

             * in a function call do not match the name and arity of a function

             * signature in the static context.

             */

            XPST0017,

            /**

             * It is a type error if the result of the last step in a path expression

             * contains both nodes and atomic values.

             */

            XPTY0018,

            /**

             * It is a type error if the result of a step (other than the last

             * step) in a path expression contains an atomic value.

             */

            XPTY0019,

            /**

             * It is a type error if, in an axis step, the context item is not

             * a node.

             */

            XPTY0020,

            /**

             * (Not currently used.)

             */

            XPDY0021,

            /**

             * It is a static error if the value of a namespace declaration

             * attribute is not a URILiteral.

             */

            XQST0022,

            /**

             * (Not currently used.)

             */

            XQTY0023,

            /**

             * It is a type error if the content sequence in an element constructor

             * contains an attribute node following a node that is not an attribute

             * node.

             */

            XQTY0024,

            /**

             * It is a dynamic error if any attribute of a constructed element

             * does not have a name that is distinct from the names of all other

             * attributes of the constructed element.

             */

            XQDY0025,

            /**

             * It is a dynamic error if the result of the content expression

             * of a computed processing instruction constructor contains the

             * string "?>".

             */

            XQDY0026,

            /**

             * In a validate expression, it is a dynamic error if the root element

             * information item in the PSVI resulting from validation does not

             * have the expected validity property: valid if validation mode

             * is strict, or either valid or notKnown if validation mode is

             * lax.

             */

            XQDY0027,

            /**

             * (Not currently used.)

             */

            XQTY0028,

            /**

             * (Not currently used.)

             */

            XQDY0029,

            /**

             * It is a type error if the argument of a validate expression does

             * not evaluate to exactly one document or element node.

             */

            XQTY0030,

            /**

             * It is a static error if the version number specified in a version

             * declaration is not supported by the implementation.

             */

            XQST0031,

            /**

             * A static error is raised if a Prolog contains more than one base

             * URI declaration.

             */

            XQST0032,

            /**

             * It is a static error if a module contains multiple bindings for

             * the same namespace prefix.

             */

            XQST0033,

            /**

             * It is a static error if multiple functions declared or imported

             * by a module have the number of arguments and their expanded QNames

             * are equal (as defined by the eq operator).

             */

            XQST0034,

            /**

             * It is a static error to import two schema components that both

             * define the same name in the same symbol space and in the same

             * scope.

             */

            XQST0035,

            /**

             * It is a static error to import a module if the importing module's

             * in-scope schema types do not include definitions for the schema

             * type names that appear in the declarations of variables and functions

             * (whether in an argument type or return type) that are present

             * in the imported module and are referenced in the importing module.

             */

            XQST0036,

            /**

             * (Not currently used.)

             */

            XQST0037,

            /**

             * It is a static error if a Prolog contains more than one default

             * collation declaration, or the value specified by a default collation

             * declaration is not present in statically known collations.

             */

            XQST0038,

            /**

             * It is a static error for a function declaration to have more

             * than one parameter with the same name.

             */

            XQST0039,

            /**

             * It is a static error if the attributes specified by a direct

             * element constructor do not have distinct expanded QNames.

             */

            XQST0040,

            /**

             * It is a dynamic error if the value of the name expression in

             * a computed processing instruction constructor cannot be cast

             * to the type xs:NCName.

             */

            XQDY0041,

            /**

             * (Not currently used.)

             */

            XQST0042,

            /**

             * (Not currently used.)

             */

            XQST0043,

            /**

             * It is a dynamic error if the node-name property of the node constructed

             * by a computed attribute constructor is in the namespace http://www.w3.org/2000/xmlns/

             * (corresponding to namespace prefix xmlns), or is in no namespace

             * and has local name xmlns.

             */

            XQDY0044,

            /**

             * It is a static error if the function name in a function declaration

             * is in one of the following namespaces: http://www.w3.org/XML/1998/namespace,

             * http://www.w3.org/2001/XMLSchema, http://www.w3.org/2001/XMLSchema-instance,

             * http://www.w3.org/2005/xpath-functions.

             */

            XQST0045,

            /**

             * An implementation MAY raise a static error if the value of a

             * URILiteral is of nonzero length and is not in the lexical space

             * of xs:anyURI.

             */

            XQST0046,

            /**

             * It is a static error if multiple module imports in the same Prolog

             * specify the same target namespace.

             */

            XQST0047,

            /**

             * It is a static error if a function or variable declared in a

             * library module is not in the target namespace of the library

             * module.

             */

            XQST0048,

            /**

             * It is a static error if two or more variables declared or imported

             * by a module have equal expanded QNames (as defined by the eq

             * operator.)

             */

            XQST0049,

            /**

             * It is a dynamic error if the dynamic type of the operand of a

             * treat expression does not match the sequence type specified by

             * the treat expression. This error might also be raised by a path

             * expression beginning with "/" or "//" if the context node is

             * not in a tree that is rooted at a document node. This is because

             * a leading "/" or "//" in a path expression is an abbreviation

             * for an initial step that includes the clause treat as document-node().

             */

            XPDY0050,

            /**

             * It is a static error if a QName that is used as an AtomicType

             * in a SequenceType is not defined in the in-scope schema types

             * as an atomic type.

             */

            XPST0051,

            /**

             * (Not currently used.)

             */

            XQDY0052,

            /**

             * (Not currently used.)

             */

            XQST0053,

            /**

             * It is a static error if a variable depends on itself.

             */

            XQST0054,

            /**

             * It is a static error if a Prolog contains more than one copy-namespaces

             * declaration.

             */

            XQST0055,

            /**

             * (Not currently used.)

             */

            XQST0056,

            /**

             * It is a static error if a schema import binds a namespace prefix

             * but does not specify a target namespace other than a zero-length

             * string.

             */

            XQST0057,

            /**

             * It is a static error if multiple schema imports specify the same

             * target namespace.

             */

            XQST0058,

            /**

             * It is a static error if an implementation is unable to process

             * a schema or module import by finding a schema or module with