"

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

"{ NameSpace: Smalltalk }"

Time subclass:#TimeDuration

	instanceVariableNames:'additionalPicoseconds'

	classVariableNames:'DefaultFormatForPrinting TimeDurationZero'

	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 time/timestamp difference.

    The resolution is 1 picosecond.

    However, such small timedurations are usually only created by physical computations (see goodies/physic),

    or when reading timestamps from external measurement equipment.

    The typical OS-time resolution is in the milli- or microsecond range.

    External logging hardware may generate timestamps in the micro- or nanosecond range,

    and picosecond resolution should be good enough for almost any application (at least for the near future).

    Most timedurations only require/have millisecond resolution,

    so the picoseconds are held in a separate instvar (which is often nil or zero) 

    and does on most cases not require aditional slow largeInteger operations.

    [class variables:]

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

    [author:]

        Claus Gittinger

    [see also:]

        Date Time Timestamp AbstractTime OperatingSystem

"

! !

!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  

    "

!

fromMicroseconds:n

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

    ^ self new setMicroseconds:n

    "

     TimeDuration fromMicroseconds:500  

     500 microseconds  

    "

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

!

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  

    "

!

fromNanoseconds:n

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

    ^ self new setNanoseconds:n

    "

     TimeDuration fromNanoseconds:500  

     500 nanoseconds  

    "

!

fromPicoseconds:n

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

    ^ self new setPicoseconds:n

    "

     TimeDuration fromPicoseconds:500  

     500 picoseconds  

    "

!

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

    "

!

microseconds:microseconds

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

     Now we support microseconds (even picoseconds) but we still round to milliseconds for backward

     compatibility with the historic interface."

    microseconds == 0 ifTrue:[^ TimeDurationZero].

    ^ self basicNew setMicroseconds:microseconds rounded.

    "

     TimeDuration microseconds:2499 

     TimeDuration microseconds:2500 

     TimeDuration microseconds:12345678900 

    "

    "Modified: / 02-03-2020 / 14:16:07 / Stefan Vogel"

!

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:defaultUnitOrNilArg 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'] | [n 'us'] | [n 'ns'] | [n 'ps'])

        where 

            yr -> year

            mon -> month

            w -> week

            d -> day

            h -> hour

            m -> minutes

            s -> seconds

            ms -> milliseconds (only one of ms,us,ns or ps can follow)

            us -> microseconds

            ns -> nanoseconds

            ps -> picoseconds

     or:

        h:m:s.<ms2>

        h:m:s.<fract>

     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.

     Individual components may be negative, as in '1h -10m', which gives 50m

     or the whole duration may be negative, as in '-(1h 10m)'

    "

    ^ [

        |seconds millis picos restMillis 

         t1 str val fraction mantissa uIdx unit unitChar1 negative defaultUnitOrNil|

        defaultUnitOrNil := defaultUnitOrNilArg.

        str := aStringOrStream readStream.

        seconds := 0.

        millis := 0.

        picos := 0.

        negative := false.

        str peek == $- ifTrue:[

            str next.

            str peek == $( ifTrue:[

                |t|

                str next.

                t := self readFrom:str defaultUnit:defaultUnitOrNil onError:[^ exceptionBlock value].

                str skipSeparators == $) ifTrue:[

                    str next.

                    ^ t negated.

                ].

                ^ exceptionBlock value.

            ].                

            negative := true.

        ].

        [

            |nextCh|

            val := Integer readFrom:str onError:nil.

            val isNil ifTrue:[^ exceptionBlock value].

            negative ifTrue:[ val := val negated. negative := false. ].

            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 == $. or:[str peek == $,]) ifTrue:[

                        "/ hour:minutes:seconds.millis format

                        str next.

                        "/ the old code here was wrong in assuming that exactly 3 digits

                        "/ are coming; thus hh:mm:ss.1 was interpreted as 1ms (instead of 100)

                        "/ thus: count the zeros...

                        str peek isDigit ifTrue:[

                            "/ fraction := Number readMantissaFrom:str radix:10.

                            "/ fraction isNil ifTrue:[^ exceptionBlock value].

                            "/ ignore the float value; take the fraction

                            mantissa := Number readMantissaAndScaleFrom:str radix:10.

                            fraction := (mantissa at:2) / (10 raisedTo:(mantissa at:3)).

                            (mantissa at:3) > 3 ifTrue:[

                                picos := fraction * (1000 * 1000 * 1000 * 1000).

                                millis := picos // (1000 * 1000 * 1000).

                                picos := picos \\ (1000 * 1000 * 1000).

                            ] ifFalse:[

                                millis := fraction * 1000.

                            ].

                        ] ifFalse:[

                            millis := 0

                        ].

                    ]

                ].

                t1 := self fromMilliseconds:(seconds*1000+millis).

                picos notNil ifTrue:[

                    t1 additionalPicoseconds:picos

                ].

                ^ t1

            ].

            ((str peek == $.) or:[(str peek == $,)]) ifTrue:[

                str next.

                "/ fraction := Number readMantissaFrom:str radix:10.

                "/ ignore the float value; take the fraction

                mantissa := Number readMantissaAndScaleFrom:str radix:10.

                fraction := (mantissa at:2) / (10 raisedTo:(mantissa at:3)).

                val := val + fraction.

            ].

            str skipSeparators.

            str atEnd ifTrue:[

                defaultUnitOrNil isNil ifTrue:[

                    ^ exceptionBlock value

                ].

                "/ no unit given - assume defaultUnit

                unitChar1 := defaultUnitOrNil.

                "/ can be only used for one number

                defaultUnitOrNil := nil.

            ] ifFalse:[

                unitChar1 := str next.

            ].

            str atEnd ifFalse:[ 

                nextCh := str peek

            ].

            "/ milli, micro, nano and pico

            unitChar1 == $µ ifTrue:[ unitChar1 := $u].

            uIdx := 'munp' indexOf:unitChar1.

            ((uIdx ~~ 0) and:[nextCh == $s]) ifTrue:[

                unitChar1 == $m ifTrue:[

                    millis := millis + val.

                ] ifFalse:[

                    unit := #(

                          1000000       "us" 

                          1000          "ns" 

                          1             "ps" 

                          ) at:uIdx-1.

                    picos := (unit * val).

                    millis := picos // (1000 * 1000 * 1000).

                    picos := picos \\ (1000 * 1000 * 1000).

                ].

            ] ifFalse:[

                uIdx := 'ywdhms' indexOf:unitChar1.

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

                (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 and:[str peek ~~ $)]]] whileTrue:[ str next].

            str skipSeparators.

            "/ done when at the end or a $) is to be read

            str atEnd or:[aStringOrStream isString not and:[str peek == $)]]

        ] whileFalse.

        millis := (seconds*1000) + millis.

        restMillis := millis - millis truncated.

        millis := millis truncated.

        picos := picos + (restMillis * 1000 * 1000 * 1000) truncated. 

        millis := millis + (picos // (1000*1000*1000)).

        picos := picos \\ (1000*1000*1000).

        t1 := self fromMilliseconds:millis asInteger.

        t1 additionalPicoseconds:picos.

        t1

    ] on:Error do:[:ex |

        |t|

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

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

        (t isTimeDuration) ifFalse:[

            ^ exceptionBlock value

        ].

        t

    ]

    "

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

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

     TimeDuration readFrom:'100' defaultUnit:$s onError:nil -> 1m 40s

     TimeDuration readFrom:'0200' defaultUnit:$h onError:nil -> 1w 1d 8h

     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:'-1h'

     TimeDuration readFrom:'-1h 10m'

     TimeDuration readFrom:'1h -10m'

     TimeDuration readFrom:'-(1h 10m)' 

     TimeDuration readFrom:'1ms' -> 1ms 

     TimeDuration readFrom:'5us' 

     TimeDuration readFrom:'5µs' 

     TimeDuration readFrom:'5ns' 

     TimeDuration readFrom:'5ps' 

     TimeDuration readFrom:'5005 ps' 

     TimeDuration readFrom:'1.01 s' -> 1.010s 

     TimeDuration readFrom:'1.001 s' -> 1.001s 

     TimeDuration readFrom:'1.0001 s' -> 1.0001s 

     TimeDuration readFrom:'1s 5ns' -> 1.000000005s

     (TimeDuration readFrom:'1s 5ns') = (TimeDuration fromNanoseconds:(5+1000000000))

     TimeDuration readFrom:(TimeDuration new storeString)

    "

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

    "Modified: / 28-09-2019 / 15:23:14 / Stefan Vogel"

!

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'