"

 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' }"

Time subclass:#TimeDuration

	instanceVariableNames:''

	classVariableNames:'TimeDurationZero DefaultFormatForPrinting'

	poolDictionaries:''

	category:'Magnitude-Time'

!

!TimeDuration 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

"

    Represents a timestap difference.

    DefaultFormatForPrinting    if non-nil, allows for the variable printFormat to be overwritten

"

! !

!TimeDuration class methodsFor:'instance creation'!

days:d 

    "return a new TimeDuration representing a duration of d days."

    d == 0 ifTrue:[^ TimeDurationZero].

    ^ self hours:(d*24) minutes:0

    "

     TimeDuration days:1  

    "

!

days:d hours:h minutes:m seconds:s 

    "return a new TimeDuration representing a duration of d days, h hours, m minutes and s seconds.

     See also Time now / Date today / Timestamp now."

    ^ self basicNew 

        setHours:(d*24)+h minutes:m seconds:s milliseconds:0

    "

     TimeDuration days:1  hours:2 minutes:33 seconds:0   

     TimeDuration days:4 hours:100 minutes:33 seconds:0   

    "

!

fromHours:hoursInterval

    "return a new TimeDuration representing a duration of n hours."

    ^ self new setSeconds:(hoursInterval * (60*60))

    "

     TimeDuration fromHours:8  

    "

!

fromMilliseconds:n

    "return a new TimeDuration representing a duration of n milliseconds."

    "redefined to disable wrapping at 24hours."

    ^ self new setMilliseconds:n

    "

     TimeDuration fromMilliseconds:500  

     500 milliseconds  

    "

    "Created: / 18-07-2007 / 13:56:25 / cg"

!

fromMinutes:minutesInterval

    "return a new TimeDuration representing a duration of n minutes."

    ^ self new setSeconds:(minutesInterval * 60)

    "

     TimeDuration fromMinutes:120  

    "

!

fromSeconds:secondsInterval

    "return a new TimeDuration representing a duration of n seconds."

    "redefined to disable wrapping at 24hours."

    ^ self new setSeconds:secondsInterval

    "

     TimeDuration fromSeconds:3600  

    "

!

hours:h

    "return a new TimeDuration representing a duration of h hours.

     See also Time now / Date today / Timestamp now."

    h == 0 ifTrue:[^ TimeDurationZero].

    ^ self basicNew setHours:h minutes:0 seconds:0 milliseconds:0

    "

     TimeDuration hours:2 

     TimeDuration hours:100  

    "

    "Created: / 14-07-2007 / 18:15:51 / cg"

!

hours:h minutes:m

    "return a new TimeDuration representing a duration of h hours and m minutes.

     See also Time now / Date today / Timestamp now."

    ^ self basicNew setHours:h minutes:m seconds:0 milliseconds:0

    "

     TimeDuration hours:2 minutes:33 

     TimeDuration hours:100 minutes:33  

    "

!

hours:h minutes:m seconds:s millis:millis

    <resource: #obsolete>

    "return a new TimeDuration representing a duration of h hours, m minutes, s seconds and millis milliseconds.

     See also Time now / Date today / Timestamp now."

    self obsoleteMethodWarning:'use hours:minutes:seconds:milliseconds:'.

    ^ self hours:h minutes:m seconds:s milliseconds:millis

    "

     TimeDuration hours:2 minutes:33 seconds:0 milliseconds:123  

     TimeDuration hours:100 minutes:33 seconds:0 milliseconds:123  

    "

!

hours:h minutes:m seconds:s milliseconds:millis

    "return a new TimeDuration representing a duration of h hours, m minutes, s seconds and millis milliseconds.

     See also Time now / Date today / Timestamp now."

    ^ self basicNew 

        setHours:h minutes:m seconds:s milliseconds:millis

    "

     TimeDuration hours:2 minutes:33 seconds:0 milliseconds:123  

     TimeDuration hours:100 minutes:33 seconds:0 milliseconds:123  

    "

!

microseconds:microseconds

    "return a new TimeDuration representing a duration of microseconds microseconds.

     Currently we do not support this (we round to millis), but maybe later..."

    microseconds == 0 ifTrue:[^ TimeDurationZero].

    ^ self basicNew setMilliseconds:((microseconds / 1000) rounded).

    "

     TimeDuration microseconds:2499 

     TimeDuration microseconds:2500 

    "

!

milliseconds:m

    "return a new TimeDuration representing a duration of m millis.

     See also Time now / Date today / Timestamp now."

    m == 0 ifTrue:[^ TimeDurationZero].

    ^ self basicNew setMilliseconds:m

    "

     TimeDuration milliseconds:2 

    "

!

minutes:m

    "return a new TimeDuration representing a duration of m minutes.

     See also Time now / Date today / Timestamp now."

    m == 0 ifTrue:[^ TimeDurationZero].

    ^ self basicNew setHours:0 minutes:m seconds:0 milliseconds:0

    "

     TimeDuration minutes:2 

    "

    "Created: / 06-08-2007 / 15:32:42 / cg"

!

readFrom:aStringOrStream defaultUnit:defaultUnitOrNil onError:exceptionBlock

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

     The format is either:

        [n 'yr'] [n 'mon'] [n 'w'] [n 'd'] [n 'h'] [n 'm'] [n 's'] [n 'ms']

        where 

            yr -> year

            mon -> month

            w -> week

            d -> day

            h -> hour

            m -> minutes

            s -> seconds

            ms -> milliseconds

     or:

        h:m:s.ms

     The yr and mon specifiers stand for 365d and 30d respectively.

     If defaultUnitOrNil is non-nil, a plain number is treated as that;

     otherwise, a plain number raises an error.

    "

    ^ [

        |seconds millis str val fraction uIdx unit unitChar1 unitChar2|

        str := aStringOrStream readStream.

        seconds := 0.

        millis := 0.

        [

            |nextCh|

            val := Integer readFrom:str onError:nil.

            val isNil ifTrue:[^ exceptionBlock value].

            str peek == $: ifTrue:[

                "/ hour:minutes format

                str next.

                seconds := val*3600.

                val := Integer readFrom:str onError:nil.

                val isNil ifTrue:[^ exceptionBlock value].

                seconds := seconds + (val*60).

                str peek == $: ifTrue:[

                    "/ hour:minutes:seconds format

                    str next.

                    val := Integer readFrom:str onError:nil.

                    val isNil ifTrue:[^ exceptionBlock value].

                    seconds := seconds + val.

                    str peek == $. ifTrue:[

                        "/ hour:minutes:seconds.millis format

                        str next.

                        val := Integer readFrom:str onError:nil.

                        val isNil ifTrue:[^ exceptionBlock value].

                        millis := val.

                    ]

                ].

                ^ self fromMilliseconds:(seconds*1000+millis) rounded asInteger.

            ].

            str peek == $. ifTrue:[

                str next.

                fraction := Number readMantissaFrom:str radix:10.

                val := val + fraction.

            ].

            str skipSeparators.

            str atEnd ifTrue:[

                defaultUnitOrNil isNil ifTrue:[

                    ^ exceptionBlock value

                ].

                "/ no unit given - assume defaultUnit

                unitChar1 := defaultUnitOrNil.

            ] ifFalse:[

                unitChar1 := str next.

            ].

            uIdx := #($y $w $d $h $m $s) indexOf:unitChar1.

            uIdx == 0 ifTrue:[^ exceptionBlock value].

            str atEnd ifFalse:[ 

                nextCh := str peek

            ].

            (unitChar1 == $m and:[nextCh == $s]) ifTrue:[

                millis := millis + val.

            ] ifFalse:[

                (unitChar1 == $m and:[nextCh == $o]) ifTrue:[

                    unit := 2592000 "24*60*60*30"     "mon"

                ] ifFalse:[

                    unit := #(

                              31536000 "24*60*60*365" "yr"

                              604800 "24*60*60*7"     "w"

                              86400  "24*60*60"       "d"

                              3600                    "h"

                              60                      "m"

                              1 ) at:uIdx.

                ].

                seconds := seconds + (unit * val).

            ].

            [str atEnd not and:[str peek isSeparator not]] whileTrue:[ str next].

            str skipSeparators.

            str atEnd

        ] whileFalse.

        self fromMilliseconds:(seconds*1000+millis) rounded asInteger.

    ] on:Error do:[

        |t|

        "/ retry, using inherited readFrom (Object-storeString)

        t := Object readFrom:aStringOrStream onError:[^ exceptionBlock value].

        (t isKindOf:TimeDuration) ifFalse:[

            ^ exceptionBlock value

        ].

        t

    ]

    "

     TimeDuration readFrom:'2' defaultUnit:$h onError:nil 2h

     TimeDuration readFrom:'100' defaultUnit:$m onError:nil 1h 40m

     TimeDuration readFrom:'1h'      

     TimeDuration readFrom:'1h 35m'     

     TimeDuration readFrom:'25h'     

     TimeDuration readFrom:'3d'     

     TimeDuration readFrom:'1w'     

     TimeDuration readFrom:'120s'     

     TimeDuration readFrom:'1500ms    

     TimeDuration readFrom:'3ms'     

     TimeDuration readFrom:'1yr 5d'     

     TimeDuration readFrom:'1mon'     

     TimeDuration readFrom:'05:10'     

     TimeDuration readFrom:'05:10:5'     

     TimeDuration readFrom:'05:10:5.150'  

     TimeDuration readFrom:(TimeDuration new storeString)

    "

    "Modified: / 08-10-2007 / 16:41:48 / cg"

!

readFrom:aStringOrStream onError:exceptionBlock

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

     The format is [n 'yr'] [n 'mon'] [n 'w'] [n 'd'] [n 'h'] [n 'm'] [n 's'] [n 'ms']

     where 

            yr -> year

            mon -> month

            w -> week

            d -> day

            h -> hour

            m -> minutes

            s -> seconds

            ms -> milliseconds

     The yr and mon specifiers stand for 365d and 30d respectively.

     If no unit is given (i.e. a plain number string is given), assume seconds.

    "

    ^ self readFrom:aStringOrStream defaultUnit:$s onError:exceptionBlock

    "

     TimeDuration readFrom:'100' onError:nil      

     TimeDuration readFrom:'100' defaultUnit:$m onError:nil 

     TimeDuration readFrom:'1h'      

     TimeDuration readFrom:'1h 35m'     

     TimeDuration readFrom:'25h'     

     TimeDuration readFrom:'3d'     

     TimeDuration readFrom:'1w'     

     TimeDuration readFrom:'120s'     

     TimeDuration readFrom:'1500ms    

     TimeDuration readFrom:'3ms'     

     TimeDuration readFrom:'1yr 5d'     

     TimeDuration readFrom:'1mon'     

    "

    "Modified: / 08-10-2007 / 16:41:48 / cg"

!

seconds:s

    "return a new TimeDuration representing a duration of s seconds.

     See also Time now / Date today / Timestamp now."

    s == 0 ifTrue:[^ TimeDurationZero].

    ^ self basicNew setMilliseconds:(s * 1000)

    "

     TimeDuration seconds:2 

    "

    "Created: / 06-08-2007 / 15:32:21 / cg"

!

weeks:w 

    "return a new TimeDuration representing a duration of w weeks."

    ^ self days:(w * 7)

    "

     TimeDuration weeks:1  

    "

    "Created: / 05-09-2011 / 11:18:27 / cg"

! !

!TimeDuration class methodsFor:'class initialization'!

initialize

    TimeDurationZero isNil ifTrue:[

        TimeDurationZero := self basicNew setHours:0 minutes:0 seconds:0 milliseconds:0.

    ]

    "Modified: / 10-05-2011 / 10:31:35 / cg"

! !

!TimeDuration class methodsFor:'constants'!

zero

    "return the neutral element for addition (0s)"

    ^ TimeDurationZero

    "Modified: 18.7.1996 / 12:26:12 / cg"

! !

!TimeDuration class methodsFor:'format strings'!

defaultFormatForPrinting

    ^  DefaultFormatForPrinting

!

defaultFormatForPrinting:aString

    DefaultFormatForPrinting := aString

!

formatString12us

    "return the format string used to format US times (and other areas)"

    ^ '%h:%m:%s.%i'

!

formatString24

    "return the format string used to format european times (and other areas)"

    ^ '%h:%m:%s.%i'

! !

!TimeDuration class methodsFor:'timing evaluation'!

toRun:aBlock

    "return the TimeDuration it takes to execute aBlock.                          

     A modern variant of Time millisecondsToRun: (which prints itself nicely)"

    ^ self microseconds:(Time microsecondsToRun:aBlock).

    "

     TimeDuration toRun:[ 20000 factorial ]     

     TimeDuration toRun:[ 2000 factorial ]     

     TimeDuration toRun:[ 900 factorial ]     

    "

! !

!TimeDuration methodsFor:'accessing'!

days

    "get the number of days"

    ^ timeEncoding // 1000 // 3600 // 24

!

hours

    "get the number of hours.

     (notice: that is NOT the total number of hours,

     but the fractional part only. Use this only for printing"

    ^ timeEncoding // 1000 // 3600 \\ 24

!

milliseconds

    "get the milliseconds part 

     (notice: that is NOT the total number of millis,

     but the fractional part only. Use this only for printing"

    ^ timeEncoding \\ 1000

    "Modified: / 05-05-2010 / 14:22:04 / cg"

!

minutes

    "get the number of minutes.

     (notice: that is NOT the total number of minutes,

     but the fractional part only. Use this only for printing"

    ^ timeEncoding // 1000 // 60 \\ 60

!

seconds

    "get the number of seconds.

     (notice: that is NOT the total number of seconds,

     but the fractional part only. Use this only for printing"

    ^ timeEncoding // 1000 \\ 60

! !

!TimeDuration methodsFor:'arithmetic'!

* aNumber

    "return a new scaled timeDuration"

    ^ self species basicNew 

        setMilliseconds:(self getMilliseconds * aNumber) asInteger

    "

     (TimeDuration fromString:'10s') * 5

    "

!

+ aTimeDurationOrNumberOfSeconds

    "return a new timeDuration"

    aTimeDurationOrNumberOfSeconds isNumber ifTrue:[

        ^ self species basicNew 

            setMilliseconds:(self getMilliseconds + (aTimeDurationOrNumberOfSeconds * 1000) asInteger)

    ].

    ^ self species basicNew

        setMilliseconds:(self getMilliseconds + aTimeDurationOrNumberOfSeconds getMilliseconds)