qqmlsasourcelocation.cpp

Go to the documentation of this file.

// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
// Qt-Security score:significant
 
#include "qqmlsasourcelocation.h"
#include "qqmlsasourcelocation_p.h"
 
#include <private/qqmljssourcelocation_p.h>
 
QT_BEGIN_NAMESPACE
 
using namespace Qt::StringLiterals;
 
namespace QQmlSA {
 
static_assert(SourceLocationPrivate::sizeOfSourceLocation() == sizeof(SourceLocation));
 
/*!
    \class QQmlSA::SourceLocation
    \inmodule QtQmlCompiler
 
    \brief Represents a location or region in the source code.
 */
 
/*!
    Constructs a new SourceLocation with values given by \a offset, \a length,
    \a line, and \a column.
 */
QQmlSA::SourceLocation::SourceLocation(quint32 offset, quint32 length, quint32 line, quint32 column)
{
    new (m_data) QQmlJS::SourceLocation{ offset, length, line, column };
}
 
// explicitly defaulted out-of-line for PIMPL
/*!
    Creates a copy of \a other.
 */
QQmlSA::SourceLocation::SourceLocation(const SourceLocation &other) = default;
 
/*!
    \fn SourceLocation::SourceLocation(SourceLocation &&other) noexcept
    Move-Constructs a SourceLocation from \a other.
 */
 
/*!
    Assigns \a other to this SourceLocation.
 */
QQmlSA::SourceLocation & QQmlSA::SourceLocation::operator=(const QQmlSA::SourceLocation &other) = default;
 
/*!
    \fn SourceLocation &SourceLocation::operator=(SourceLocation &&other) noexcept
    Move-assigns \a other to this SourceLocation.
 */
 
/*!
    Destructs this SourceLocation instance.
 */
SourceLocation::~SourceLocation() = default;
 
/*!
    Returns \c true is this SourceLocation is valid, \c false otherwise.
 */
bool QQmlSA::SourceLocation::isValid() const
{
    return QQmlSA::SourceLocationPrivate::sourceLocation(*this).isValid();
}
 
/*!
    Returns the offset of the beginning of this source location.
 */
quint32 QQmlSA::SourceLocation::begin() const
{
    return offset();
}
 
/*!
    Returns the offset of the end of this source location.
 */
quint32 QQmlSA::SourceLocation::end() const
{
    return offset() + length();
}
 
/*!
    Returns the offset of the beginning of this source location.
 */
quint32 QQmlSA::SourceLocation::offset() const
{
    return QQmlSA::SourceLocationPrivate::sourceLocation(*this).offset;
}
 
/*!
    Returns the length of this source location.
 */
quint32 QQmlSA::SourceLocation::length() const
{
    return QQmlSA::SourceLocationPrivate::sourceLocation(*this).length;
}
 
/*!
    Returns the line number containing the beginning of this source location.
 */
quint32 QQmlSA::SourceLocation::startLine() const
{
    return QQmlSA::SourceLocationPrivate::sourceLocation(*this).startLine;
}
 
/*!
    Returns the column number containing the beginning of this source location.
 */
quint32 QQmlSA::SourceLocation::startColumn() const
{
    return QQmlSA::SourceLocationPrivate::sourceLocation(*this).startColumn;
}
 
/*!
    Returns a source location of lenth zero pointing to the beginning of this
    source location.
 */
QQmlSA::SourceLocation QQmlSA::SourceLocation::startZeroLengthLocation() const
{
    QQmlSA::SourceLocation saLocation;
    auto &wrappedLocation = reinterpret_cast<QQmlJS::SourceLocation &>(saLocation.m_data);
    wrappedLocation =
            QQmlSA::SourceLocationPrivate::sourceLocation(*this).startZeroLengthLocation();
 
    return saLocation;
}
 
/*!
    Returns a source location of lenth zero pointing to the end of this source
    location pointing to \a text.
 */
QQmlSA::SourceLocation QQmlSA::SourceLocation::endZeroLengthLocation(QStringView text) const
{
    QQmlSA::SourceLocation saLocation;
    auto &wrappedLocation = reinterpret_cast<QQmlJS::SourceLocation &>(saLocation.m_data);
    wrappedLocation = wrappedLocation.endZeroLengthLocation(text);
 
    return saLocation;
}
 
/*!
    \fn friend qsizetype SourceLocation::qHash(const SourceLocation &location, qsizetype seed)
    Returns the hash value for \a location, using \a seed to seed the calculation.
 */
 
/*!
    \fn friend bool SourceLocation::operator==(const SourceLocation &lhs, const SourceLocation &rhs)
    Returns true if \a lhs equals \a rhs, and \c false otherwise.
    Two SourceLocations are considered equal if they have the same values for
    their offset, length, line, and column members.
 */
/*!
    \fn friend bool SourceLocation::operator!=(const SourceLocation &lhs, const SourceLocation &rhs)
    Returns true if \a lhs does not equal \a rhs, and \c false otherwise.
    See \l {SourceLocation::operator==} for when two source locations are considered equal.
 */
 
qsizetype QQmlSA::SourceLocation::qHashImpl(const SourceLocation &location, qsizetype seed)
{
    return qHash(QQmlSA::SourceLocationPrivate::sourceLocation(location), seed);
}
 
bool QQmlSA::SourceLocation::operatorEqualsImpl(const SourceLocation &lhs,
                                                const SourceLocation &rhs)
{
    return QQmlSA::SourceLocationPrivate::sourceLocation(lhs)
            == QQmlSA::SourceLocationPrivate::sourceLocation(rhs);
}
 
/*!
    Returns the source location of the origin of any QML document.
 */
SourceLocation SourceLocation::documentOrigin()
{
    return QQmlSA::SourceLocationPrivate::createQQmlSASourceLocation(QQmlJS::s_documentOrigin);
}
 
} // namespace QQmlSA
 
QT_END_NAMESPACE