"

 COPYRIGHT (c) 1994 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:libview' }"

Object subclass:#FontDescription

	instanceVariableNames:'family face style size encoding manufacturer name flags masks

		pixelSize'

	classVariableNames:'BoldnessMask FixedFlag ItalicFlag OutlineFlag SerifFlag

		ShadowFlag StrikeoutFlag UnderlineFlag CharacterSetToFontMapping

		CharacterEncodingToCharacterSetMapping'

	poolDictionaries:''

	category:'Graphics-Support'

!

!FontDescription class methodsFor:'documentation'!

copyright

"

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

"

    FontDescription is just a place-holder for scanned font names.

    [Instance variables:]

        family          <String>        the fonts family ('courier', 'helvetica' etc)

        face            <String>        the fonts face ('bold', 'medium' etc)

        style           <String>        the fonts style ('roman', 'italic', 'oblique')

        size            <String>        the fonts size (not in pixels) 

        encoding        <Symbol>        the fonts encoding (usually #iso8859-1)

        manufacturer    <nil|String|Array>

                                        the fonts origin - if known

        name            <nil|String|Array>

                                        the platform specific name

        flags           <SmallInteger>  holds serif/italic etc. as flag bits

        masks           <SmallInteger>  currently dummy; to allow ST-80 compatible subclassing

        pixelSize       <SmallInteger>  currently dummy; to allow ST-80 compatible subclassing

    [class variables:]

        BoldnessMask                    currently dummy; to allow ST-80 compatible subclassing

        FixedFlag                       currently dummy; to allow ST-80 compatible subclassing

        ItalicFlag                      currently dummy; to allow ST-80 compatible subclassing

        OutlineFlag                     currently dummy; to allow ST-80 compatible subclassing

        SerifFlag                       currently dummy; to allow ST-80 compatible subclassing

        ShadowFlag                      currently dummy; to allow ST-80 compatible subclassing

        StrikeoutFlag                   currently dummy; to allow ST-80 compatible subclassing

        UnderlineFlag                   currently dummy; to allow ST-80 compatible subclassing

    [author:]

        Claus Gittinger

    [see also:]

        Font

        FontPanel

        GraphicsContext

        ( introduction to view programming :html: programming/viewintro.html#FONTS )

"

! !

!FontDescription class methodsFor:'initialization'!

initialize

    "initialize class variables"

    BoldnessMask  := 2r0000000111.      "/ allows for 8 boldnesses to be encoded

    FixedFlag     := 2r0000001000.

    ItalicFlag    := 2r0000010000.

    OutlineFlag   := 2r0000100000.

    SerifFlag     := 2r0001000000.

    ShadowFlag    := 2r0010000000.

    StrikeoutFlag := 2r0100000000.

    UnderlineFlag := 2r1000000000.

    self initializeCharacterEncodingToCharacterSetMapping.

    self initializeCharacterSetToFontMapping.

!

initializeCharacterEncodingToCharacterSetMapping

    "character encoding"

    CharacterEncodingToCharacterSetMapping isNil ifTrue:[

        CharacterEncodingToCharacterSetMapping := Dictionary new

    ].

    #(

        'utf7'      'unicode'

        'utf-7'     'unicode'

        'utf8'      'unicode'

        'utf-8'     'unicode'

    ) pairWiseDo:[:encoding :fontEncoding|

         CharacterEncodingToCharacterSetMapping at:encoding put:fontEncoding

    ].

!

initializeCharacterSetToFontMapping

    "character sets"

    CharacterSetToFontMapping isNil ifTrue:[

        CharacterSetToFontMapping := Dictionary new

    ].

    #(

        'unicode'      'iso10646-*'

        'koi8-r'       'iso8859-5'

        'iso2022-jp'   'jis*0208*'

        'x-iso2022-jp' 'jis*0208*'

        'x-euc-jp'     'jis*0208*'

        'x-shift-jis'  'jis*0208*'

        'x-sjis'       'jis*0208*'

        'x-jis7'       'jis*0208*'

        'jis7'         'jis*0208*'

        'euc'          'jis*0208*'

        'euc-jp'       'jis*0208*'

        'sjis'         'jis*0208*'

        'big5'         'big5*'

        'gb2312'       'gb*'

        'hz-gb-2312'   'gb*'

        'x-gbk'        'gb*'

        'iso2022-kr'   'ksc*'

        'x-euc-kr'     'ksc*'

    ) pairWiseDo:[:charSet :fontEncoding|

         CharacterSetToFontMapping at:charSet put:fontEncoding

    ].

! !

!FontDescription class methodsFor:'instance creation'!

family:familyString

    "returns a font for given family and default (12pt) size 

     with default encoding.

     The new fonts face defaults `medium', its style to `roman'.

     The returned font is not associated to a specific device"

    ^ self family:familyString

           face:(self defaultFace) 

           style:(self defaultStyle) 

           size:(self defaultSize) 

           encoding:(self defaultEncoding)

    "

     Font family:'helvetica'

     Font family:'courier'

    "

    "Modified: 30.4.1996 / 17:20:44 / cg"

!

family:familyString face:faceString size:sizeNum

    "returns a font for given family and size with default encoding.

     The new fonts style defaults to `roman'.

     The returned font is not associated to a specific device"

    ^ self family:familyString

           face:faceString 

           style:(self defaultStyle)

           size:sizeNum

           encoding:(self defaultEncoding)

    "

     Font family:'helvetica' face:'medium' size:10

     Font family:'helvetica' face:'bold' size:10

     Font family:'courier'   face:'bold' size:10

    "

    "Modified: 30.4.1996 / 17:21:07 / cg"

!

family:familyString face:faceString style:styleString size:sizeNum

    "returns a font for given family, face, style and size with default encoding. 

     The returned font is not associated to a specific device"

    ^ self family:familyString

           face:faceString

           style:styleString

           size:sizeNum

           encoding:(self defaultEncoding)

    "

     Font family:'helvetica' face:'medium' style:'roman'  size:10

     Font family:'helvetica' face:'medium' style:'italic' size:10

     Font family:'helvetica' face:'bold'   style:'roman'  size:10

     Font family:'courier'   face:'bold'   style:'italic' size:10

    "

!

family:familyString face:faceString style:styleString size:sizeNum encoding:encoding

    "returns a font for given family, face, style, size and the specified encoding. 

     The returned font is not associated to a specific device"

    ^ self new

          family:familyString 

          face:faceString 

          style:styleString 

          size:sizeNum 

          encoding:encoding

    "Modified: 20.4.1996 / 23:19:04 / cg"

!

family:familyString size:sizeNum

    "returns a font for given family and size with default encoding.

     The new fonts face defaults to `medium', its style to `roman'.

     The returned font is not associated to a specific device"

    ^ self family:familyString

           face:(self defaultFace)

           style:(self defaultStyle)

           size:sizeNum

           encoding:(self defaultEncoding)

    "

     Font family:'helvetica' size:10

     Font family:'courier' size:10

    "

    "Modified: 30.4.1996 / 17:21:40 / cg"

!

family:familyString size:sizeNum encoding:encoding

    "returns a font for given family and size with default encoding.

     The new fonts face defaults to `medium', its style to `roman'.

     The returned font is not associated to a specific device"

    ^ self family:familyString

           face:(self defaultFace)

           style:(self defaultStyle)

           size:sizeNum

           encoding:encoding

    "

     Font family:'helvetica' size:10 encoding:#'iso8859-1'

     Font family:'courier' size:10 encoding:#'iso8859-1'

    "

    "Modified: 30.4.1996 / 17:21:40 / cg"

!

family:familyString style:aStyle size:sizeNum

    "returns a font for given family and size with default encoding.

     The new fonts face defaults to `medium', its style to `roman'.

     The returned font is not associated to a specific device"

    ^ self family:familyString

           face:(self defaultFace)

           style:aStyle 

           size:sizeNum

           encoding:(self defaultEncoding)

    "

     Font family:'helvetica' style:#roman size:48

     Font family:'courier' style:#roman size:10

    "

    "Modified: 30.4.1996 / 17:21:40 / cg"

    "Created: 8.10.1996 / 18:33:55 / cg"

!

name:aFontName

    "returns a font with the given explicit name.

     WARNING:

       You shuld not use explicit naming, since font names vary

       with operatingSystems, devices and architecture.

     This interface is provided for special purposes only.

     On X, the name given should be according the X fontname conventions;

     i.e. something like: '-*-times-bold-r-normal-*-*-240-*-*-*-*-iso8859-1'.

     On other devices, font naming may be completely different."

    ^ self family:aFontName 

           face:nil

           style:nil

           size:nil 

           encoding:nil

    "

     Font name:'-*-times-bold-r-normal-*-*-240-*-*-*-*-iso8859-1'

     Font name:'6x10'

     Font name:'k14'

     ((Font name:'k14') on:Display) encoding

    "

    "Modified: 30.4.1996 / 17:23:09 / cg"

! !

!FontDescription class methodsFor:'defaults'!

defaultEncoding

    ^ #'iso8859-1'

!

defaultFace

    ^ 'medium'

!

defaultSize

    ^ 12

!

defaultStyle

    ^ 'roman' 

! !

!FontDescription class methodsFor:'queries'!

characterSetForCharacterEncoding:encodingName

    "return the font-encoding for a character encoding"

    ^ CharacterEncodingToCharacterSetMapping at:encodingName ifAbsent:encodingName

    "

     FontDescription characterSetForCharacterEncoding:'utf8'     

     FontDescription characterSetForCharacterEncoding:'koi8-r'     

     FontDescription characterSetForCharacterEncoding:'unicode'     

    "

!

fontNamePatternForCharset:aCharSetName

    "return the font-encoding for an iso-charset"

    ^ CharacterSetToFontMapping at:aCharSetName ifAbsent:nil

    "

     FontDescription fontNamePatternForCharset:'iso2022-jp'       

     FontDescription fontNamePatternForCharset:'euc-jp'     

    "

!

preferredFontEncodingFor:fileEncoding

    "given a file encoding, return a corresponding match pattern for a preferred fontEncoding"

    |ce fe|

    ce := FontDescription characterSetForCharacterEncoding:fileEncoding.

    ce isNil ifTrue:[

        ce := fileEncoding.

    ].

    fe := FontDescription fontNamePatternForCharset:ce.

    fe notNil ifTrue:[^ fe].

    ^ ce ? 'iso8859*'

! !

!FontDescription methodsFor:'Compatibility-ST80'!

boldness:aNumber

    "added for ST-80 compatibility; actually ignored currently"

    |val|

    flags isNil ifTrue:[

        flags := masks := 0

    ].

    "/ scale from 0..1 to 0..BoldnessMask

    val := (aNumber max:0.0) min:1.0.

    val := (BoldnessMask * val) rounded.

    flags := flags bitOr:val.

    masks := masks bitOr:BoldnessMask

    "Created: 25.1.1997 / 03:20:05 / cg"

    "Modified: 25.1.1997 / 03:20:47 / cg"

!

color:aColor

    "added for ST-80 compatibility; actually ignored currently"

    "Created: 25.1.1997 / 03:21:28 / cg"

!

encodings:aCollectionOfEncodings

    "added for ST-80 compatibility; actually ignored currently"

    "Created: 20.6.1997 / 09:52:46 / cg"

!

fixedWidth:aBoolean

    "added for ST-80 compatibility; actually ignored currently"

    flags isNil ifTrue:[

        flags := masks := 0

    ].

    flags := flags bitOr:FixedFlag.

    masks := masks bitOr:FixedFlag

    "Created: 25.1.1997 / 03:14:06 / cg"

    "Modified: 25.1.1997 / 03:21:03 / cg"

!

italic:aBoolean

    "added for ST-80 compatibility; actually ignored currently"

    flags isNil ifTrue:[

        flags := masks := 0

    ].

    flags := flags bitOr:ItalicFlag.

    masks := masks bitOr:ItalicFlag

    "Created: 25.1.1997 / 03:15:37 / cg"

    "Modified: 25.1.1997 / 03:20:55 / cg"

!

outline:aBoolean

    "added for ST-80 compatibility; actually ignored currently"

    flags isNil ifTrue:[

        flags := masks := 0

    ].

    flags := flags bitOr:OutlineFlag.

    masks := masks bitOr:OutlineFlag

    "Modified: 25.1.1997 / 03:20:55 / cg"

    "Created: 20.6.1997 / 09:50:06 / cg"

!

pixelSize

    ^ pixelSize 

!

pixelSize:aNumber

    "if specified as non-nil, the size is ignored, and a pixel-sized font is chosen."

    pixelSize := aNumber

!

serif:aBoolean

    "added for ST-80 compatibility; actually ignored currently"

    flags isNil ifTrue:[

        flags := masks := 0

    ].

    flags := flags bitOr:SerifFlag.

    masks := masks bitOr:SerifFlag

    "Created: 25.1.1997 / 03:15:17 / cg"

    "Modified: 25.1.1997 / 03:20:59 / cg"

!

shadow:aBoolean

    "added for ST-80 compatibility; actually ignored currently"

    flags isNil ifTrue:[

        flags := masks := 0

    ].

    flags := flags bitOr:ShadowFlag.

    masks := masks bitOr:ShadowFlag

    "Modified: 25.1.1997 / 03:20:55 / cg"

    "Created: 20.6.1997 / 09:51:03 / cg"

!

strikeout:aBoolean

    "added for ST-80 compatibility; actually ignored currently"

    flags isNil ifTrue:[

        flags := masks := 0

    ].

    flags := flags bitOr:StrikeoutFlag.

    masks := masks bitOr:StrikeoutFlag

    "Modified: 25.1.1997 / 03:20:55 / cg"

    "Created: 20.6.1997 / 09:51:36 / cg"

!