ttktime.h

Go to the documentation of this file.

#ifndef TTKTIME_H
#define TTKTIME_H

/***************************************************************************
 * This file is part of the TTK Library Module project
 * Copyright (C) 2015 - 2025 Greedysky Studio

 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.

 * You should have received a copy of the GNU Lesser General Public License along
 * with this program; If not, see <http://www.gnu.org/licenses/>.
 ***************************************************************************/

#include <QDataStream>
#include "ttkmoduleexport.h"

class TTK_MODULE_EXPORT TTKTime
{
    TTK_DECLARE_MODULE(TTKTime)
public:
    TTKTime() noexcept;
    TTKTime(qint64 value) noexcept;
    TTKTime(int day, int hour, int min, int sec, int msec) noexcept;
    TTKTime(const TTKTime &other) noexcept;
    TTKTime(TTKTime &&other) noexcept;

    bool isNull() const noexcept;
    bool isValid() const noexcept;

    inline void setDay(int day) noexcept { m_day = day; }
    inline void setHour(int hour) noexcept { m_hour = hour; }
    inline void setMinute(int min) noexcept { m_minute = min; }
    inline void setSecond(int sec) noexcept { m_second = sec; }
    inline void setMillionSecond(int msec) noexcept { m_msecond = msec; }

    inline int day() const noexcept { return m_day; }
    inline int hour() const noexcept { return m_hour; }
    inline int minute() const noexcept { return m_minute; }
    inline int second() const noexcept { return m_second; }
    inline int millionSecond() const noexcept { return m_msecond; }

    static TTKTime fromString(const QString &time, const QString &format) noexcept;
    static QString toString(qint64 time, const QString &format) noexcept;

    QString toString(const QString &format) const noexcept;
//    h the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display)
//    hh        the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display)
//    H the hour without a leading zero (0 to 23, even with AM/PM display)
//    HH        the hour with a leading zero (00 to 23, even with AM/PM display)
//    m the minute without a leading zero (0 to 59)
//    mm        the minute with a leading zero (00 to 59)
//    s the second without a leading zero (0 to 59)
//    ss        the second with a leading zero (00 to 59)
//    z the milliseconds without leading zeroes (0 to 999)
//    zzz       the milliseconds with leading zeroes (000 to 999)
//    AP or A   use AM/PM display. A/AP will be replaced by either "AM" or "PM".
//    ap or a   use am/pm display. a/ap will be replaced by either "am" or "pm".
//    t the timezone (for example "CEST")

    void fromValue(int day, int hour, int min, int sec, int msec = 0) noexcept;
    void fromValue(qint64 value) noexcept;
    qint64 toValue() const noexcept;

    static qint64 formatDuration(const QString &time) noexcept;
    static QString formatDuration(qint64 time) noexcept;

    TTKTime& operator = (const TTKTime &other) noexcept;
    TTKTime& operator = (TTKTime &&other) noexcept;
    TTKTime& operator+= (const TTKTime &other) noexcept;
    TTKTime& operator+= (const int other) noexcept;
    TTKTime& operator-= (const TTKTime &other) noexcept;
    TTKTime& operator-= (const int other) noexcept;
    TTKTime& operator*= (const int other) noexcept;
    TTKTime& operator/= (const int other) noexcept;

    TTKTime  operator+ (const TTKTime &other) noexcept;
    TTKTime  operator+ (const int other) noexcept;
    TTKTime  operator- (const TTKTime &other) noexcept;
    TTKTime  operator- (const int other) noexcept;
    TTKTime  operator* (const int other) noexcept;
    TTKTime  operator/ (const int other) noexcept;

    bool operator== (const TTKTime &other) const noexcept;
    bool operator!= (const TTKTime &other) const noexcept;

    inline friend QDataStream& operator<<(QDataStream &stream, const TTKTime &other) noexcept
    {
        stream << other.day() << TTK_SPACE << other.hour() << TTK_SPACE << other.minute() << TTK_SPACE
               << other.second() << TTK_SPACE << other.millionSecond();
        return stream;
    }

    inline friend QDataStream& operator>>(QDataStream &stream, TTKTime &other) noexcept
    {
        int x[5];
        stream >> x[0] >> x[1] >> x[2] >> x[3] >> x[4];
        other.fromValue(x[0], x[1], x[2], x[3], x[4]);
        return stream;
    }

private:
    void initialize() noexcept;
    void copyToThis(const TTKTime &other) noexcept;

    int m_day, m_hour;
    int m_minute, m_second, m_msecond;

};


class TTK_MODULE_EXPORT TTKDateTime
{
public:
    static qint64 currentTimestamp() noexcept;
    static QString format(const QString &time, const QString &format);
    static QString format(qint64 time, const QString &format);

};


namespace TTK
{
    TTK_MODULE_EXPORT void initRandom();
    TTK_MODULE_EXPORT int random(int value = RAND_MAX);

}

#endif // TTKTIME_H