/****************************************************************************
**
** Copyright (C) 2021 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:COMM$
**
** 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.
**
** $QT_END_LICENSE$
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
****************************************************************************/

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.

#ifndef Patternist_ComparesCaseAware_H
#define Patternist_ComparesCaseAware_H

#include <private/qfunctioncall_p.h>

QT_BEGIN_NAMESPACE

namespace QPatternist
{
    /**
     * @short Base-class for functions that compares strings and provides
     * an opportunity to optimize compares intended to be case insensitive.
     *
     * @ingroup Patternist_functions
     * @author Frans Englich <frans.englich@nokia.com>
     */
    class ComparesCaseAware : public FunctionCall
    {
    public:
        /**
         * Performs initialization.
         */
        ComparesCaseAware();

        virtual Expression::Ptr compress(const StaticContext::Ptr &context);

        /**
         * Tells whether the return value of the two operands must be compared
         * case insensitively or not.
         */
        inline Qt::CaseSensitivity caseSensitivity() const
        {
            return m_caseSensitivity;
        }

    private:
        Qt::CaseSensitivity m_caseSensitivity;
    };
}

QT_END_NAMESPACE

#endif