source: icXML/icXML-devel/src/xercesc/dom/DOMLocator.hpp @ 2722

Last change on this file since 2722 was 2722, checked in by cameron, 6 years ago

Original Xerces files with import mods for icxercesc

File size: 3.9 KB
Line 
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: DOMLocator.hpp 676853 2008-07-15 09:58:05Z borisk $
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
27XERCES_CPP_NAMESPACE_BEGIN
28
29
30class DOMNode;
31
32
33/**
34  * DOMLocator is an interface that describes a location. (e.g. where an error
35  * occured).
36  *
37  * @see DOMError#DOMError
38  * @since DOM Level 3
39  */
40
41class CDOM_EXPORT DOMLocator
42{
43protected:
44    // -----------------------------------------------------------------------
45    //  Hidden constructors
46    // -----------------------------------------------------------------------
47    /** @name Hidden constructors */
48    //@{
49    DOMLocator() {};
50    //@}
51
52private:
53    // -----------------------------------------------------------------------
54    // Unimplemented constructors and operators
55    // -----------------------------------------------------------------------
56    /** @name Unimplemented constructors and operators */
57    //@{
58    DOMLocator(const DOMLocator &);
59    DOMLocator & operator = (const DOMLocator &);
60    //@}
61
62public:
63    // -----------------------------------------------------------------------
64    //  All constructors are hidden, just the destructor is available
65    // -----------------------------------------------------------------------
66    /** @name Destructor */
67    //@{
68    /**
69     * Destructor
70     *
71     */
72    virtual ~DOMLocator() {};
73    //@}
74
75    // -----------------------------------------------------------------------
76    //  Virtual DOMLocator interface
77    // -----------------------------------------------------------------------
78    /** @name Functions introduced in DOM Level 3 */
79    //@{
80    // -----------------------------------------------------------------------
81    //  Getter methods
82    // -----------------------------------------------------------------------
83    /**
84     * Get the line number where the error occured, or 0 if there is
85     * no line number available.
86     *
87     * @since DOM Level 3
88     */
89    virtual XMLFileLoc getLineNumber() const = 0;
90
91    /**
92     * Get the column number where the error occured, or 0 if there
93     * is no column number available.
94     *
95     * @since DOM Level 3
96     */
97    virtual XMLFileLoc getColumnNumber() const = 0;
98
99    /**
100     * Get the byte offset into the input source, or ~(XMLFilePos(0)) if
101     * there is no byte offset available.
102     *
103     * @since DOM Level 3
104     */
105    virtual XMLFilePos getByteOffset() const = 0;
106
107    /**
108     * Get the UTF-16 offset into the input source, or ~(XMLFilePos(0)) if
109     * there is no UTF-16 offset available.
110     *
111     * @since DOM Level 3
112     */
113    virtual XMLFilePos getUtf16Offset() const = 0;
114
115    /**
116     * Get the DOMNode where the error occured, or <code>null</code> if there
117     * is no node available.
118     *
119     * @since DOM Level 3
120     */
121    virtual DOMNode* getRelatedNode() const = 0;
122
123    /**
124     * Get the URI where the error occured, or <code>null</code> if there is no
125     * URI available.
126     *
127     * @since DOM Level 3
128     */
129    virtual const XMLCh* getURI() const = 0;
130    //@}
131};
132
133XERCES_CPP_NAMESPACE_END
134
135#endif
Note: See TracBrowser for help on using the repository browser.