| /**************************************************************************** |
| ** |
| ** Copyright (C) 2016 The Qt Company Ltd. |
| ** Contact: https://www.qt.io/licensing/ |
| ** |
| ** This file is part of the QtXmlPatterns module of the Qt Toolkit. |
| ** |
| ** $QT_BEGIN_LICENSE:LGPL$ |
| ** Commercial License Usage |
| ** Licensees holding valid commercial Qt licenses may use this file in |
| ** accordance with the commercial license agreement provided with the |
| ** Software or, alternatively, in accordance with the terms contained in |
| ** a written agreement between you and The Qt Company. For licensing terms |
| ** and conditions see https://www.qt.io/terms-conditions. For further |
| ** information use the contact form at https://www.qt.io/contact-us. |
| ** |
| ** GNU Lesser General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU Lesser |
| ** General Public License version 3 as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
| ** packaging of this file. Please review the following information to |
| ** ensure the GNU Lesser General Public License version 3 requirements |
| ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
| ** |
| ** GNU General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU |
| ** General Public License version 2.0 or (at your option) the GNU General |
| ** Public license version 3 or any later version approved by the KDE Free |
| ** Qt Foundation. The licenses are as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
| ** included in the packaging of this file. Please review the following |
| ** information to ensure the GNU General Public License requirements will |
| ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
| ** https://www.gnu.org/licenses/gpl-3.0.html. |
| ** |
| ** $QT_END_LICENSE$ |
| ** |
| ****************************************************************************/ |
| |
| #include "qxmldebug_p.h" |
| |
| #include "qsourcelocation.h" |
| |
| |
| QT_BEGIN_NAMESPACE |
| |
| /*! |
| \class QSourceLocation |
| \reentrant |
| \since 4.4 |
| \brief The QSourceLocation class identifies a location in a resource by URI, line, and column. |
| \ingroup xml-tools |
| \inmodule QtXmlPatterns |
| |
| QSourceLocation is a simple value based class that has three |
| properties, uri(), line(), and column(), that, taken together, |
| identify a certain point in a resource, e.g., a file or an in-memory |
| document. |
| |
| line() and column() refer to character counts (not byte counts), and |
| they both start from 1, as opposed to 0. |
| */ |
| |
| /*! |
| Construct a QSourceLocation that doesn't identify anything at all. |
| |
| For a default constructed QSourceLocation(), isNull() returns \c true. |
| */ |
| QSourceLocation::QSourceLocation() : m_line(-1), m_column(-1) |
| { |
| } |
| |
| /*! |
| Constructs a QSourceLocation that is a copy of \a other. |
| */ |
| QSourceLocation::QSourceLocation(const QSourceLocation &other) |
| : m_line(other.m_line), m_column(other.m_column), m_uri(other.m_uri) |
| { |
| } |
| |
| /*! |
| Constructs a QSourceLocation with URI \a u, line \a l and column \a c. |
| */ |
| QSourceLocation::QSourceLocation(const QUrl &u, int l, int c) |
| : m_line(l), m_column(c), m_uri(u) |
| { |
| } |
| |
| /*! |
| Destructor. |
| */ |
| QSourceLocation::~QSourceLocation() |
| { |
| } |
| |
| /*! |
| Returns \c true if this QSourceLocation is equal to \a other; \c false |
| otherwise. |
| |
| Two QSourceLocation instances are equal if their uri(), line() and |
| column() are equal. |
| |
| QSourceLocation instances for which isNull() returns true are |
| considered equal. |
| */ |
| bool QSourceLocation::operator==(const QSourceLocation &other) const |
| { |
| return m_line == other.m_line |
| && m_column == other.m_column |
| && m_uri == other.m_uri; |
| } |
| |
| /*! |
| Returns \c true if this QSourceLocation is not equal to \a other; \c false |
| otherwise. |
| */ |
| bool QSourceLocation::operator!=(const QSourceLocation &other) const |
| { |
| return !operator==(other); |
| } |
| |
| /*! |
| Assigns this QSourceLocation instance to \a other. |
| */ |
| QSourceLocation &QSourceLocation::operator=(const QSourceLocation &other) |
| { |
| if(this != &other) |
| { |
| m_line = other.m_line; |
| m_column = other.m_column; |
| m_uri = other.m_uri; |
| } |
| |
| return *this; |
| } |
| |
| /*! |
| Returns the current column number. The column number refers to the |
| count of characters, not bytes. The first column is column 1, not 0. |
| The default value is -1, indicating the column number is unknown. |
| */ |
| qint64 QSourceLocation::column() const |
| { |
| return m_column; |
| } |
| |
| /*! |
| Sets the column number to \a newColumn. 0 is an invalid column |
| number. The first column number is 1. |
| */ |
| void QSourceLocation::setColumn(qint64 newColumn) |
| { |
| Q_ASSERT_X(newColumn != 0, Q_FUNC_INFO, |
| "0 is an invalid column number. The first column number is 1."); |
| m_column = newColumn; |
| } |
| |
| /*! |
| Returns the current line number. The first line number is 1, not 0. |
| The default value is -1, indicating the line number is unknown. |
| */ |
| qint64 QSourceLocation::line() const |
| { |
| return m_line; |
| } |
| |
| /*! |
| Sets the line number to \a newLine. 0 is an invalid line |
| number. The first line number is 1. |
| */ |
| void QSourceLocation::setLine(qint64 newLine) |
| { |
| m_line = newLine; |
| } |
| |
| /*! |
| Returns the resource that this QSourceLocation refers to. For |
| example, the resource could be a file in the local file system, |
| if the URI scheme is \c file. |
| */ |
| QUrl QSourceLocation::uri() const |
| { |
| return m_uri; |
| } |
| |
| /*! |
| Sets the URI to \a newUri. |
| */ |
| void QSourceLocation::setUri(const QUrl &newUri) |
| { |
| m_uri = newUri; |
| } |
| |
| /*! |
| \relates QSourceLocation |
| \since 4.4 |
| |
| Prints \a sourceLocation to the debug stream \a debug. |
| */ |
| #ifndef QT_NO_DEBUG_STREAM |
| QDebug operator<<(QDebug debug, const QSourceLocation &sourceLocation) |
| { |
| debug << "QSourceLocation(" |
| << sourceLocation.uri() |
| << ", line:" |
| << sourceLocation.line() |
| << ", column:" |
| << sourceLocation.column() |
| << ')'; |
| return debug; |
| } |
| #endif |
| |
| /*! |
| Returns \c true if this QSourceLocation doesn't identify anything. |
| |
| For a default constructed QSourceLocation, this function returns \c |
| true. The same applies for any other QSourceLocation whose uri() is |
| invalid. |
| */ |
| bool QSourceLocation::isNull() const |
| { |
| return !m_uri.isValid(); |
| } |
| |
| /*! |
| \since 4.4 |
| |
| Computes a hash key for the QSourceLocation \a location. |
| |
| \relates QSourceLocation |
| */ |
| uint qHash(const QSourceLocation &location) |
| { |
| /* Not the world's best hash function exactly. */ |
| return qHash(location.uri().toString()) + location.line() + location.column(); |
| } |
| |
| QT_END_NAMESPACE |
| |