ZonedExtra.h

/*
 * MIT License
 * Copyright (c) 2023 Brian T. Park
 */
 
#ifndef ACE_TIME_ZONED_EXTRA_H
#define ACE_TIME_ZONED_EXTRA_H
 
#include <string.h> // strncpy()
#include <stdint.h>
#include "common/common.h" // acetime_t, kAbbrevSize
#include "TimeOffset.h"
 
namespace ace_time {
 
class TimeZone;
class LocalDateTime;
 
class ZonedExtra {
  public:
    static const uint8_t kAbbrevSize = ace_time::kAbbrevSize;
 
    static const uint8_t kTypeNotFound = 0;
 
    static const uint8_t kTypeExact = 1;
 
    static const uint8_t kTypeGap = 2;
 
    static const uint8_t kTypeOverlap = 3;
 
    static ZonedExtra forError() {
      return ZonedExtra();
    }
 
    static ZonedExtra forComponents(
        int16_t year, uint8_t month, uint8_t day,
        uint8_t hour, uint8_t minute, uint8_t second,
        const TimeZone& tz, uint8_t fold = 0);
 
    static ZonedExtra forEpochSeconds(
        acetime_t epochSeconds,
        const TimeZone& tz);
 
    static ZonedExtra forLocalDateTime(
        const LocalDateTime& ldt,
        const TimeZone& tz);
 
    explicit ZonedExtra() {}
 
    explicit ZonedExtra(
        uint8_t type,
        int32_t stdOffsetSeconds,
        int32_t dstOffsetSeconds,
        int32_t reqStdOffsetSeconds,
        int32_t reqDstOffsetSeconds,
        const char* abbrev)
      : mStdOffsetSeconds(stdOffsetSeconds)
      , mDstOffsetSeconds(dstOffsetSeconds)
      , mReqStdOffsetSeconds(reqStdOffsetSeconds)
      , mReqDstOffsetSeconds(reqDstOffsetSeconds)
      , mType(type)
    {
      strncpy(mAbbrev, abbrev, kAbbrevSize - 1);
      mAbbrev[kAbbrevSize - 1] = '\0';
    }
 
    bool isError() const {
      return mStdOffsetSeconds == kInvalidSeconds;
    }
 
    uint8_t type() const { return mType; }
 
    TimeOffset stdOffset() const {
      return TimeOffset::forSeconds(mStdOffsetSeconds);
    }
 
    TimeOffset dstOffset() const {
      return TimeOffset::forSeconds(mDstOffsetSeconds);
    }
 
    TimeOffset timeOffset() const {
      return TimeOffset::forSeconds(mStdOffsetSeconds + mDstOffsetSeconds);
    }
 
    TimeOffset reqStdOffset() const {
      return TimeOffset::forSeconds(mReqStdOffsetSeconds);
    }
 
    TimeOffset reqDstOffset() const {
      return TimeOffset::forSeconds(mReqDstOffsetSeconds);
    }
 
    TimeOffset reqTimeOffset() const {
      return TimeOffset::forSeconds(
          mReqStdOffsetSeconds + mReqDstOffsetSeconds);
    }
 
    const char* abbrev() const { return mAbbrev; }
 
  private:
    static const int32_t kInvalidSeconds = INT32_MIN;
 
    int32_t mStdOffsetSeconds = kInvalidSeconds;
    int32_t mDstOffsetSeconds = kInvalidSeconds;
    int32_t mReqStdOffsetSeconds = kInvalidSeconds;
    int32_t mReqDstOffsetSeconds = kInvalidSeconds;
    uint8_t mType = kTypeNotFound;
    char mAbbrev[kAbbrevSize] = "";
};
 
}
 
#endif