xercesc/dom/DOMLocator.hpp

0001 /*
0002  * Licensed to the Apache Software Foundation (ASF) under one or more
0003  * contributor license agreements.  See the NOTICE file distributed with
0004  * this work for additional information regarding copyright ownership.
0005  * The ASF licenses this file to You under the Apache License, Version 2.0
0006  * (the "License"); you may not use this file except in compliance with
0007  * the License.  You may obtain a copy of the License at
0008  *
0009  *      http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  */
0017
0018 /*
0019  * $Id$
0020  */
0021
0022 #if !defined(XERCESC_INCLUDE_GUARD_DOMLOCATOR_HPP)
0023 #define XERCESC_INCLUDE_GUARD_DOMLOCATOR_HPP
0024
0025 #include <xercesc/util/XercesDefs.hpp>
0026
0027 XERCES_CPP_NAMESPACE_BEGIN
0028
0029
0030 class DOMNode;
0031
0032
0033 /**
0034   * DOMLocator is an interface that describes a location. (e.g. where an error
0035   * occured).
0036   *
0037   * @see DOMError#DOMError
0038   * @since DOM Level 3
0039   */
0040
0041 class CDOM_EXPORT DOMLocator
0042 {
0043 protected:
0044     // -----------------------------------------------------------------------
0045     //  Hidden constructors
0046     // -----------------------------------------------------------------------
0047     /** @name Hidden constructors */
0048     //@{
0049     DOMLocator() {};
0050     //@}
0051
0052 private:
0053     // -----------------------------------------------------------------------
0054     // Unimplemented constructors and operators
0055     // -----------------------------------------------------------------------
0056     /** @name Unimplemented constructors and operators */
0057     //@{
0058     DOMLocator(const DOMLocator &);
0059     DOMLocator & operator = (const DOMLocator &);
0060     //@}
0061
0062 public:
0063     // -----------------------------------------------------------------------
0064     //  All constructors are hidden, just the destructor is available
0065     // -----------------------------------------------------------------------
0066     /** @name Destructor */
0067     //@{
0068     /**
0069      * Destructor
0070      *
0071      */
0072     virtual ~DOMLocator() {};
0073     //@}
0074
0075     // -----------------------------------------------------------------------
0076     //  Virtual DOMLocator interface
0077     // -----------------------------------------------------------------------
0078     /** @name Functions introduced in DOM Level 3 */
0079     //@{
0080     // -----------------------------------------------------------------------
0081     //  Getter methods
0082     // -----------------------------------------------------------------------
0083     /**
0084      * Get the line number where the error occured, or 0 if there is
0085      * no line number available.
0086      *
0087      * @since DOM Level 3
0088      */
0089     virtual XMLFileLoc getLineNumber() const = 0;
0090
0091     /**
0092      * Get the column number where the error occured, or 0 if there
0093      * is no column number available.
0094      *
0095      * @since DOM Level 3
0096      */
0097     virtual XMLFileLoc getColumnNumber() const = 0;
0098
0099     /**
0100      * Get the byte offset into the input source, or ~(XMLFilePos(0)) if
0101      * there is no byte offset available.
0102      *
0103      * @since DOM Level 3
0104      */
0105     virtual XMLFilePos getByteOffset() const = 0;
0106
0107     /**
0108      * Get the UTF-16 offset into the input source, or ~(XMLFilePos(0)) if
0109      * there is no UTF-16 offset available.
0110      *
0111      * @since DOM Level 3
0112      */
0113     virtual XMLFilePos getUtf16Offset() const = 0;
0114
0115     /**
0116      * Get the DOMNode where the error occured, or <code>null</code> if there
0117      * is no node available.
0118      *
0119      * @since DOM Level 3
0120      */
0121     virtual DOMNode* getRelatedNode() const = 0;
0122
0123     /**
0124      * Get the URI where the error occured, or <code>null</code> if there is no
0125      * URI available.
0126      *
0127      * @since DOM Level 3
0128      */
0129     virtual const XMLCh* getURI() const = 0;
0130     //@}
0131 };
0132
0133 XERCES_CPP_NAMESPACE_END
0134
0135 #endif