"

 COPYRIGHT (c) 1989 by Claus Gittinger

              All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

"{ Package: 'stx:libbasic' }"

AbstractTime subclass:#Timestamp

	instanceVariableNames:'osTime'

	classVariableNames:''

	poolDictionaries:''

	category:'Magnitude-Time'

!

Object subclass:#TimestampBuilderAbstract

	instanceVariableNames:'year month day hour minute second millisecond isUtcTime'

	classVariableNames:''

	poolDictionaries:''

	privateIn:Timestamp

!

Timestamp::TimestampBuilderAbstract subclass:#TimestampISO8601Builder

	instanceVariableNames:'stream'

	classVariableNames:''

	poolDictionaries:''

	privateIn:Timestamp

!

!Timestamp class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1989 by Claus Gittinger

              All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

!

documentation

"

    This class represents time values in milliSeconds starting some

    time in the past. When printing an accessing values like #hour, the timestamp will be

    interpreted in the local timezone.

    (The internal representation, osTime, will typically start with 1970-01-01 0:00, 

     as used in the Unix operating system, but other systems may bias the time differently.

     Actually, the implementation does not depend or even know which time/date 

     the OperatingSystem bases its time upon - it is simply keeping the value(s)

     as returned from the OS.

     For conversion, these values are given back to the OS, which will know

     how to convert these times. This has the advantage, that timestamps on files 

     (such as last-access-time or last-modification-time) can be handled transparently - 

     especially when performing comparisons).

    You should not interpret the osTime instance variable directly, instead

    (if at all), ask the OS to convert.

    The implementation of this class is not the same as in ST-80 

    (which represents the time as seconds from Jan 1., 1901).

    This class should not be confused with Time (which only represents the

    time within one day). Time instances cannot be used to compare times across midnight; 

    instances of Timestamp can.

    Notice: this class was once called AbsoluteTime. Einstein told us in 1905, that talking

    about a absolute time is not a good idea (at least in our universe). So the class

    has been renamed to Timestamp which makes us more compatible to other ST dialects (e.g. VW)

    AbsoluteTime is still kept as an alias for backward compatibility.

    [author:]

        Claus Gittinger

    [See also:]

        UtcTimestamp Time Date

        Delay ProcessorScheduler

"

! !

!Timestamp class methodsFor:'initialization'!

initialize

    AbsoluteTime := self.       "backward compatibility"

! !

!Timestamp class methodsFor:'instance creation'!

UTCYear:y month:m day:d hour:h minute:min second:s millisecond:millis

    "return an instance of the receiver, given individual components,

     interpreted in the UTC timezone."

    ^ self basicNew 

        fromOSTime:(OperatingSystem 

                        computeOSTimeFromUTCYear:y month:m day:d 

                                         hour:h minute:min second:s

                                         millisecond:millis)

    "

     Timestamp UTCYear:1970 month:1 day:1 hour:0 minute:0 second:0 millisecond:0

     Timestamp UTCYear:1991 month:1 day:2 hour:12 minute:30 second:0 millisecond:0

     Timestamp UTCYear:1991 month:1 day:2 hour:12 minute:30 second:0 millisecond:100

     Timestamp UTCYear:1999 month:7 day:1 hour:1 minute:0 second:0 millisecond:0

     Timestamp UTCYear:2000 month:1 day:1 hour:1 minute:0 second:0 millisecond:0

     UtcTimestamp UTCYear:2000 month:1 day:1 hour:1 minute:0 second:0 millisecond:0

    "

    "Modified: / 1.7.1996 / 15:22:07 / cg"

    "Created: / 13.7.1999 / 12:34:37 / stefan"

    "Modified: / 13.7.1999 / 12:42:30 / stefan"

!

decodeFromLiteralArray:anArray

    "decode an Timestamp literalArray.

     anArray may be:

        #(Timestamp '200004182000.123')

     or the deprecated old format, that is not portable between different architectures.

     We parse this for backward compatibility (will be eventually removed).

        #(Timestamp #osTime: 12345678)     

    "

    (anArray at:2) == #osTime: ifTrue:[

        ^ self new osTime:(anArray at:3).

    ].

    ^ self 

        readGeneralizedFrom:(anArray at:2) 

        onError:[ self conversionErrorSignal 

                    raiseErrorString:'literal array decoding' ]

    "

     Timestamp

        decodeFromLiteralArray:#(Timestamp '20050323175226.014')      

    "

!

fromDate:aDate andTime:aTime

    "return an instance of the receiver, initialized from a time and a date

     object.

     See also `Timestamp now' and other protocol inherited

     from my superclass."

    ^ self 

        year:aDate year 

        month:aDate month 

        day:aDate day 

        hour:aTime hours 

        minute:aTime minutes 

        second:aTime seconds 

        millisecond:0

    "

     Timestamp fromDate:(Date today) andTime:(Time now)  

     Timestamp fromDate:(Date today plusDays:1) andTime:(Time now) 

     Timestamp now 

    "

    "Modified: / 8.9.1995 / 15:07:30 / claus"

    "Modified: / 19.4.1996 / 15:25:46 / cg"

    "Modified: / 13.7.1999 / 12:30:47 / stefan"

!

newDay:dayInYear year:year

    "return a new Timestamp, given the year and the day-in-year (starting at 1).

     Date protocol compatibility"

    ^ (Date newDay:dayInYear year:year) asTimestamp

    "

     Timestamp newDay:183 year:1996

    "

    "Modified: 2.7.1996 / 09:39:30 / cg"

!

secondsSince1970:secs

    "set time from elapsed seconds since 1-1-1970, 0:0:0.

     This is the format used in the UNIX world"

    ^ self basicNew setSeconds:secs.

    "

     Timestamp secondsSince1970:0      

     Timestamp secondsSince1970:3600

     Timestamp secondsSince1970:3600*24

     (Timestamp year:2010 month:7 day:1 hour:0 minute:0 second:0)

       =

     (Timestamp secondsSince1970:1277935200)

    "

    "Created: / 21-10-1996 / 17:48:30 / stefan"

    "Modified: / 13-07-1999 / 12:31:22 / stefan"

    "Modified: / 08-01-2011 / 16:06:28 / cg"

!

utcMillisecondsSince1970:secs

    "set time from elapsed milliseconds since 1-1-1970, 0:0:0."

    ^ self basicNew setMilliseconds:secs

    "Created: / 08-01-2011 / 16:09:32 / cg"

!

utcNow

    ^ UtcTimestamp now

    "

        Timestamp now

        Timestamp utcNow

    "

!

utcSecondsSince1970:secs

    "set time from elapsed seconds since 1-1-1970, 0:0:0.

     This is the format used in the UNIX world"

    ^ self secondsSince1970:secs

"/    |divMod|

"/

"/    divMod := secs divMod:3600.

"/    ^ self year:1970 month:1 day:1 hour:(divMod at:1) minute:0 second:(divMod at:2) millisecond:0.

    "

     Timestamp secondsSince1970:0      

     Timestamp secondsSince1970:3600    

     Timestamp secondsSince1970:3600*24  

    "

    "Modified: / 13-07-1999 / 12:31:22 / stefan"

    "Created: / 08-01-2011 / 16:05:09 / cg"

!

year:y month:m day:d hour:h minute:min second:s

    "return an instance of the receiver, given individual components.

     See also `Timestamp now' and other protocol inherited

     from my superclass."

    ^ self year:y month:m day:d hour:h minute:min second:s millisecond:0

    "

     Timestamp year:1970 month:1 day:1 hour:1 minute:0 second:0 

     Timestamp year:1991 month:1 day:2 hour:12 minute:30 second:0 

     Timestamp year:1991 month:1 day:2 hour:12 minute:30 second:0 millisecond:100

     Timestamp year:2000 month:7 day:1 hour:1 minute:0 second:0 

    "

    "Modified: / 1.7.1996 / 15:22:07 / cg"

    "Created: / 13.7.1999 / 12:06:39 / stefan"

    "Modified: / 13.7.1999 / 12:27:47 / stefan"

!

year:y month:m day:d hour:h minute:min second:s millisecond:millis

    "return an instance of the receiver, given individual components.

     See also `Timestamp now' and other protocol inherited

     from my superclass."

    ^ self basicNew 

            year:y month:m day:d hour:h minute:min second:s millisecond:millis

    "

     Timestamp year:1970 month:1 day:1 hour:0 minute:0 second:0 

     Timestamp year:1991 month:1 day:2 hour:12 minute:30 second:0 

     Timestamp year:1991 month:1 day:2 hour:12 minute:30 second:0 millisecond:100

     Timestamp year:2000 month:7 day:1 hour:1 minute:0 second:0 

     UtcTimestamp year:2000 month:7 day:1 hour:1 minute:0 second:0 

    "

    "Modified: / 1.7.1996 / 15:22:07 / cg"

    "Created: / 13.7.1999 / 12:28:44 / stefan"

    "Modified: / 13.7.1999 / 12:37:57 / stefan"

! !

!Timestamp class methodsFor:'Compatibility-Squeak'!

current

    ^ self now

! !

!Timestamp class methodsFor:'obsolete'!

day:d month:m year:y hour:h minutes:min seconds:s

    <resource: #obsolete>

    "This is obsolete. User #year:month:day:hour:minute:second:"

    ^ self 

        year:y month:m day:d hour:h 

        minute:min second:s millisecond:0

    "Modified: / 1.7.1996 / 15:22:26 / cg"

    "Modified: / 13.7.1999 / 12:29:56 / stefan"

!

day:d month:m year:y hour:h minutes:min seconds:s milliseconds:millis

    <resource: #obsolete>

    "This is obsolete. User #year:month:day:hour:minute:second:millisecond:"

    ^ self year:y month:m day:d hour:h minute:min second:s millisecond:millis

    "

     Timestamp day:1 month:1 year:1970 hour:1 minute:0 second:0 

     Timestamp day:2 month:1 year:1991 hour:12 minute:30 second:0 

     Timestamp day:2 month:1 year:1991 hour:12 minute:30 second:0 millisecond:100

    "

    "Created: / 1.7.1996 / 14:46:09 / cg"

    "Modified: / 1.7.1996 / 15:22:07 / cg"

    "Modified: / 13.7.1999 / 12:30:26 / stefan"

! !

!Timestamp class methodsFor:'private'!

basicReadFrom:aStream

    "return a new Timestamp, reading a printed representation from aStream.

     The string is interpreted as 24 hour format, as printed.

     Notice, that this is not the storeString format and 

     is different from the format expected by readFrom:.

     KLUDGE: 

        us and non-us format have different ordering of day and month;

        The format read here is (non-us) dd-mm-yyyy hh:mm:ss.iii

        or (us-format, for Travis) mm/dd/yyyy hh:mm:ss.iii.

     On error, raise an exception"

    |firstNumber secondNumber day month year hour min sec millis usFormat possibeMonthName|

    firstNumber := Integer readFrom:aStream onError:[TimeConversionError raiseErrorString:' - integer expected'].

    firstNumber > 31 ifTrue:[

        "/ assume iso8601 format;

        ^ self readIso8601FormatFrom:aStream yearAlreadyRead:firstNumber.

    ].

    aStream skipSeparators.

    "/ consider this a kludge

    usFormat := (aStream peek == $/ ).

    [aStream peek isLetterOrDigit] whileFalse:[aStream next].

    aStream peek isDigit ifTrue:[

        secondNumber := Integer readFrom:aStream onError:-1.

        usFormat ifTrue:[

            month := firstNumber.

            day := secondNumber.

        ] ifFalse:[

            month := secondNumber.

            day := firstNumber.

        ].

    ] ifFalse:[

        possibeMonthName := aStream throughAnyForWhich:[:ch | ch isLetter].

        month := Date indexOfMonth:possibeMonthName asLowercase.

        day := firstNumber.

    ].

    (day between:1 and:31) ifFalse:[ TimeConversionError raiseErrorString:' - bad day' ].

    (month between:1 and:12) ifFalse:[ TimeConversionError raiseErrorString:' - bad month' ].

    [aStream peek isDigit] whileFalse:[aStream next].

    year := Integer readFrom:aStream onError:[ TimeConversionError raiseErrorString:' - bad year' ].

    aStream atEnd ifTrue:[

        hour := min := sec := millis := 0.

    ] ifFalse:[

        [aStream peek isDigit] whileFalse:[aStream next].

        hour := Integer readFrom:aStream onError:-1.

        (hour between:0 and:24) ifFalse:[ TimeConversionError raiseErrorString:' - bad hour' ].

        [aStream peek isDigit] whileFalse:[aStream next].

        min := Integer readFrom:aStream onError:-1.

        (min between:0 and:59) ifFalse:[ TimeConversionError raiseErrorString:' - bad minute' ].

        aStream atEnd ifTrue:[

            sec := millis := 0.

        ] ifFalse:[

            [aStream peek isDigit] whileFalse:[aStream next].

            sec := Integer readFrom:aStream onError:-1.

            (sec between:0 and:59) ifFalse:[ TimeConversionError raiseErrorString:' - bad second' ].

            aStream peek = $. ifTrue:[

                aStream next.

                millis := Integer readFrom:aStream onError:0.

                millis >= 1000 ifTrue:[ TimeConversionError raiseErrorString:' - bad millisecond' ].

            ] ifFalse:[

                millis := 0.

            ].

        ].

    ].

    "special check - only 24:00:00 is allowed;

     every time after that must wrap"

    hour == 24 ifTrue:[

        (min ~~ 0 or:[sec ~~ 0 or:[millis ~~ 0]]) ifTrue:[ TimeConversionError raiseErrorString:' - bad hour' ].

    ].

    ^ self year:year month:month day:day hour:hour minute:min second:sec millisecond:millis.

    "

     Timestamp basicReadFrom:'20-2-1995 13:11:06' readStream   

     Timestamp basicReadFrom:'20-2-1995 13:11:06.' readStream   

     (Timestamp basicReadFrom:'10-9-1995 13:11:06' readStream) month   

     (Timestamp basicReadFrom:'10/9/1995 13:11:06' readStream) month   

     Timestamp basicReadFrom:'20-2-1995 13:11' readStream       

     Timestamp basicReadFrom:'20-2-1995 13:11:06.100' readStream    

     Timestamp basicReadFrom:'32-2-1995 13:11:06.100' readStream  

     Timestamp basicReadFrom:'32-foo-1995 13:11:06.100' readStream 

     Timestamp basicReadFrom:'20-13-1995 13:11:06.100' readStream   

     Timestamp basicReadFrom:'20-12-1995 25:11:06.100' readStream   

     Timestamp basicReadFrom:'20-12-1995 23:61:06.100' readStream   

     Timestamp basicReadFrom:'20-12-1995 23:10:66.100' readStream   

     Timestamp basicReadFrom:'20-12-1995 23:10:00.1000' readStream   

     Timestamp basicReadFrom:'20-2-1995 24:01:00.100' readStream 

     Timestamp basicReadFrom:'20-2-1995 24:00:01.100' readStream 

     Timestamp basicReadFrom:'foo' readStream                    

     Timestamp basicReadFrom:(Timestamp now printString readStream)                  

     Timestamp basicReadFrom:'1995-10-20 24:00:00.000' readStream 

     Timestamp basicReadFrom:'1995-10-20 12:10:00.000' readStream 

     UtcTimestamp basicReadFrom:'1995-10-20 12:10:00.000' readStream 

    "

!

readIso8601FormatFrom:aStringOrStream yearAlreadyRead:yearOrNil

    "common helper for read methods.

     Return a new Timestamp, reading an iso8601 representation from aStream.

     If the time ends with a 'Z' it is the UTC (or zulu) time,

     othrwise it is local time.

     Missing month/day values are replaced with 1; i.e. 1999T24:00

     is the same as 1999-01-01T24:00:00.

     Missing minute, second and ms values are replaced with 0;

     i.e. 1999T12 is the same as 1999-01-01T12:00:00.000.

     Of course, a 24 hour clock is used.

     On error, raise an exception.

     Please use this format for all external representations - its the standard."

    |str day month year hour min sec millis fraction isUtcTime peekChar|

    str := aStringOrStream readStream.

    month := day := 1.

    hour := min := sec := millis := 0.

    isUtcTime := false.

    yearOrNil notNil ifTrue:[

        year := yearOrNil