interval.h

/*
    SPDX-FileCopyrightText: 2020 Volker Krause <vkrause@kde.org>
 
    SPDX-License-Identifier: LGPL-2.0-or-later
*/
 
#ifndef KOPENINGHOURS_INTERVAL_H
#define KOPENINGHOURS_INTERVAL_H
 
#include "kopeninghours_export.h"
 
#include <QDateTime>
#include <QDebug>
#include <QExplicitlySharedDataPointer>
#include <QMetaType>
 
class QDateTime;
 
namespace KOpeningHours {
 
class IntervalPrivate;
 
/** A time interval for which an opening hours expression has been evaluated. */
class KOPENINGHOURS_EXPORT Interval
{
    Q_GADGET
    Q_PROPERTY(State state READ state)
    Q_PROPERTY(QDateTime begin READ begin)
    Q_PROPERTY(bool hasOpenBegin READ hasOpenBegin)
    Q_PROPERTY(QDateTime end READ end)
    Q_PROPERTY(bool hasOpenEnd READ hasOpenEnd)
    Q_PROPERTY(bool hasOpenEndTime READ hasOpenEndTime)
    Q_PROPERTY(QString comment READ comment)
    Q_PROPERTY(QDateTime estimatedEnd READ estimatedEnd)
    Q_PROPERTY(int dstOffset READ dstOffset)
public:
    Interval();
    Interval(const Interval&);
    Interval(Interval&&);
    ~Interval();
    Interval& operator=(const Interval&);
    Interval& operator=(Interval&&);
 
    /** Check whether this interval starts before @p other. */
    bool operator<(const Interval &other) const;
 
    /** Default constructed empty/invalid interval. */
    bool isValid() const;
 
    /** Checks whether this interval overlaps with @p other. */
    bool intersects(const Interval &other) const;
 
    /** Begin of the interval.
     *  This is the first point in time included in the interval, or invalid if this is an interval with an open begin.
     */
    QDateTime begin() const;
    void setBegin(const QDateTime &begin);
 
    /** Returns @c true if this is an interval with an open begin, ie. starting at the beginning of time. */
    bool hasOpenBegin() const;
 
    /** End of the interval.
     *  This is the first point in time not included in the interval anymore, or invalid for open-ended intervals.
     *  That is, the end of an interval describing the year 2020 would be Jan 1st 2021 at midnight (00:00).
     */
    QDateTime end() const;
    void setEnd(const QDateTime &end);
 
    /** Returns @c true if this is an interval with an open end date, ie. continuing for all eternity.
     *  @note This is different from an interval with an open end time.
     */
    bool hasOpenEnd() const;
 
    /** Returns @c true if this is an interval with an open end time, ie. an interval generated by a selector like "20:00+".
     *  @note This is different from an interval with an open end.
     */
    bool hasOpenEndTime() const;
    void setOpenEndTime(bool openEndTime);
 
    /** Returns an estimated end time for intervals with an open end time.
     *  By default this is the same as end() would return, unless higher-level
     *  logic with a view on multiple intervals and/or other context actually sets this.
     */
    QDateTime estimatedEnd() const;
    void setEstimatedEnd(const QDateTime &estimatedEnd);
 
    /** Returns the UTC offset change between estimatedEnd() and begin().
     *  This is 0, unless there is a DST transition happening in that interval.
     *  @since 23.04.0
     */
    int dstOffset() const;
 
    /** Check if this interval contains @p dt. */
    bool contains(const QDateTime &dt) const;
 
    /** Opening state during a time interval */
    enum State {
        Invalid,
        Open,
        Closed,
        Unknown
    };
    Q_ENUM(State)
 
    /** The opening state for this time interval. */
    State state() const;
    void setState(State state);
 
    /** Comment. */
    QString comment() const;
    void setComment(const QString &comment);
 
private:
    QExplicitlySharedDataPointer<IntervalPrivate> d;
};
 
}
 
Q_DECLARE_METATYPE(KOpeningHours::Interval)
 
KOPENINGHOURS_EXPORT QDebug operator<<(QDebug debug, const KOpeningHours::Interval &interval);
 
#endif // KOPENINGHOURS_INTERVAL_H