"

 COPYRIGHT (c) 1996 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.

"

CharacterArray subclass:#Text

	instanceVariableNames:'string runs'

	classVariableNames:''

	poolDictionaries:''

	category:'Collections-Text'

!

!Text class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1996 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

"

    Texts add emphasis information to a string.

    Texts and strings should behave interchanchably to the outside

    world, except that texts keep per-character emphasis information.

    (strings return nil, when asked for an elements emphasis).

    Use #string, to get a texts underlying string without any emphasis

    information.

    Currently, the following attributes are supported:

        #bold     

        #italic  

        #underline  

        #strikeout

        (#color -> aColor)

        (#backgroundColor -> aColor)

    Attributes may be combined (pass an array of above) as emphasis.

    See examples.

    This class is not yet fully implemented - being constructed.

    [author:]

        Claus Gittinger

    [see also:]

        CharacterArray String RunArray

"

!

examples

"

  plain string (for comparison):

                                                                        [exBegin]

    Dialog

        warn:'hello'

                                                                        [exEnd]

  emphasized strings as dialog titles:

                                                                        [exBegin]

    Dialog

        warn:((Text string:'hello') allBold)

                                                                        [exEnd]

                                                                        [exBegin]

    Dialog

        warn:(Text string:'hello' emphasis:#italic)

                                                                        [exEnd]

                                                                        [exBegin]

    Dialog

        warn:(Text string:'hello' emphasis:#(bold underline))

                                                                        [exEnd]

                                                                        [exBegin]

    Dialog

        warn:(Text string:'hello' 

                 emphasis:(Array with:#bold

                                 with:#strikeout

                                 with:(#color->Color red)))

                                                                        [exEnd]

                                                                        [exBegin]

    Dialog

        warn:(Text string:'hello' 

                 emphasis:(Array with:#bold

                                 with:#strikeout

                                 with:(#color->Color red)

                                 with:(#backgroundColor->Color yellow)))

                                                                        [exEnd]

                                                                        [exBegin]

    Dialog

        warn:(Text string:'hello' color:(Color red))

                                                                        [exEnd]

  in an editTextView:

                                                                        [exBegin]

    |t v|

    t := 'The quick brown fox jumps over the lazy dog' asText.

    t emphasizeFrom:(t findString:'quick') count:5 with:#bold.

    t emphasizeFrom:(t findString:'brown') count:9 

                                         with:(Array with:#color->(Color name:'brown')

                                                     with:#bold).

    t emphasizeFrom:(t findString:'lazy') count:4 

                                          with:(Array with:#color->(Color red)

                                                      with:#italic).

    t emphasizeFrom:(t findString:'dog') count:3 with:#underline.

    v := HVScrollableView for:EditTextView.

    v contents:t.

    v width:450.

    v open.

                                                                        [exEnd]

"

! !

!Text class methodsFor:'initialization'!

initialize

    "initialize the class"

    "

     consider this a kludge:

     I want to inherit behavior from CharacterArray, but not

     its implementation (indexed access).

    "

    self flags:(Behavior flagRegular)

    "

     Text initialize

    "

    "Modified: 12.5.1996 / 17:53:50 / cg"

! !

!Text class methodsFor:'instance creation'!

fromString:aString 

    "create a Text instance, for the characters in aString,

     without emphasis."

    ^ self new string:aString emphasis:nil

    "

     Text fromString:'hello'

    "

    "Modified: 12.5.1996 / 17:05:34 / cg"

!

new:size

    "create a new empty Text instance.

     Redefined for string-protocol compatibility"

    ^ self string:(String new:size)

    "Created: 12.5.1996 / 11:57:27 / cg"

    "Modified: 12.5.1996 / 17:05:17 / cg"

!

string:aString 

    "create a Text instance, for the characters in aString,

     without emphasis."

    ^ self new string:aString emphasis:nil

    "

     Text string:'hello'

    "

    "Modified: 12.5.1996 / 17:05:00 / cg"

!

string:aString color:aColor

    "create a Text instance, for the characters in aString,

     which are colored as aColor (only the foregroundColor is affected).

     This is a shortCut for creating an emphasis of #color->aColor)"

    ^ self new string:aString emphasis:(#color->aColor)

    "

     Dialog

        information:(Text string:'hello' color:(Color red))

    "

    "Created: 12.5.1996 / 17:03:20 / cg"

    "Modified: 16.5.1996 / 12:37:46 / cg"

!

string:aString emphasis:attribute

    "create a Text instance, for the characters in aString,

     which are emphasized as described by attribute."

    ^ self new string:aString emphasis:attribute

    "

     Text string:'hello' emphasis:#bold

     Dialog

        information:(Text string:'hello' emphasis:#bold)

     Dialog

        information:(Text string:'hello' emphasis:#italic)

     Dialog

        information:(Text string:'hello' emphasis:#underline)

     Dialog

        information:(Text string:'hello' emphasis:#strikeout)

    "

    "Modified: 12.5.1996 / 17:16:03 / cg"

!

string:aString emphasisCollection:attributeCollection

    "create a Text instance, for the characters in aString,

     which are individually emphasized as described by attributeCollection."

    ^ self new string:aString emphasisCollection:attributeCollection

    "

     Text 

        string:'hello' 

        emphasisCollection:#(#bold #bold #italic #italic #italic)

     Dialog

        information:(Text 

                        string:'hello' 

                        emphasisCollection:#(#bold #bold #italic #italic #(#underline italic)))

    "

    "Created: 14.5.1996 / 14:02:18 / cg"

    "Modified: 14.5.1996 / 15:01:28 / cg"

!

string:aString foregroundColor:fgColor backgroundColor:bgColor

    "create a Text instance, for the characters in aString,

     which are colored in fgColor on bgColor.

     This is a shortCut for creating an emphasis of 

     #( #color->fgColor) (#backgroundColor->bgColor)"

    ^ self new 

        string:aString 

        emphasis:(Array with:#color->fgColor

                        with:#backgroundColor->bgColor)

    "

     Dialog

        information:(Text string:'hello' 

                          foregroundColor:(Color red)

                          backgroundColor:(Color yellow))

    "

    "Modified: 11.5.1996 / 14:21:01 / cg"

    "Created: 16.5.1996 / 12:37:24 / cg"

! !

!Text class methodsFor:'emphasis helper'!

addEmphasis:e1 to:e2

    "merge two emphasis's into one"

    |ne|

    e1 isNil ifTrue:[^ e2].

    e2 isNil ifTrue:[^ e1].

    e1 == e2 ifTrue:[^ e1].

    (e1 isSymbol 

     or:[e1 isAssociation]) ifTrue:[

        (e2 isSymbol 

         or:[e2 isAssociation]) ifTrue:[

            ^ Array with:e1 with:e2

        ].

        (e2 includes:e1) ifTrue:[^ e2].

        ^ e2 copyWith:e1

    ].

    (e2 isSymbol 

     or:[e2 isAssociation]) ifTrue:[

        (e1 includes:e2) ifTrue:[^ e1].

        ^ e1 copyWith:e2

    ].

    "/ ould use:

    "/    ^ (e1 asSet addAll:e2; asArray)

    "/ but we do it manually, to preserve the

    "/ order. (should create longer runs, while editing)

    ne := e1.

    e2 do:[:e |

        (ne includes:e) ifFalse:[

           ne := ne copyWith:e

        ]

    ].

    ^ ne.

    "

     Text addEmphasis:#bold to:#bold           

     Text addEmphasis:#bold to:#italic         

     Text addEmphasis:#bold to:#(italic strikeout)   

     Text addEmphasis:#italic to:#(italic strikeout) 

     Text addEmphasis:#(italic strikeout) to:#bold  

     Text addEmphasis:#(italic strikeout) to:#italic 

     Text addEmphasis:#(italic strikeout) to:#(bold underline) 

     Text addEmphasis:(#color->Color red) to:#(bold underline) 

    "

    "Modified: 14.5.1996 / 17:15:44 / cg"

!

emphasis:e1 includes:e2

    "return true, if e1 includes e2.

     e2 should be a single emphasis."

    |ne|

    e1 isNil ifTrue:[^ false].

    e2 isNil ifTrue:[^ false].

    e1 == e2 ifTrue:[^ true].

    (e1 isSymbol 

     or:[e1 isAssociation]) ifTrue:[

        ^ false

    ].

    (e2 isSymbol 

     or:[e2 isAssociation]) ifTrue:[

        ^ (e1 includes:e2)

    ].

    ^ false

    "

     Text emphasis:#bold includes:#bold           

     Text emphasis:#bold includes:#ialic         

     Text emphasis:#(italic strikeout) includes:#bold  

     Text emphasis:#(italic strikeout) includes:#italic 

    "

    "Modified: 14.5.1996 / 17:45:11 / cg"

!

removeEmphasis:e1 from:e2

    "remove an emphasis; if it was not in e1, do nothing"

    |ne|

    e1 isNil ifTrue:[^ nil].

    e2 isNil ifTrue:[^ e1].

    e1 == e2 ifTrue:[^ nil].

    (e2 isSymbol 

     or:[e2 isAssociation]) ifTrue:[

        (e1 includes:e2) ifTrue:[^ nil].

        ^ e2

    ].

    (e1 isSymbol 

     or:[e1 isAssociation]) ifTrue:[

        (e2 includes:e1) ifTrue:[

            ne := e2 copyWithout:e1.

            ne size == 1 ifTrue:[^ ne at:1].

            ne size == 0 ifTrue:[^ nil].

            ^ ne

        ].

        ^ e2

    ].

    "/ ould use:

    "/    ^ (e2 asSet removeAll:e1; asArray)

    "/ but we do it manually, to preserve the

    "/ order. (should create longer runs, while editing)

    ne := e2.

    e1 do:[:e |

        (ne includes:e) ifTrue:[

           ne := ne copyWithout:e

        ]

    ].

    ne size == 1 ifTrue:[^ ne at:1].

    ne size == 0 ifTrue:[^ nil].

    ^ ne.

    "

     Text removeEmphasis:#bold from:#bold           

     Text removeEmphasis:#bold from:#italic         

     Text removeEmphasis:#bold from:#(italic strikeout)   

     Text removeEmphasis:#italic from:#(italic strikeout) 

     Text removeEmphasis:#(italic strikeout) from:#bold  

     Text removeEmphasis:#(italic strikeout) from:#italic  

     Text removeEmphasis:#(italic strikeout) from:#(bold underline) 

     Text removeEmphasis:#(italic strikeout bold) from:#(bold underline) 

     Text removeEmphasis:#(italic strikeout bold underline) from:#(bold underline) 

     Text removeEmphasis:(#color->Color red) from:#(bold underline) 

    "

    "Modified: 14.5.1996 / 17:23:46 / cg"

! !

!Text methodsFor:'comparing'!

= aStringOrText

    "compare the receiver and the argument, ignoring emphasis"

    ^ string = aStringOrText string

    "

     'hello' asText = 'hello'        

     'hello' asText = 'hello' asText 

     'hello' asText allBold = 'hello' 

    "

! !

!Text methodsFor:'converting'!

asText

    "return the receiver itself - it is already a text object"

    ^ self

    "Created: 11.5.1996 / 14:08:36 / cg"

    "Modified: 16.5.1996 / 11:15:12 / cg"

!

at:characterIndex

    "return the plain character at characterIndex"

    ^ string at:characterIndex

    "Created: 11.5.1996 / 14:25:41 / cg"

    "Modified: 16.5.1996 / 11:15:33 / cg"

!

at:characterIndex put:aCharacter

    "change the character at characterIndex to be aCharacter.

     The emphasis (if any) of that character remains unchanged."

    ^ string at:characterIndex put:aCharacter

    "Created: 11.5.1996 / 14:25:49 / cg"

    "Modified: 16.5.1996 / 11:15:57 / cg"

! !

!Text methodsFor:'copying'!

, aStringOrText

    "concatenate the receivers characters with the arguments characters, 

     and return string or text object containing those characters.

     If either the receiver or the argument contains emphasis information,

     a text object will be returned. Otherwise, a string (i.e. without emphasis)

     is returned."

    (aStringOrText hasChangeOfEmphasis 

    or:[self hasChangeOfEmphasis]) ifTrue:[

        ^ self species new

            string:(string , aStringOrText)

            emphasisCollection:(runs , aStringOrText emphasisCollection)

    ].

    ^ string , aStringOrText string

    "

     ('hello' asText allBold) , ' world'    

     'hello' , (' world' asText allBold)

     'hello' , ' world'

     ('hello' asText allBold) , (' world' asText allBold)

    "

    "Modified: 16.5.1996 / 11:17:40 / cg"

!

concatenateFromString:aString

    "return the concatenation of aString and myself.

     This may be a Text (if I have emphasis) or a string (if not)."

    self hasChangeOfEmphasis ifTrue:[

        ^ self species new

                string:(aString , string)

                emphasisCollection:((RunArray new:(aString size)) , runs).