kDateTime.h

//This header is deprecated and will be removed in an upcoming release. 
//Please replace the use of any functions defined in this header with 
//the recommended replacements (see comments, below).
#ifndef K_FIRESYNC_DATE_TIME_H
#define K_FIRESYNC_DATE_TIME_H

#include <kApi/Utils/kDateTime.h>
#include <kFireSync/Utils/kTimeSpan.h>

/* 
* Deprecated (Stage 1): not recommended for further use, but not yet announced via kDeprecate
*/

//[Deprecated] Replace with kDateTime static cast
kInlineFx(kDateTime) kDateTime_FromTicks(k64s ticks)
{
    return ticks;
} 

//[Deprecated] Replace with k64s static cast
kInlineFx(k64s) kDateTime_Ticks(kDateTime dateTime)
{
    return dateTime;
}

//[Deprecated] Replace with kDateTime_Now
kInlineFx(kDateTime) kDateTime_NowUtc()
{
    return kDateTime_Now();
}

//[Deprecated] Use kDateTime_LocalParts instead
kInlineFx(k32s) kDateTime_Year(kDateTime dateTime)
{
    k32s value = 0;

    kDateTime_LocalParts(dateTime, &value, kNULL, kNULL, kNULL, kNULL, kNULL, kNULL, kNULL, kNULL);

    return value; 
}

//[Deprecated] Use kDateTime_LocalParts instead
kInlineFx(k32s) kDateTime_Month(kDateTime dateTime)
{
    k32s value = 0;

    kDateTime_LocalParts(dateTime, kNULL, &value, kNULL, kNULL, kNULL, kNULL, kNULL, kNULL, kNULL);

    return value; 
}

//[Deprecated] Use kDateTime_LocalParts instead
kInlineFx(k32s) kDateTime_Day(kDateTime dateTime)
{
    k32s value = 0;

    kDateTime_LocalParts(dateTime, kNULL, kNULL, &value, kNULL, kNULL, kNULL, kNULL, kNULL, kNULL);

    return value; 
}

//[Deprecated] Use kDateTime_LocalParts instead
kInlineFx(k32s) kDateTime_Hour(kDateTime dateTime)
{
    k32s value = 0;

    kDateTime_LocalParts(dateTime, kNULL, kNULL, kNULL, kNULL, &value, kNULL, kNULL, kNULL, kNULL);

    return value; 
}

//[Deprecated] Use kDateTime_LocalParts instead
kInlineFx(k32s) kDateTime_Minute(kDateTime dateTime)
{
    k32s value = 0;

    kDateTime_LocalParts(dateTime, kNULL, kNULL, kNULL, kNULL, kNULL, &value, kNULL, kNULL, kNULL);

    return value; 
}

//[Deprecated] Use kDateTime_LocalParts instead
kInlineFx(k32s) kDateTime_Second(kDateTime dateTime)
{
    k32s value = 0;

    kDateTime_LocalParts(dateTime, kNULL, kNULL, kNULL, kNULL, kNULL, kNULL, &value, kNULL, kNULL);

    return value; 
}

//[Deprecated] Use kDateTime_LocalParts instead
kInlineFx(k32s) kDateTime_Millisecond(kDateTime dateTime)
{
    k32s value = 0;

    kDateTime_LocalParts(dateTime, kNULL, kNULL, kNULL, kNULL, kNULL, kNULL, kNULL, &value, kNULL);

    return value/1000; 
}

//[Deprecated] Replace with noop
kInlineFx(kDateTime) kDateTime_UtcToLocal(kDateTime utc)
{
    return utc;
}

//[Deprecated] Replace with noop
kInlineFx(kDateTime) kDateTime_LocalToUtc(kDateTime local)
{
    return local;
}

//[Deprecated] Use kDateTime_FromLocalParts instead
kInlineFx(kDateTime) kDateTime_FromParts(k32s year, k32s month, k32s day, k32s hour, k32s minute, k32s second, k32s millisecond)
{
    kDateTime value = 0;
    
    kDateTime_FromLocalParts(&value, year, month, day, hour, minute, second, 1000*millisecond, k32S_NULL);
    
    return value;
}

//[Deprecated] Use kDateTime_LocalParts instead
kInlineFx(kStatus) kDateTime_Parts(kDateTime dateTime, k32s* year, k32s* month, k32s* day, k32s* hour, k32s* minute, k32s* second, k32s* millisecond)
{   
    kCheck(kDateTime_LocalParts(dateTime, year, month, day, kNULL, hour, minute, second, millisecond, kNULL));
    
    if (!kIsNull(millisecond))
    {
        *millisecond /= 1000;
    }
    
    return kOK;
}

//[Deprecated] Replace with integer addition
kInlineFx(kDateTime) kDateTime_Add(kDateTime dateTime, kTimeSpan span)
{
    return dateTime + span;
}

//[Deprecated] Replace with integer subtraction
kInlineFx(kTimeSpan) kDateTime_Subtract(kDateTime a, kDateTime b)
{
    return a - b;
}

//[Deprecated] Replace with integer comparisons
kInlineFx(k32s) kDateTime_Compare(kDateTime a, kDateTime b)
{
    return ((a - b) > 0) ? 1 : (((a - b) < 0) ? 1 : 0);
}

#endif