Xerces-C++: DOMLocator.hpp Source File

Xerces-C++ 3.3.0

DOMLocator.hpp
Go to the documentation of this file.
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18/*
19 * $Id$
20 */
21
22#if !defined(XERCESC_INCLUDE_GUARD_DOMLOCATOR_HPP)
23#define XERCESC_INCLUDE_GUARD_DOMLOCATOR_HPP
24
25#include <xercesc/util/XercesDefs.hpp>
26
27 XERCES_CPP_NAMESPACE_BEGIN
28
29
30class DOMNode;
31
32
41 class CDOM_EXPORT DOMLocator
42{
43protected:
44 // -----------------------------------------------------------------------
45 // Hidden constructors
46 // -----------------------------------------------------------------------
49 DOMLocator() {};
51
52private:
53 // -----------------------------------------------------------------------
54 // Unimplemented constructors and operators
55 // -----------------------------------------------------------------------
58 DOMLocator(const DOMLocator &);
59 DOMLocator & operator = (const DOMLocator &);
61
62public:
63 // -----------------------------------------------------------------------
64 // All constructors are hidden, just the destructor is available
65 // -----------------------------------------------------------------------
72 virtual ~DOMLocator() {};
74
75 // -----------------------------------------------------------------------
76 // Virtual DOMLocator interface
77 // -----------------------------------------------------------------------
80 // -----------------------------------------------------------------------
81 // Getter methods
82 // -----------------------------------------------------------------------
89 virtual XMLFileLoc getLineNumber() const = 0;
90
97 virtual XMLFileLoc getColumnNumber() const = 0;
98
105 virtual XMLFilePos getByteOffset() const = 0;
106
113 virtual XMLFilePos getUtf16Offset() const = 0;
114
121 virtual DOMNode* getRelatedNode() const = 0;
122
129 virtual const XMLCh* getURI() const = 0;
131};
132
133 XERCES_CPP_NAMESPACE_END
134
135#endif
XercesDefs.hpp
CDOM_EXPORT
#define CDOM_EXPORT
Definition XercesDefs.hpp:166
XERCES_CPP_NAMESPACE_BEGIN
#define XERCES_CPP_NAMESPACE_BEGIN
Definition XercesDefs.hpp:112
XERCES_CPP_NAMESPACE_END
#define XERCES_CPP_NAMESPACE_END
Definition XercesDefs.hpp:113
XMLCh
char16_t XMLCh
Definition Xerces_autoconf_config.hpp:120
XMLFilePos
XMLUInt64 XMLFilePos
Definition Xerces_autoconf_config.hpp:139
XMLFileLoc
XMLUInt64 XMLFileLoc
Definition Xerces_autoconf_config.hpp:144
DOMLocator
DOMLocator is an interface that describes a location.
Definition DOMLocator.hpp:42
DOMLocator::~DOMLocator
virtual ~DOMLocator()
Destructor.
Definition DOMLocator.hpp:72
DOMLocator::DOMLocator
DOMLocator()
Definition DOMLocator.hpp:49
DOMLocator::getUtf16Offset
virtual XMLFilePos getUtf16Offset() const =0
Get the UTF-16 offset into the input source, or ~(XMLFilePos(0)) if there is no UTF-16 offset availab...
DOMLocator::getLineNumber
virtual XMLFileLoc getLineNumber() const =0
Get the line number where the error occured, or 0 if there is no line number available.
DOMLocator::getURI
virtual const XMLCh * getURI() const =0
Get the URI where the error occured, or null if there is no URI available.
DOMLocator::getRelatedNode
virtual DOMNode * getRelatedNode() const =0
Get the DOMNode where the error occured, or null if there is no node available.
DOMLocator::getByteOffset
virtual XMLFilePos getByteOffset() const =0
Get the byte offset into the input source, or ~(XMLFilePos(0)) if there is no byte offset available.
DOMLocator::getColumnNumber
virtual XMLFileLoc getColumnNumber() const =0
Get the column number where the error occured, or 0 if there is no column number available.
DOMNode
The DOMNode interface is the primary datatype for the entire Document Object Model.
Definition DOMNode.hpp:139