/* -*- 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 .

 */

#pragma once

#include <connectivity/dbtoolsdllapi.hxx>

#include <rtl/ustring.hxx>

namespace com::sun::star::uno { class Any; }

namespace com::sun::star::uno { template <typename > class Reference; }

namespace com::sun::star::util { struct Date; }

namespace com::sun::star

{

    namespace lang

    {

        struct Locale;

    }

    namespace sdb

    {

        class XColumn;

        class XColumnUpdate;

    }

    namespace beans

    {

        class XPropertySet;

    }

    namespace util

    {

        class XNumberFormatter;

        class XNumberFormatsSupplier;

        struct Time;

        struct DateTime;

    }

    namespace script

    {

        class XTypeConverter;

    }

    namespace sdbc

    {

        class XConnection;

    }

}

namespace dbtools::DBTypeConversion

{

        OOO_DLLPUBLIC_DBTOOLS css::util::Date const & getStandardDate();

        /// @throws css::lang::IllegalArgumentException

        OOO_DLLPUBLIC_DBTOOLS void setValue(const css::uno::Reference< css::sdb::XColumnUpdate>& xVariant,

                                    const css::uno::Reference< css::util::XNumberFormatter>& xFormatter,

                                    const css::util::Date& rNullDate,

                                    const OUString& rString,

                                    sal_Int32 nKey,

                                    sal_Int16 nFieldType,

                                    sal_Int16 nKeyType);

        /// @throws css::lang::IllegalArgumentException

        OOO_DLLPUBLIC_DBTOOLS void setValue(const css::uno::Reference< css::sdb::XColumnUpdate>& xVariant,

                             const css::util::Date& rNullDate,

                             const double& rValue,

                             sal_Int16 nKeyType);

        OOO_DLLPUBLIC_DBTOOLS double getValue( const css::uno::Reference< css::sdb::XColumn>& xVariant, const css::util::Date& rNullDate );

        // get the columnvalue as string with a default format given by the column or a default format

        // for the type

        OOO_DLLPUBLIC_DBTOOLS OUString getFormattedValue(

                                        const css::uno::Reference< css::beans::XPropertySet>& _xColumn,

                                        const css::uno::Reference< css::util::XNumberFormatter>& xFormatter,

                                        const css::lang::Locale& _rLocale,

                                        const css::util::Date& rNullDate);

        OOO_DLLPUBLIC_DBTOOLS OUString getFormattedValue(

                                        const css::uno::Reference< css::sdb::XColumn>& _xColumn,

                                        const css::uno::Reference< css::util::XNumberFormatter>& xFormatter,

                                        const css::util::Date& rNullDate,

                                        sal_Int32 nKey,

                                        sal_Int16 nKeyType);

        OOO_DLLPUBLIC_DBTOOLS css::util::Date     toDate(double dVal, const css::util::Date& _rNullDate = getStandardDate());

        OOO_DLLPUBLIC_DBTOOLS css::util::Date     toDate(std::u16string_view _sSQLDate);

        OOO_DLLPUBLIC_DBTOOLS css::util::Time     toTime(double dVal, short nDigits = 9);

        OOO_DLLPUBLIC_DBTOOLS css::util::Time     toTime(std::u16string_view _sSQLDate);

        OOO_DLLPUBLIC_DBTOOLS css::util::DateTime toDateTime(double dVal, const css::util::Date& _rNullDate = getStandardDate());

        OOO_DLLPUBLIC_DBTOOLS css::util::DateTime toDateTime(const OUString& _sSQLDate);

        OOO_DLLPUBLIC_DBTOOLS sal_Int64 getNsFromTime(const css::util::Time& rVal);

        OOO_DLLPUBLIC_DBTOOLS sal_Int32 toDays(const css::util::Date& _rVal, const css::util::Date& _rNullDate = getStandardDate());

        OOO_DLLPUBLIC_DBTOOLS double   toDouble(const css::util::Date& rVal, const css::util::Date& _rNullDate = getStandardDate());

        OOO_DLLPUBLIC_DBTOOLS double   toDouble(const css::util::Time& rVal);

        OOO_DLLPUBLIC_DBTOOLS double   toDouble(const css::util::DateTime& rVal, const css::util::Date& _rNullDate = getStandardDate());

        OOO_DLLPUBLIC_DBTOOLS css::util::Date toDate(sal_Int32 _nVal);

        OOO_DLLPUBLIC_DBTOOLS css::util::Time toTime(sal_Int64 _nVal);

        /** convert a double which is a date value relative to the standard db null date into a date value relative

            to a given fixed date.

        */

        inline double toNullDate(const css::util::Date& _rNullDate, double _rVal) { return _rVal - toDays(_rNullDate); }

        // return the date from the numberformatsupplier or the STANDARD_DATE (1899,12,30)

        OOO_DLLPUBLIC_DBTOOLS css::util::Date getNULLDate(const css::uno::Reference< css::util::XNumberFormatsSupplier > &xSupplier);

        // return the date in the format %04d-%02d-%02d

        OOO_DLLPUBLIC_DBTOOLS OUString toDateString(const css::util::Date& rDate);

        // return the time in the format %02d:%02d:%02d

        OOO_DLLPUBLIC_DBTOOLS OUString toTimeStringS(const css::util::Time& rTime);

        // return the time in the format %02d:%02d:%02d[.%d], the fraction (up to 9

        // digits, trailing zeros trimmed) being omitted entirely when there is none.

        // The value's full precision is kept - callers that build a SQL literal for a

        // backend which cannot parse that many fractional digits must round the value

        // first, see roundTimeFraction() below (the trailing-zero trim here is what

        // makes such a rounded value actually render with fewer digits, rather than

        // the same digit count with zeros in the low positions).

        OOO_DLLPUBLIC_DBTOOLS OUString toTimeString(const css::util::Time& rTime);

        // return the DateTime in the format %04d-%02d-%02d, plus the time part as toTimeString() above

        OOO_DLLPUBLIC_DBTOOLS OUString toDateTimeString(const css::util::DateTime& _rDateTime);

        /** rounds rTime's fractional seconds to at most nMaxFractionDigits digits

            (nearest 10^(9-nMaxFractionDigits) nanoseconds), carrying into

            seconds/minutes/hours as needed. A value of 9 (or higher, or negative) is

            treated as "no cap" and leaves rTime untouched.

            Some backends (e.g. Firebird, whose native TIME/TIMESTAMP precision is

            1/10000s) reject a literal carrying more fractional digits than that

            (tdf#153057) - see dbtools::DatabaseMetaData::getMaxDateTimeLiteralFractionDigits()

            for the driver-aware digit count to pass in. This is deliberately *not*

            done inside toTimeString()/toDateTimeString(), which several drivers use to

            render a value for parameter binding rather than to build a literal (e.g.

            PostgreSQL's setTime()/setTimestamp(), which support microsecond precision)

            - only code generating a SQL literal should opt in.

            @return whether the rounding carried past 23:59:59 into the next day. A bare

                    Time has no date to absorb that, so its Hours wrap to 0; use

                    roundDateTimeFraction() when a date is available. [[nodiscard]] because

                    silently dropping this return is exactly how the day-carry regression

                    this function was introduced to fix would resurface - a caller with a

                    genuine Date in scope (as opposed to a bare Time for a SQL TIME value,

                    which has nothing to advance) must check it.

        */

        [[nodiscard]] OOO_DLLPUBLIC_DBTOOLS bool roundTimeFraction(css::util::Time& rTime, sal_Int32 nMaxFractionDigits);

        /** as roundTimeFraction(), but advances rDateTime's date part by a day if the

            rounding carries past 23:59:59.

        */

        OOO_DLLPUBLIC_DBTOOLS void roundDateTimeFraction(css::util::DateTime& rDateTime, sal_Int32 nMaxFractionDigits);

        // return the any in an sql standard format, capping any fractional-seconds

        // digits to what _rxConnection's driver declares it can parse in a literal

        // (see dbtools::DatabaseMetaData::getMaxDateTimeLiteralFractionDigits())

        OOO_DLLPUBLIC_DBTOOLS OUString toSQLString(sal_Int32 eType, const css::uno::Any& _rVal,

            const css::uno::Reference< css::script::XTypeConverter >&  _rxTypeConverter,

            const css::uno::Reference< css::sdbc::XConnection >& _rxConnection);

        /** converts a Unicode string into a 8-bit string, using the given encoding

            @param _rSource

                the source string to convert

            @param _rDest

                the destination string

            @param _eEncoding

                the encoding to use for the conversion

            @throws css::sdbc::SQLException

                if the given string contains characters which are not convertible using the given encoding

                The SQLState of the exception will be set to 22018 ("Invalid character value for cast specification")

            @return

                the length of the converted string

        */

        OOO_DLLPUBLIC_DBTOOLS sal_Int32 convertUnicodeString(

            const OUString& _rSource,

            OString&  _rDest,

            rtl_TextEncoding _eEncoding

        );

        /** converts a Unicode string into a 8-bit string, using the given encoding

            @param _rSource

                the source string to convert

            @param _rDest

                the destination string

            @param _nMaxLen

                the maximum length of the destination string

            @param _eEncoding

                the encoding to use for the conversion

            @throws css::sdbc::SQLException

                if convertUnicodeString, which is called internally, throws such an exception

            @throws css::sdbc::SQLException

                if the conversion results in a string which is longer than _nMaxLen

            @return

                the length of the converted string

        */

        OOO_DLLPUBLIC_DBTOOLS sal_Int32 convertUnicodeStringToLength(

            const OUString& _rSource,

            OString&  _rDest,

            sal_Int32 _nMaxLen,

            rtl_TextEncoding _eEncoding

       );

} // namespace dbtools::DBTypeConversion

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