/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */

/*

 * This file is part of the LibreOffice project.

 *

 * This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/.

 *

 * This file incorporates work covered by the following license notice:

 *

 *   Licensed to the Apache Software Foundation (ASF) under one or more

 *   contributor license agreements. See the NOTICE file distributed

 *   with this work for additional information regarding copyright

 *   ownership. The ASF licenses this file to you under the Apache

 *   License, Version 2.0 (the "License"); you may not use this file

 *   except in compliance with the License. You may obtain a copy of

 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .

 */

#ifndef INCLUDED_CONNECTIVITY_IPARSECONTEXT_HXX

#define INCLUDED_CONNECTIVITY_IPARSECONTEXT_HXX

#include <rtl/ustring.hxx>

namespace com::sun::star::lang { struct Locale; }

namespace connectivity

{

    //= IParseContext

    class IParseContext

    {

    public:

        enum class ErrorCode

        {

            General,                // "Syntax error in SQL expression"

            ValueNoLike,            // "The value #1 can not be used with LIKE."

            FieldNoLike,            // "LIKE can not be used with this field."

            InvalidCompare,         // "The entered criterion can not be compared with this field."

            InvalidIntCompare,      // "The field can not be compared with a number."

            InvalidDateCompare,     // "The field can not be compared with a date."

            InvalidRealCompare,     // "The field can not be compared with a floating point number."

            InvalidTableNosuch,     // "The database does not contain a table named \"#\"."

                                            // Named like this to avoid conflict with a #define in the Windows system ODBC headers.

            InvalidTableOrQuery,     // "The database does contain neither a table nor a query named \"#\"."

            InvalidColumn,           // "The column \"#1\" is unknown in the table \"#2\"."

            InvalidTableExist,       // "The database already contains a table or view with name \"#\"."

            InvalidQueryExist        // "The database already contains a query with name \"#\".";

        };

        enum class InternationalKeyCode

        {

            None = 0,

            Like,

            Not,

            Null,

            True,

            False,

            Is,

            Between,

            Or,

            And,

            Avg,

            Count,

            Max,

            Min,

            Sum,

            Every,

            Any,

            Some,

            StdDevPop,

            StdDevSamp,

            VarSamp,

            VarPop,

            Collect,

            Fusion,

            Intersection

        };

    public:

        // retrieves language specific error messages

        virtual OUString getErrorMessage(ErrorCode _eCodes) const = 0;

        // retrieves language specific keyword strings (only ASCII allowed)

        virtual OString getIntlKeywordAscii(InternationalKeyCode _eKey) const = 0;

        // finds out, if we have an international keyword (only ASCII allowed)

        virtual InternationalKeyCode getIntlKeyCode(const OString& rToken) const = 0;

        /** gets a locale instance which should be used when parsing in the context specified by this instance

            <p>if this is not overridden by derived classes, it returns the static default locale.</p>

        */

        virtual css::lang::Locale getPreferredLocale( ) const = 0;

    protected:

        ~IParseContext() {}

    };

}

#endif // INCLUDED_CONNECTIVITY_IPARSECONTEXT_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */